Reference: Launch Parameters Helper Object
Useful Properties
Name | Notes |
|---|---|
integrationEventWID
| Returns the WID for the integration event relating to the current launch of the
integration. Useful when making webservice calls such as
Get_Event_Documents ,
Put_Integration_Message , or
Put_Integration_Event . Automatically provides a
default parameter to the wcc://GetEventDocuments,
wcc://PutIntegrationMessage, and wcc://PutIntegrationEvent common
components. |
integrationSystem
| Returns the Integration_System_ID for the current integration
system. Useful when populating webservice calls for event subscription
or field override requests. |
integrationSystemRefWID
| Returns the WID for the current integration system. An entirely equivalent
alternative to the integrationSystem
property. |
parentEventWID
| Returns the WID for the current launch event's parent event. |
sentOn
| Returns the date and time of the integration's launch formatted as an ISO-8601 date
and time. |
sentOnAsDate
| Returns the date and time of the integration's launch in the form of a
java.util.Date object. |
Useful Functions
Some of these functions specify a launch parameter by its name alone. Others specify both
the launch parameter's name and the name of the integration service that
provides it. The latter are useful when a launch parameter with the same
name exists in multiple integration services configured on the integration
system. Most integrations don't need to accommodate launch parameter names
that are duplicated across multiple services, so those functions are less
frequently required.
Name | Arguments | Return Value Type | Notes |
|---|---|---|---|
exists
| String name | Boolean | Returns true if the named launch parameter has a nonempty value. |
String service_name, String name | Boolean | Returns true if the named launch parameter in the specified integration service has a
nonempty value. Preferable to the single argument version
only when a launch parameter of the same name exists in multiple
integration services enabled on the integration
system. | |
getDate
| String name | String | Returns the String-formatted date value of the runtime parameter. The format is
YYYY-MM-DDZ or YYYY-MM-DD+/-offset. |
String service_name, String name | String | Returns the String-formatted date value of the runtime parameter
of the specified service. The format is YYYY-MM-DDZ or
YYYY-MM-DD+/-offset. | |
getParameterData
| String name | org.w3c.dom.Element | Returns the XML element
Integration_Runtime_Parameter_Data , which holds the
named launch parameter from the
Launch_Integration_Event message that's sent to
the integration at startup. |
String service_name, String name | org.w3c.dom.Element | Returns the XML element
Integration_Runtime_Parameter_Data , which holds the
named launch parameter of the specified service from the
Launch_Integration_Event message that's sent to the
integration at startup. | |
getReferenceData
| String name, String type | String | Returns the reference ID of the given type for the launch parameter
with the specified name. Example: this code returns the employee ID
for a launch parameter named
Employee:
|
getReferenceDataList
| String name, String type | List<String> | Returns a Java List containing zero or more reference IDs from a
multi-instance launch parameter. |
String service_name, String name, String type | List<String> | Returns a Java List containing zero or more reference IDs from a
multi-instance launch parameter of a specified service. | |
getSequencedValue
| String name | String | Returns the current value of the sequence generator with the
specified name. |
String service_name, String name | String | Returns the current value of the specifed sequence generator
declared on the specified service. |