Metrics configuration properties

Configuration properties control how and when various Metrics operations occur and help optimize performance.

Modify configuration properties

You can modify the following configuration properties in the metrics-config.xml file. After making changes to the file, restart the server to implement the changes.

Restriction: Note the following restrictions on the values allowed in the file:
  • All configuration properties, except those with multiple values, are required.
  • .enabled properties must have boolean values of either true or false.
  • Number values must be integers.
communitiesMetricsDateRanges group
Five configuration properties that specify the scope of date ranges against which community metrics static reports should be generated. Generating reports for all 5 date ranges can be time consuming. You can reduce report generation time by disabling one or more date ranges. A disabled date range is not displayed in the community metrics application. The 5 date ranges properties specify the last 7 days, last 4 weeks, last quarter, last 12 months, and all years.
  • communitiesMetricsDateRange.last7days.enabled
  • communitiesMetricsDateRange.last4weeks.enabled
  • communitiesMetricsDateRange.lastquarter.enabled
  • communitiesMetricsDateRange.last12months.enabled
  • communitiesMetricsDateRange.all.enabled
scheduledTasks group
Properties for the three scheduler tasks used by Metrics. Each task has two properties, "enabled" and "interval". "enabled" determines whether the task is run or not. If the value is false, the task is still registered, but does not run. "interval" specifies the task schedule. To get more information on how to configure the scheduler tasks, See Managing the scheduler.
  • scheduledTasks.ReportGenerator.enabled
  • scheduledTasks.ReportGenerator.interval
  • scheduledTasks.MetricsDBCleanup.enabled
  • scheduledTasks.MetricsDBCleanup.interval
  • scheduledTasks.DataSynchronization.enabled
  • scheduledTasks.DataSynchronization.interval
Reflects the current database type, typically specified during installation.

Valid values include DB2, Oracle, or SQL Server.

UserAttributesMappings group
Contains three configuration properties that define the mapping relationship between the user attribute filters used in Metrics and user properties in Profiles.
  • userAttributesMappings.attribute1
  • userAttributesMappings.attribute2
  • userAttributesMappings.attribute3
Metrics supports up to three report dimensions that are based on user attributes defined in Profiles. By default, the three dimensions are Geography, Department, and Role. You can redefine them by mapping the preceding attributes to other available attributes in Profiles. For more information, see Mapping user profile attributes to report dimensions.
Number of months from the date a metrics event is created until it is removed from the database. Metrics events are periodically removed from the database. You can change this value based on your database's capacity.

The value must be greater than 0.

User names are not displayed in all reports if this configuration is set to "true".

By default, the value is "false". Valid values are "true" and "false".

Specifies the authentication namespace ID configured during IBM® Cognos® Business Intelligence installation. The authentication namespace defines a group of properties that allows Cognos® to access an LDAP for user authentication.

This value must be the same as what you defined in the Cognos® configuration. Otherwise, you might have authentication issues when accessing Metrics.

Specifies the estimated time to generate a whole set of reports for a community. This value is used when Metrics calculates the estimated finish time of Community Metrics report generation. Be default, the value is 1200, which is measured on a normal two-CPU server. You can change this value based on the capacity of your server.

The value must be in seconds and must be greater than 0.