DispatchProEventPreParser – Dispatch event (Preprocessing)

See also: DispatchProEventPostExecuter – Dispatch event (Phase 5), DispatchProEventResponse – Dispatch event (Responder)

When executing a profile, the received data can be transferred directly to Lobster Data Platform / Orchestration via the pre-processing (extension) event. There, the data can be further manipulated or completely different data can be returned to the responders.
The event is executed in the context of a user, which must be specified in the configuration.

If the input data refers to an existing entity, it is loaded and transferred to event handling as input data. Otherwise, the data is store in Variable data.

Data that is transferred to the mapping or the responders must be stored in Variable result.

Result types are handled as follows:

  • String – Forwards this in text format

  • 'Content' (Content) – Forwards this in binary format

  • Other – Serialisation as XML or JSON is attempted. The format depends on the Integration Unit or the targetFormat parameter (see configuration).

In the 'Configuration file' field, both the path to a file and the configuration can be specified directly in 'Name=Value' pairs, separated by semicolons (Name1=Value1;Name2=Value2).
The following configuration parameters are supported:

Parameter name

Optional?

Description

eventName

no (required)

The name of the Custom action events to be triggered.

userName

no (required)

The name of the Lobster_pro user in whose context the event is processed.

selectedRole

If exactly one role is assigned to the user.

'ID' (id) of one of the Roles assigned to the use by property 'Roles' (roles).

selectedCompany

If exactly one company is assigned to the user.

'ID' (id) of one of the Companies/Clients assigned to the use by property 'Companies' (companies).

locale

yes (optional)

The Locale code of a Locale (e.g. de_DE).
Default: Locale assigned for user by property 'Locale' (locale).

useRaw

yes (optional)

true or false (default):

  • If true, the data is passed directly to Event handling in raw form (binary, as a 'Content' (Content) object.
    ►NOTE◄ A 'Content' (Content) object can also be read directly as a string by resolvers and actions (e.g. Set value for a string variable).

  • If false, an attempt is made to read the data as text and to read it as an object. JSON and XML are supported.

charSet

yes (optional)

The Character encoding of the Integration unit and the output format.

  • If useRaw=true, the Character encoding for input data is ignored.

  • If a 'Content' (Content) object is returned by Event handling, the encoding for the output data is ignored.

targetFormat

yes (optional)

XML or JSON

Specifies the format for writing output data that is not of type String or 'Content' (Content).