Parameters for Custom Operations and Custom Hooks

All custom operations and hooks get default parameters for the instances, hosts, and virtual hosts on which they are executed.

All configured custom properties of the instance are available with the prefix PROP-<Custom Property Name>. For custom operations you can also configure your own parameters which have to be set by the user and are available with the prefix PARAM-<Custom Parameter Name>.

Parameter	Description	Available for Entity Type
PHYSICAL_HOSTNAME	Host on which this operations is started	Database Instance SAP Instance Custom Instance
SERVICE_CLASS	Instance class Example Database, Instance, Custom Instance	Database Instance SAP Instance Custom Instance
SERVICE_SUBTYPE	Instance subtype: Instance_Diag_Agnt/None Instance_Diag_Agnt/SolMan Instance_System_DB/ABAP Instance_System_DB/J2EE Instance_System_DB/Shared Instance_System_DB/None Instance_Shadow_DB/ABAP Instance_Shadow_DB/J2EE Instance_Shadow_DB/Shared Instance_LC_Shadow_DB/None Instance_LC_Shadow_DB/ABAP Instance_LC_Shadow_DB/J2EE Instance_LC_Shadow_DB/Shared Instance_Shadow_DB/None Instance_System_DB/MDM Instance_Other_DB/None Instance_Other_DB/ABAP Instance_Other_DB/J2EE Instance_Other_DB/Rep Instance_System_HDB/ABAP Instance_System_HDB/J2EE Instance_System_HDB/Shared Instance_System_HDB/SystemDB Instance_System_HDB/MDC_Node Instance_System_HDB/None Instance_Tenant_HDB/ABAP Instance_Tenant_HDB/J2EE Instance_Tenant_HDB/Shared Instance_Tenant_HDB/None Instance_HDB_SDS/None Instance_HDB_Option/SDS Instance_HDB_Option/AFA Instance_HDB_Option/RDS Instance_HDB_Option/XSA Instance_HDB_Option/ES Instance_CC/CCD Instance_CC/CCB Instance_CC/CCG Instance_CC/CCR Instance_CC/CCU Instance_CC/BART Instance_LiveCache_DB/None Instance_LiveCache_DB/ABAP Instance_Gateway/None Instance_Web_Dispatcher/None Instance_SCS/ABAP Instance_SCS/J2EE Instance_SCS/Shared Instance_SCS/None Instance_ERS/ABAP Instance_ERS/J2EE Instance_ERS/Shared Instance_ERS/None Instance_TREX/None Instance_Central_Application_Server/ABAP Instance_Central_Application_Server/Shared Instance_Central_Application_Server/J2EE Instance_Central_Application_Server/None Instance_Application_Server/ABAP Instance_Application_Server/J2EE Instance_Application_Server/Shared Instance_Application_Server/None MDM_Server/None MDM_Syndication_Server/None MDM_Import_Server/None MDM_Data_Server/None MDM_Layout_Server/None	Database Instance SAP Instance Custom Instance
SYSTEM_SERVICE_ID	Instance ID of the parent system	Database Instance SAP Instance Custom Instance
system_sid	System ID (SID) of the parent system	Database Instance SAP Instance Custom Instance
SYSTEM_HOST	Configured host of the parent system	Database Instance SAP Instance Custom Instance
SERVICE_ID	ID of the instance	Database Instance SAP Instance Custom Instance
service_name	Custom Instance: service_name SAP Instance: SAPSYSTEMNAME Database: SAPDBNAME	Database Instance SAP Instance Custom Instance
service_type	Custom Instance: service_type SAP Instance: SAPSYSTEM Database: SAPDBTYPE	Database Instance SAP Instance Custom Instance
service_hostname	Custom Instance: service_host SAP Instance: SAPLOCALHOST Database: SAPDBHOST	Database Instance SAP Instance Custom Instance
service_release	Release of the instance	Database Instance SAP Instance Custom Instance
PRIMARY_NETWORK	Network name of the primary virtual host name	Database Instance SAP Instance Custom Instance
COMMUNICATION_HOSTNAME	Communication host name of the instance	Database Instance SAP Instance Custom Instance
NETWORKS	All configured networks for this instance, separated by `\|`	Database Instance SAP Instance Custom Instance
NOTE_TEXT	Content of the note, if provided for this operation	Database Instance SAP Instance Custom Instance
RealHostName	Instance for which this operation is triggered, might be different from the PHYSICAL_HOSTNAME, if executed using a central operation	Database Instance SAP Instance Custom Instance
CustomOpTarget	Name of the custom operation, URL, and so on.	Database Instance SAP Instance Custom Instance Host
CustomOpDefId	ID of the provider implementation	Database Instance SAP Instance Custom Instance Host
CustomOpId	ID of the hook or custom operation	Database Instance SAP Instance Custom Instance Host
OpName	Caption of the hook or custom operation	Database Instance SAP Instance Custom Instance Host
Username	Name of the J2EE user executing this hook or operation	Database Instance SAP Instance Custom Instance Host Virtual Host
ACTIVITY_ID	Numeric ID of the process as shown in the activities screen	Database Instance SAP Instance Custom Instance Host Virtual Host
LOG_ID	Numeric ID of the process step as shown in the log view	Database Instance SAP Instance Custom Instance Host Virtual Host
PROCESS_STEP_ID	Universal unique identifier of the process step	Database Instance SAP Instance Custom Instance Host Virtual Host
PROCESS_ID	Universal unique identifier of the process	Database Instance SAP Instance Custom Instance Host Virtual Host
HookType	Hooks only: Type of the executed hook Example Pre, post, or error	Database Instance SAP Instance Custom Instance Host Virtual Host
HookOperationName	Hooks only: Name of the operation for which the hook is executed	Database Instance SAP Instance Custom Instance Virtual Host
HOOK_PROCESS_NAME	Hooks only: Name of the process, in which this hook is executed Example Mass start, system refresh	Database Instance SAP Instance Custom Instance Virtual Host
SAPDBNAME	Database name	Database Instance
SAPDBTYPE	Database type	Database Instance
SAPDBHOST	Database host	Database Instance
SAPDBCONF_DIR	Database configuration directory	Database Instance
SAPDBINSTANCE	Database instances	Database Instance
SAPDBUSER	User to connect to the database Example Control for MaxDB	Database Instance
SAPSYSTEMNAME	SID of the system	SAP Instance
SAPSYSTEM	Instance number of the instance	SAP Instance
SAPLOCALHOST	Installation host of the instance	SAP Instance
SAPSTARTPROFILE	Configured start profile path	SAP Instance
SYSTEM_UUID	Universal unique identifier of the system	SAP Instance
SAPROUTER	SAProuter string	SAP Instance
SMD_SAPSYSTEMNAME	SID of the configured SMD agent	Database Instance SAP Instance
SMD_SAPSYSTEM	Instance number of the configured SMD agent	Database Instance SAP Instance
SMD_SAPSTARTPROFILE	Start profile of the configured SMD agent	Database Instance SAP Instance
MOUNT_XML_PATH	Path to the temporary file containing the mount data of the service. Only available for custom provisioning or if configured for the custom operation or hook.	Database Instance SAP Instance Custom Instance
service_name	Identifying instance name	Custom Instance
service_type	Type of the instance	Custom Instance
service_hostname	Host name of the instance	Custom Instance
OS_TYPE	Type of the operating system Example Windows NT, Linux	Host
OS_ARCH	Operating system architecture Example x86_64	Host
OS_VERSION	Version of the operating system Example SLES11	Host
SAPS	Configured SAPS	Host
MEMAV	Available memory	Host
CPUS	Number of CPUs	Host
RealHostName	Host for which this operation is triggered. Might be different from the PHYSICAL_HOSTNAME, if executed using a central operation.	Host
VIRTUAL_RESOURCE_ID	Virtual host ID	Virtual Host
VIRTUAL_RESOURCE_PROVIDER_ID	Virtual host provider ID	Virtual Host
CHARAC-`<Characteristic Name>`	Available for each characteristic where the entity is assigned to a value. The value of the parameter is the assigned characteristic value.	Database Instance SAP Instance Custom Instance Host