Developing Apama Applications > Developing Apama Applications in Event Modeler > Using Functions in Event Modeler > Reference information for provided functions > System value functions
System value functions
The following table describes the system value functions.
System value functions
Function name
Return value
Parameters
Description
GET_DASHBOARD_ INSTANCEID
string
None
Returns the instance ID of the current Scenario instance for use in dashboards. The apama.instanceId field contains this value.
GET_INSTANCEID
string
None
Returns the complete instance ID of the current Scenario instance. For example: "default.myScenario.1".
GET_INSTANCE_ OWNER
string
None
Returns the value of the owner attribute of the current Scenario instance. This might be, but is not necessarily, the account Id that created the Scenario. You can use the Scenario service API to create Scenario instances and set the owner attribute to a value you choose. When you use a dashboard to create Scenario instances, the owner attribute has the value of the account you logged into.
GET_NUMERIC_ INSTANCEID
float
None
Returns only the number at the end of the complete instance Id of the current Scenario instance. For example, if the complete instance Id is default.myScenario.1, this function returns 1.
GET_SCENARIO_ID
string
None
Returns the unique scenario ID of the current scenario definition. The correlator uses this key to create new instances of the scenario.
GET_SCENARIO_ NAME
string
None
Returns the display name of the current Scenario.
Copyright © Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its Subsidiaries and or/its Affiliates and/or their licensors.
Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG.