Performance Analytics properties
These system properties control the behavior of Performance Analytics.
To configure properties, navigate to or to sys_properties_list.do.
Collection cleanup Performance Analytics properties
Several properties determine how long Performance Analytics scores and snapshots are maintained before the scheduled cleanup job deletes them.
| Property | Description |
|---|---|
| com.snc.pa.dc.keep_scores_for.frequency | Maximum number of periods prior to today for which scores are collected and kept. The number of periods varies according to the score collection frequency, as follows: daily; weekly; bi-weekly; four weeks; monthly;
bi-monthly; quarterly; fiscal quarterly; half-yearly; yearly; fiscal yearly Scores older than this limit are not collected during data collection. Note: This property can be overridden on individual indicators.
|
| com.snc.pa.dc.keep_snapshots_for.frequency | Maximum number of periods prior to today for which lists of records (snapshots) related to a score are collected and kept. The number of periods varies according to the score collection frequency, as follows: daily;
weekly; bi-weekly; four weeks; monthly; bi-monthly; quarterly; fiscal quarterly; half-yearly; yearly; fiscal yearly. Snapshots older than this limit are not collected during data collection. Note: This property can be overridden on individual indicators.
|
Fiscal year Performance Analytics properties
These properties set the year in Performance Analytics to match your company fiscal year.
| Property | Description |
|---|---|
| com.snc.pa.fy_start | Start of the fiscal year of your company Range: 1 (January) - 12 (December) Default: 1 |
Default color scheme Performance Analytics properties
These properties set the default colors for the chart overall and for indicator targets.
| Property | Description |
|---|---|
| com.snc.pa.indicator_target_default_color_schema | Default indicator target color scheme Default: 3 color traffic light |
| com.snc.pa.chart_default_color_schema | Default visualization color scheme Default: Default UI14 |
Breakdown and indicator Performance Analytics properties
These properties set limits on breakdown elements and indicators, mostly in the context of visualizations.
| Property | Description |
|---|---|
| com.snc.pa.scoresheet.max_elements | Maximum number of elements of a breakdown that can be shown in a scoresheet Default: 500 |
| com.snc.pa.breakdown_element_cutoff | Maximum number of elements that a breakdown can have where the Analytics Hub and KPI Details show its scoreless elements. An element is scoreless when it meets one of these conditions:
Note: This parameter does not affect whether unmatched elements are shown. Default: 50 |
| com.snc.pa.scorecards.max_breakdown_elements | Maximum number of breakdown elements in Analytics Hub lists Default: 1000 Maximum: 10,000. Any value set above 10,000 is treated as 10,000. Tip:
If this value is not high enough for your indicators, consider redesigning your Performance Analytics solution. |
| com.snc.pa.scorecard.breakdown.chart.max_rows | Number of breakdown elements in visualizations Default: 10 |
| com.snc.pa.thresholds.frequency_intervals_in_the_past_limit | Maximum number of frequency intervals in the past that a threshold check job analyzes Default: 2 |
| com.snc.pa.scorecard.max_record_num | Number of records to be loaded automatically on the records tab of the Analytics Hub for a single indicator. If the number of records exceeds the value of this property, records are not automatically loaded. In this case, the user is presented with a message and a button to load all records. Default: 50,000 |
| com.snc.pa.breakdown_element_ui_max_records | Deprecated in Analytics Hub. Limit for the number of elements to be fetched for a breakdown. Used for the lookup fields (breakdown dashboard, old detailed scorecard, and so on.) Default: 100 |
| com.snc.pa.target_batch_operation_limit | Applies only to KPI Details: The maximum number of targets that can be inserted or updated in one bulk action on the Targets Configuration page. If you face timeouts while inserting or updating targets in bulk, consider reducing this limit. Default: 100 |
| com.snc.pa.widget.max_widget_indicators | Maximum number of widget indicators, in addition to the main indicator that can be added to a widget Default: 7 |
| com.snc.pa.widgets.respect_acl | Restrict widget visibility following the ACLs of indicators and breakdowns. True|false.
|
Chart properties for Performance Analytics
A chart refers here to a graphical component of a Performance Analytics widget or the Analytics Hub. These properties apply only to the Core UI, not visualizations in configurable workspaces.
| Property | Description |
|---|---|
| com.snc.pa.default_chart_line_color | Color of the scores in the
Analytics Hub
and widgets, including the trend line and bullet chart.
|
| com.snc.pa.text.trendline_points_for.frequency | Maximum number of points visible in the text analytics trend-line Default: 30 |
| com.snc.pa.default_chart_target_color | Color of the target in a graph.
|
| com.snc.pa.default_chart_personal_target_color | The line color for personal targets displayed on the Analytics Hub for a single indicator.
|
| com.snc.pa.default_chart_threshold_color | Color of the threshold in a chart.
|
| com.snc.pa.default_chart_personal_threshold_color | The line color for personal thresholds displayed on the Analytics Hub for a single indicator.
|
| com.snc.pa.default_chart_area_color0 | Color of the first gradient area in a chart.
|
| com.snc.pa.default_chart_area_color1 | Color of the second gradient area in a chart.
|
| com.snc.pa.navigator_line_color | Color of the Line in the chart navigator.
|
| com.snc.pa.navigator_area_color0 | Color of the first gradient area in the chart navigator.
|
| com.snc.pa.navigator_area_color1 | Color of the second gradient area in the chart navigator.
|
| com.snc.pa.navigator_mask_fill_color | Deprecated in the Analytics Hub. Mask fill color of the chart navigator.
|
| com.snc.pa.spark_line_width | Pixel width of the chart line. Used only on the workbench widget. Default: 1 |
| com.snc.pa.scorecard.breakdown.chart.name_max_length | Maximum number of element names on the legend in a breakdown widget. Default: 27 |
Data collector Performance Analytics properties
Data collector properties enable you to configure various limits for Performance Analytics data collection. The properties are configured to safeguard the data collection process. The default values are appropriate for most environments.
| Property | Description |
|---|---|
| com.snc.pa.dc.script_timeout | The maximum time in seconds that a script is allowed to run during a data collection cycle, such as an indicator source script or a breakdown script. This limit applies individually for each record processed by the data collection job. If a script exceeds this limit, the data collection job skips the current record. If your scripts frequently reach the default limit, simplify the scripts as much as possible before modifying this property.
|
| com.snc.pa.dc.query_time_limit | The maximum duration in minutes that a single query for a data collection job can run before a warning is logged.
|
| com.snc.pa.dc.max_row_count_indicator_source | The maximum number of records that a job can collect from a single indicator source. Important:
This property applies
only to jobs that do not use optimized data collection. If optimized data collection is enabled, which is the default condition, see the property
com.snc.pa.dc.hsql.max_row_count_indicator_source. This limit applies separately to each indicator source included in a data collection job. The number of indicators associated with each indicator source does not affect this limit. For example, if a data collection job collects scores for 12 indicators from three indicator sources, the job can collect a maximum of 150,000 records by default: 50,000 from each indicator source. Warning:
|
| com.snc.pa.dc.hsql.max_row_count_indicator_source | The maximum number of records that a job can collect from a single indicator source. Important:
This property applies only to jobs that use optimized data collection. Otherwise, com.snc.pa.dc.max_row_count_indicator_source applies. For more information, see Optimizing data collection. This limit applies separately to each indicator source included in a data collection job. The number of indicators associated with each indicator source does not affect this limit. For example, if a data collection job collects scores for 12 indicators from three indicator sources, the job can collect a maximum of 3 million records by default: 1 million from each indicator source. On upgrade to a later version than San Diego, the optimized data collector becomes enabled. This property then overrides com.snc.pa.dc.max_row_count_indicator_source. The value of the new property is set to the default 1 million, unless the value of com.snc.pa.dc.max_row_count_indicator_source was more than 1 million. In the latter case, the original property value is retained. Warning:
|
| com.snc.pa.dc.max_breakdown_elements_limit | Maximum number of breakdown elements retrieved by data collection for each breakdown source. If the number of elements on a breakdown source exceeds this limit, the data collector does not collect scores from that breakdown source. Important: This property applies only to jobs that do not use optimized data collection. For optimized data collection, see the property com.snc.pa.dc.hsql.max_breakdown_elements_limit. Also
see Optimizing data collection. This limit applies separately to each breakdown source included in a data collection job. The number of breakdowns associated with each breakdown source does not affect this limit. For example, if a data collection job collects scores for 12 breakdowns from three breakdown sources, the job can collect a maximum of 30,000 records by default: 10,000 from each breakdown source.
Warning: Increasing this limit increases the processing load on the node. This property is handled differently depending on whether nested collection is enabled: If nested collection is enabled, only elements with non-null scores count against this limit. The count is taken as the data collection job runs. When the number of elements with scores reaches this limit, the breakdown source is disabled and the scores cleared from memory. When nested collection is not enabled, all elements of a breakdown source are counted against the limit. The count is taken before any scores are collected. Consider a case where the default limit of 10,000 elements is applied to a breakdown source with 1 million elements of which 5,000 have scores. Under nested collection, the job collects the scores for those 5,000 elements. With nested collection turned off, the job does not collect any scores for this breakdown source.
|
| com.snc.pa.dc.hsql.max_breakdown_elements_limit | Maximum number of breakdown elements retrieved by data collection for each breakdown source. If the number of elements on a breakdown source exceeds this limit, the data collector does not collect scores from that breakdown source. Important: This property applies only to jobs that use optimized data collection. Otherwise, com.snc.pa.dc.max_breakdown_elements_limit applies. For more information, see Optimizing data collection. This limit applies separately to each breakdown source included in a data collection job. The number of breakdowns associated with each breakdown source does not affect this limit. By default, no limit is set on the number of breakdown elements. If you experience performance issues on jobs with breakdown sources with large numbers of elements, consider setting a limit in consultation with Customer Service and Support. On upgrade to a later version than San Diego, optimized data collection is activated. This property then overrides com.snc.pa.dc.max_breakdown_elements_limit.
|
| com.snc.pa.dc.max_breakdown_elements_level2_limit | Maximum number of breakdown elements allowed in a matrix of two breakdowns. If this limit is exceeded, the breakdown elements in the matrix are not collected. Important: This property applies only to jobs that do not use optimized data collection. For optimized data collection, see the property com.snc.pa.dc.hsql.max_breakdown_elements_level2_limit.
Also see Optimizing data collection. For example, with the default limit of 1 million elements, a first-level breakdown with 10,000 elements, and a second-level breakdown with 500, the resulting matrix of 5 million elements is not collected. If the
first-level breakdown had only 1,000 elements, the resulting 500,000 elements would be collected. Note:
This limit is also affected by the com.snc.pa.dc.max_breakdown_elements_limit property. No
breakdown matrix is collected where one of the breakdown sources exceeds that limit.
|
| com.snc.pa.dc.hsql.max_breakdown_elements_level2_limit | Maximum number of breakdown elements allowed in a matrix of two breakdowns. If this limit is exceeded, the breakdown elements are not collected. Important: This property applies only to jobs that use optimized data collection. See Optimizing data collection. By default, no limit is set on the number of breakdown elements in a matrix. If you experience performance issues on jobs with breakdown sources with large numbers of elements, consider setting a limit in consultation with Customer Service and Support. Note:
This limit could be affected by the com.snc.pa.dc.hsql.max_breakdown_elements_limit property. If that limit is set, no breakdown matrix is collected where one of the breakdown sources exceeds that
limit.
|
| com.snc.pa.dc.max_error_count | The maximum number errors that may occur for a single data collection job run before data collection is stopped. Errors during data collection usually occur due to an invalid script, or when encountering the script timeout limit. If you encounter this limit, review any scripts that run during data collection to ensure that they are valid and perform as expected.
|
| com.snc.pa.dc.max_records | Maximum number of sys IDs that are stored in a single Snapshot [pa_snapshots] record. A Snapshot record is created for each collected score, and a field in this record contains all the sys IDs of the records that
contribute to the score. If this limit is exceeded, a Snapshot record is created with the maximum number of records. This limit applies only when Collect records is selected for an indicator. For example, say you are using the default limit of 5,000 and you run a job where 5,010 records contribute to the score. The system creates a Snapshot record with a comma-separated list of the first 5,000 sys IDs in the sys_id field. Generally, the default limit provides enough detail into collected records. Increasing this limit may impact performance during data collection or when performing operations on the Snapshot table.
|
Collected scores and com.snc.pa.breakdown_element_cutoff
The elements of a breakdown that the Analytics Hub and KPI Details display for a selected date depend on the number of elements and the value of com.snc.pa.breakdown_element_cutoff.
In general, when the number of elements for a breakdown exceeds com.snc.pa.breakdown_element_cutoff, the Analytics Hub and KPI Details display only the elements that have ever had a score.
For a formula indicator, the elements that have ever had a score for all the contributing automated indicators are displayed. These scores do not need to be on the same date. The requirement is only that for each contributing indicator, on some date, there was a score for the element.
- If the number of elements that have ever had a score is less than the limit set in com.snc.pa.breakdown_element_cutoff, all of these elements are listed for any selected date. Elements that do not have a score for the selected date are still listed for that date. This behavior is the same as the behavior for real-time scores.
- If the number of elements that have ever had a score is greater than the limit set in com.snc.pa.breakdown_element_cutoff, only elements that have a score or a Change value for a selected date are listed for that date. Elements that do not have a score or Change value for that date are not listed regardless of whether they have a score for any other date.
To prevent elements with null scores appearing in the Analytics Hub or KPI Details for automated indicators, consider setting a low value for com.snc.pa.breakdown_element_cutoff, such as 0 or 1. Elements with null scores may still appear however for real-time scores and formula indicators.
Scores appearing for automated indicators with different values of com.snc.pa.breakdown_element_cutoff
This example uses KPI Details to explore the Assignment Group breakdown for the "Number of open incidents" indicator. The Assignment Group breakdown on the instance used in the example has just under 50 elements.
First is the default case, where com.snc.pa.breakdown_element_cutoff=50. This value is higher than the number of elements of Assignment Group. Therefore, for any selected date, all elements of the breakdown group are displayed.
The next case is where com.snc.pa.breakdown_element_cutoff=10. The number of elements in the Assignment Group breakdown far exceeds this value. However, only eight elements have ever had a score. This number is less than the cutoff value of 10, so for any date, all eight elements are shown, even when null.
Finally, there is the case where com.snc.pa.breakdown_element_cutoff=5. This number is less than the number of elements that have ever had a score. Now only the elements with a non-null value or a change value on the selected date are shown on that date. Different elements are thus shown for different dates.
The Analytics Settings Manager element is shown for March 7 despite having a null value. It is shown because it had a value of 5 for the previous collection period and thus has a change value of -5 for March 7.