Skip to main content

# Custom check macros

Custom check macros are placeholders replaced with values specific to the particular System the custom check is executed on. Using these macros provides greater flexibility in custom check definition for multiple Systems.

note

Please check the list of macros available for every custom check you select, as each macro can be used on specific custom checks only.

## Available macros​

Macro | Description | Available for Custom Checks | Available for System Types
--- | --- | --- | ---
`%%BAS_REL%%` | The Basis release of an SAP system | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP Instance, SAP System
`%%BASE_DIR%%` | The installation directory of Avantra Agent (e.g., `C:\Program Files (x86)\syslink\agent` on Windows, `/syslink/agent/` on Unix-like systems). You most likely need to set quotes while referencing this macro. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System, Database
`%%BIN_DIR%%` | The bin directory of Avantra Agent (`[agent_basedir]/bin`). You most likely need to set quotes while referencing this macro. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System, Database
`%%CFG_DIR%%` | The cfg directory of Avantra Agent (`[agent_basedir]/cfg`). You most likely need to set quotes while referencing this macro. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System, Database
`%%CI_ID%%` | The internal ID of the Central SAP instance | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP System
`%%CI_NAME%%` | The Central SAP instance's name of an SAP system | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP System
`%%CI_SYSNO%%` | The system number of the Central SAP instance | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP System
`%%DB_HOST%%` | The name of the Server monitoring the Database. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | database, SAP System
`%%DB_ID%%` | The internal ID of a standalone Database. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | database, SAP System
`%%DB_NAME%%` | The name of a Database. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | database, SAP System
`%%DB_PASSWD%%` | The password corresponding to %%DB_USER%%. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | database, SAP System
`%%DB_PASSWD2%%` | The password corresponding to %%DB_USER2%%. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | database, SAP System
`%%DB_PASSWD_JAVA%%` | The password corresponding to %%DB_USER_JAVA%%. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | database, SAP System
`%%DB_PORT%%` | The listening port of the Database. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | database, SAP System
`%%DB_UNIFIED_NAME%%` | The unified Database name of a standalone Database. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | database, SAP System
`%%DB_USER%%` | The user name used by the Avantra Agent to access the Database. For Database instance of an SAP system it corresponds to the ABAP schema user. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | database, SAP System
`%%DB_USER2%%` | The name of the administrative user of a MaxDB Database. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | database, SAP System
`%%DB_USER_JAVA%%` | The user name used by the Avantra Agent to access the Java schema of a Database instance of an SAP system. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | database, SAP System
`%%DBT%%` | The Database type of an SAP system | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP Instance, SAP System
`@@[env_var]@@` | Replaced by the environment variable `[env_var]`, if available. Must be defined in the environment of the user running the Avantra Agent. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System, Database
`%%I_ID%%` | The (internal) ID of SAP instances. Returns a list for Servers/systems, single value for instances. Only available if "Run Custom Check on DB Host" flag is not set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System
`%%I_NAME%%` | The name of SAP instances. Returns a list for Servers/systems, single value for instances. Only available if "Run Custom Check on DB Host" flag is not set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System
`%%I_PATH%%` | Resolves to the instance path (e.g., `/usr/sap/C11/DVEBMGS00`) | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP Instance
`%%I_SYSNR%%` | The system numbers of SAP instances. Returns a list for Servers/systems, single value for instances. Only available if "Run Custom Check on DB Host" flag is not set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System
`%%I_TYPE%%` | The type of SAP instances. Returns a list for Servers/systems, single value for instances. Only available if "Run Custom Check on DB Host" flag is not set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System
`%%J2EE_PWD%%` | The J2EE user password corresponding to %%J2EE_USR%% | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP Instance, SAP System
`%%J2EE_USR%%` | The J2EE user name used by the Avantra Agent to access the SAP system | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP Instance, SAP System
`%%LOG_DIR%%` | The log directory of Avantra Agent (`[agent_basedir]/log`). You most likely need to set quotes while referencing this macro. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System, Database
`%%NEWLINE%%` | The newline character. Use when you need to define a newline in your command line call. | RUN_PROG | Server, SAP Instance, SAP System, Database
`%%ORACLE_HOME%%` | Oracle Home directory, as detected by the Agent. For SAP systems, only available if "Run Custom Check on DB Host" flag is set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Oracle Database, SAP system with Oracle
`%%PROG_DIR%%` | Absolute directory containing the script/program to be executed. Only available in "Program Executable Name" and "Command Line Call" fields when Avantra deploys the program. You most likely need quotes while referencing this macro. | RUN_PROG | Server, SAP Instance, SAP System, Database
`%%PROG_NAME%%` | Name of the script/program to be executed. Only available when Avantra deploys the program. | RUN_PROG | Server, SAP Instance, SAP System, Database
`%%PROG_PATH%%` | Absolute path of the script/program to be executed. Only available when Avantra deploys the program. You most likely need quotes while referencing this macro. | RUN_PROG | Server, SAP Instance, SAP System, Database
`%%RFC_PWD%%` | The RFC user password corresponding to %%RFC_USR%% | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP Instance, SAP System
`%%RFC_USR%%` | The RFC user name used by the Avantra Agent to access the SAP system | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP Instance, SAP System
`%%RSID%%` | The real SAP SID of SAP systems. Returns a list for Servers/systems, single value for instances. Only available if "Run Custom Check on DB Host" flag is not set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System
`%%SAPCONTROL_PWD%%` | The SAPControl user password corresponding to %%SAPCONTROL_USR%% | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP Instance, SAP System
`%%SAPCONTROL_USR%%` | The SAPControl user name used by the Avantra Agent to access the SAP system | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | SAP Instance, SAP System
`%%SRV_DNSDOMAIN%%` | The Server's DNS Domain field value | All custom checks | Server, SAP Instance, SAP System, Database
`%%SRV_FQDN%%` | The Server's FQDN or IP Address field value | All custom checks | Server, SAP Instance, SAP System, Database
`%%SRV_ID%%` | The internal ID referencing the Server the custom check is executed on | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System, Database
`%%SRV_NAME%%` | The name referencing the Server the custom check is executed on | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System, Database
`%%TMP_DIR%%` | The tmp directory of Avantra Agent (`[agent_basedir]/tmp`). You most likely need to set quotes while referencing this macro. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System, Database
`%%USID%%` | The unified SAP SID of SAP systems. Returns a list for Servers/systems, single value for instances. Only available if "Run Custom Check on DB Host" flag is not set. | FILE_EXISTS, FILE_UPTODATE, FILE_CONTENT, NW_RESPONSE, PROCESS, RUN_PROG, HTTP_RESPONSE, LOG_ADAPTER, WIN_SERVICE | Server, SAP Instance, SAP System