Caplin Director Configuration

Here are the DataSource configuration items that are specific to Director.

Because Director is a DataSource application, it also uses DataSource configuration. For instance, you need to configure its DataSource peer connections and the logging set up. To see the list of DataSource configuration reference pages, click here.

Tip: Director is usually deployed as part of the Caplin Deployment Framework, so you set up the configuration for it within the appropriate bits of the Deployment Framework's file structure. For details, see the Deployment Framework pages.

For an overview of how configuration works see Features and concepts of DataSource configuration.

To find out about the format of configuration items, see the DataSource Configuration Syntax Reference (PDF).

Contents:

director-auditLog-maxBytes

director-auditLog-maxBytes specifies the maximum size in bytes of a Director audit log file.

Syntax: director-auditLog-maxBytes <max-bytes>

Type: integer

Default value: 268435456

director-auditLog-maxCount

director-auditLog-maxCount specifies the maximum number of Director audit log files in the rotating set (see director-auditLog-name).

Syntax: director-auditLog-maxCount <max-number-of-files>

Type: integer

Default value: 25

director-auditLog-name

director-auditLog-name specifies the base filename of Director's audit log files.

The audit files are written using the simple Java file logging handler (FileHandler), which writes to a rotating set of files whose names are derived from the base filename by adding a sequence number; for example, director-audit.log.0, director-audit.log.1director-audit.log.2, and so on.  Log messages are always written to the zeroth file (for example, to director-audit.log.0). When file 0 reaches the size limit specified by director-auditLog-maxBytes, it's closed and renamed as file 1. When file 0 is filled again, file 1 is renamed to file 2, file 0 is renamed to file 1, and a new file 0 is opened. This process repeats until (director-auditLog-maxCount +1) files have been written, when the oldest file is deleted and the remaining files are renumbered.

The base filename can contain the parameter %g, which represents the file number. For example, my-audit-%g.log would produce log files with the names my-audit-0.logmy-audit-1.log, and so on. If you don't specify a %g parameter, the file number is added to the end of the filename; for example my-audit.log.0, my-audit.log.1 ...

Use director-auditLog-path to specify the directory path to the log files.

Syntax: director-auditLog-name <audit-log-filename>

Type: string

Default value: director-audit.log

director-auditLog-path

director-auditLog-path specifies the directory path to Director's audit log files. This can can be an absolute path, or a path relative to the current directory.

Syntax: director-auditLog-path <directory-path>

Type: string

Default value: . (The current directory)

director-database-catalog

director-database-catalog specifies the name of Director's database catalog. It sets the hibernate configuration item hibernate.default_catalog.

Syntax: director-database-catalog <catalog-name>

Type: string

Default value: director

director-database-schema

director-database-schema specifies the database schema to be used. It sets the hibernate configuration item hibernate.default_schema.

Syntax: director-database-schema <schema-name>

Type: string

Default value: [no schema defined]

director-disable-new-users

Specifies whether new users are disabled by default.

Since: Director 2.0

Syntax: director-disable-new-users <value>

Type: boolean

Default value: false

director-disable-new-clients

Specifies whether new clients are disabled by default.

Since: Director 2.0

Syntax: director-disable-new-clients <value>

Type: boolean

Default value: false

director-disable-new-accounts-for-users

Specifies whether new accounts are initially disabled for all users under a client. When a new user is added to a client, all accounts will be initially disabled for that user.

Since: Director 2.0

Syntax: director-disable-new-accounts-for-users <value>

Type: boolean

Default value: false

allow-edit-account

Enables the account widget to edit account details

Since: Director 2.0

Syntax: allow-edit-account <value>

Type: boolean

Default value: false

allow-separate-spot-fwd-tier

Specifies whether clients have a seperate spot tier and forward tier.

Since: Director 2.0

Syntax: allow-separate-sport-fwd-tier <value>

Type: boolean

Default value: false

allow-client-hierarchy

Specifies whether client navigation displays clients in a hierarchy.

Since: Director 2.0

Syntax: allow-client-hierarchy <value>

Type: boolean

Default value: false

role-based-clients

Specifies whether the clients loaded for a user are based on users role.

Since: Director 2.0

Syntax: role-based-clients <value>

Type: boolean

Default value: false

role-based-actions

Specifies whether the actions permitted for a user are based on the user's role.

Since: Director 2.0

Syntax: role-based-actions <value>

Type: boolean

Default value: false

deny-root-level-client-creation

Prohibit the creation of root-level clients.

Since: Director 2.0

Syntax: deny-root-level-client-creation <value>

Type: boolean

Default value: false

allow-not-empty-client-deletion

Allow the deletion of clients that have users and sub clients.

Since: Director 2.0

Syntax: allow-not-empty-client-deletion <value>

Type: boolean

Default value: false

database-partition-in-clause

The maximum number of literal values allowed in a single SQL IN condition. When the number of values exceeds the value of database-partition-in-clause, Director combines multiple IN conditions to achieve the required comparison.

This configuration provides compatibility with Oracle database servers, which enforce a limit on the number of literal values in an IN condition. See your database manual for details. 

Since: Director 2.0

Syntax: database-partition-in-clause <value>

Type: integer

Default value: 500

max-search-result

The maximum number of search results to retrieve.

Since: Director 2.0

Syntax: max-search-result <value>

Type: integer

Default value: 50