Activity
An
activity which sends an OpenSpirit GIS event to a designated user's running
OpenSpirit enabled applications. A GIS event contains point, linestring,
or polygon layers with zero of more features in each layer.
OpenSpirit Send GIS Selection Event Configuration Fields
Field | Global Var? | Optional? | Description |
Name | No | No | User assigned name given to the Send GIS 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 GIS 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. |
OspPolygonLayers |
A sequence of OspPolygonLayer elements |
A sequence of OspPolygonLayer elements, each of which specifies a layer name, CRS, vertical unit , definition of feature attribute names/types, and then a sequence of polygon features (geometry plus attribute values). The geometry is specified as ESRI well known text (WKT- see appendix) |
OspLineStringLayers |
A sequence of OspLineStringLayer elements |
A sequence of OspLineStringLayer elements, each of which specifies a layer name, CRS, vertical unit , definition of feature attribute names/types, and then a sequence of polygon features (geometry plus attribute values). The geometry is specified as ESRI well known text (WKT- see appendix) |
OspPointLayers |
A sequence of OspPointLayer elements |
A sequence of OspPolygonLayer elements, each of which specifies a layer name, CRS, vertical unit , definition of feature attribute names/types, and then a sequence of polygon features (geometry plus attribute values). The geometry is specified as ESRI well known text (WKT- see appendix) |
The output for this activity mirrors the input for convenience of subsequent activities.
Output Item | Datatype | Description |
EventParameters | Complex | Root element for all output 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 be included in the sent event. |
OspPolygonLayers |
A sequence of OspPolygonLayer elements |
A sequence of OspPolygonLayer elements, each of which specifies a layer name, CRS, vertical unit , definition of feature attribute names/types, and then a sequence of polygon features (geometry plus attribute values). The geometry is specified as ESRI well known text (WKT- see appendix) |
OspLineStringLayers |
A sequence of OspLineStringLayer elements |
A sequence of OspLineStringLayer elements, each of which specifies a layer name, CRS, vertical unit , definition of feature attribute names/types, and then a sequence of polygon features (geometry plus attribute values). The geometry is specified as ESRI well known text (WKT- see appendix) |
OspPointLayers |
A sequence of OspPointLayer elements |
A sequence of OspPolygonLayer elements, each of which specifies a layer name, CRS, vertical unit , definition of feature attribute names/types, and then a sequence of polygon features (geometry plus attribute values). The geometry is specified as ESRI well known text (WKT- see appendix) |
The Error Output tab lists the possible exceptions that can be thrown by this activity.
Exception | Thrown When ... |
OspException msg msgCode |
The GIS 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) |