An
activity which sends an OpenSpirit data selection event to a designated
user's running OpenSpirit enabled applications. Activity
An
activity which sends an OpenSpirit data selection event to a designated
user's running OpenSpirit enabled applications.
OpenSpirit Send Data Selection Event Configuration Fields
| Field | Global Var? | Optional? | Description |
| Name | No | No | User assigned name given to the Send Data Selection Event activity |
| Description | No | Yes | User assigned description (optional) |
| OpenSpirit User | No | Required unless OspUser is supplied in input | 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 |
| Input Item | Datatype | 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. |
OspDataKeyArray |
OspDataKeyArray | A sequence of Datakey elements, each of which contains an OpenSpirit datakey represented as a string. |
The output for this activity mirrors the input for convenience of subsequent activities.
| Input Item | Datatype | Description |
| EventParameters | Complex | Root element for all input elements |
| OspUser | string | The OpenSpirit user that the event was sent to. |
| 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. |
OspDataKeyArray |
OspDataKeyArray | A sequence of Datakey elements, each of which contains an OpenSpirit datakey represented as a string. |
The Error Output tab lists the possible exceptions that can be thrown by this activity.
| Exception | Thrown When ... |
OspException msg msgCode |
The data selection event could
not be successfully sent.
The msg element should contain some indication of the reason. The error code (see list of possible codes) |