(DI-2311) Configuration of Properties

Owned by SNP
Nov 16, 2023
9 min read

By selecting Configuration in the tree, it is possible to display system configuration properties and customize the behavior of some predefined properties.

Add system description to alert notification subject

The user has the opportunity to add a system description to the Alert notification subject of the email. By default, the system description is not added to the email subject. 

Max. runtime for execution of collector BG jobs in seconds
Determines the maximum runtime for the execution of Collector background (BG) jobs. If the BG job runtime reaches this time limit, it is aborted. The default value is 600 seconds (10 minutes). 

Use kill WP for long-running collector BG jobs
Allows you to use the OS-level function KILL Work-Process to terminate the Collector BG job, which cannot be aborted with the standard functionality. Works only, if the previous configuration parameter Max. runtime for BG job agent... is specified. Set this parameter to X to turn it on. The value is by default empty.

Kill long-running WP on the remote system 
This functionality allows you to check and kill WP on the remote system, which was triggered by a background collector job executed on the central system. When any background collector job is long-running (exceeding the defined maximum runtime threshold) on the central system, this job is automatically terminated, but in special cases, it does not kill the triggered WP on the remote system. If this property is enabled, it checks whether any long-running WP triggered by terminated collector job is still running on the remote system and kills this WP automatically. 
By default, this property is empty (disabled) as it requires an additional RFC call to the remote system, so the existing functionality is not impacted. If you want to always check for any long-running WP on the remote system, you can enable this functionality by setting this property into value 'X'. 

Retention time for background jobs in days
Background jobs are periodically deleted to clean the TBTCO table. The property BG_JOB_RETENTION_TIME sets a time condition in days, based on which the system deletes background jobs back into the past. The default value is 7 days.

Priority class for the execution of collector BG jobs 
Sets BG job priority class for the execution of Collector BG jobs. There are three priority classes used:

  • C: Lowest priority
  • B: Medium priority
  • A: Highest priority

The default value is C. If the value isn't specified, the priority is the same as by default value C.

Server group for executing collector BG jobs
Specifies the name of a server group on which BG jobs are executed. A server group must be created by the SAP transaction SM61. It determines a specific list of application servers on which BG jobs can run. The value is by default empty (no specific server group is used). 
Warning: If the server group is not set correctly (doesn't exist in SM61) then the execution of Collector jobs fails.

User ID used for the execution of collector BG jobs
Sets the user ID which is used for the execution of Collector jobs. Each execution of Collector jobs and all actions of monitoring on the central system are performed under this user ID. If a user ID isn't defined (default value), then the ID of logon user who triggers the execution of the Collector BG job is used. In case the user ID is not valid, the system displays the following error message Can not start a background job! Reason: <user ID> does not exist.
It is recommended to create a system-type user on the central monitoring system and set it up with limited authorizations which can be defined in the role /DVD/MON_ADMIN.
When the set user ID used for the execution of BG jobs is deleted, all affected jobs start failing. CrystalBridge® Monitoring can detect these failures and display them by marking the particular line with a red icon in the Collector jobs tab in the Insights Monitor. Also, affected systems are marked with a red icon in the list of monitored systems. Please note: For the correct run of collector jobs, it is important that the user ID is not deleted or locked.

Name of the cleanup job
Specifies the name of the BG job which cleans up all transactional data according to retention dates. The retention date for all collected data is calculated based on retention time (in days) which you set in the Collector BG jobs' definition. This cleanup job is scheduled and executed only once per day (the starting time of this job depends on the next setting Starting time of cleanup job). The purpose of this cleanup job is to delete all transactional data that has a retention date older than the date of the cleanup job execution. The goal of this cleanup job is to have on the system only data that fulfills the retention period. 

Starting time of clean up
Specifies the starting time of the BG job to clean up all transactional data according to retention dates. When you change the starting time to a time that already passed that day, the cleanup job is rescheduled to the next day. The time must be set in the following way: <HH:MM:SS>. 

External storage ID in Storage Management
This setup allows you to store monitoring results in a different (external) transparent storage with the help of Storage Management (SM). You must define a Storage ID in DVD SM through the transaction /DVD/SM_SETUP. Monitoring results stored on external storage is protected against retention deletion. Only transparent storages are supported. For more information about DVD SM please contact our consultants. The value is by default empty (no external storage is used).

Maximum allowed percentage of used aRFC resources
CrystalBridge® Monitoring checks the system and server availability using asynchronous processes [aRFC] to prevent communication freezes. Each system has a limited number of dialog worker processes (75% is the system default value, check the transaction SARFC for details) which are used for aRFCs. This setting determines the maximum number of aRFC resources that can be used by Insights availability checks. If Insights requests aRFC resources, which have exceeded the configured limits, it waits until aRFC resources are available again. The waiting time is set in the following configuration parameter. If the waiting time is exceeded, the availability check is not performed and an error message is written to the log. This setting should be applied only in the case when the Insights central instance runs on a system with limited resources or on a system that uses aRFC by other transactions. The value is by default empty. 

Maximum waiting time to check available aRFC resources 
Defines waiting time in seconds, to check if aRFC resources are available for the CrystalBridge® Monitoring availability check. This parameter works only in combination with the previous configuration parameter. The value is by default empty. (no waiting time, availability check, and Collector job are canceled when aRFC resources aren't available, an error message is written to the log).

Scenario to ping the server from OS level
Defines the scenario of how the server is pinged from the OS level. The following scenarios are currently supported: 

  • C: Ping functionality is executed from the Central system 
  • R: Ping functionality is executed from the Remote system 
  • N: Ping functionality is not executed for any server 

By default, the central scenario is used and servers are pinged from the central system as it worked before this parameter was created. If any other value than C, R, or N is defined for this property, the central scenario is automatically used. If there is any technical limitation that the server can not be pinged from the central system (e.g., network restrictions), you can change the ping functionality to be executed from the remote system (if the remote system is reachable through the RFC destination) or to skip the ping functionality. 

This configuration property is available since the 2305 version and to be able to use the remote scenario, the remote (satellite) system has to be upgraded to 2305 and higher versions as well. Otherwise, you will experience the warning message Function module '/DVD/MON_RFC_PING' does not exist on the system! as the functionality is not available on the lower versions and in this case, the default central scenario is automatically used.  

Also be aware that it is possible to define dependent values for this property only for the system, not for the specific profile. 

E-mail address used for the sender of the notification
The E-mail address is used as a sender in notification emails. Default value is do_not_reply@snpgroup.com (same e-mail address is used if the value is not specified). 
Warning: If you enter an invalid e-mail address, no notification emails will be sent.

Suppress collector runtime statistics 
The user has the opportunity to suppress the calculation of the collector's runtime statistics. Each Collector job calculates the runtime of its current run and also an average runtime from previously calculated values. You might speed up the Collector job executions by suppressing the calculation of its runtime statistics. 
Don't save each message occurrence
The user has the opportunity to suppress the saving of occurred messages into the database table /DVD/MON_MSG. This configuration parameter might be set if there are many records in the database table /DVD/MON_MSG. If this parameter is set to X, messages are not saved and it's not possible to display these messages in Non-aggregated view.   

Displays pop-up in a different time zone
Informs the user that there are time zone differences between the system and the user (default X value). If the parameter isn't set, a pop-up won't appear. If the parameter is set to Y, the pop-up is displayed and the CrystalBridge® Monitoring Monitor is closed.

User name for default variant replication
Defines a username whose variant is used as the default variant for other users during the first execution of CrystalBridge® Monitoring cockpit or when a user resets the user settings. This username doesn't need to exist in the system. The user variant can be copied through the transaction /DVD/MON_COPY_USRVAR from an existing user to a non-existing user and this non-existing username is used for the default variant replication.

Information only for Transformation related content packages (DTS, TC)

If any content package for Data Transformation Streamlined (DTS) or Transformation Cockpit (TC) is installed on the system, the following configuration property is also available in the list. If no content package is installed on the system, this configuration property is not available. 

Minimum retention time in days to retain data on the system
This configuration property overrides the predefined (either default or custom) retention time in days for the collector job(s). This retention time in days defines how long the collected data are retained in the monitored system. If this property is set to a value greater than 0, the retention time for affected collector jobs (collector jobs whose defined retention time is smaller than the value of this property) is automatically updated to retain the collected data based on this configured value. 

By default, this configuration property is empty and the existing retention times (either default or custom) are used. If any value greater than 0 is defined, only the collector jobs with retention times smaller than this value are updated.

IMPORTANT NOTE: Use and configure this property only if you are sure that you have enough system resources to be able to retain all collected data longer than recommended period (default values).

Example of affecting the retention functionality by using this configuration property:

  • If you have one KPI collected every 1 minute and the default retention time is 7 days, the collected values for this KPI are retained on the system for 7 days (approximately 10 000 records for all collected values for this one KPI). If this configuration property is set, for example into value 90, the collected values for this KPI are retained on the system for 90 days (approximately 130 000 records only for all collected values for this one KPI). 

This example just shows what is the impact when setting this configuration property and consider this impact before setting any custom value to this configuration property.

Dependent configuration

In Dependent configuration each value of the properties mentioned above can be set for a specific System ID or a Profile or a combination of both. In the case there are present several rows with the same System ID or Profile, the Property value is loaded according to the following rules:

  1. Property values with a specified System ID and Profile (both fields are not empty) have the highest priority.
  2. Property values with only specified System ID (Profile field is empty) have a medium priority.
  3. Property values with specified Profile (System ID field is empty) have the lowest priority.  


Configuration property setup for specific SID / Profile


Example:

The configuration property AGENT_MAX_RUNTIME has the default value of 600 seconds (After this time limit the BG job will be aborted).
The first row sets the value for each collector job with the profile DEF_1MIN for each system except the NSD system (higher priority has the second row as it has the same profile and adds the specified System ID NSD).
The second row overrides the value for the system NSD and the profile DEF_1MIN, it also overrides the property value of the first row for the profile DEF_1MIN.
The third row overrides the value for each collector job executed for the system NSD and any profile of the system except the profile DEF_1MIN, which is defined in the second row. The third row overrides as well the fourth row, as a property value with a specified System ID has higher priority than a property value with a specified Profile only.
The fourth row overrides the default value for each collector job with the profile DEF_5MIN and on every system except the NSD system, as the third row has a specified System ID and therefore has a higher priority.