Global config reference
Global config settings control the behavior of the Legacy Content Delivery application.
The following tables provide references for all the global configuration settings. The settings relevant to Legacy Content Delivery only are documented in the Legacy documentation.
| Config Name | Description |
|---|---|
| app.language | Default language for the application user interface. The user interface will be presented in this language to a new visitor. A user can modify his or her preferences in order to select a different language. |
| app.skin | The skin used by the application. All user interface resources will be loaded from this skin. If you switch to a different skin and save Global Config you must exit the current session and log back in. Then the new skin will be in effect. |
| analytics.optimization.enable | Enables indexing of the audit collection database, which improves the speed of generating analytics reports. |
| audit.enable | A flag indicating whether the application should record user audit trails. If set to Yes, all user activity will be recorded in an XML audit trail. If set to no, the application will not record any audit trails. |
| audit.aggregation.enable | A flag indicating whether the application will aggregate audit trails. If set to Yes, the application will attempt to periodically transfer its local audit trails to the aggregation server, as defined in the audit.aggregation.url setting. |
| audit.garbagecollection.enable | A flag indicating whether the application will eventually delete older audit trails. If set to no, audit trails will be kept indefinitely. If set to Yes (aggregated only), the application will delete audit trails which have been successfully aggregated. If set to Yes (local), the application will delete all audit trails that have passed the age defined in audit.aggregation.age. |
| audit.aggregation.age | Defines the time limit before a local audit is transferred to the aggregation server, if aggregation is enabled. Therefore, if set as the value Week, when an audit trail was more than 7 days old, it would be transferred to the aggregation server. If this time period has passed, and audit.garbagecollection.enable is set to Yes (aggregated), this audit trail will be aggregated and then deleted. If this time period has passed and audit.garbagecollection.enable is set to Yes (all), the audit trail will be deleted without being aggregated. |
| audit.aggregation.key and xforms.aggregation.key | A unique string used to verify the connection between an aggregation client and an aggregation server. When aggregating either form instances or audit trails, the corresponding key is compared between the client and server. If the keys are not the same on the client and server, aggregation will not occur. |
| audit.aggregation.url xforms.aggregation.url | The URL of the aggregation server. When aggregating either XForm instances or audit trails, the corresponding URL is used by the client to contact the server. These URLs should include the fully qualified domain name, port number, and application context, such as http://aggregation.lc.example.com/ (where lc refers to an example related to output, and aggregation specifies it further as a server dedicated to aggregation) |
| browsers.supported | A list of User Agent keys that identifies supported browsers. |
| cache.prefill.onpublishing.enabled | Enables (yes) or disables (no) the pre-caching of the table of content. |
| cache.prefill.onpublishing.sync.execution | Fills in the cache synchronously, at the end of the publish process before the content can be viewed (yes). Or fills in the cache asynchronously, after the publish process, and the content can be viewed before the TOC is cached (no) |
| cache.prefill.onstartup.enabled | Enables (yes) or disables (no) the pre-caching of all tables of contents after an application server restart. |
| commenting.identifiers | A pipe-delimited list of XML attributes used to identify the text or image that the user selects when adding an inline comment. This will control the behavior of inline comment targeting. |
| content.toc.depth | The number of levels of the table of contents that is loaded at a given time. If a given table of contents is deeper than content.toc.depth, as a user navigates deeper into the structure additional chunks of the TOC are loaded with AJAX. By setting this value lower, you can control the size of the chunks that are loaded and increase load performance. The recommended value for content.toc.depth is |
| custom.toc.prepare.publishing | If set to yes, applies a custom transformation to the table of content during publishing through the loading of a skin file named custom_toc_prepare_after.xsl located in the XSL\DITA directory. If set to no, no custom transformation is applied. |
| custom.toc.prepare.sync | If set to yes, applies a custom transformation to the table of content during synchronization events through the loading of a skin file named custom_toc_prepare_after.xsl located in the XSL\DITA directory. If set to no, no custom transformation is applied. |
| host.id | A unique key to identify this installation of Legacy Content Delivery . A unique host.id is generated during installation, but this can be replaced with a human-readable identifier, such as the system hostname. The application's host.id is used to differentiate audit trails and form instances that may have been created across different systems. |
| index.binary.formats | The list of binary format types that should be indexed by the application's search engine. |
| pub.session.timeout | Legacy Content Delivery session timeout override, in minutes, for Tomcat during publish tasks. When user inactivity is detected in Legacy Content Delivery , a publish process may be terminated based on Tomcat's session timeout. This configuration overrides the timeout for publishing. The default value is 600. When working with publications including several thousands of topics or more, it is suggested to at least double this number. |
| search.filter.enable | If set to yes, all searches will take filtering conditions into account. Therefore, search results will check to insure that the terms are not in content sections that would be filtered out based on the current conditions. Setting to yes may have a negative impact on performance. |
| search.ignore | Lets you choose Legacy Content Delivery object types (Libraries) to prevent them from appearing in the search results list. Those are often (at many sites) conref libraries that should not be an individual search result. |
| sitemap.changefreq sitemap.priority | Global values that are used when generating the sitemap for your application. These can be overwritten by publication and language configurations. See Configuring Sitemaps. |
| sitemap.custom.url | Lets you specify a URL that will be added to the sitemap links. If the value is empty, the URL of the computer where the publishing takes place will be used. The default value is empty.
|
| sitemap.links.in.single.file | Lets you specify the maximum number of elements making up a single sitemap. Default value: 25000. |
| social.enable | Indicates whether the Share links should be shown when a user is visiting publications and topics. When set to If you change the value of this flag, you must clear the cache to see the result. |
| sync.otherpubs.processing.retries.count | The maximum number of lock attempts in case a publication lock for synchronization fails. |
| sync.otherpubs.processing.retries.timeout | The time, in minutes, between two lock attempts in case a publication lock for synchronization fails. |
The following table provides a reference for all global configuration settings involved in setting up form instances.
| Config Name | Description |
|---|---|
| xforms.aggregation.key | A unique string used to verify the connection between an aggregation client and an aggregation server. When aggregating form instances, the corresponding key is compared between the client and server. If the keys are not the same on the client and server, aggregation will not occur. |
| xforms.aggregation.url | The URL of the aggregation server. When aggregating XForm instances, the corresponding URL is used by the client to contact the server. These URLs should include the fully qualified domain name, port number, and application context, such as http://aggregation.lc.example.com/ (where lc refers to an example related to output, and aggregation specifies it further as a server dedicated to aggregation) |
| xforms.aggregation.enable | A flag indicating whether the application will aggregate form instances. When set to yes, the application attempts to periodically transfer its local form instances to the aggregation server, as defined in the xforms.aggregation.url setting. |