Configuring a Marshall Service

Reference:

To configure a Marshall service:

  1. Perform the steps as described in Configuring Services.
  2. Ensure that you select Marshall Agent {com.ibi.agents.XDMarshallAgent} as the service type you are configuring.

    For a complete description of the configuration parameters that are available for the Marshall service, see Marshall Service Parameters.

    For a complete description of the edges that are returned by the Marshall service, see Marshall Service Edges.


Top of page

x
Reference: Marshall Service Parameters

The following table lists and describes parameters for the Marshall service.

Parameter

Description

Compress Messages *

Supports optional compression

Marshall User Special Registers

Set to true if the marshalling is to include user registers. Normally the marshaller passes header, document, and system registers associated with the message. This parameter is set to false by default.

Namespace

If empty or an asterisk character (*) is entered, then all namespaces are marshalled. If a namespace is entered, then only registers in the specified namespace are marshalled.

Security

Use Encryption *

Set to true if the marshalled messages should be encrypted after compression. The AES Key parameter must also be configured if this parameter is set.

AES Key

Must be the same value on both sides. Maximum length is 16 characters, but can include escapes to allow the use of binary values. For more information, see the _aes() iFL function in the iWay Functional Language Reference Guide.

This key can be generated by an iFL statement, such as storing the key in a special register accessed at runtime. Once set, the key can not be altered. Use of AES encryption can be slow, and should only be used when the marshalled message can appear in a publicly accessible area.



x
Reference: Marshall Service Edges

The following table lists and describes the edges that are returned by the Marshall service.

Edge

Description

success

The outgoing document carries a marshalled message and context.

fail_compress

The outgoing message or context could not be compressed.

fail_encrypt

The outgoing message or context could not be encrypted.


iWay Software