adhocreporting.properties

The adhocreporting.properties file supports the custom reporting module.

Properties used to configure reporting.

Report Generation
reportPageSize
  Number of rows displayed on each page of a PDF report. The maximum number of rows on a page must not exceed 45. Example (default):
    reportPageSize=45
reportColWidth
  Width, in centimeters (cm), of the report column in a PDF report output. You can adjust the size of all columns by modifying this value. Note: 2.54 cm equals 1 inch. Example (default):
    reportColWidth=20
 
Access Control Item Enforcement on Report Data Generated
availableForNonAdministrators
  Specifies whether to synchronize access control item-related information during data synchronization. Set this value to true to enable non-administrators to run reports. Set this value to false to disable all functions related to non-administrator execution of reports, such as access control item data synchronization and setting report access control items on reports. Example:
    availableForNonAdministrators=true
 
Incremental schema Enforcement using Incremental Data Synchronizer
enableDeltaSchemaEnforcer
  Specifies whether to synchronize any schema changes in reporting. Schema changes include new mappings that were created or existing mappings that were removed with the Schema Designer. When set to true, the Incremental Data Synchronizer manages the attributes that are mapped (changed) in the Schema Designer since the last full data synchronization was run. When set to false, the Incremental Data Synchronizer does not synchronize the attributes which are mapped (changed) since the last full data synchronization was run. Example (default):
    enableDeltaSchemaEnforcer=false
 
Data Synchronization
changelogEnabled
  Specifies whether the Incremental Data Synchronizer is used. Values include:
  • true – Incremental Data Synchronizer is configured
  • false – Incremental Data Synchronizer is not configured
Example (default):
    changelogEnabled=false
changelogBaseDN
  DN in the directory where the change log is configured. Example (default):
    changelogBaseDN=cn=changelog
changeLogFetchSize
  Number of change logs to be fetched at one time from the directory server. A value of 0, or a negative value, results in no fetch restriction. Fetch restriction is useful when the directory server cannot be heavily loaded for a time. For example, retrieving 100,000 change log entries at a time can delay the directory server response time for a few minutes. Example (default):
    changeLogFetchSize=200
maximumChangeLogsToSynchronize
  Maximum number of change logs to be synchronized in a single use of the Incremental Data Synchronizer. Consider the available system memory and CPU utilization that is required for other processes in the system when you set this property. If the value is set to zero or a negative value, the Incremental Data Synchronizer synchronizes all change log entries. Example (default):
    maximumChangeLogsToSynchronize=10000
changeLogsToAnalyzeBeforeSynchronization
  Number of fetched change log entries to be analyzed before all analyzed entries are synchronized to the database. For example, consider the following values:
    changeLogFetchSize=500 changeLogsToAnalyzeBeforeSynchronization=20000 maximumChangeLogsToSynchronize=100000

500 change log entries are considered one batch. After 20,000 change log entries (40 batches) are analyzed, data synchronization occurs. This process repeats until 100,000 entries are analyzed (5 synchronizations).

Setting this value to 0 or a negative value results in synchronization of all fetched change log entries. Example (default):

    changeLogsToAnalyzeBeforeSynchronization=5000
enableChangelogPruning
  Specifies whether changelog entries need to be pruned after they are successfully synchronized. This property takes effect only for the SunOne Version 5.2 directory server. For the IBM Security Directory Server, see its documentation about pruning changelog entries. Example (default):
    enableChangelogPruning=false
itimAdminID
  Administrator ID required to run the Incremental Data Synchronizer in a z/OS environment.

For example:

    itimAdminID=myadminid
itimAdminCredential
  Security Identity Manager password required to run the Incremental Data Synchronizer in a z/OS environment. For example:
    itimAdminCredential=myadmincredential
createIndex
  Specifies whether to create database indexes for frequently used database columns. If this property is set to true, reports are generated more quickly. Valid values for this property are:
  • true – Creates indexes for columns used by reporting. Enabling this value might increase the data synchronization time.
  • false – Does not create indexes during data synchronization. Disabling this value might increase the time needed to generate reports.
Example (default):
    createIndex=true
reportIndexes
  Set of <ENTITY:(ATTR1 ORDER1, ATTR2 ORDER2, ...)> values on which indexes are created. Both single and compound indexes can be created with this property. If you are creating a single index, use the name of entity that you see in the report designer or schema mapping.

If you are defining a compound index, specify the exact table name, such as Account or Person_cn, instead of the entity name. You can specify an optional order asc or desc for an index. Observe the usage of a semi-colon as the delimiter between indexes. You must maintain the syntax of this property correctly, or indexes might not get created successfully.

If we add additional indexes, follow the syntax for these default indexes:

    reportIndexes=Person:cn asc;Account:eraccountcompliance;
    Account:(eraccountstatus asc);Account:erlastaccessdate asc;
    Account:eruid asc;Service:(servicetype asc);
    Service:erservicename asc;ProvisioningPolicy:erpolicyitemname asc;
    ProvisioningPolicy:erpolicytarget asc;
    ProvisioningPolicy:erpolicymembership asc;Role:errolename asc;
    Account:(eraccountstatus asc, erservice asc);
    Person_cn:(dn, cn);Account_owner:(dn asc, owner asc)
sqlBatchSize
  Size of batch updates that are processed during data synchronization. To improve performance, set this value to a larger number. This value is affected by the specific database settings for the transaction log file size, a database property. Setting the value too high might cause data synchronization to fail. Always use the default value of 50 to avoid data synchronization failure.

A value of 0, or a negative value, causes all SQL updates to be processed as a single batch. Example (default):

    sqlBatchSize=50
attribsSkippedInSchema
  These attributes contain XMLs as data. The reporting engine currently does not support reporting on these attributes. Example (on one line):
    attribsSkippedInSchema=erEntitlements erAcl erHistoricalPassword erJavascript erLostPasswordAnswer erPassword erPlacementRule erxforms erXML
reportsAllowedAttributes
  A set of attributes on which reporting engine does not enforce attribute-level access control. Example (default):
    reportsAllowedAttributes=servicetype
reportsAllowedEntities
  A set of entities on which reporting engine does not enforce attribute-level access control. Example (default):
    reportsAllowedEntities=RecertificationPolicy,Group
reservedWords
  Database reserved words. These words are not used as table/column names during Schema Mapping and Data Synchronization. Example (on one line):
    reservedWords=ALL ADD ALTER BACKUP BEGIN BY BULK CASCADE CHECK CHECKPOINT CLUSTORED COLUMN CREATE CURRENT DUMMY DOMAIN DELETE DEFAULT DISTINCT DROP FORIGN FROM GROUP IDENTITY IDENTITY_INSERT IDENTITYCOL INSERT IN LIKE SET SELECT TABLE VALUES ORDER UID WHERE
disallowedChars
  Characters that are not part of Table/Column name in database. If the entity/attribute name contains one or more of these characters, the characters are removed from the table or column name. In the following example, the double backslashes (\\) are used as escape characters. Example (default):
    disallowedChars=~!@#%^&*()+{}|:\"<>? -=[]\\;',./
disallowedCharsForStart
  Characters are not used as the starting character of table or column name. In the following example, the double backslashes (\\) are used as escape characters. Example (default):
    disallowedCharsForStart=~!@#$%^&*()_+{}|:\"<>? -=[]\\;',./0123456789
maxTableNameLength
  Default maximum length for a table name. Example (default):
    maxTableNameLength=30
maxColumnNameLength
  Default maximum length for a column name. Example (default):
    maxColumnNameLength=30
maxTableNameLength_DB2
  Maximum name length for a table name in DB2 . Example (default):
    maxTableNameLength_DB2=128
maxColumnNameLength_DB2
  Maximum name length for a column name in DB2. Example (default):
    maxColumnNameLength_DB2=30
maxTableNameLength_ZDB2
  Maximum name length for a table name in DB2 z/OS. Example (default):
    maxTableNameLength_ZDB2=128
maxColumnNameLength_ZDB2
  Maximum name length for a column name in DB2 z/OS. Example (default):
    maxColumnNameLength_ZDB2=30
maxTableNameLength_ORACLE=30
  Maximum name length for a table name in Oracle. Example (default):
    maxTableNameLength_ORACLE=30
maxColumnNameLength_ORACLE
  Maximum name length for a column name in Oracle. Example (default):
    maxColumnNameLength_ORACLE=30
maxTableNameLength_MS_SQL_SERVER
  Maximum name length for a table name in Microsoft SQL Server. Example (default):
    maxTableNameLength_MS_SQL_SERVER=128
maxColumnNameLength_MS_SQL_SERVER
  Maximum name length for a column name in Microsoft SQL Server. Example (default):
    maxColumnNameLength_MS_SQL_SERVER=128
populateGroupMembers
  Specifies whether Service group membership changes need to be synchronized during incremental synchronization. Service group membership information is stored in the GROUPMEMBERS table. Valid values for this property are:
  • true – Synchronizes membership changes to service groups and accesses (for example, because of a new access request).
  • false – Does not synchronize group membership changes, since this type of synchronization is performance intensive.
Example (default):
    populateGroupMembers=false

Parent topic: Supplemental property files