6.3. Optional Settings

Engineering Knowledge Manager

Administration Guide | Chapter 6: Configuring EKM Server Settings |

6.2. Specifying General Server Settings |  | Chapter 7: Defining Custom Types
Prev |  | Next

## 6.3. Optional Settings

Optional settings are advanced settings that provide additional options for customizing and configuring the EKM server. They are described below and their usage demonstrated by sample XML code.

- `bootstrapper` and `initializer`

- `sessionTimeout`

- `showBetaFeatures`

- `fileBackupPath`

- `dataLink`

- `passwordChangeScript`

### Configuring Custom Bootstrapper and Initializer Classes (<bootstrapper> and <initializer>)

The `bootstrapper` and `initializer` settings can be used to configure custom bootstrapper and initializer classes. The `bootstrapper` class is used when a workspace is created and is populated with initial objects. The `initializer` class is used every time EKM starts up and can be used to execute custom logic at startup time. Both of these settings require that a Java class is created in a plug-in, and the full name of the `java` class is specified as a value. By default, the value for these settings is empty as shown in Figure 6.19: Default Value for bootstrapper and initializer Settings.

Figure 6.19: Default Value for bootstrapper and initializer Settings

    <bootstrapper></bootstrapper>
    <initializer></initializer>

### Specifying the Maximum Idle Time for a Session (<sessionTimeout>)

The `sessionTimeout` setting can be used to specify the maximum time (in minutes) that a user session can remain idle without any user activity. Once this time has elapsed, the user session is deactivated and the EKM license is released. The default value of this setting is 30 minutes as shown in the example below.

Figure 6.20: Default Value for sessionTimeout Setting

    <sessionTimeout>30</sessionTimeout>

### Showing or Hiding Beta Features (<showBetaFeatures>)

The `showBetaFeatures` setting can be used to either show or hide beta features. By default, the value of this setting is `false` as shown in the example below.

Figure 6.21: Default Value for showBetaFeatures Setting

    <showBetaFeatures>false</showBetaFeatures>

### Specifying a Backup Location (<fileBackupPath>)

The `fileBackupPath` setting is the full path of the folder where all files in EKM will be written to by the `fileBackup` scheduled task. The default value for this setting is shown below.

Figure 6.22: Default Value for fileBackupPath Setting

    !-- Uncomment the following if you plan to use the fileBackup task to export files to
             an external location. Provide the full path of the folder where you want the
             backup files to be stored.
    <fileBackupPath></fileBackupPath>

### Enabling PDM/PLM Integration (<dataLink>)

The `dataLink` setting is used to enable PDM/PLM integration using EKM DataLink. See the DataLink configuration guide for more details.

### Configuring a Password Change Script (<passwordChangeScript>)

You can configure EKM to use a password change script that allows users to change their password within EKM. Configuring a password change script causes a Change password option to be displayed in the Edit Profile dialog box when a user is editing their own profile information.

To enable this functionality, set the value of the `<passwordChangeScript>` setting to the path of the password change script. The username and new password will be provided to the script in two environment variables, `username` and `password`, respectively.

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.