Software AG Products 10.7 | Integrating On-Premises and Cloud Applications | Integration Cloud | Applications | Predefined Applications | Electronic Data Interchange | Predefined Operations
 
Predefined Operations
The following predefined operations are available for EDI application:
addGroupEnvelope
Adds a functional group header to an EDI message according to the UN/EDIFACT, ANSI X12, UCS, or VICS standards.
Input Parameters
ediMessages
String EDI messages to which a group envelope is added.
documentType
Either X12/UCS/VICS or UN/EDIFACT.
functionalIDcode
String Functional ID Code of the EDI document.
senderQual
String EDI ID qualifier for the sender ID. It is used with sender.
sender
String Identifies sender in the group envelope. For example, if you specify 01 for senderQual (indicating a D-U-N-S number), specify the D-U-N-S number for sender.
receiverQual
String EDI ID qualifier for the receiver ID. It is used with receiver .
receiver
String Receiver to be identified in the group envelope. For example, if you specify 01 for receiverQual (indicating a D-U-N-S number), specify the D-U-N-S number for receiver .
grpCtlNumber
String Group control number of the EDI document.
agencyCode
String Responsible agency code as per EDI standard: T (default) or X.
verCode
String EDI standard version and release code. For example, 4010, 3040.
UN/EDIFACT
Document When the document type is UN/EDIFACT, assign values to the following parameters:
Key
Description
syntaxVersion
String Syntax version of the envelope level.
releaseCode
String EDI message standard release code. For example, 96A, 97b.
assignedCode
String EDI message standard assigned code. For example, OD, EN.
password
String The recipient transmission reference password.
delimiters
Document Delimiters used in the EDI document:
Key
Description
segment
String Segment terminator for the EDI document. For example, \u000a.
Default New line character
field
String Field separator for each EDI segment. For example, exclamation mark (!).
Default *
subfield
String Separator for composite elements. For example, caret (^).
Default :
release
String Release character for composite elements. For example, caret (^).
Default ?
Output Parameters
ediMessage
String Contains the ediMessage.
statusCode
String Status code based on success or failure.
statusMessage
String Status message after executing the operation.
addInterchangeEnvelope
Adds an interchange control header to an EDI message according to the UN/EDIFACT, ANSI X12, UCS, or VICS standards.
Input Parameters
ediMessages
String EDI messages to which a group envelope is added.
documentType
Either X12/UCS/VICS or UN/EDIFACT.
senderQual
String EDI ID qualifier for the sender ID. It is used with sender.
sender
String The sender to be identified in the group envelope. For example, if you specify 01 for senderQual (indicating a D-U-N-S number), specify the D-U-N-S number for sender.
receiverQual
String EDI ID qualifier for the receiver ID. It is used with receiver.
receiver
String The receiver to be identified in the group envelope. For example, if you specify 01 for receiverQual (indicating a D-U-N-S number), specify the D-U-N-S number for receiver.
ctlNumber
String The interchange control number of the EDI document.
ackRequested
String Indicates whether to request an acknowledgment for this interchange:
Value
Meaning
false
Do not request an acknowledgment.
Default False
true
Requests an acknowledgment.
delimiters
Document Delimiters used in the EDI document.
Key
Description
segment
String Segment terminator for the EDI document. For example, \u000a.
Default \
field
String Field separator for each EDI segment. For example, exclamation mark (!).
Default *
subfield
String Separator for composite elements. For example, caret (^).
Default :
release
String Release character for composite elements. For example, caret (^).
Default ?
decimal
String Decimal character for composite elements. For example, caret (^). If UN/EDIFACT > unaSegmentRequired is true, the decimal delimiter is used.
Default .
If UN/EDIFACT > unaSegmentRequired is false, decimal is ignored.
X12/UCS/VICS
Document When the document type is X12/UCS/VICS, assign values to the following parameters:
Key
Description
authQual
String Authorization qualifier for the interchange envelope.
authInfo
String Authorization information for the interchange envelope.
securityQual
String Security qualifier for the interchange envelope.
securityInfo
String Security information for the interchange envelope.
ctlVersion
String Version of the EDI standard used, with a 00 prefix. For example, if version is 4010, specify 004010.
addLeadingZerosToCtlNumber
String (ANSI X12 only) Adds leading zeros to the interchange control number to make it a nine-digit number.
Value
Meaning
false
Do not add leading zeros to the interchange control number.
Default false
true
Add leading zeros to the interchange control number to make it a nine digit number. For example, 12 becomes 000000012.
repSeparator
String A separator for the repeated occurrences of a simple data element or a composite data structure. Field length: 1
Note:
The repSeparator must be different from the record, field, or subfield delimiters.
messageAlignment
String Aligns the messages.
Value
Description
left
Left justify.
right
Right justify.
none
No justification.
Default
UN/EDIFACT
Document When the document type is UN/EDIFACT, assign values to the following parameters:
Key
Description
syntaxID
String Syntax identifier.
syntaxVersion
String Syntax version of the envelope level.
password
String Recipient transmission reference password.
passwordQual
String Recipient reference password qualifier.
applReference
String Application reference.
priority
String Processing priority code.
agreementID
String Interchange agreement identifier.
unaSegmentRequired
String Adds a UNA segment to the resulting final message.
Value
Description
true
Create UNA segment.
false
Do not create UNA segment.
directoryVersionNumber
String Type the directory version number in the UNB01/S00103 subfield of the EDIFACT envelope interchange header.
characterEncoding
String Type the character encoding in the UNB01/S00104 subfield of the EDIFACT envelope interchange header.
syntaxReleaseNumber
String Type the syntax release number in the UNB01/S00105 subfield of the EDIFACT envelope interchange header.
senderInternalId
String Type the sender's internal ID in the UNB02/S00203 subfield of the EDIFACT envelope interchange header.
senderInternalSubId
String Type the sender's internal sub ID in the UNB02/S00204 subfield of the EDIFACT envelope interchange header.
receiverInternalId
String Type the receiver's internal ID in the UNB03/S00203 subfield of the EDIFACT envelope interchange header.
receiverInternalSubId
String Type the receiver's internal sub ID in the UNB03/S00204 subfield of the EDIFACT envelope interchange header.
Output Parameters
ediMessage
String Contains the ediMessage.
statusCode
String Status code based on success or failure.
statusMessage
String Status message after executing the operation.
convertDocumentToEDIMessage
Converts a document to an EDI message. When creating an orchestration with ConvertDocumentToEDIMessage, you must select the appropriate document type. This is for the structure of an ediDocument to appear in the pipeline data when you map with another ediDocument during orchestration.
Input Parameters
ediDocument
Document The ediDocument you want to convert to an EDI message.
documentType
Either Default or TRADACOMS.
encoding
String The type of encoding used to write a message to the output file.
Default UTF-8
delimiters
Document Delimiters used in the outbound EDI document.
Note:
This parameter is not applicable to TRADACOMS messages.
Key
Description
segment
String Segment terminator character to be appended at the end of each record in the output string.
field
String Field separator to be inserted between each field for each segment.
subfield
String Separator for composite elements.
release
String Release character to use as the escape character for composite elements.
messageAlignment
String Aligns the messages.
Value
Description
left
Left justify.
right
Right justify.
none
No justification.
Default
noEmptyTrailingFields
String Indicates whether to remove empty trailing fields from the output.
Value
Description
true
Removes empty trailing fields from the output. For example, AAA*01*02! (where ! is the segment terminator).
false
This does not remove empty trailing fields. Instead it uses the field separator to denote an empty field. For example, AAA*01*02********!(where * is the field separator and ! is the segment terminator).
Output Parameters
ediMessage
String Contains the EDI message.
errors[]
String List Error messages describing the errors encountered during conversion. If there are no errors, then error[] is null.
segmentCount
String The number of segments in the ediMessage.
statusCode
String Status code based on success or failure.
statusMessage
String Status message after executing the operation.
convertEDIMessageToDocument
Converts an EDI message that is stream or string into a document. When creating an orchestration with ConvertEDIMessageToDocument, you must select the appropriate document type. This is for the structure of an ediDocument to appear in the pipeline data when you map with another ediDocument during orchestration.
Input Parameters
ediMessage
String The ediMessage you want to convert to a document.
edistream
InputStream The ediMessage stream you want to convert to a document.
documentType
Either Default or TRADACOMS
encoding
String The encoding of the message passed into an ediMessage or edistream.
delimiters
Document Delimiters to parse the input message. If no delimiters are specified, then the parameter uses the default delimiter defined for the flat file schema.
Note:
This parameter is not applicable to TRADACOMS messages.
Key
Description
segment
String Segment terminator used in the input message.
field
String Field separator used in the input message.
subfield
String Subfield separator used in the input message.
release
String Release character used in the input message.
validate
String Validates the ediMessage.
Value
Description
true
Return errors describing how the given ediMessage violates the constraints described in the flat file schema.
false
Do not return error messages describing how the ediMessage differs from the specified flat file schema. This is the default value.
processOnlyTopLevelRecord
String Processes the segments one at a time or process all input data at one time. Specify true or false.
Value
Meaning
true
Starts processing segment structures with a top-level record as defined by the flat file schema. The parameter returns to the caller when it encounters another top-level record in the input data.
false
Processes all input data at one time. This is the default value.
ignoreSpaces
String Ignores white space from the beginning of the segments. Specify true or false.
Value
Meaning
true
Ignore white spaces. This is the default value.
false
Use the segments as they are. Specify false when the data contains positional data records.
repeatingFieldSeparator
String Inserts field separator between repeating fields of an EDI document.
Note:
This parameter is not applicable to TRADACOMS messages.
Output Parameters
ediDocument
Document The Document representation of the input ediMessage.
isValid
String Checks the validity of ediMessage.
Value
Description
true
validate input parameter was set to true and no errors were found.
false
validate input parameter was set to true and errors were found.
errors[]
Document List The validation errors, if any, that were found in edimessage.Validation errors are returned in errors only if validate is set to true and returnErrors is set to asArray or both. The list includes the path of the errors.
statusCode
String Status code based on success or failure.
statusMessage
String Status message after executing the operation.
processEnvelope
Accepts and processes the envelope of an ANSI X12/UN/EDIFACT/UCS/VICS/EANCOM EDI or TRADACOMS message and converts the envelope header segments to a document. When creating an orchestration with processEnvelope, you must select the appropriate document type. This is for the structure of an ediDocument to appear in the pipeline data when you map with another ediDocument during orchestration.
Input Parameters
ediMessage
String Processes the input EDI message. Input must not have manual line breaks.
validate
String Whether to validate the envelopes against a predefined flat file schema.
Value
Description
true
Validate the envelopes against a predefined flat file schema.
false
Does not validate the envelope.
complianceCheck
String Performs a compliance check against the interchange.
Note:
This parameter is not applicable to TRADACOMS messages.
Value
Description
true
Perform a compliance check. The parameter stops executing after encountering the first error. This is the default value.
false
Does not perform the compliance check.
Output Parameters
ediEnvelopeDocument
Document Resulting EDI envelope document.
standard
String The standard to which the EDI document adheres. For example, X12 or UNEDIFACT.
hasError
String Whether the validation or compliance check resulted in error.
Value
Description
false
If the validate is true, validation errors are retrieved from errorArray.Otherwise, it indicates errors from the compliance check.
true
No errors.
errors[]
Document List Validation errors, if any, that were found in edimessage.Validation errors are returned in errors only if validate is set to true -AND- returnErrors is set to asArray or both. The list includes the path of the errors.
statusCode
String Status code based on success or failure.
statusMessage
String Status message after executing the operation.
createTradacomsMessage
Creates a TRADACOMS message containing the STX header segment, payload, and the END segment. When the validate parameter is set to true, EDI application validates the content of the message.
Input Parameters
STX
Document The document representation of TRADACOMS STX segment.
includeRSGRSG
String Whether the service creates an RSGRSG (reconciliation) message in the output message.
Value
Description
true
Creates an RSGRSG message in the output message. This is the default value.
false
Does not create an RSGRSG message.
encoding
String Optional. The encoding format to use in the message.
tradacomsMessages
String The TRADACOMS payload.
END
Document The document representation of TRADACOMS END segment.
validate
String Validates the tradacomsMessages.
Value
Description
true
Returns errors describing how the given tradacomsMessages violates the constraints described in the flat file schema.
false
Does not return error messages describing how the tradacomsMessages differs from the specified flat file schema. This is the default value.
Output Parameters
ediMessage
String Contains the EDI message.
errors[]
String List Validation errors, if any, that are found in tradacomsMessages. Validation errors are returned only if validate is set to true.
isValid
String Checks the validity of tradacomsMessages.
Value
Description
true
If the validate is set to true and no errors are found.
false
If the validate is set to true and there are errors.
statusCode
String Status code based on success or failure.
statusMessage
String Status message after performing the operation.