Application Settings
The following tables list the configuration settings available in CDM.config, along with a description and possible values that you may assign. Never edit settings that are not included in the tables.
Table 1: Batch Processing Configuration Settings
objectLockingParallel ThreadsNo="8"
|
Specifies the maximum number of threads to be used at lock report time, when locking multiple report objects at once by using parallel execution. |
n |
generationBatchRefresh Enabled="true"
|
Enables or disables batch refresh when generating a report. |
true/false |
generationBatchRefresh ParallelThreadsNo="8"
|
Specifies the maximum number of threads to be used at report generation time, when refreshing multiple report objects at once by using parallel execution. |
n |
generationBatchRefresh Size="10"
|
Specifies the number of objects to be refreshed at once (in a batch) at Report Generation time. |
nn |
generationBatchRefresh WaitTimeout="00:02:00"
|
Specifies the maximum timeout to wait for a refresh response already initiated in the batch refresh of objects. |
HH:MM:SS |
Table 2: Import and Data Cleanup Configuration Settings
<AllowRememberCredentials
enabled="true" />
|
Enables or disables the Remember me checkbox on the client. |
true/false |
<CacheZoneReference cacheZone="ImportCache" />
|
Specifies the reference to the cache zone. This cache is used when importing users and groups from the active directory. |
The name of the cache zone to be used |
<SessionDataCleanupTime timeToKeepData="30.00:00:00"/>
|
The data retention time set to keep the user sessions in the database. The default value is 30 days. |
DD:HH:MM:SS |
<LrpDataCleanupTime
timeToKeepData="3.00:00:00" />
|
The data retention time to keep the results of the processes. The default value is 3 days. |
D:HH:MM:SS |
Table 3. Data Source Configuration Settings
<DataSources queryMetadataLoadTimeout>
|
Handles the relational query metadata load during query creation or editing. |
n |
<DataSources skipLoadMetadata>
|
Bypasses the metadata load action leaving the query builder empty, allowing advanced users (that do not use the query builder UI) to improve query creation/editing performance. |
|
<DataSources
queryPreviewMaxCells="200000">
|
The number of cells can be controlled in the query window. |
n |
<Whitelist>
<add name="unique_name" serverName="server_name or IP_address"/>
</Whitelist>
</DataSources>
|
For each data source, you must add an add line to the DataSources\Whitelist element.
The name property identifies the configuration and must be unique in the whitelist element.
The serverName property contains the fully qualified server host name or IP address. You can use the following wildcards:
Examples:
<add name="Fixed IP" serverName="192.168.1.100" />
<add name="Whole subnet" serverName="192.168.1.*" />
<add name="First 10 IPs" serverName="192.168.1.10?" />
<add name="Fixed hostname in domain" serverName="dataSourcesServer.mydomain.com" />
|
Name
Server name or IP address
|
<TM1Configuration
RestApiVersion="v1" TM1DatasourceTimeout="300" />
|
Specifies parameters for the TM1 server.
The RestApiVersion attribute specifies the version of the TM1 REST API you want to use.
The TM1DatasourceTimeout attribute specifies how long CDM waits for TM1 server responses during HTTP REST calls for data retrieval, in seconds. The timeout applies to the ReadWriteTimeout property of the REST calls.
|
v1, v2, v3, and so on (refer to the TM1 REST API documentation)
300
|
<BIConfiguration
RestApiVersion="v1" />
|
The version of the Cognos BI REST API you want to use. |
v1, v2, v3, and so on (refer to the Cognos BI REST API documentation) |
<DataSourceConnector UseSecureConnection="false" ServerCertificateName="CertName"/>
|
Specifies parameters for the Data Source Connector.
The UseSecureConnection attribute denotes whether the connection between the CDM Server and the Data Source Connector should be secured. Set it to true for a secure connection (in this case you also have to provide a valid certificate name).
The ServerCertificateName attribute specifies the name of the certificate used to secure the connection between the CDM Server and the Data Source Connector. The certificate should be imported in IIS (the certificate that is already configured for the CDM Server WebService is normally used).
|
true/false
String value certificate name
|
<EPMConfiguration metadataExportJobName="CDM_Metadata_Export" EPMFormulaExecutionTimeoutInSeconds="600" MaxDegreeOfParallelism="5"/>
|
Specifies parameters for EPM connection and formulas.
The metadataExportJobName attribute specifies a custom export job name in the EPM portal. To enable metadata export from Oracle EPM, you should manually create the specified export metadata job in the EPM instance and configure the required dimensions within that job. The dimensions included in the job will be the only ones available for selection during data query preparation in CDM. You also need to make sure CDM Server has sufficient read/write privilege access to the temp folder of the machine where the EPM server is located. The temp folder is where metadata is exported and cube names are parsed.
When defining the job name, you should avoid using the following special characters according to XML specifications.
" |
" |
' |
' |
< |
< |
> |
> |
& |
& |
The EPMFormulaExecutionTimeoutInSeconds attribute specifies the timeout during EPM formula execution, in seconds. When the execution time for a formula exceeds the configured timeout (excluding execution at report generation), CDM terminates the ongoing API call or formula evaluation, and adds an appropriate log entry to indicate the timeout event.
The MaxDegreeOfParallelism attribute specifies the maximum parallel threads allowed for processing EPM formulas.
|
CDM_Metadata_Export
600
5
|
Table 4: Session Configuration Settings
SessionExpiration="true"
|
The expiration of a session. If set to false, the session never expires. |
true/false |
timeoutAfterLogOn="24:00:00"
|
The timeAfterLogOn attribute specifies the amount of time after the creation of a session that the session will expire. See Session Timeout. |
HH:MM:SS |
acceptedIdleTime="02:00:00"
|
This option dictates when CDM will time out the session, based on
inactivity. |
HH:MM:SS |
<CdmAccountLockoutPolice accountLockoutThreshold="0" accountLockoutDuration="0" />
|
The accountLockoutThreshold property identifies the allowed number of initial failed attempts to log in by the user before the duration property takes effect. The value must be any number greater than 0.
The accountLockoutDuration property identifies the time in minutes the user's account is locked after the threshold has been met. When the duration has passed, the user can attempt another log in. If it fails, the duration takes effect again and for each subsequent single log in failure thereafter. The value must be any number greater than 0. A negative integer locks the
user's account immediately when the threshold is reached and requires an administrator to unlock it.
|
n |
<UserDisplayFormat name="DisplayName" />
|
This option is used to set how user information is displayed. The default is DisplayName which is the display name entered when the user was created. You can add either UserName to display the user's login name, or ImportSourceName to display the source that the user was imported from if their user information was imported, or both. If no parameters exist in the UserDisplayFormat key, DisplayName is used as the default. |
DisplayName/
UserName/
ImportSourceName |
Table 5: Cache Storage and Refresh Configuration Settings
<CacheZoneReference cacheZone="RefreshCache"/>
|
Specifies the cache zone to be used by the refresh cache. |
Name of the cache zone listed in the CDM.config file |
<DataSourceMonitor recoverWaitInterval="00:05:00"/>
|
The recoverWaitInterval attribute specifies the time interval to wait for a data source (identified as currently unavailable) to recover from its failure. |
HH:MM:SS |
<PendingRefresh enabled="true" pendingRefreshVerifyInterval="00:00:01"
maxWaitTime="00:01:00"/>
|
The enabled attribute specifies if Pending Refresh is used. This option is used when a refresh is performed on an object that is currently being refreshed; the Pending Refresh feature waits until the first refresh is completed, then will get the refreshed value from the cache without doing a new refresh. This feature only works in the same process space.
The pendingRefreshVerifyInterval attribute specifies the time to wait for a pending refresh item to be checked regarding its refresh completion. This is used when multiple refresh requests on the same resources, objects, and queries are executed at the same time. In this case only one refresh is made and the other requests are waiting for the refresh to be completed.
The maxWaitTime attribute specifies the maximum time to wait for the first refresh to finish.
|
true/false
HH:MM:SS
HH:MM:SS
|
<ExcelRefresh queryResultMaxRows="1000" truncateOnQueryResultMaxRowsExceeded="True"/>
|
The queryResultMaxRows attribute specifies the maximum number of rows to return after executing a query when the truncateOnQueryResultMaxRowsExceeded attribute is set to True.
Note: This setting applies to all these data query types when inserted into an Excel object: OLAP and relational databases, and external Microsoft™ Excel files.
|
n
true/false
|
<ExpirationPolicies minimumAcceptedSlidingTime="00:10:00" />
|
Specifies the minimum accepted sliding time for time expiration policies. |
HH:MM:SS |
Table 6: Backing Stores Configuration Settings
add name="RefreshMemoryStore"
|
The name attribute specifies the name of the backing store, and is a reference in the Cache Zone settings. |
String |
storageProvider="Ibm.CognosDM.
Cache.Storage.Providers.
InMemoryNoZonesCacheStorage,
Ibm.CognosDM.Cache"
|
The storageProvider attribute defines the actual implementation of the ICacheStorage. |
String |
monitorPerfomanceCounters="false" memoryLimitMegabytes="500" persistentCacheSyncInterval="00:10:00"
|
The monitorPerformanceCounters attribute specifies the storage that should update the Generic Cache Layer counters. As a dual implementation is used, only one storage should make these updates and usually the persistent storage is used. |
true/false
n
HH:MM:SS
|
priorityScavengingInterval="00:10:00" priorityScavengingMegabytes="50"
|
The priorityScavengingInterval and priorityScavengingMegabytes attributes specify the interval to test if the memory limit exceeded and the size that the in-memory storage will be reduced. |
HH:MM:SS
n
|
add name="ImportMemoryStore"
|
The name attribute specifies the name of the backing store, and is a reference in the Cache Zone settings. |
String |
storageProvider="Ibm.CognosDM.
Cache.Storage.Providers.
InMemoryNoZonesCacheStorage,
Ibm.CognosDM.Cache"
|
The storageProvider attribute defines the actual implementation of the ICacheStorage. |
String |
monitorPerfomanceCounters="false" memoryLimitMegabytes="200" persistentCacheSyncInterval="00:10:00"
|
The monitorPerformanceCounters attribute specifies the storage that should update the Generic Cache Layer counters. As a dual implementation is used, only one storage should make these updates and usually the persistent storage is used. |
true/false
n
HH:MM:SS
|
priorityScavengingInterval="00:30:00" priorityScavengingMegabytes="20"
|
The priorityScavengingInterval and priorityScavengingMegabytes attributes specify the interval to test if the memory limit exceeded and the size that the in-memory storage will be reduced. |
HH:MM:SS
n
|
<persistent>
<add name="PersistentStore"
storageProvider="Ibm.CognosDM.
Cache.Storage.Providers.
PersistentCacheStorage,
Ibm.CognosDM.Cache"
connectionStringName="CDMCache"
pageSize="100" />
</persistent>
|
The persistent storage uses a connectionStringName attribute and pageSize attribute to define the location and the page size used for the proactive-loading at application startup. |
String
true/false
n
|
Table 7: Report Generation and Report Export and Import Configuration Settings
<ReportGeneration imageDpi="200" reduceStyles="false" htmlOutputFixedWidthInches="8.5">
</ReportGeneration>
|
The imageDpi attribute is used to specify the DPI ratio used to render the ##IRS-##IRE ranges as images in a Word object.
The reduceStyles attribute describes how a table or list style is applied when defined and used in multiple Word objects included in a report generation. When set to true, the first occurrence of the style is the one used for all styles of the same name. When set to false, all styles are copied each time in the generated output. False is the default setting.
The htmlOutputFixedWidthInches attribute is used to set a fixed width for HTML output content in a browser for EDGAR and Inline XBRL outputs. If this attribute is not present the default width is 8.5 inches.
|
n
true/false
n
|
<FontSettings>
<FontsSource fontsFolderPath="Filepath"/>
<DefaultFontSubstitution isEnabled="true" defaultFontName="Arial"/>
</FontSettings>
|
The fontsFolderPath attribute sets
the path of the custom font files you want to use at PDF generation.
If the provided path points to a network-shared folder, you need to include the credentials of a user with at least read access to that fonts folder in Credentials.config under the <SharedFolderAccessCredentials> key.
The isEnabled attribute specifies whether to apply the predefined default font when CDM fails to access the custom font path.
The defaultFontName attribute sets
the default font name.
|
Path
true/false
String
|
<Export path="Filepath"/>
|
The path attribute sets the path where the temporary export files are stored. The value of this attribute is mandatory but there is no default value. The administrator needs to provide a path to an existing folder where the Application Pool Identity has write access. |
Path and file name |
<Import path="Filepath"/>
|
The path attribute sets the path where the temporary import files are stored. The value of this attribute is optional. The administrator can provide a path to an existing folder where the Application Pool Identity has write access.
If the Import element is not supplied the temporary folder of Application Pool Identity is used to store the temporary import files.
|
Path and file name |
Table 8: High Definition HTML Generation Configuration Settings
<Fonts> ... </Fonts>
|
Specifies the font names to include in HD generation. You can add a font using the <add name=""/> tag, for example <add name="Arial"/>. All the fonts inside this list are considered supported by CDM. This means that if any of these fonts is used inside CDM objects, in the resulting HD generation the fonts are referenced by name (when the HTML is viewed in a browser, the browser will use that reference in combination with the font present on the machine to render the output). If a CDM object contains a font that is not mentioned in the list, the generation will:
Embed the font inside the HTML when the Embed Font checkbox is selected for the following generation types: High Definition HTML, High Definition ESMA ESEF xHTML, and Inline XBRL High Definition (ESMA jurisdiction). An embedded font is included (as a base64 string) inside the HTML file, allowing browsers to correctly render it on machines that do not have that font installed. Not embed the font when the Embed Font checkbox is not selected for High Definition HTML generations, and return a warning (UnsupportedFontDetectedWarning). -
Fail and return an error message (UnsupportedFontDetectedError), informing the user regarding the unsupported font, for the following generation types:
EDGAR HTML and Inline XBRL High Definition (SEC jurisdiction) High Definition ESMA ESEF xHTML and Inline XBRL High Definition (ESMA jurisdiction), when the Embed Font checkbox is not selected.
|
String |
<CreateHtmlTables value="false"/>
|
Enables or disables rendering HD tables using HTML table tags. This setting applies only to Inline XBRL High Definition generations, for ESMA jurisdiction. |
true/false |
<FixStyleForSecInlineViewer value="false"/>
|
Enables or disables fix styles for rendering in Edgar Renderer. Should be true for Arelle versions earlier than 2023. |
true/false |
<InlineCSS value="false"/>
|
Enables or disables generating CSS styles inline so auditors can review text blocks in external tools for ESEF. When set to true, it increases the inline instance file size. |
true/false |
<PixelsThreshold value="2"/>
|
Controls the tolerance when deciding to create inline blocks to fill up space between words. |
n |
<Precision value="2"/>
|
The number of decimals to place on coordinates and widths. This setting has a direct impact on file size and number of unique styles. |
n |
Table 9: Desktop Publishing Generation Utility Configuration Settings
<EnableDesktopPublishing AutomaticWordGeneration value="true">
|
The EnableDesktopPublishing attribute is used to grant access to the Desktop Publishing Utility.
|
true/false |
Table 10: Enforcement of Microsoft Office Version Configuration Settings
<ForceToOfficeVersion enabled="true" Value="" />
|
Enter a specific Office version then all objects saved by client systems are saved in this level of Microsoft Office.
If the field remains empty, there is no enforcement of an Office version. The report is generated based on the version of Office in which each object was last saved.
For more information, see Multiple Versions of Microsoft Office.
|
A supported version of Microsoft Office, for example, 2013 or 2016 |
Table 11: Enable or Disable Simultaneous Query Requests
<ParallelRefresh enabled="true">
</ParallelRefresh>
|
Used to enable and disable the running of simultaneous query requests to a data source when there are multiple data queries in an object. If an object only has one data query within it then this feature is not used. |
true/false |
Table 12: Enable or Disable Using Advanced Refresh
<BackgroundTaskServi enabled="true">
</BackgroundTaskService>
|
Used to enable the use of Advanced Refresh in the report properties. |
true/false |
Table 13: Feature Flags
<add name="InlineHiddenBookmarks" enabled="true" />
|
Used to include or exclude hidden bookmarks when generating inline XBRL. When set to false, the hidden bookmarks will be ignored at reordering. |
true/false |
<add name="ESMAParagraphTagging" value="false" />
|
Used to display the Paragraph Tagging command in the Home tab of CDM XBRL projects. When set to true, you can toggle on paragraph tagging to apply a text block concept to one or more paragraphs when you select a portion of the paragraphs. |
true/false |