8.2. Accessing Sample Files

Engineering Knowledge Manager

User's Guide | Chapter 8: Managing Repository Data |

8.1.5. Extraction Monitor |  | 8.3. Displaying Objects
Prev |  | Next

## 8.2. Accessing Sample Files

The web client provides you with direct access to a folder on the EKM server that contains sample files that you can use as templates for customizing EKM. The Data/Shared Data/Sample Files folder is a built-in remote folder that maps to the `EKM_HOME/examples` directory on the EKM server. It contains a `README.txt` file, five folders, and an archive file. The `README.txt` file provides instructions on how to use the contents in the `Sample Files` folder.

Note:

- The Sample Files folder is accessible only by `admin` users.

- The Delete action is not available for the Sample Files folder, even for an `admin` user. Providing `Full Control` permission to this folder to another user does not provide them with the delete option.

Figure 8.4: Built-In Sample Files Folder

There are various examples throughout the EKM documentation that refer to files found in the Sample Files folder. This includes the following tutorials:

- Tutorial: Creating a Widget Catalog

- Tutorial: Creating a Custom Analysis Project

### Sample Scripts

Also packaged with an EKM server installation and accessible from the web client are sample scripts that make use of EKM's scripting interface. These scripts are contained in a “script library” in `EKM_HOME/examples/conf/scripts` and can be accessed from the Data/Shared Data/Sample Files/conf/scripts folder, as shown below.

Figure 8.5: Scripts Folder Containing Sample Scripts

Some sample Python scripts are provided and described in more detail in Using Sample Scripts Supplied by EKM in the Administration Guide. You can use these sample scripts, and the macros (or methods) contained with them, when you define your own custom scripts. However, you should note that scripts contained within this folder are not under workspace configuration control and are therefore not available to other files or processes in different contexts. Only when the script is moved to the common Administration/Configuration/Scripts folder and put under configuration control will it be available in all contexts and not just the context they are defined for. For example, when a macro from a script that is not under configuration control is used in a lifecycle definition, then that macro cannot be called from another lifecycle or process template file unless it is defined separately within those contexts. See Configuring a Common Scripts Library in the Administration Guide for more details on how a scripts library can be configured for a workspace by an `admin` user.

For general information on scripting features in EKM, see Scripts and Journals in the Administration Guide.

### README.txt File for the Sample Files Folder

The README.txt file that is included in the Data/Shared Data/Sample Files folder provides a description of each sample file that is supplied with your EKM server setup. You can click on the file to view its contents, or select (More) > Display > Content.

Contains proprietary and confidential information of ANSYS, Inc. and its subsidiaries and affiliates.

Prev | Up / Contents | Next

Release 18.2 - © ANSYS, Inc. All rights reserved.