SendDataSelectionEvent
An activity which sends an OpenSpirit data selection event to a designated user's running OpenSpirit enabled applications.
General
The General tab contains the following fields.
Field | Module Property? | Description |
---|---|---|
Name | No | The name to be displayed as the label for the activity in the process. |
OpenSpirit User | No | The OpenSpirit user to send the event to. Any application that is running under this user account and is registered to receive data selection events will receive this event. Required unless OspUser is supplied in input. |
Input
The following is the input for the activity.
Input Item | Data Type | Description |
---|---|---|
EventParameters | Complex | Root element for all input elements |
OspUser | String | Required if the OpenSpirit User is not specified in the configuration panel. If the OpenSpirit User is supplied in the configuration panel and as an input, the value specified in the input will override the configuration panel value. Any application that is running under this user account and is registered to receive data selection events will receive this event. |
SenderId | String | Optional input that identifies the sending application. |
EventMetadata | String | Optional input that contains additional information, normally an xml string, that will be included in the sent event. |
ModelName | String | Optional name of the model in which the entities that defines the datakeys. If not supplied, the OpenSpirit model will be used. |
ModelName | String | Optional version of the model in which the entities that defines the datakeys. Required if model name is supplied and is not "OpenSpirit". |
ModelVersion | String | The optional name of the model in which the entities that defines the datakeys. |
OspDataKeyArray | OspDataKeyArray | A sequence of Datakey elements, each of which contains an OpenSpirit datakey represented as a string. |
Output
The following is the output for the activity. The output for this activity mirrors the input for convenience of subsequent activities.
Output Item | Data Type | Description |
---|---|---|
EventParameters | Complex | Root element for all output elements. |
OspUser | String | The OpenSpirit user that the event was sent with. |
SenderId | String | Optional input that identifies the sending application. |
EventMetadata | String | Optional input that contains additional information, normally an xml string, that will is included in the sent event. |
ModelName | String | Optional version of the model in which the entities that defines the datakeys. Required if model name is supplied and is not "OpenSpirit". |
ModelVersion | String | The optional name of the model in which the entities that defines the datakeys. |
OspDataKeyArray | OspDataKeyArray | A sequence of Datakey elements, each of which contains an OpenSpirit datakey represented as a string. |