Set Document State (com.ibi.agents.XDDocAgent)

Syntax:

com.ibi.agents.XDDocAgent

iIT Service Object:

Description:

Sets or resets the current state of the document. This includes error states, encoding and current format.

Parameters:

Parameter

Description:

Error

Sets whether the document is in error state. Documents in error state are sent to the errorTo addresses. The error state can be tested by the iFL function iserr().

  • Leave . Do not change the error state.
  • Set. Set ON the error state.
  • Reset. Set OFF the error state.

Schema Error

If the document has passed through a schema check, this state reflects whether an error was reported.

  • Leave. Do not change the error state.
  • Set. Set ON the error state.
  • Reset. Set OFF the error state.

Encoding

Sets the current encoding. Select from the list or enter the correct IANA code. The encoding is used when the document is flattened or serialized for output. This does not affect the encoding in which the document is actually carried in the document.

Output Form

Messages are carried in document in a form appropriate to their processing. Usually this is an XML tree. Use this option to change the form to either a binary byte array produced according to the encoding set, or a Unicode string. These formats are often called Flat in iSM documentation. Subsequent use of the document must expect that the message contained in the document arrives in the specified format

iFL

Applies only if output form is String. If present, this iFL expression is applied to the flattened string.

Edges:

The following table lists the available line edges for the Set Document State (com.ibi.agents.XDDocAgent).

Line Edge

Description

OnError

Error

OnSuccess

Success

OnFailure

Failure

OnCustom

  • OnError
  • OnSuccess
  • OnFailure
  • fail_parse
  • fail_cancelled
  • fail_encoding