SAP System Monitoring Parameters
Here you will find detailed information about monitoring parameters for SAP System monitored objects.
Monitoring parameters are the mechanism for you to configure how your systems are monitored. They are how you set configuration of how the agent runs, how checks are executed, thresholds for checks (when does a check go critical or warning) and much more. All Monitoring Parameters have a carefully chosen default value. As soon as you add a new system, Avantra uses these defaults. You may change these defaults by defining a parameter and by modifying its values. Monitoring Parameters can be defined for a single system, or for collections of systems using Monitoring Parameter Sets. You can also define your own Custom Monitoring Parameters for use within Custom Checks and automations.
ABAP_DD_DB_Exclude
Indexes defined in this parameter are excluded from the "indexes missing" and "unknown indexes" part of the ABAP_DD_DB check. Please note that this parameter can only be used for indexes, but not for tables. Indexes listed must be separated by one or more spaces
Reference Data
| Configures Checks | ABAP_DD_DB |
| Default Value | |
| Unit | String |
ABAPDBSchema
If the tables required for the [DB2_CBO_STATS]built-in-checks#db2_cbo_stats) check cannot be found in the default schema you may define the appropriate schema in here.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | String |
AbapJsonMode
there are problems with the default ABAP class used to generate JSON in an SAP system, a compatibility mode can be chosen.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | String |
AutoChangeDetectionIgnore
This check is used to exclude parameters from System Change Auto Detection. If, for example, a parameter value changes regularly and this behavior is well-known, you may add the parameter to the exclude list. The parameter value is still updated in the Avantra Database, but no change record will be created. Since there are several change detection objects, you must prefix the list with a keyword to indicate the object type.
For SAP Systems, only DBPARAM is currently supported. Wildcard * is supported to define multiple parameters, e.g. DBPARAM: *MEMORY*, CPU_COUNT
Reference Data
| Configures | System Change Auto Detection |
| Default Value | |
| Unit | String |
BatchInputClientExclude
This parameter specifies clients which are excluded from all checks provided by BATCH_INPUT.
Reference Data
| Configures | BATCH_INPUT |
| Default Value | 000 066 |
| Unit | String |
BatchInputMaxAge
This parameter specifies the maximum age of batch input sessions. If there are records older than BatchInputMaxAge found, BATCH_INPUT will result as Warning. You can turn this part of BATCH_INPUT off if you change the parameter to 0.
Reference Data
| Configures Checks | BATCH_INPUT |
| Default Value | 60 |
| Unit | Days |
BatchInputMaxRunTime
This parameter specifies the maximum run time of batch input sessions. If there are running sessions older than BatchInputMaxRunTime found, BATCH_INPUT will result as Warning.
Reference Data
| Configures Checks | BATCH_INPUT |
| Default Value | 24 |
| Unit | Hours |
BatchInputQIDExclude
This parameter defines batch input sessions by Queue-ID which are excluded from all sub-Checks of the BATCH_INPUT Check. The list of Queue-IDs may be separated by blanks or commas. Wildcards are not supported.
Reference Data
| Configures Checks | BATCH_INPUT |
| Default Value | |
| Unit | String |
BcsOutboundClientList
Works together with BcsOutboundClientMode, either to specify clients to be excluded (BcsOutboundClientMode is in mode deny (Blacklist)) or limited to only clients listed (BcsOutboundClientMode is in mode allow (Whitelist)). Please be aware that if you change parameter BcsOutboundClientMode, you can also change this parameter to another list, since the default value 000 066 is intended to work in deny mode.
Reference Data
| Configures Checks | BCS_OutboundWaitStat, BCS_OutboundErrStat, BCS_OutboundErrors |
| Default Value | 000 066 |
| Unit | String |
BcsOutboundClientMode
All Business Communication Services checks are designed to retrieve data of all clients found in an SAP system, no matter which client is used for RFC by the Avantra Agent. To exclude clients from being checked, you may use BcsOutboundClientList in either deny (Blacklist) or allow (Whitelist) mode. The default value is deny, i.e. all clients will be checked except clients 000 and 066. If you want to, for instance, only check on specific clients, you may change this mode to allow and specify the clients to be checked using parameter BcsOutboundClientList.
Reference Data
| Configures Checks | BCS_OutboundWaitStat, BCS_OutboundErrStat, BCS_OutboundErrors |
| Default Value | Blacklist |
| Unit | Enum |
BcsOutboundErrorsNumCrit
If the number of erroneous outbound business communication records since the last Daily Check start is equal to or above the defined value, the check status is set to Critical.
Reference Data
| Configures Checks | BCS_OutboundErrors |
| Default Value | 20 |
| Unit | Number |
BcsOutboundErrorsNumWarn
If the number of erroneous outbound business communication records since the last Daily Check start is equal to or above BcsOutboundErrorsNumWarn but below BcsOutboundErrorsNumCrit, the check status is set to Warning.
Reference Data
| Configures Checks | BCS_OutboundErrors |
| Default Value | 1 |
| Unit | Number |
BcsOutboundErrStatNumCrit
If the number of erroneous outbound business communication records in the last BcsOutboundErrStatTimeSpan minutes is equal to or above the defined value, the check status is set to Critical.
Reference Data
| Configures Checks | BCS_OutboundErrStat |
| Default Value | 5 |
| Unit | Number |
BcsOutboundErrStatNumWarn
If the number of erroneous outbound business communication records in last BcsOutboundErrStatTimeSpan minutes is equal to or above BcsOutboundErrStatNumWarn but below BcsOutboundErrStatNumCrit, the check status is set to Warning.
Reference Data
| Configures Checks | BCS_OutboundErrStat |
| Default Value | 1 |
| Unit | Number |
BcsOutboundErrStatTimeSpan
If the date/time of an erroneous business communication record is after now minus BcsOutboundErrStatTimeSpan minutes, the record will be counted, otherwise, it's no longer retrieved.
Reference Data
| Configures Checks | BCS_OutboundErrStat |
| Default Value | 60 |
| Unit | Minutes |
BcsOutboundWaitTimeExceptions
If you want to use different wait times thresholds for certain outbound waiting records, you may use this parameter which follows the syntax:
<list of clients> or \* for all | <list of send methods> or * for all | warning threshold in minutes | critical threshold in minutes
Multiple clients and send methods of an exception are separated by comma (,). Please use the short name of the send method. Multiple exceptions are separated by semicolon (;). Spaces may exist at any place of the parameter string, since they will be ignored.
There is also a special value 0 for the warning and critical thresholds. 0 means that the corresponding threshold will not be verified. So if you set both to 0, you can exclude records completely from being verified. They are, however, still displayed in the result table.
Examples: Exceptions
101,102|FAX|60|120 ; *|INT|20|40
For clients 101 and 102 send method FAX the warning/critical thresholds are changed to 60/120 minutes. For all clients and send method INT the warning/critical thresholds are changed to 20/40 minutes
900|FAX|0|0
In client 900 all waiting records for sent method FAX are completely ignored and will not contribute to the check result.
Reference Data
| Configures Checks | BCS_OutboundWaitStat |
| Default Value | |
| Unit | String |
BcsOutboundWaitNumCrit
If the number of waiting business communication records in an SAP client is above BcsOutboundWaitNumCrit and the wait time is above BcsOutboundWaitTimeCrit, the check result status of BCS_OutboundWaitStat will be Critical.
Reference Data
| Configures Checks | BCS_OutboundWaitStat |
| Default Value | 5 |
| Unit | Number |
BcsOutboundWaitNumWarn
If the number of waiting business communication records in an SAP client is above BcsOutboundWaitNumWarn and the wait time is above BcsOutboundWaitTimeWarn, the check result status of BCS_OutboundWaitStat will be Warning, as long as the number and time are still below the Critical thresholds.
Reference Data
| Configures Checks | BCS_OutboundWaitStat |
| Default Value | 1 |
| Unit | Number |
BcsOutboundWaitTimeCrit
If the number of waiting business communication records in an SAP client is above BcsOutboundWaitNumCrit and the wait time is above BcsOutboundWaitTimeCrit, the check result status of BCS_OutboundWaitStat will be Critical.
Reference Data
| Configures Checks | BCS_OutboundWaitStat |
| Default Value | 15 |
| Unit | Minutes |
BcsOutboundWaitTimeWarn
If the number of waiting business communication records in an SAP client is above BcsOutboundWaitNumWarn and the wait time is above BcsOutboundWaitTimeWarn, the check result status of BCS_OutboundWaitStat will be Warning, as long as the number and time are still below the Critical thresholds.
Reference Data
| Configures Checks | BCS_OutboundWaitStat |
| Default Value | 5 |
| Unit | Minutes |
BDOCMonitorClients
By default, CRM_BDOC_MONITOR check reads from all SAP clients. This monitoring parameter is used to limit clients. Client numbers containing BDoc data are entered in a comma-separated format (no spaces), i.e., 001,002,100,200, etc. If blank, the Avantra monitoring RFC client will be used.
Reference Data
| Configures Checks | CRM_BDOC_MONITOR |
| Default Value | |
| Unit | String |
BDOCMonitorDays
This monitoring parameter sets the number of days from today to check for BDoc message monitor errors. If zero (0), then it will be all of today, i.e., today - zero = today.
Reference Data
| Configures Checks | CRM_BDOC_MONITOR |
| Default Value | 0 |
| Unit | Number |
BDOCMonitorType
This parameter specifies the filter for including/excluding BDoc types. The format is comma-separated without spaces, i.e., OBJCL_MESSAGE,VEND_MAIN,BU*, etc.
Reference Data
| Configures Checks | CRM_BDOC_MONITOR |
| Default Value | |
| Unit | SelectOptions |
BDOCMonitorWarn
This monitoring parameter configures the warning threshold for CRM_BDOC_MONITOR check based on the number of records returned.
Reference Data
| Configures Checks | CRM_BDOC_MONITOR |
| Default Value | 1 |
| Unit | Number |
BDOCMonitorCrit
This monitoring parameter configures the critical threshold for CRM_BDOC_MONITOR check based on the number of records returned.
Reference Data
| Configures Checks | CRM_BDOC_MONITOR |
| Default Value | 20 |
| Unit | Number |
BgRfcErrorClientList
Configures the clients to include in the BG_RFC_ERROR check.
Reference Data
| Configures Checks | BG_RFC_ERROR |
| Default Value | empty |
| Unit | String |
BWProcessChainsCancelledStatus
Define the status that should be reported if one of the process chains is cancelled.
Reference Data
| Configures Checks | BW_PROCESSCHAINS |
| Default Value | 2 |
| Unit | Number |
BWProcessChainsExclude
Process chains defined in this parameter are not considered for the check status.
Reference Data
| Configures Checks | BW_PROCESSCHAINS |
| Default Value | |
| Unit | String |
BWProcessChainsRTCrit
If one of the process chains exceeds the runtime threshold defined, the check status turns to Critical.
Reference Data
| Configures Checks | BW_PROCESSCHAINS |
| Default Value | 240 |
| Unit | Minutes |
BWProcessChainsRTWarn
If one of the process chains exceeds the runtime threshold defined, but none exceeds the threshold defined in BWProcessChainsRTCrit and none terminates with errors, the check status turns to Warning.
Reference Data
| Configures Checks | None |
| Default Value | 120 |
| Unit | Minutes |
BWQueryRuntimeCrit
If a query within an SAP BW/BI System runs longer than the time defined in this parameter, the check turns to Critical.
Reference Data
| Configures Checks | BW_QUERYRUNTIME |
| Default Value | 1200 |
| Unit | Seconds |
BWQueryRuntimeExclude
Queries added to this list are not considered for the check result.
Reference Data
| Configures Checks | BW_QUERYRUNTIME |
| Default Value | |
| Unit | String |
BWQueryRuntimeWarn
If a query within an SAP BW/BI System runs longer than the time defined in this parameter, but not longer than BWQueryRuntimeCrit, the check turns to Warning.
Reference Data
| Configures Checks | BW_QUERYRUNTIME |
| Default Value | 900 |
| Unit | Seconds |
CCMSMonsetMTEMaxCount
A CCMS monitor tree of a CCMS_MONSET Custom Check may contain a lot of MTEs, which results in many checks being created in Avantra's RealTime Monitoring. If you want to limit this number of checks, you can set the CCMSMonsetMTEMaxCount parameter. When MTEs are CCMS Monitor tree is read, and the number of CCMSMonsetMTEMaxCount is exceeded, the remaining MTEs are ignored and the corresponding CCMS_MONSET Custom Check will report a Warning result.
Per default, this parameter is 0, i.e. it's inactive and the number of MTEs is unlimited.
Reference Data
| Configures Checks | None |
| Default Value | 0 |
| Unit | Number |
CompVersFunction
If any component version shows 0 instead of the correct version using the function DELIVERY_GET_INSTALLED_COMPS, it's recommended to use the function OCS_GET_INSTALLED_COMPS.
Reference Data
| Configures Checks | None |
| Default Value | OCS_GET_INSTALLED_COMPS |
| Unit | Enum |
DialogPerfMinStepCount
If during a reported day period the number of dialog steps is less than the defined value, the runtime of the steps is not considered for the Check Result of the DIALOGPERF and WORKLOAD Checks.
Roughly speaking, if you have less than 1000 dialog steps from — let's say — 6h to 7h, it won't hurt if 20% of them run longer than a second. Obviously, this is different for 10000 dialog steps.
Reference Data
| Configures Checks | WORKLOAD, DIALOGPERF |
| Default Value | 1000 |
| Unit | Number |
DialogPerfPctCumulatedCrit
The check turns Critical if less than DialogPerfPctCumulatedCrit percent of the dialog steps finish within DialogPerfRespTimeLimit, except if only less than DialogPerfMinStepCount are performed.
Reference Data
| Configures Checks | DIALOGPERF |
| Default Value | 85 |
| Unit | % |
DialogPerfPctCumulatedWarn
The check turns to Warning if more than DialogPerfPctCumulatedCrit percent but less than DialogPerfPctCumulatedWarn percent of the dialog steps finish within DialogPerfRespTimeLimit except if only less than DialogPerfMinStepCount are performed.
Reference Data
| Configures Checks | DIALOGPERF |
| Default Value | 95 |
| Unit | % |
DialogPerfRespTimeLimit
Defined the runtime threshold. Valid parameters are: 0.1, 0.2, 0.3, 0.4, 0.5, 1, 2, 3, 10
Reference Data
| Configures Checks | DIALOGPERF |
| Default Value | 1 |
| Unit | String |
DialogPerfTimePeriod
Defines the time period the check should consider. Valid values are within the range 00-24, like e.g. 06-18.
Reference Data
| Configures Checks | DIALOGPERF |
| Default Value | 00-24 |
| Unit | String |
DialogRespTimeCrit
If the SAP Systems average dialog response time exceeds DialogRespTimeCrit ms, the check status is set to Critical.
Reference Data
| Configures Checks | WORKLOAD |
| Default Value | 2000 |
| Unit | Milliseconds |
DialogRespTimeWarn
If the SAP Systems average dialog response time exceeds DialogRespTimeWarn ms, but does not exceed DialogRespTimeCrit ms, the check status is set to Warning.
Reference Data
| Configures Checks | WORKLOAD |
| Default Value | 1000 |
| Unit | Milliseconds |
DialogResponseTimeNames
By default, the DialogResponseTimes check only monitors FrontendResponseTime.
Other typical response times are: ResponseTimeDialog, ResponseTimeDialogRFC, ResponseTimeHTTP.
Reference Data
| Configures Checks | None |
| Default Value | FrontendResponseTime |
| Unit | String |
IdocsAgeWarn
If there are IDOCs older than IdocsAgeWarn days, the check result is set to Warning.
Reference Data
| Configures Checks | IDOCS |
| Default Value | 365 |
| Unit | Days |
IdocsGrpRedCountCrit
If the number of IDOCS in group "red" exceeds IdocsGrpRedCountCrit during IdocsGrpRedTimeSpan minutes, the check result is set to Critical.
Reference Data
| Configures Checks | IDOCSTAT |
| Default Value | 5 |
| Unit | Number |
IdocsGrpRedCountWarn
If the number of IDOCS in group "red" exceeds IdocsGrpRedCountWarn during IdocsGrpRedTimeSpan minutes, but does not exceed IdocsGrpRedCountCrit, the check result is set to Warning.
Reference Data
| Configures Checks | IDOCSTAT |
| Default Value | 1 |
| Unit | Number |
IdocsGrpRedDailyCountCrit
If the number of IDOCS in group "red" exceeds IdocsGrpRedDailyCountCrit in the daily check, the result of IDOCS check is set to Critical.
Reference Data
| Configures Checks | IDOCS |
| Default Value | 50 |
| Unit | Number |
IdocsGrpRedDailyCountWarn
If the number of IDOCS in group "red" exceeds IdocsGrpRedDailyCountWarn in the daily check, but does not exceed IdocsGrpRedDailyCountCrit, the result of IDOCS check is set to Warning.
Reference Data
| Configures Checks | None |
| Default Value | 1 |
| Unit | Number |
IdocsGrpRedTimeSpan
See the description of parameters IdocsGrpRedCountCrit and IdocsGrpRedCountCrit.
Reference Data
| Configures Checks | IDOCSTAT |
| Default Value | 60 |
| Unit | Minutes |
ignoreDB
This monitoring parameter activates/deactivates the direct DB Call using the database connection. This parameter may need to be enabled to deactivate direct database access if credentials are unavailable or access is denied, e.g., some SAP Rise on Public Cloud or AS400 environment.
Reference Data
| Configures Checks | None |
| Default Value | 0 |
| Unit | Boolean |
IgnoreProfileParametersPatterns
Defines a comma-separated list of profile parameters that SAPOpModeConsistency and SAPActiveServerProfiles will ignore. Wildcards are supported.
Reference Data
| Configures | SAPOpModeConsistency, SAPActiveServerProfiles |
| Default Value | empty |
| Unit | String |
JavaDBSchema
If the tables required to retrieve the J2EE Software Components cannot be found in the default schema you may define the appropriate schema in here.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | String |
JavaJobStatTimeSpan
Defines the time the span jobs are checked by the JavaJobStat check.
Reference Data
| Configures Checks | JavaJobStat |
| Default Value | 60 |
| Unit | Minutes |
JavaJobsSelectRange
Defines the range of jobs that are checked by the JavaJobs check.
Reference Data
| Configures Checks | JavaJobs |
| Default Value | 1 |
| Unit | Days |
JobAbortCountCrit
f the number of aborted jobs exceeds JobAbortCountCrit during the last JobAbortTimespan minutes, the check result is set to Critical
Reference Data
| Configures Checks | JOBSTAT |
| Default Value | 2 |
| Unit | Number |
JobAbortCountWarn
If the number of aborted jobs exceeds JobAbortCountWarn during the last JobAbortTimespan minutes, but does not exceed JobAbortCountCrit, the check result is set to Warning.
Reference Data
| Configures Checks | JOBSTAT |
| Default Value | 1 |
| Unit | Number |
JobAbortExclude
Defines job names excluded from aborted jobs monitoring. Separate multiple entries by spaces (wildcard * allowed). If your job name includes spaces, put double quotes (") around it.
Reference Data
| Configures Checks | JOBS, JOBSTAT |
| Default Value | |
| Unit | String |
JobUsersExclude
Defines job users excluded from aborted jobs or delayed jobs monitoring. Separate multiple entries by spaces (wildcard * allowed). If your job user includes spaces, put double quotes (") around it.
Reference Data
| Configures Checks | JOBS, JOBSTAT |
| Default Value | |
| Unit | String |
JobAbortTimespan
See the description of parameters JobAbortCountCrit and JobAbortCountWarn.
Reference Data
| Configures Checks | JOBSTAT |
| Default Value | 60 |
| Unit | Minutes |
JobDelayedCountCrit
If JobDelayedCountCrit jobs are delayed for more than JobDelayedTimeCrit minutes, the check status is set to Critical.
Reference Data
| Configures Checks | JOBSTAT |
| Default Value | 1 |
| Unit | Number |
JobDelayedCountWarn
If JobDelayedCountWarn jobs are delayed for more than JobDelayedTimeWarn minutes, but jobs are still below JobDelayedCountCrit / JobDelayedTimeCrit criteria, the check status is set to Warning.
Reference Data
| Configures Checks | JOBSTAT |
| Default Value | 1 |
| Unit | Number |
JobDelayedExclude
Defines job names excluded from job delay monitoring. Separate multiple entries by spaces (wildcard * allowed). If your job name includes spaces, put double quotes (") around it.
Reference Data
| Configures Checks | JOBSTAT |
| Default Value | |
| Unit | String |
JobDelayedIncludeExpired
If set (which is the default), jobs with configured and expired No start after date/time are considered as delayed jobs as well. You can exclude expired jobs from delay monitoring by disabling this parameter.
Reference Data
| Configures Checks | JOBSTAT |
| Default Value | 1 |
| Unit | Boolean |
JobMaxSelect
For the monitoring of aborted and delayed jobs, only this number of jobs are considered.
Reference Data
| Configures Checks | JOBSTAT |
| Default Value | 1000 |
| Unit | Number |
JobDelayedTimeCrit
See description of JobDelayedCountCrit above.
Reference Data
| Configures Checks | JOBSTAT |
| Default Value | 10 |
| Unit | Minutes |
JobDelayedTimeWarn
See description of JobDelayedCountWarn above.
Reference Data
| Configures Checks | JOBSTAT |
| Default Value | 2 |
| Unit | Minutes |
JobsDailyCountCrit
If the number of aborted jobs reported in a daily check exceeds this value, the daily check result is set to Critical.
Reference Data
| Configures Checks | JOBS |
| Default Value | 20 |
| Unit | Number |
JobsDailyCountWarn
If the number of aborted jobs reported in a daily check exceeds this value but does not exceed JobsDailyCountCrit, the daily check result is set to Warning
Reference Data
| Configures Checks | JOBS |
| Default Value | 1 |
| Unit | Number |
KernelBackupDir
This parameter configures the local SAP Kernel Backup directory where existing kernel packages are backed up.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | String |
KernelDownloadDir
This parameter configures the target directory for kernel packages on the SAP server.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | String |
LocalMonitoringOff
If you set this parameter Avantra will stop monitoring the System.
This setting can be used if you want to monitor this System only using End-to-End Application Monitoring (from a different System).
Do not change this Monitoring Parameter unless you really know what you are doing.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | Boolean |
LockAgeCrit
If an SAP lock is older than LockAgeCrit hours, the check status is set to Critical.
Reference Data
| Configures Checks | LOCKTABLE |
| Default Value | 24 |
| Unit | Hours |
LockAgeWarn
If an SAP lock is older than LockAgeWarn hours, but not older than LockAgeCrit hours, the check status is set to Warning.
Reference Data
| Configures Checks | LOCKTABLE |
| Default Value | 8 |
| Unit | Hours |
LockExclude
This parameter is used to exclude certain locks from the LOCKTABLE check. You can specify the locks to be excluded by client, user, table, and optionally argument. The syntax of parameter values is: client:user:table. If you want to exclude by the lock argument, use this syntax: client:user:table:argument. Wildcards * are allowed, e.g. if you specify *:*:*, all locks will be excluded and the check will always result in Ok (which is certainly not recommended). Multiple lock exclude specs are separated by one or more spaces.
If you, for instance; want to exclude all locks of user BGRFCSUPER on all tables starting with BGRFC, and additionally all locks on WSRM_EH* tables, no matter which user but only in client 000, your LockExclude specification would look like:
*:BGRFCSUPER:BGRFC* 000:*:WSRM_EH*
If you want to exclude all locks containing ESH in lock arguments, your LockExclude specification would look like:
*:*:*:*ESH*
Colons : and spaces must be escaped by \ (backslash) if used as values.
Reference Data
| Configures Checks | LOCKTABLE |
| Default Value | |
| Unit | String |
MaskUserPersonalDetails
This monitoring parameter masks user emails and full names from the BCS_OutboundErrors, BCS_OutboundErrStat, and BCS_OutboundWaitStat checks so that check results are anonymized.
Reference Data
| Configures Checks | BCS_OutboundWaitStat, BCS_OutboundErrStat, BCS_OutboundErrors |
| Default Value | 1 |
| Unit | Boolean |
MIIDataServerNames
Filter data server names for MII_DataServers check. Use a comma to separate multiple schedules, wildcard * is supported.
Reference Data
| Configures Checks | MII_DataServers |
| Default Value | |
| Unit | String |
MIIDataServerConnectorTypes
Filter data servers by connector types for MII_DataServers check. Use a comma to separate multiple schedules, wildcard * is supported. Valid connector types are: AGG, PIC, KPI, XCT, XML and many more.
Reference Data
| Configures Checks | MII_DataServers |
| Default Value | |
| Unit | String |
MIIScheduleNames
Filter schedule names for MII_Schedules check. Use a comma to separate multiple schedules, wildcard * is supported.
Reference Data
| Configures Checks | MII_Schedules |
| Default Value | |
| Unit | String |
MIIScheduleStatus
Filter by schedule status for MII_Schedules check. Use a comma to separate multiple schedules status. Valid status are: PENDING, RUNNING, STOPPED, DISABLED.
Reference Data
| Configures Checks | MII_Schedules |
| Default Value | RUNNING |
| Unit | String |
MIIFailedMessageNames
Filter message names for MII_FailedMessageStat and MII_FailedMessages check. Use a comma to separate multiple message names, wildcard * is supported.
Reference Data
| Configures Checks | MII_FailedMessageStat, MII_FailedMessages |
| Default Value | |
| Unit | String |
MIIFailedMessageTypes
Filter message types for MII_FailedMessageStat and MII_FailedMessages check. Use a comma to separate multiple message types, wildcard * is supported.
Reference Data
| Configures Checks | MII_FailedMessageStat, MII_FailedMessages |
| Default Value | |
| Unit | String |
MIIFailedMessageServers
Filter message servers for MII_FailedMessageStat and MII_FailedMessages check. Use a comma to separate multiple message servers, wildcard * is supported.
Reference Data
| Configures Checks | MII_FailedMessageStat, MII_FailedMessages |
| Default Value | |
| Unit | String |
MIIFailedMessageTimeSpan
Configures time span to look back for failed messages.
Reference Data
| Configures Checks | MII_FailedMessageStat |
| Default Value | 60 |
| Unit | Minutes |
MIIFailedTransactionNames
Filter transaction names for MII_FailedTransactions and MII_FailedTransactionStat check. Use comma to separate multiple transaction names, wildcard * is supported.
Reference Data
| Configures Checks | MII_FailedTransactionStat, MII_FailedTransactions |
| Default Value | |
| Unit | String |
MIIFailedTransactionTimeSpan
Configures time span to look back for failed transactions.
Reference Data
| Configures Checks | MII_FailedTransactionStat, MII_FailedMessageStat |
| Default Value | 60 |
| Unit | Minutes |
MIIIgnoreTerminatedTransactions
This monitoring parameter ignores the transaction names with a terminated status for MII_FailedTransactions and MII_FailedTransactionStat checks. Use comma to separate multiple transaction names. Wildcard * is supported. To ignore all terminated transactions set the value of the monitoring parameter to *.
Reference Data
| Configures Checks | MII_FailedTransactionStat, MII_FailedTransactions |
| Default Value | |
| Unit | String |
MIILongRunningTransactionWarn
If the number range's exhaustion exceeds NumRangesUsageWarn percent, but does not exceed NumRangesUsageCrit percent, the check status turns to Warning.
Reference Data
| Configures Checks | MII_LongRunningTransactions |
| Default Value | 30 |
| Unit | Minutes |
MIILongRunningTransactionCrit
Configures a critical threshold in minutes for long-running MII transactions.
Reference Data
| Configures Checks | MII_LongRunningTransactions |
| Default Value | 60 |
| Unit | Minutes |
MonitorLevel
Force sets the Monitor Level of a SAP System. Can be used to override automatic Monitor Level determination.
Reference Data
| Configures Checks | None |
| Default Value | Auto |
| Unit | Enum |
NumRangesUsageWarn
If the number range's exhaustion exceeds NumRangesUsageWarn percent, but does not exceed NumRangesUsageCrit percent, the check status turns to Warning.
Reference Data
| Configures Checks | NumberRanges |
| Default Value | 85 |
| Unit | % |
NumRangesUsageCrit
If the NumberRanges exhaustion exceeds NumRangesUsageCrit percent, the check status turns to Critical.
Reference Data
| Configures Checks | NumberRanges |
| Default Value | 95 |
| Unit | % |
NumRangesClientMode
To exclude clients from being checked, you may use NumRangesClientList in either deny (Blacklist) (default) or allow (Whitelist) mode. If you want to exclude specific clients, change this mode to deny and specify the clients to be excluded using parameter NumRangesClientList. If you want to check on specific clients only, change this mode to allow and specify the clients to be checked using parameter NumRangesClientList.
Reference Data
| Configures Checks | NumberRanges |
| Default Value | Blacklist |
| Unit | Enum |
NumRangesClientList
Works together with NumRangesClientMode either to specify clients to be excluded or to specify clients to include.
Reference Data
| Configures Checks | NumberRanges |
| Default Value | 066 |
| Unit | String |
NumRangesExclude
You may exclude some Number Ranges from monitoring with this monitoring parameter. The syntax of an exclude specification is: <Object>:<Subobject>:<Number>. Please make sure to not use any spaces between the separation char : since spaces or semicolon ; are used to separate multiple entries. You can use wildcard * in an exclude specification.
To exclude all Number Ranges you can use *. This makes sense if you would want to use the individual thresholds only as defined in SAP transaction SNUM. See NumRangesUseObjectDef for further information.
Example: NumRangesExclude
| Value | Selection |
|---|---|
AUFTRAG | All number ranges AUFTRAG are excluded, no matter which object or Subobject |
ANLAGENNR:1000 | All number ranges with Object ANLAGENNR AND Subobject 1000 are excluded |
ANLAGENNR:1000:03 | All number ranges with Object ANLAGENNR AND Subobject 1000 AND Number 03 are excluded |
RKE_BELEG::02 | All number ranges with Object RKE_BELEG, any Subobject AND Number 02 are excluded |
ANLAGENNR:1000,3000:02,03 | All number ranges with Object ANLAGENNR, AND Subobject 1000 or Subobject 3000 AND Number 02 or NUMBER 03 are excluded |
RKE* | All number ranges with Object name starting with RKE are excluded, no matter which object or Subobject |
Reference Data
| Configures Checks | NumberRanges |
| Default Value | |
| Unit | String |
NumRangesInclude
You may include some Number Ranges from monitoring with this monitoring parameter. The syntax of an include specification is:<Object>:<Subobject>:<Number>. It is exactly the same syntax as described in NumRangesExclude parameter. Please note that NumRangesInclude precedes before NumRangesExclude.
Reference Data
| Configures Checks | NumberRanges |
| Default Value | |
| Unit | String |
NumRangesUsageEx
The default warning and critical thresholds for Number Ranges can be set with NumRangesUsageWarn and NumRangesUsageCrit monitoring parameters. If you need different threshold values for your Number Ranges, then use NumRangesUsageEx to define individual thresholds. The syntax is as follows:
<Client>:<Object>:<Subobject>:<Number>:warn:crit
Please make sure to not use any spaces between the separation char : since spaces or semicolon ; are used to separate multiple entries. You can use wildcard *`. Please note that all 6 values must be set for a valid usage specification.
Example: NumRangesUsageEx
| Value | Selection |
|---|---|
000:COPA_PLAN:0012:01:80:99 | All number ranges from Client 000, Object COPA_PLAN, Subobject 0012 and Number 01 get a warning threshold of 80% and a critical threshold of 99%. |
*:GL*:*:05:20:90 | All number ranges from all Clients (*), Objects starting with GL (GL*), all Subobjects (*) and Number 05 get a warning threshold of 20% and a critical threshold of 90%. |
Reference Data
| Configures Checks | NumberRanges |
| Default Value | |
| Unit | String |
NumRangesUseObjectDef
Each SAP Number Range may define a specific threshold. Those thresholds can have a different value. Avantra does not use those thresholds by default. Avantra uses the monitoring parameters NumRangesUsageWarn and NumRangesUsageCrit to define thresholds. If you want to use the threshold defined for the Number Range in your SAP System, use this monitoring parameter. Since the SAP System only provides one threshold, you need to specify if the check status is set to Critical or Warning when the threshold exceeds. The syntax is: <Object>:<CRITICAL|WARNING>. Multiple specifications are separated by a space or semicolon. You can use wildcard * in a specification.
Example: NumRangesUseObjectDef
| Value | Selection |
|---|---|
AUFTRAG | For all number ranges AUFTRAG, the threshold defined on AUFTRAG number range is used. If the number range exhausts the threshold, the check reports WARNING. |
RKE_BELEG:CRITICAL | For all number ranges RKE_BELEG, the threshold defined on RKE_BELEG number range is used. If the number range exhausts the threshold, the check reports CRITICAL. |
Reference Data
| Configures Checks | NumberRanges |
| Default Value | |
| Unit | String |
NumRangesRollingIntervals
SAP Number Ranges can be rolling or not. NumberRanges selects by default both rolling and non-rolling Number Ranges. If you want to select only non-rolling Number Ranges, then deselect this option.
Reference Data
| Configures Checks | NumberRanges |
| Default Value | 1 |
| Unit | Boolean |
NumRangesStartYear
This monitoring parameter configures when the new financial year begins and which year to have NumberRanges check start monitoring from.
The format if MM.dd[+|-]d, where it's month.day and an optional offset.
All number ranges with financial years for this year and above are considered for further evaluation.
All those number ranges without a financial year are always considered, irrespective of the value in this monitoring parameter.
Example:
- If the
day-monthdefined is 6th April (04.06), and today is 3rd April 2022 (03.06), then the start year is 2021. - If the
day-monthdefined is 6th April (04.06), and today is 6th April 2022 (06.06), then the start year is 2022. - If the
day-month + offsetdefined is 6th April + 1 (04.06+1), and today is 6th April 2022 (06.06), then the start year is 2023. - If the
day.month - offsetdefined is 6th April - 3 (04.06-3) and today is 3rd April 2022 (03.06), then the start year is 2018.
Reference Data
| Configures Checks | NumberRanges |
| Default Value | |
| Unit | String |
PerfDataCollectABAPTaskTypes
This parameter does exactly the same as SAP Instances, except that it will control the Performance Data Collection of the SAP system, i.e. the total values of the configured ABAP task types.
For the unit String, the list of task types separated by comma or semicolon (,;). Leading, trailing or multiple spaces between the separation chars are allowed and will be trimmed away. Though unlikely to be necessary, you must escape ,; by a backslash \, should these chars appear in a task type name.
Reference Data
| Configures Checks | None |
| Default Value | BACKGROUND; HTTP |
| Unit | String |
PerfDataCollection
Controls whether or not Performance Data Collection is turned on for Systems. If you do not want the Avantra Agent to collect performance data you may remove the flag.
Reference Data
| Configures Checks | None |
| Default Value | 1 |
| Unit | Boolean |
PerfDataTARuntimeStepsMinPct
Transactions with a percentage of the total number of transaction steps below threshold PerfDataTARuntimeStepsMinPct will not be listed in section Top N transaction response times sorted by average response time of the Service Level Report. This is to ignore transactions with a very low number of steps which often have a high response time and thus makes the service level report more significant.
Reference Data
| Configures Checks | None |
| Default Value | 2 |
| Unit | % |
PerfDataTARuntimeTop
Defines the number of transactions to be listed in the section Top N transaction response times sorted by average response time of the service level report.
Reference Data
| Configures Checks | None |
| Default Value | 20 |
| Unit | Number |
PerfDataTAStepsTop
Defines the number of transactions to be listed in the section Top N transaction response times sorted by number of steps of the service level report
Reference Data
| Configures Checks | None |
| Default Value | 20 |
| Unit | Number |
PerfDataTopNIncludeReports
Set this monitoring parameter to include reports in Top N performance chart. If this monitoring parameter is not set, only transactions are included in Top N performance chart.
Reference Data
| Configures Checks | None |
| Default Value | 0 |
| Unit | Boolean |
PerfDataTransactions
Defines the SAP transactions of which you want to explicitly collect performance data. The response times of these transactions will be reported in the service level report in section Monthly average response times of named transactions.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | String |
PerfDataCollectABAPTimeRange
Defines the time ranges in days and hours for which performance data of SAP transactions defined in PerfDataTransactions is effectively collected. If this parameter is not set, performance data is collected 7 days a week and 24 hours per day. If, for instance, you want to collect transaction performance data only from Monday to Friday and from 08:00 to 17:00, then set this value to: 1-5:8-17
The first part defines the day range, where 1 is Monday and 7 is Sunday. The second part defines the hours within a day.
You can define multiple ranges by separating them with a comma. Following patterns selects transaction performance data from Monday to Thursday from 08:00 to 17:00 and Friday from 08:00 to 16:00 only: 1-4:8-17,5:8-16
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | TimeRange |
PIAEMessagesNumCrit
If the number of erroneous PI Adapter Engine XML messages since the last Daily Check start is equal to or above this value, the check status is set to Critical.
Reference Data
| Configures Checks | PI_AEMessages |
| Default Value | 20 |
| Unit | Number |
PIAEMessagesNumWarn
If the number of erroneous PI Adapter Engine XML messages since the last Daily Check start is equal to or above PIAEMessagesNumWarn but below PIAEMessagesNumCrit, the check status is set to Warning
Reference Data
| Configures Checks | PI_AEMessages |
| Default Value | 1 |
| Unit | Number |
PIAEMessagesStatNumCrit
If the number of erroneous PI Adapter Engine XML messages in last PIAEMessagesStatTimeSpan minutes is equal to or above this value, the check status is set to Critical.
Reference Data
| Configures Checks | PI_AEMessagesStat |
| Default Value | 5 |
| Unit | Number |
PIAEMessagesStatNumWarn
If the number of erroneous PI Adapter Engine XML messages in last PIAEMessagesStatTimeSpan minutes is equal to or above PIAEMessagesStatNumWarn but below PIAEMessagesStatNumCrit, the check status is set to Warning
Reference Data
| Configures Checks | PI_AEMessagesStat |
| Default Value | 1 |
| Unit | Number |
PIAEMessagesStatTimeSpan
If the date/time of an erroneous PI Adapter Engine XML message is after now minus PIAEMessagesStatTimeSpan minutes, the message will be counted, otherwise, it's no longer retrieved.
Reference Data
| Configures Checks | PI_AEMessagesStat |
| Default Value | 60 |
| Unit | Minutes |
PIAEMessagesReceiverExclude
Use this monitoring parameter for specifying the number of receivers not to be monitored by the PI_AEMessagesStat check. The receivers list is comma-separated, wildcard * is supported.
Reference Data
| Configures Checks | PI_AEMessages, PI_AEMessagesStat |
| Default Value | |
| Unit | String |
PIAEMessagesUseHttps
If your PI J2EE instance is configured to use HTTPS only, usually due to security reasons, please use this parameter to indicate that the Agent shall use HTTPS to get the PI Adapter engine data.
Reference Data
| Configures Checks | PI_AEMessages, PI_AEMessagesStat |
| Default Value | 0 |
| Unit | Boolean |
PICommChannelsCountCrit
Defines the amount of channels that must have a failure state at the same time to turn the check state of the entire PI_CommChannels check to Critical. Channels are checked every Medium Check Cycle, i.e. per default every 10 minutes.
Reference Data
| Configures Checks | PI_CommChannels |
| Default Value | 1 |
| Unit | Number |
PICommChannelsCountWarn
Defines the amount of channels that must have a failure state at the same time to turn the check state of the entire PI_CommChannels check to Warning. When PICommChannelsCountCrit is smaller or equal, this parameter won't have any effect. Channels are checked every Medium Check Cycle, i.e. per default every 10 minutes.
Reference Data
| Configures Checks | PI_CommChannels |
| Default Value | 1 |
| Unit | Number |
PICommChannelsErrsCrit
Defines the number of subsequent ERROR channel states, before the check state of a channel is Critical. Channels are checked every Medium Check Cycle, i.e. per default every 10 minutes.
Reference Data
| Configures Checks | PI_CommChannels |
| Default Value | 1 |
| Unit | String |
PICommChannelsErrsWarn
Defines the number of subsequent ERROR channel states, before the check state of a channel is Warning. However, if the number of subsequent ERROR channel states is equal to or above PICommChannelsErrsCrit, this parameter has no effect. Channels are checked every Medium Check Cycle, i.e. per default every 10 minutes.
Reference Data
| Configures Checks | PI_CommChannels |
| Default Value | 1 |
| Unit | String |
PICommChannelsTimeCrit
Defines the number of minutes before the check state of a channel is reported as Critical. Please consider that channels are checked every Medium Check Cycle, i.e. per default every 15 minutes, so the reporting might be delayed additionally by the Medium Check Cycle interval.
Reference Data
| Configures Checks | PI_CommChannels |
| Default Value | 0 |
| Unit | Minutes |
PICommChannelsTimeWarn
Defines the number of minutes before the check state of a channel is reported as Warning. Please consider that channels are checked every Medium Check Cycle cycle, i.e. per default every 10 minutes, so the reporting might be delayed additionally by the Medium Check Cycle interval.
If the setting is equal to or above PICommChannelsTimeCrit, this parameter has no effect.
Reference Data
| Configures Checks | PI_CommChannels |
| Default Value | 0 |
| Unit | Minutes |
PICommChannelsExclude
If a channel matches at least one criteria of the list of exclude criteria provided, it will be excluded from the check evaluation. The syntax of an excluded criterion is:
Exclude term: party|service|channel|activationState|channelState=<pattern>. A pattern may contain placeholders * (for any number of any characters) and/or ? (for a single character).
An exclude criteria consists of at least one or multiple exclude terms separated by a comma and surrounded by {}: {Exclude specification(,Exclude specification)*}. All exclude terms must match, i.e. the exclude terms are combined by logical AND.
Multiple criteria can be concatenated either by comma (,) or semicolon (;). A channel is excluded if it matches any of the listed criteria, i.e. the criteria are combined by logical OR.
Example: Exclusions
{party=bad,service=Test*},{channelState=INACTIVE}
Excludes all channels with a party that contain the term bad and with a service that starts with Test. Channels with an inactive channel state are excluded by the 2nd criterion {channelState=INACTIVE}. Please be aware that all string comparisons are case sensitive.
Reference Data
| Configures Checks | PI_CommChannels |
| Default Value | |
| Unit | String |
PIExcludeSelftestFeatures
Under certain circumstances, PI checks might report features with status not OK which results in Critical status of the whole check. You can exclude a certain feature from contributing to the check status. To do this, simply put the name of the feature on the comma-separated list provided by PIExcludeSelftestFeatures.
Excluded features will still be listed in the check result table, but the not OK status is are marked in grey color and is appended by Excluded info.
Reference Data
| Configures Checks | PI_IntegrationRepository, PI_IntegrationDirectory, PI_IntegrationEngine, PI_SystemLandscapeDir, PI_RuntimeWorkbench, PI_AdapterFramework, PI_BusinessProcessEngine, PI_MappingRuntime, PI_J2SEAdapterEngine |
| Default Value | WS_Security_Check;CompChannelStatus |
| Unit | String |
PIForceEnable
You can set this Monitoring Parameter to force the Avantra Agent to detect an SAP PI system in the rare case it does not automatically.
Reference Data
| Configures Checks | None |
| Default Value | 0 |
| Unit | Boolean |
PIIEMessagesClientList
Works together with PIIEMessagesClientMode, either to specify clients to be excluded PIIEMessagesClientMode is in mode deny (Blacklist)) or limited to only clients listed PIIEMessagesClientMode is in mode allow (Whitelist)). Please be aware that if you change parameter PIIEMessagesClientMode, you can also change this parameter to another list, since the default value 000 066 is intended to work in deny mode.
Reference Data
| Configures Checks | PI_IEMessages, PI_IEMessagesStat |
| Default Value | 000 066 |
| Unit | String |
PIIEMessagesClientMode
PI Integration Engine XML messages checks are designed to retrieve data of all clients found in an SAP system, no matter which client is used for RFC by the Avantra Agent. To exclude clients from being checked, you may use PIIEMessagesClientList in either deny (Blacklist) or allow (Whitelist) mode. The default value is deny, i.e. all clients will be checked except client 000 and 066. If you want to, for instance, only check on specific clients, you may change this mode to allow and specify the clients to be checked using parameter PIIEMessagesClientList.
Reference Data
| Configures Checks | PI_IEMessages, PI_IEMessagesStat |
| Default Value | Blacklist |
| Unit | Enum |
PIIEMessagesNumCrit
If the number of erroneous PI Integration Engine XML messages since the last Daily Check start is equal to or above this value, the check status is set to Critical.
Reference Data
| Configures Checks | PI_IEMessages |
| Default Value | 20 |
| Unit | Number |
PIIEMessagesNumWarn
If the number of erroneous PI Integration Engine XML messages since the last Daily Check start is equal to or above PIIEMessagesNumWarn but below PIIEMessagesNumCrit the check status is set to Warning.
Reference Data
| Configures Checks | PI_IEMessages |
| Default Value | 1 |
| Unit | Number |
PIIEMessagesStatNumCrit
If the number of erroneous PI Integration Engine XML messages in last PIIEMessagesStatTimeSpan minutes is equal to or above this value the check status is set to Critical . Please note that the threshold is applied to each client individually, see PIIEMessagesClientMode and PIIEMessagesClientList parameters.
Reference Data
| Configures Checks | PI_IEMessagesStat |
| Default Value | 5 |
| Unit | Number |
PIIEMessagesStatNumWarn
If the number of erroneous PI Integration Engine XML messages in last PIIEMessagesStatTimeSpan minutes is equal to or above PIIEMessagesStatNumWarn but below PIIEMessagesStatNumCrit the check status is set to Warning. Please note that the threshold is applied to each client individually, seePIIEMessagesClientMode and PIIEMessagesClientList parameters.
Reference Data
| Configures Checks | PI_IEMessagesStat |
| Default Value | 1 |
| Unit | Number |
PIIEMessagesStatTimeSpan
If the date/time of an erroneous PI Integration Engine XML message is after now minus PIIEMessagesStatTimeSpan minutes, the message will be counted, otherwise, it's no longer retrieved.
Reference Data
| Configures Checks | PI_IEMessagesStat |
| Default Value | 60 |
| Unit | Minutes |
PIReportOKMessages
Defines if or if not Ok check messages are displayed for the SAP PI checks
Reference Data
| Configures Checks | PI_AdapterFramework, PI_BusinessProcessEngine, PI_J2SEAdapterEngine, PI_AdapterEngine |
| Default Value | 0 |
| Unit | Boolean |
PredictiveAnalyticsEngine
Use this monitoring parameter to configure the Predictive Analytics engine for the SAP System. By default the engine is configured as Balanced.
- Use
Offto turn off the Predictive Analytics engine. - Use
Best Performanceto configure the Predictive Analytics engine to run with best performance. - Use
Balancedto configure the Predictive Analytics engine to run in a balanced way. - Use
Highest Precisionto configure the Predictive Analytics engine run to with highest precision.
Reference Data
| Configures Checks | None |
| Default Value | Balanced |
| Unit | Enum |
ProfileParsDuplOk
List of SAP or database profile parameters allowed to occur multiple times in a file. Parameters listed here will no longer be considered as duplicate entries in the PROFILES check.
Reference Data
| Configures Checks | PROFILES |
| Default Value | |
| Unit | String |
SAPLicenseIgnore
This monitoring parameter excludes the expired certificates so, if they are expired for the number of days defined by SAPLicenseIgnore or more, they are not displayed in the status of SAPLicense check.
Reference Data
| Configures Checks | SAPLicense |
| Default Value | 10 |
| Unit | Days |
SAPLicenseIgnoreMaintenance
This monitoring parameter makes the certificates where the Software Product is Maintenance* (where * is a wildcard) to be ignored.
Reference Data
| Configures Checks | SAPLicense |
| Default Value | false |
| Unit | Boolean |
SAPLicenseCrit
If one or more licenses are found, that expire in predefined by SAPLicenseCrit number of days or less, the check status is set to Critical.
Reference Data
| Configures Checks | SAPLicense |
| Default Value | 10 |
| Unit | Days |
SAPLicenseWarn
If one or more licenses are found, that expire in predefined by SAPLicenseWarn number of days or less, but do not expire in set by SAPLicenseCrit number of days or less, then the check status is set to Warning.
Reference Data
| Configures Checks | SAPLicense |
| Default Value | 30 |
| Unit | Days |
QRFCInQueueExclude
If defined, the checks QRFC_IN and QRFC_IN_ERRQ will ignore all queues defined in QRFCInQueueExclude.
Separate multiple queues by blank space (wildcard * is allowed)
You may also restrict queues based on the client if you use the format queue1:client11,client12,… queue2:client21,client22,…
Reference Data
| Configures Checks | QRFC_IN, QRFC_IN_ERRQ |
| Default Value | |
| Unit | String |
QRFCInQueueHangCrit
If there are QRFCInQueueHangCrit or more hanging queues, the check status is set to Critical.
Reference Data
| Configures Checks | QRFC_IN_ERRQ |
| Default Value | 10 |
| Unit | Number |
QRFCInQueueHangWarn
If there are QRFCInQueueHangWarn or more hanging queues, but still less than QRFCInQueueHangCrit the check status is set to Warning.
Reference Data
| Configures Checks | QRFC_IN_ERRQ |
| Default Value | 1 |
| Unit | Number |
QRFCInRecQueuedCrit
If there are queues with more than QRFCInRecQueuedCrit records, the check status is set to Critical.
Reference Data
| Configures Checks | None |
| Default Value | 30 |
| Unit | Number |
QRFCInRecQueuedWarn
If there are queues with more than QRFCInRecQueuedWarn records, there is no queue with more than QRFCInRecQueuedCrit records, the check status is set to Warning.
Reference Data
| Configures Checks | QRFC_IN |
| Default Value | 15 |
| Unit | Number |
QRFCOutQueueExclude
If defined, the checks QRFC_OUT and QRFC_OUT_ERRQ will ignore all queues defined in QRFCOutQueueExclude. Separate multiple queues by blank space (wildcard * is allowed).
You may also restrict queues based on the client if you use the format queue1:client11,client12,… queue2:client21,client22,…
Reference Data
| Configures Checks | QRFC_OUT, QRFC_OUT_ERRQ |
| Default Value | |
| Unit | String |
QRFCOutQueueHangCrit
If there are QRFCOutQueueHangCrit or more hanging queues, the check status is set to Critical.
Reference Data
| Configures Checks | QRFC_OUT_ERRQ |
| Default Value | 10 |
| Unit | Number |
QRFCOutQueueHangWarn
If there are QRFCOutQueueHangWarn or more hanging queues, but still less than QRFCOutQueueHangCrit the check status is set to Warning.
Reference Data
| Configures Checks | QRFC_OUT_ERRQ |
| Default Value | 1 |
| Unit | Number |
QRFCOutRecQueuedCrit
If there are queues with more than QRFCOutRecQueuedCrit records, the check status is set to Critical
Reference Data
| Configures Checks | QRFC_OUT |
| Default Value | 30 |
| Unit | Number |
QRFCOutRecQueuedWarn
If there are queues with more than QRFCOutRecQueuedWarn records, there is no queue with more than QRFCOutRecQueuedCrit records, the check status is set to Warning.
Reference Data
| Configures Checks | QRFC_OUT |
| Default Value | 15 |
| Unit | Number |
RelevantDailyCheckDetails
Defines a list of Daily Check details that are considered relevant for the Daily Check status, i.e. the status of which contribute to the overall status. By default the parameter is not defined, i.e. all Daily Check details contribute.
If you define an empty list no Daily Check detail will contribute. In this case, the status of the Daily Check will be Unknown always.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | DCDList |
RFCConnectorWPMaxUsed
In order to assure that the Avantra Agent does not allocate too many work processes, it checks the amount of work processes being used by the SAP System RFC user before running new RFC calls.
If more than RFCConnectorWPMaxUsed work processes are already used, the Avantra Agent stops with an error message, like Too many [3] dialog work processes in use by Avantra RFC user [AVANTRA_RFC].
Reference Data
| Configures Checks | None |
| Default Value | 3 |
| Unit | Number |
RunDailyCheckOnWE
If set, Daily Checks will run on Saturday and Sunday as well.
Reference Data
| Configures Checks | FULLCHECK, FULLCHECK, FULLCHECK, FULLCHECK, FULLCHECK, FULLCHECK, FULLCHECK, FULLCHECK, SYB_ErrorLog, FULLCHECK |
| Default Value | 0 |
| Unit | Boolean |
RUNJSAllowDBWrite
This monitoring parameter can be set to Enabled or Disabled (default) value. It allows SQL queries defined within custom checks and workflows to change the data in the Database.
This monitoring parameter is only effective when the configuration setting Security.RUNJSAllowDBWrite is set to moniparam.
Reference Data
| Configures Checks | None |
| Default Value | Disabled |
| Unit | Enum |
SAPBufferSummaryHitCrit
This monitoring parameter defines the critical threshold for the buffer hit ratio.
This monitoring parameter is specified as a comma-separated list of buffer and value pairs, for example CALE:95,TABL:92,*:90.
You can also specify a general threshold for all other buffers by using a wildcard value, for example *:90, that is used if the specific buffer is not included.
Reference Data
| Configures Checks | SAPBufferSummary |
| Default Value | CALE:95;CUA:95;EIBUF:95;ESM:95;FTAB:95;IRBD:95;OTR:95;PRES:95;PXA:95;SNTAB:95;TABL:95; TABLP:95;TTAB:95 |
| Unit | String |
SAPBufferSummaryHitWarn
This monitoring parameter defines the warning threshold for the buffer hit ratio.
This monitoring parameter is specified as a comma-separated list of buffer and value pairs, for example CALE:95,TABL:92,*:90.
You can also specify a general threshold for all other buffers by using a wildcard value, for example *:90, that is used if the specific buffer is not included.
Reference Data
| Configures Checks | SAPBufferSummary |
| Default Value | CALE:98;CUA:98;EIBUF:98;ESM:98;FTAB:98;IRBD:98;OTR:98;PRES:98;PXA:98;SNTAB:98;TABL:98; TABLP:98;TTAB:98 |
| Unit | String |
SAPBufferSummaryIgnoreSwap
When set to true, this monitoring parameter prevents SAPBufferSummary returning Warning or Critical check statuses (set by SAPBufferSummaryHitWarn and SAPBufferSummaryHitCrit (hit ratio) threshold monitoring parameters), if the number of swaps is 0 (zero). If the number of swaps is greater than 0 (zero), then the SAPBufferSummaryHitWarn and SAPBufferSummaryHitCrit monitoring parameters will be used to determine the SAPBufferSummary check status.
Reference Data
| Configures Checks | SAPBufferSummary |
| Default Value | true |
| Unit | Boolean |
SAPBufferSummarySwapDeltaCrit
This monitoring parameter defines the critical threshold for the total number of SAP buffer swaps.
This monitoring parameter is specified as a comma-separated list of buffer and value pairs, for example CALE:95,TABL:92,*:90.
You can also specify a general threshold for all other buffers by using a wildcard value, for example *:90, that is used if the specific buffer is not included.
Reference Data
| Configures Checks | SAPBufferSummary |
| Default Value | CALE:2;CUA:2;EIBUF:2;ESM:2;FTAB:2;IRBD:2;OTR:2;PRES:2;PXA:2;SNTAB:2; TABL:2;TABLP:2;TTAB:2 |
| Unit | String |
SAPBufferSummarySwapDeltaWarn
This monitoring parameter defines the warning threshold for the total number of SAP buffer swaps.
This monitoring parameter is specified as a comma-separated list of buffer and value pairs, for example CALE:95,TABL:92,*:90.
You can also specify a general threshold for all other buffers by using a wildcard value, for example *:90, that is used if the specific buffer is not included.
Reference Data
| Configures Checks | SAPBufferSummary |
| Default Value | CALE:1;CUA:1;EIBUF:1;ESM:1;FTAB:1;IRBD:1;OTR:1;PRES:1;PXA:1;SNTAB:1;TABL:1; TABLP:1;TTAB:1 |
| Unit | String |
SAPNotesCanBeImplStatus
This monitoring parameter defines an Avantra status (OK, WARNING or CRITICAL) for SAP notes found in the SAP system in can be implemented status (snote).
Reference Data
| Configures Checks | SAP_Notes |
| Default Value | OK |
| Unit | Enum |
SAPNotesComponentExclude
This parameter defines the list of SAP components that are excluded from the SAP_Notes check.
Reference Data
| Configures Checks | SAP_Notes |
| Default Value | |
| Unit | String |
SAPNotesComponentInclude
This parameter defines the list of SAP components that are included in the SAP_Notes check.
Reference Data
| Configures Checks | SAP_Notes |
| Default Value | |
| Unit | String |
SAPNotesExclude
This parameter defines the list of SAP note IDs that are excluded from the SAP_Notes check.
Reference Data
| Configures Checks | SAP_Notes |
| Default Value | |
| Unit | String |
ShortDumpAgeWarn
If there are short dumps older than ShortDumpAgeWarn days, the check status of the SHORTDUMPS check is set to Warning.
Reference Data
| Configures Checks | SHORTDUMPS |
| Default Value | 7 |
| Unit | Days |
ShortDumpCountCrit
If the number of short dumps exceeds ShortDumpCountCrit during ShortDumpTimeSpan minutes, the check status is set to Critical.
Reference Data
| Configures Checks | ShortDumpStat |
| Default Value | 10 |
| Unit | Number |
ShortDumpCountWarn
If the number of short dumps exceeds ShortDumpCountWarn during the last ShortDumpTimeSpan minutes, but does not exceed ShortDumpCountCrit, the check status is set to Warning.
Reference Data
| Configures Checks | ShortDumpStat |
| Default Value | 5 |
| Unit | Number |
ShortDumpDailyCountCrit
If the number of short dumps reported within Daily Checks exceeds this value the check status is set to Critical.
Reference Data
| Configures Checks | SHORTDUMPS |
| Default Value | 20 |
| Unit | Number |
ShortDumpDailyCountWarn
If the number of short dumps reported within Daily Checks exceeds ShortDumpDailyCountWarn but does not exceed ShortDumpDailyCountCrit the check status is set to Warning.
Reference Data
| Configures Checks | SHORTDUMPS |
| Default Value | 1 |
| Unit | Number |
ShortDumpExclude
Defines short dump Error IDs (as displayed in SAP transaction ST22) to be excluded from monitoring. Separate multiple entries by commas. Wildcard * is allowed.
Reference Data
| Configures Checks | SHORTDUMPS, ShortDumpStat |
| Default Value | |
| Unit | String |
ShortDumpTimeSpan
See the description of parameters ShortDumpCountCritand ShortDumpCountWarn.
Reference Data
| Configures Checks | ShortDumpStat |
| Default Value | 60 |
| Unit | Minutes |
ShortDumpCountMaxSelect
The number of short dumps returned SHORTDUMPS and ShortDumpStat check are limited to this value.
Reference Data
| Configures Checks | SHORTDUMPS, ShortDumpStat |
| Default Value | 1000 |
| Unit | Number |
SLT_JobsFilter
List of jobs suffix separated with ; and having the following syntax: INCLUDE:job10, job11; EXCLUDE:job01;job02.
Wildcards are allowed. If the parameter is empty (default) all jobs with the prefix /1LT/IUC_ are monitored.
Reference Data
| Configures | SLT_IUCjobs |
SLT_JobsRunTimeCrit
Max job runtime duration before Critical.
Reference Data
| Configures | SLT_IUCjobs |
| Default Value | 60 |
| Unit | Minutes |
SLT_JobsRunTimeWarn
Max job runtime duration before Warning.
Reference Data
| Configures | SLT_IUCjobs |
| Default Value | 15 |
| Unit | Minutes |
SLT_StatusFilter
List of SLT configurations separated with ; and having the following syntax: INCLUDE:config10, config11; EXCLUDE:config01;config02.
Wildcards are allowed. If the parameter is empty (default) all configuration are monitored.
Reference Data
| Configures | SLT_Status |
SLT_TableFilter
List of tables separated with ; and having the following syntax: INCLUDE:table10, table11; EXCLUDE:table01;table02 .
Wildcards are allowed. If the parameter is empty (default) all tables are monitored.
Reference Data
| Configures | SLT_UnprocessedRecords |
SLTStatusConfigName
Description
This monitoring parameter defines a comma separated list of SLT_Status names to be included in the check results. Wildcards * are allowed.
Reference Data
| Configures Checks | SLT_Status |
| Default Value | |
| Unit | String |
SLTStatusIgnored
This monitoring parameter allows turning off the irrelevant sub checks performed by SLT_Status. The configurations are semicolon-separated, and the ignored sub checks should be comma-separated, e.g. <CONFIGURATION_NAME_1>:<SUBCHECK1>,<SUBCHECK2>;<CONFIGURATION_NAME2>:<SUBCHECK3>,<SUBCHECK4> Possible values of the sub check names are:
CONNECTIONJOB_ACTIVITYLATENCYLOGTAB_STATUSREPLICATIONTABLE_STATUSTRIGGER
Wildcards (*) are supported for configuration names.
Reference Data
| Configures Checks | SLT_Status |
| Default Value | |
| Unit | String |
SLTDisableInactiveConfig
If the configuration matches this monitoring parameter, the check is disabled (status is set to DISABLED); otherwise, the check is performed and the status is WARNING if the configuration is not active with the message Configuration <configuration name> is not active. By default this monitoring parameter is empty ( ) meaning all configurations are checked. Also, it allows using wildcards (*) to match multiple configurations.
This monitoring parameter can contain multiple values (comma-separated).
Reference Data
| Configures Checks | SLT_Status, SLT_UnprocessedRecords, SLT_SrcTrgt |
| Default Value | |
| Unit | String |
SLTIucJobs
This parameter configures the jobs to be included in the SLT_IUCJobs check. Use commas to define multiple jobs, wildcards * are allowed.
Reference Data
| Configures Checks | SLT_IUCJobs |
| Default Value | |
| Unit | String |
SLTIucJobsMinutesCrit
If there were no SLT jobs finished within the time period specified by this parameter, the check result is set to Critical.
Reference Data
| Configures Checks | SLT_IUCJobs |
| Default Value | 60 |
| Unit | Minutes |
SLTIucJobsMinutesWarn
there were no SLT jobs finished within the time period specified by this parameter, the check result is set to Warning.
Reference Data
| Configures Checks | SLT_IUCJobs |
| Default Value | 15 |
| Unit | Minutes |
SLTSrcTrgtConfigName
This parameter filters SLT configuration names considered for the SLT_SrcTrgt check, which must be separated by commas.
Reference Data
| Configures Checks | SLT_SrcTrgt |
| Default Value | |
| Unit | String |
SLTSrcTrgtMtId
This parameter filters SLT MTIDs (3-digit numbers) considered for the SLT_SrcTrgt check, which must be separated by commas.
Reference Data
| Configures Checks | SLT_SrcTrgt |
| Default Value | |
| Unit | String |
SLTSrcTrgtCrit
This monitoring parameter is now deprecated. Please use SLTSrcTrgtRecordDiff instead.
With this parameter, you can set a Critical threshold for the difference between the source and target line numbers. If the difference is greater than or equal to the set parameter value, the evaluation result will be Critical.
Reference Data
| Configures Checks | SLT_SrcTrgt |
| Default Value | 100 |
| Unit | Number |
SLTSrcTrgtWarn
This monitoring parameter is now deprecated. Please use SLTSrcTrgtRecordDiff instead.
With this parameter, you can set a warning threshold for the difference between the source and target line numbers. If the difference is greater than or equal to this parameter value, but less than the value of the SLTSrcTrgtCrit parameter, the evaluation result will be Warning..
Reference Data
| Configures Checks | SLT_SrcTrgt |
| Default Value | 10 |
| Unit | Number |
SLTStatusMtId
With this parameter, you can set a warning threshold for the difference between the source and target line numbers. If the difference is greater than or equal to this parameter value, but less than the value of the SLTSrcTrgtCrit parameter, the evaluation result will be warning.
Reference Data
| Configures Checks | SLT_Status |
| Default Value | |
| Unit | String |
SLTSrcTrgtRecordDiff
This monitoring parameter sets warning and critical thresholds for SLT when table record counts differ for different tables. The first record of the * table can provide the default behavior, and subsequent lines provide override behavior for particular tables. The SLTSrcTrgtRecordDiff can be configured in UI with a special editor. This editor supports the wildcards for tables, and warning thresholds can be set for specific tables. The tables marked as 'not replicated' should not be included in the result except if a specific entry is included with “include”.
The default values of SLTSrcTrgtRecordDiff is represented by certain numbers, where * - all tables, 1 - include, 10 warn, 100 crit, 0 dbsource not marked, 0 - db target not marked.
As of 23.0, this monitoring parameter has replaced SLTSrcTrgtWarn and SLTSrcTrgtCrit.
Reference Data
| Configures Checks | SLT_SrcTrgt |
| Default Value | *;1;10;100;0;0 |
| Unit | SltRecDiff |
SLTUnprocRecordsClient
Set this parameter to filter SLT configurations considered during the SLT_UnprocessedRecords check. The listed configuration names must be separated by a comma. If the value is empty, all configurations are retrieved.
Reference Data
| Configures Checks | SLT_UnprocessedRecords |
| Default Value | |
| Unit | String |
SLTUnprocRecsConfigName
Set this parameter to filter SLT configurations considered during the SLT_UnprocessedRecords check. The listed configuration names must be separated by a comma. If the value is empty, all configurations are retrieved.
Reference Data
| Configures Checks | SLT_UnprocessedRecords |
| Default Value | |
| Unit | String |
SLTUnprocRecsLimit
With this parameter, you can define different warning and critical thresholds for the count of unprocessed records in each table as well as the warning and critical thresholds for the allowed latency for replication delay evaluation. Wildcards * are supported. Use the provided editor to set this monitoring parameter.
An example of the parameter value: *;1;100;1000;300;900
where each value is as follows: *; (table value);(count warning level);(critical latency level, 300 seconds);(warning latency level, 900 seconds)
The critical latency and warning latency values are in seconds.
Reference Data
| Configures Checks | SLT_UnprocessedRecords |
| Default Value | *;1;100;1000;300;900 |
| Unit | SltRecLimit |
SLTUnprocRecsMtId
Set this parameter to filter SLT configuration IDs considered during the SLT_UnprocessedRecords check. The listed SLT configuration IDs (3-digit numbers) must be separated by a comma. When empty, all available configurations are retrieved.
Reference Data
| Configures Checks | SLT_UnprocessedRecords |
| Default Value | |
| Unit | String |
SMClient
With this parameter, you can override the client this check gets data from. By default it's taken from the system properties.
Reference Data
| Configures Checks | SM_SolmanSetup |
| Default Value | |
| Unit | String |
SNCLevelOfProtection
This setting is used as parameter JCO_CLIENT_SNC_QOP for the SAP JCo connection and configures the SNC quality of protection level setting. The default value is 3, i.e. Privacy protection.
Reference Data
| Configures Checks | None |
| Default Value | 3 |
| Unit | String |
SNCLibraryPath
This parameter defines the path and file name of the SAP Cryptographic Library to use for SNC encryption of ABAP RFC connection, i.e. the RFCCONNECT check. The file must be found by the Avantra Agent locally on the Server file system and must be accessible, of course. The SAP Cryptographic Library is used by all clients with SNC communication e.g. SAP GUI, so you can find out more details on this file by checking your existing configuration.
You can override this parameter on the SAP Instance level.
Example: Crypto Library
Windows: <Install_folder>\sapcrypto.dll
Unix: <Install_folder>/sapcrypto.lib
This parameter is required when you want to use SNC for the Avantra Agent RFC connection.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | String |
SNCMode
Enabling this parameter will use SNC for the RFCCONNECT check. Before you enable this parameter, you need to make sure to completely configure the SNC settings, i.e. you need to configure the required SNC parameters according to your SNC setup, these are: SNCLibraryPath and SNCPartnerName. Also, setting SNCMyName is recommended.
Reference Data
| Configures Checks | None |
| Default Value | Disabled |
| Unit | Enum |
SNCMyName
This is a specific string containing the user name and some additional product information. The normal format is: <name type>:<external name>.
Example: p:CN=miller, OU=ADMIN, O=SAP, C=DE, p/secude:CN=miller, OU=ADMIN
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | String |
SNCPartnerName
Specifies the AS ABAP's SNC name the Avantra Agent connects to. You can find the application server's SNC name in the profile parameter snc/identity/as.
Example: p:CN=ABC, O=MyCompany, C=US
This parameter is required when you want to use SNC for the Avantra Agent's RFC connection.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | String |
SNCSecuDir
Defines the value for the SECUDIR environment variable that is used by the RFC connection over SNC.
You can override this parameter on the SAP Instance level.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | String |
SNCSingleSignOn
Do not use unless instructed by the Avantra Support.
Reference Data
| Configures Checks | None |
| Default Value | 1 |
| Unit | Boolean |
SpoolNOkCountCrit
If the number of unprocessed or erroneous output requests (older than SpoolNOkTimeOffset minutes) during the last SpoolNOkTimeSpan minutes exceeds this value, the check status is set to Critical.
Reference Data
| Configures Checks | SPOOLSTAT |
| Default Value | 10 |
| Unit | Number |
SpoolNOkCountWarn
If the number of unprocessed or erroneous output requests (older than SpoolNOkTimeOffset minutes) during the last SpoolNOkTimeSpan minutes exceeds this value but does not exceed SpoolNOkCountCrit, the check status is set to Warning.
Reference Data
| Configures Checks | SPOOLSTAT |
| Default Value | 1 |
| Unit | Number |
SpoolNOkDailyCountCrit
If the number of unprocessed or erroneous output requests (older than SpoolNOkTimeOffset minutes) within Daily-Checks exceeds this value the check status is set to Critical.
Reference Data
| Configures Checks | SPOOL |
| Default Value | 20 |
| Unit | Number |
SpoolNOkDailyCountWarn
If the number of unprocessed or erroneous output requests (older than SpoolNOkTimeOffset minutes) within Daily-Checks minutes exceeds this value but does not exceed SpoolNOkDailyCountCrit, the check status is set to Warning.
Reference Data
| Configures Checks | SPOOL |
| Default Value | 1 |
| Unit | Number |
SpoolNOkTimeOffset
See the description of parameters SpoolNOkCountCrit, SpoolNOkCountWarn, SpoolNOkDailyCountCrit and SpoolNOkDailyCountWarn.
Reference Data
| Configures Checks | SPOOLSTAT |
| Default Value | 5 |
| Unit | Minutes |
SpoolNOkTimeSpan
See the description of parameters SpoolNOkCountCrit and SpoolNOkCountWarn.
Reference Data
| Configures Checks | SPOOLSTAT |
| Default Value | 60 |
| Unit | Minutes |
SpoolNumRangeUsageCrit
If the percentage of used spool requests exceeds the SpoolNumRangeUsageCrit threshold the check status is set to Critical.
Reference Data
| Configures Checks | SPOOLSTAT |
| Default Value | 90 |
| Unit | % |
SpoolNumRangeUsageEnable
Defines if or if not the SPOOLSTAT check verifies the number range usage ratio.
Reference Data
| Configures Checks | SPOOLSTAT |
| Default Value | 1 |
| Unit | Boolean |
SpoolNumRangeUsageWarn
If the percentage of used spool requests exceeds the SpoolNumRangeUsageWarn threshold but not the SpoolNumRangeUsageCrit threshold the check status is set to Warning.
Reference Data
| Configures Checks | SPOOLSTAT |
| Default Value | 80 |
| Unit | % |
SpoolOutAccessMethodExclude
Defines access methods excluded from monitoring. Output requests which use a device with an access method specified in this list will not contribute to the check status. This is especially useful if you want to exclude all output requests which go to front end printers. You would then set the parameter to F. Separate multiple entries by spaces (wildcard * is allowed).
Reference Data
| Configures Checks | SPOOL, SPOOLSTAT |
| Default Value | |
| Unit | String |
SpoolOutDevExclude
Defines output devices excluded from monitoring. Output requests which go to a device specified in this list will not contribute to the check status. Separate multiple entries by spaces (wildcard \* is allowed).
Use the printers short names.
Reference Data
| Configures Checks | SPOOL, SPOOLSTAT |
| Default Value | |
| Unit | String |
SpoolOutDevTypeExclude
Defines output devices types excluded from monitoring. Output requests which go to an output device with a device type specified in this list will not contribute to the check status. For example, you might want to use this parameter to exclude all output requests which go output devices with device type SAPWIN. Separate multiple entries by spaces (wildcard \* is allowed).
Reference Data
| Configures Checks | SPOOL, SPOOLSTAT |
| Default Value | |
| Unit | String |
SpoolOutStatusInclude
This monitoring parameter filters the spool requests retrieved from SPOOL daily check. The format is comma-separated without spaces, i.e., 1,2,3,…. The statuses are 1 (Time / Scheduled), 2 (Waiting or In Processing), 3 (Waiting), 4 (In Processing), 5 (In Processing), 6 (Problem), 7 (Printing), and 8 (<F5>).
Note: Default (*) refers to all statuses.
Reference Data
| Configures Checks | SPOOL, SPOOLSTAT |
| Default Value | |
| Unit | String |
SpoolReqAgeWarn
f there are spool requests older than SpoolReqAgeWarn days, the check status is set to Warning.
Reference Data
| Configures Checks | SPOOL |
| Default Value | 60 |
| Unit | Days |
SpoolReqIgnoreFutureDelDate
You can ignore spool requests which have a deletion date in the future. If the deletion date of the spool request is after the current date plus the number of days defined by SpoolReqIgnoreFutureDelDate, then the spool request is ignored and not reported in the check. The default value of 0 days ignores the deletion date. In other words, all spool requests with a deletion date also very far in the future are reported.
Reference Data
| Configures Checks | None |
| Default Value | 0 |
| Unit | Days |
SSLCertificatesValidityCrit
If there are one or more certificates found, which expire in SSLCertificatesValidityCrit days or less, the check status is set to Critical.
Reference Data
| Configures Checks | SSLCertificatesValidity, JavaSSLCertificatesValidity |
| Default Value | 10 |
| Unit | Days |
SSLCertificatesValidityWarn
If there are one or more certificates found, which expires in SSLCertificatesValidityWarn days or less, but do not expire in SSLCertificatesValidityCrit days or less, the check status is set to Warning.
Reference Data
| Configures Checks | SSLCertificatesValidity, JavaSSLCertificatesValidity |
| Default Value | 30 |
| Unit | Days |
SSLCertificatesValidityIgnore
Expired certificates no longer contribute to the status of SSLCertificatesValidity if they are expired for SSLCertificatesValidityIgnore days or more.
Reference Data
| Configures Checks | SSLCertificatesValidity, JavaSSLCertificatesValidity |
| Default Value | 10 |
| Unit | Days |
SSLCertificatesValidityPSEErrors
This monitoring parameter is used to control how the SSLCertificatesValidity check status is affected by PSE read errors. The status is first set based on the certificate validity thresholds. Then, if there are any PSE errors, the check status can be changed based on the setting of this monitoring parameter.
By default, it's set to OK.
Reference Data
| Configures Checks | SSLCertificatesValidity |
| Default Value | OK |
| Unit | Enum |
StartSAPCleanipc
This monitoring parameter activates/deactivates the call of cleanipc command during the restart of an SAP System. The settings for this monitoring parameter will be the same for all the instances of this SAP System.
Reference Data
| Configures Checks | None |
| Default Value | Enabled |
| Unit | Enum |
SXMBMessagesClientList
Works together with SXMBMessagesClientMode, either to specify clients to be excluded (SXMBMessagesClientMode is in mode deny (Blacklist)) or limited to only clients listed (SXMBMessagesClientMode is in mode allow (Whitelist)). Please be aware that if you change parameter SXMBMessagesClientMode, you may also change this parameter to another list, since the default value 000 066 is intended to work in deny mode.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | Boolean |
SXMBMessagesClientMode
PI Integration Engine XML messages checks are designed to retrieve data of all clients found in an SAP system, no matter which client is used for RFC by the Avantra Agent. To exclude clients from being checked, you may use SXMBMessagesClientList in either deny (Blacklist) or allow (Whitelist) mode. The default value isdeny, i.e. all clients will be checked except client 000 and 066. If you want to, for instance, only check on specific clients, you may change this mode to allow and specify the clients to be checked using parameter SXMBMessagesClientList.
Reference Data
| Configures Checks | SXMB_Messages, SXMB_MessagesStat |
| Default Value | Blacklist |
| Unit | Enum |
SXMBMessagesNumCrit
f the number of erroneous PI Integration Engine XML messages since the last Daily Check start is equal to or above this value the check status is set to Critical.
Reference Data
| Configures Checks | SXMB_Messages |
| Default Value | 20 |
| Unit | Number |
SXMBMessagesNumWarn
If the number of erroneous PI Integration Engine XML messages since the last Daily Check start is equal to or above SXMBMessagesNumWarn but below SXMBMessagesNumCrit the check status is set to Warning.
Reference Data
| Configures Checks | SXMB_Messages |
| Default Value | 1 |
| Unit | Number |
SXMBMessagesStatNumCrit
If the number of erroneous PI Integration Engine XML messages in last SXMBMessagesStatTimeSpan minutes is equal to or above this value, the check status is set to Critical. Please note that the threshold is applied to each client individually, see SXMBMessagesClientMode and SXMBMessagesClientList parameters.
Reference Data
| Configures Checks | SXMB_MessagesStat |
| Default Value | 5 |
| Unit | Number |
SXMBMessagesStatNumWarn
If the number of erroneous PI Integration Engine XML messages in last SXMBMessagesStatTimeSpan minutes is equal to or above SXMBMessagesStatNumWarn but below SXMBMessagesStatNumCrit, the check status is set to Warning. Please note that the threshold is applied to each client individually, see SXMBMessagesClientMode and SXMBMessagesClientList parameters.
Reference Data
| Configures Checks | SXMB_MessagesStat |
| Default Value | 1 |
| Unit | Number |
SXMBMessagesStatTimeSpan
If the date/time of an erroneous PI Integration Engine XML message is after now minus SXMBMessagesStatTimeSpan minutes, the message will be counted, otherwise, it's no longer retrieved.
Reference Data
| Configures Checks | SXMB_MessagesStat |
| Default Value | 60 |
| Unit | Minutes |
SysAliveIncompleteTimeCrit
Defines how long a Warning SystemAlive check waits before turning to Critical if required SAP Instances are missing or no SAP Instance is available for a certain SAP System.
Reference Data
| Configures Checks | SystemAlive |
| Default Value | 10 |
| Unit | Minutes |
TimeoutMIIConnect
Configure timeout for MII_Connect check.
Reference Data
| Configures Checks | MII_Connect |
| Default Value | 30 |
| Unit | Seconds |
TimeOutSAPControl
SAPControl is used for several operations during monitoring, like remote detection of instances for agentless SAP system monitoring, certain checks, etc. This monitoring parameter allows you to configure the connect and read timeout for those SAPControl operations.
This configures SAP Agentless Detection, WebDispatcher monitoring, ERS monitoring, and DispatcherQueue.
Reference Data
| Configures Checks | None |
| Default Value | 30 |
| Unit | Seconds |
TMSImportReturnCodeCrit
Same as TMSImportStatReturnCodeCrit except that it configures Daily Check TMS_Imports instead of TMS_ImportStat. See also TMS_ImportStat for examples of TMSImportReturnCodeCrit usage.
Reference Data
| Configures Checks | TMS_Imports |
| Default Value | 8 |
| Unit | Enum |
TMSImportReturnCodeWarn
Same as TMSImportStatReturnCodeWarn except that it configures Daily Check instead of TMS_ImportStat. See also TMS_ImportStat for examples of TMSImportReturnCodeWarn usage.
Reference Data
| Configures Checks | TMS_Imports |
| Default Value | 4 |
| Unit | Enum |
TMSImportStatReturnCodeCrit
If a transport request with return code equal to or above TMSImportStatReturnCodeCrit is found, TMS_ImportStat check status will be Critical. You can turn off Critical status completely when you set the value to off. See section TMS_ImportStat for examples of TMSImportStatReturnCodeCrit usage.
Reference Data
| Configures Checks | TMS_ImportStat |
| Default Value | 8 |
| Unit | Enum |
TMSImportStatReturnCodeWarn
If a transport request with return code equal to or above TMSImportStatReturnCodeWarn is found, and no transport request with return code equal to or above TMSImportStatReturnCodeCrit is found, TMS_ImportStat check status will be Warning. You can turn off Warning status completely when you set the value to off. See section TMS_ImportStat for examples of TMSImportStatReturnCodeWarn usage.
Reference Data
| Configures Checks | TMS_ImportStat |
| Default Value | 4 |
| Unit | Enum |
TMSImportStatTimeSpan
If the date/time of a transport request import is after now minus TMSImportStatTimeSpan minutes, the record will be counted, otherwise, it's no longer retrieved.
Reference Data
| Configures Checks | TMS_ImportStat |
| Default Value | 60 |
| Unit | Minutes |
TMSIncludeNotImported
When enabled, this parameter configures TMS_Imports to include transports that were not imported. By default, transported that were not imported are included.
Reference Data
| Configures Checks | TMS_Imports |
| Default Value | 1 |
| Unit | Boolean |
TMSNotImportedCrit
This monitoring parameter defines the number of unimported transports for the TMS_Imports check to trigger Critical alert.
Setting this parameter to 0 will cause any not imported transport to trigger a Critical alert
Reference Data
| Configures Checks | TMS_Imports |
| Default Value | -1 |
| Unit | Number |
TMSStatusIgnoreSid
This monitoring parameter configures TMS_Status to remove specific SIDs from the landscape. Multiple SIDs can be defined using a comma-seperated list, for example, SA1,SA2.
Reference Data
| Configures Checks | TMS_Status |
| Default Value | |
| Unit | String |
TmsStatusIncludeImportOverview
This monitoring parameter configures TMS_Status to include the Import Overview in the status results.
Reference Data
| Configures Checks | TMS_Status |
| Default Value | false |
| Unit | Boolean |
TRFCAgeWarn
f there are tRFC records older than TRFCAgeWarn days, the check result of TRFC_IN or TRFC_OUT is set to Warning.
Reference Data
| Configures Checks | TRFC_IN, TRFC_OUT |
| Default Value | 1 |
| Unit | Days |
TRFCInCountWarn
If the number of tRFC records with status CPICERR, SYSFAIL or SYSLOAD (older than TRFCInTimeOffset minutes) during the last TRFCInTimeSpan minutes exceeds this value but does not exceed TRFCInCountCrit, the check status is set to Warning.
Reference Data
| Configures Checks | TRFCInStat |
| Default Value | 5 |
| Unit | Number |
TRFCInCountCrit
If the number of tRFC records with status CPICERR, SYSFAIL, or SYSLOAD (older than TRFCInTimeOffset minutes) during the last TRFCInTimeSpan minutes exceeds this value, the check status is set to Critical.
Reference Data
| Configures Checks | TRFCInStat |
| Default Value | 20 |
| Unit | Number |
TRFCInExcludeFunction
This parameter excludes certain functions from the TRFCInStat check. The list of functions may be separated by blanks or a comma. Wildcards * and ? are supported.
Reference Data
| Configures Checks | TRFCInStat |
| Default Value | |
| Unit | String |
TRFCInExcludeUser
This parameter excludes certain users from the TRFCInStat](../sap-system/built-in-checks#trfcinstat) check. The list of functions may be separated by blanks or a comma. Wildcards * and ? are supported.
Reference Data
| Configures Checks | TRFCInStat |
| Default Value | |
| Unit | String |
TRFCInTimeOffset
See the description of parameters TRFCInCountCrit and TRFCInCountWarn.
Reference Data
| Configures Checks | TRFCInStat |
| Default Value | 5 |
| Unit | Minutes |
TRFCInTimeSpan
See the description of parameters TRFCInCountCrit and TRFCInCountWarn.
Reference Data
| Configures Checks | TRFCInStat |
| Default Value | 60 |
| Unit | Minutes |
TRFCOutCountCrit
If the number of tRFC records with status CPICERR, SYSFAIL or SYSLOAD (older than TRFCOutTimeOffset minutes) during the last TRFCOutTimeSpan minutes exceeds this value the check status is set to Critical.
Reference Data
| Configures Checks | TRFCOutStat |
| Default Value | 20 |
| Unit | Number |
TRFCOutCountWarn
If the number of tRFC records with status CPICERR, SYSFAIL or SYSLOAD (older than TRFCOutTimeOffset minutes) during the last TRFCOutTimeSpan minutes exceeds this value but does not exceed TRFCOutCountCrit the check status is set to Warning.
Reference Data
| Configures Checks | TRFCOutStat |
| Default Value | 5 |
| Unit | Number |
TRFCOutTimeOffset
See the description of parameters TRFCOutCountCrit and TRFCOutCountWarn.
Reference Data
| Configures Checks | TRFCOutStat |
| Default Value | 5 |
| Unit | Minutes |
TRFCOutTimeSpan
See the description of parameters TRFCOutCountCrit and TRFCOutCountWarn.
Reference Data
| Configures Checks | TRFCOutStat |
| Default Value | 60 |
| Unit | Minutes |
TRFCOutExcludeFunction
This parameter is used to exclude certain functions from the TRFCOutStat check. The list of functions may be separated by blanks or a comma. Wildcards * and ? are supported.
Reference Data
| Configures Checks | TRFCOutStat |
| Default Value | |
| Unit | String |
TRFCOutExcludeUser
This parameter is used to exclude certain users from the TRFCOutStat check. The list of functions may be separated by blanks or a comma. Wildcards * and ? are supported.
Reference Data
| Configures Checks | TRFCOutStat |
| Default Value | |
| Unit | String |
UpdateErrCountCrit
If the number of update errors exceeds UpdateErrCountCrit during the last UpdateRecErrTimeSpan minutes, the check status is set to Critical.
Reference Data
| Configures Checks | UpdateRecErrStat |
| Default Value | 6 |
| Unit | Number |
UpdateErrCountWarn
If the number of update errors exceeds UpdateErrCountWarn during the last UpdateRecErrTimeSpan minutes, but does not exceed UpdateErrCountCrit, the check status is set to Warning.
Reference Data
| Configures Checks | UpdateRecErrStat |
| Default Value | 3 |
| Unit | Number |
UpdateQueueAgeCrit
If there are UpdateQueueCountCrit or more update records older than UpdateQueueAgeCrit seconds, the check status is set to Critical.
Reference Data
| Configures Checks | UPDATEQUEUE |
| Default Value | 300 |
| Unit | Seconds |
UpdateQueueAgeWarn
f there are UpdateQueueCountWarn or more update records older than UpdateQueueAgeWarn seconds, but the number of update records older than UpdateQueueAgeCrit seconds is below UpdateQueueCountCrit the check status is set to Warning.
Reference Data
| Configures Checks | UPDATEQUEUE |
| Default Value | 60 |
| Unit | Seconds |
UpdateQueueCountCrit
See the description of parameter UpdateQueueAgeCrit.
Reference Data
| Configures Checks | UPDATEQUEUE |
| Default Value | 5 |
| Unit | Number |
UpdateQueueCountWarn
See the description of parameter UpdateQueueAgeWarn.
Reference Data
| Configures Checks | UPDATEQUEUE |
| Default Value | 1 |
| Unit | Number |
UpdateRecErrTimeSpan
See the description of parameters UpdateErrCountCrit and UpdateErrCountWarn.
Reference Data
| Configures Checks | UpdateRecErrStat |
| Default Value | 60 |
| Unit | Minutes |
UseEnvironment
Use only if instructed by Avantra support.
Environment variable names are handled case insensitive. You may use any number of spaces between = and ;.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | String |
UserPWDAuditExclude
Tells USER_PWD_AUDIT to exclude the listed users from the check result evaluation. If one of the users on this list has a well-known password, it's listed in the check message but does not contribute to the check status. Anyway, USER_PWD_AUDIT checks if the users on this list are locked.
Reference Data
| Configures Checks | USER_PWD_AUDIT |
| Default Value | SAPCPIC EARLYWATCH |
| Unit | String |
UserPWDAuditFailedLogonSeverity
UserPWDAuditFailedLogonSeverity controls how users locked due to unsuccessful login attempts will be checked. If this parameter is set to Critical a user locked due to unsuccessful login attempts will be reported as Critical. If UserPWDAuditFailedLogonSeverity is set to OK (not recommended), a user locked due to unsuccessful login attempts will not contribute to the check result.
Reference Data
| Configures Checks | USER_PWD_AUDIT |
| Default Value | Warning |
| Unit | Enum |
XALVariantActive
Defines whether the CCMS properties variant defined by XALVariantName will be activated automatically. If this parameter is set to 0, the Avantra properties variant is not activated automatically, so the settings may be written to an inactive variant and are not used by CCMS. If the parameter is set to 1, which is the default, XALVariantName is automatically activated and will stay active because any manual changes to the active variant using SAP transaction RZ21 will be overwritten periodically.
This configures the CCMS custom check.
Reference Data
| Configures Checks | None |
| Default Value | 1 |
| Unit | Number |
XALVariantName
Defines the name of the CCMS properties variant when settings are written to CCMS using Avantra. Use SAP transaction RZ21 to get an overview of properties variants. If you change XALVariantName you need to make sure that the variant already exists and the owner of the variant is set to SYSLINK. The default variant name SYSLINK is automatically created if it does not exist.
This configures the CCMS custom check.
Reference Data
| Configures Checks | None |
| Default Value | SYSLINK |
| Unit | String |
StartStopDependentWINService
This parameter is only applicable if your SAP database runs on a Windows operating system as a Windows service. Avantra Automation can start and stop those windows services, but Avantra does not know if dependent Windows services should be started or stopped as well. If you want to start and stop those dependent Windows services as well, then activate this with this parameter.
Reference Data
| Configures Checks | None |
| Default Value | |
| Unit | Boolean |
WaitingTimeStartMoniOn
After Avantra starts a system (e.g SAP System, database, or server), Avantra sets the monitoring switch to on. Avantra already has some built-in logic to detect whether the system is up and running, but sometimes a system responds that it's running, but in fact it's not yet ready for production usage. The time until the system is ready highly depends on the system internals and is unknown to Avantra. With this parameter, you can define how long Avantra should wait after starting the system until the monitoring switch is turned on.
Reference Data
| Default Value | 60 |
| Unit | Seconds |
WaitingTimeMoniOffStop
Avantra turns the monitoring switch off before stopping a system. Use this parameter to define how long Avantra should wait after turning the monitoring switch off until Avantra stops the system.
Reference Data
| Default Value | 0 |
| Unit | Seconds |