B2B

AS2

Availability: FlowServices only

AS2 (Applicability Statement 2) is a communication protocol developed by the Internet Engineering Task Force (IETF) for the exchange of business-to-business (B2B) transactions over the Internet securely. The AS2 application uses the HTTP transport protocol along with Multipurpose Internet Mail Extensions (MIME). The AS2 application governs the means of connection and exchange of data securely and reliably. Besides the advanced security features, the AS2 application offers the following additional benefits:

The AS2 application provides a medium to exchange business data with partners by configuring an account in webMethods.io Integration. The application supports the AS2 protocol versions 1.1 and 1.2.

Field Description
Recipient Endpoint The endpoint URL of the recipient.
Authorization Type The type of HTTP authorization scheme to use for the connection. You can choose one of the following options:
  • none: No additional authorization scheme will be executed at run time. For example, when you specify a user name and password, but do not specify a value for the authorization type, the user credentials are not inserted into an authorization header.
  • basic: When the application requires or supports HTTP basic authentication for user name and password.
From The AS2 ID of the sender.
To The AS2 ID of the recipient.
Response Timeout The number of milliseconds the application waits for a response before canceling its attempt to connect to the back end. In case the network is slow or the back end processing takes longer than usual, increase the Response Timeout value. It is recommended to specify a value other than 0. If you specify 0, the application will wait indefinitely for a response.
Retry Count on Response Failure The number of times the application attempts to connect to the back end to read a response if the initial attempt fails. If an I/O error occurs, it will retry only if you have selected the Retry on Response Failure option.
Retry on Response Failure Whether the application should attempt to resend the request when the response has failed, even though the request was sent successfully. Select this option if you want to re-establish the connection.
Trust store Alias Select the alias name of the webMethods.io Integration trust store configuration from the list. The trust store contains trusted certificates used to determine trust for the remote server peer certificates. Select New Certificate > New Truststore to add a new trust store from this list.
Keystore Alias Select the alias for the webMethods.io Integration keystore configuration. This is a text identifier for the keystore alias. A keystore file contains the credentials (private key/signed certificate) that a client needs for authentication. Select New Certificate > New Keystore to add a new keystore from this list.
Client Key Alias Alias to the private key in the keystore file specified in the Keystore Alias field. The outbound connections use this key to send client credentials to a remote server. To send the client’s identity to a remote server, you must specify values in both, Keystore Alias and Client Key Alias fields.
Hostname verifier Select a hostname verifier implementation for guards against man-in-the-middle (MITM) attacks from the list. The default is org.apache.http.conn.ssl.DefaultHostnameVerifier. This enables hostname verification. Select org.apache.http.conn.ssl.NoopHostnameVerifier from the list to disable hostname verification.
Username The name of the user account that the AS2 connection will use to connect to the AS2 provider.
Password The password for the user name provided in the Username field.
Compression Select this option to compress an outbound AS2 message.
Sign Message Select this option to sign an outbound AS2 message.
Signing Algorithm The signing algorithm to use for an outbound AS2 message. The available options are:
  • MD5
  • SHA-1
  • SHA-256
  • SHA-384
  • SHA-512
Signing Keystore and Key Aliases The keystore aliases and the key aliases in the keystore to use for signing an outbound AS2 message.
Receive Signed Message Select this option to receive a signed inbound AS2 message. If you select this option and the incoming AS2 message is not signed, then an Insufficient message security error is encountered and shared with the sender if MDN is requested by the sender.
Signature Verification Certificate The certificate to use for verifying an inbound signed AS2 message.
Encrypt Message Select this option to encrypt an outbound AS2 message.
Encryption Algorithm The encryption algorithm to use for an outbound AS2 message. The available options are:
  • RC2 40
  • RC2 64
  • RC2 128
  • DES
  • TripleDES
  • AES 128
  • AES 192
  • AES 256
Encryption Certificate The certificate to use for encrypting an outbound AS2 message.
Receive Encrypted Message Select this option to receive an encrypted inbound AS2 message. If you select this option and the incoming AS2 message is not encrypted, then an Insufficient message security error is encountered and shared with the sender if MDN is requested by the sender.
Decryption Keystore and Key Aliases The keystore aliases the key aliases in the keystore to use for decrypting an inbound AS2 message.
Request MDN Whether you want the recipient to return an MDN to the sender.

You can select one of the following options:

  • None: The recipient of the AS2 message does not return an MDN to the sender.
  • Synchronous: The recipient of the AS2 message returns an MDN to the sender through the same HTTP connection used to send the original AS2 message.
  • Asynchronous: The recipient of the AS2 message returns an MDN to the sender through a different HTTP connection instead of the one used to send the original AS2 message.
Request Signed MDN Select this option if you want the recipient to sign an AS2 MDN.

Ensure that you also select an option in the Request MDN field if you want the recipient to sign and return an AS2 MDN.

Asynchronous MDN Endpoint Type your endpoint URL that accepts an inbound AS2 MDN if you selected the Asynchronous option for Request MDN.
AS2 Version Select the AS2 protocol version to use from the list.
Enable SNI Server Name Indication (SNI) is an extension to the TLS protocol by which a client indicates which host name it is attempting to connect to at the start of the handshaking process. Enable this option if the SaaS provider offers SNI-based TLS connectivity, and if you want to connect to an SNI enabled SAAS provider to send the host name specified in the Server URL field, as part of the TLS SNI Extension server_name parameter.
SNI Server Name If you want to explicitly specify a host name to be included as a part of the SNI extension server_name parameter, in case the host name is other than the host name specified in the Server URL field, specify the host name value in the SNI Server Name field.

AS2 Predefined Operations

The following predefined Applicability Statement 2 (AS2) operations are available:

receive

Receives an AS2 message from a recipient.

You can perform the following configurations in the AS2 application using the receive service.

Input Parameters

contentStream Object Receives an AS2 message of content type other than application/xml.
node Object Optional. Receives an AS2 message of content type application/xml only.

Output Parameters

status String Status of an inbound message.
statusMessage String Processing status of an inbound message.
request Document Receives the raw stream, extracted payload, and attachments of an inbound message.
stream Object Raw output stream received by an application.
headers Document AS2 message headers.
AS2-To String AS2 ID of the recipient.
AS2-From String AS2 ID of the sender.
Message-ID String Message ID of the inbound message.
AS2-Version String AS2 protocol version used for the inbound message.
Content-Type String MIME content type of the inbound message.
EDIINT-Features String Optional features supported by the application.
Receipt-Delivery-Option String Optional. Sender's asynchronous MDN endpoint URL.
Disposition-Notification-To String Optional. Acknowledgment request for the inbound message.
Disposition-Notification-Options String Optional. Acknowledgment request to be signed for the inbound message.
payload Document Extracted payload that you receive.
stream Object Extracted payload stream.
contentType String Content type assigned to the payload.
headers Document Headers assigned to the payload.
attachments Document Array Optional. Attachments you receive with an inbound message, if any.
stream Object Output stream of the attachment.
contentType String Content type assigned to the attachment.
headers Document Headers assigned to the attachment.
response Document Sent MDN or received asynchronous MDN response.
status String Status of the sent or received MDN.
statusMessage String Status message of the sent or received MDN.
receipt Document Optional. Sent or received MDN.
stream Object Object stream of the sent or received MDN.
headers Document Headers of the sent or received MDN.
AS2-To String AS2 ID of the recipient.
AS2-From String AS2 ID of the sender.
Message-ID String Message ID of the inbound or outbound MDN.
AS2-Version String AS2 protocol version used for the inbound or outbound MDN.
Content-Type String MIME content type of the inbound or outbound message.

send

Sends an AS2 message to a recipient’s defined endpoint.

Input Parameters

data Document Payload you want to send.
stream Object java.io.InputStream object you want map from EDI or XML data.
contentType String Content type to assign to an outbound message. The following options are available by default:
  • application/edi-x12

  • application/edifact
  • application/xml

You can also type a custom value.

otherHeaders Document Optional. key and value strings of the header for an outbound message.
attachments Document Array Optional. Attachments for a message, if any.
stream Object java.io.InputStream object you want add to the attachment.
contentType String Content type of the attachment. For example, application/zip if the attachment is a .zip file.
otherHeaders Document Optional. key and value strings of the header you want to add to the attachment.
customHeaders Document Optional. Custom headers you want to include in an AS2 message.
key String Key for the custom header.
value String Value for the customer header.

Output Parameters

status String Status of an outbound message.
statusMessage String Processing status of an outbound message.
request Document AS2 message sent to a recipient.
stream Object AS2 message stream.
headers Document Optional. AS2 message headers.
AS2-To String AS2 ID of the recipient.
AS2-From String AS2 ID of the sender.
Message-ID String Message ID of the outbound message.
AS2-Version String AS2 protocol version used for the outbound message.
Content-Type String MIME content type of the outbound message.
EDIINT-Features String Optional features supported by the application.
Receipt-Delivery-Option String Optional. Recipient's asynchronous MDN endpoint URL.
Disposition-Notification-To String Optional. Acknowledgment request for the outbound message.
Disposition-Notification-Options String Optional. Acknowledgment request to be signed for the outbound message.
response Document Received MDN response.
status String Status of the received MDN.
statusMessage String Status message of the received MDN.
receipt Document Optional. Received MDN.
stream Object Object stream of the received MDN.
headers Document Optional. Headers of the received MDN.
AS2-To String AS2 ID of the recipient.
AS2-From String AS2 ID of the sender.
Message-ID String Message ID of the inbound MDN.
AS2-Version String AS2 protocol version used for the inbound MDN.
Content-Type String MIME content type of the inbound message.

Configuring the Auto Detect Option

You can select the Auto Detect option for the AS2 application to automatically identify an account based on the AS2-From and AS2-To headers of an inbound message.

This option enables the AS2 application to compare an account configured with From and To fields with the AS2-From and AS2-To headers of an inbound message and vice versa. In addition, specifying this option allows the use of an individual endpoint URL with multiple partners.

Note: Auto Detect option is supported only for the receive operation.

Important: Configuring multiple accounts with identical values for the From and To fields might generate unpredictable results. This happens when the application uses the account that matches the first AS2-From and AS2-To headers of an inbound message. Therefore, if you have multiple accounts configured with identical values for the From and To fields, then do not select the Auto Detect option.

Creating an Endpoint URL

A sender requires a recipient’s endpoint URL to transfer AS2 messages. You must create an endpoint URL and share it with your partner to send AS2 messages to the endpoint URL.

To create an endpoint URL

  1. Create a FlowService. Ensure that you specify a signature with contentStream and node as input parameters of type Object. Alternatively, you can define a Document Type as a signature with contentStream and node as input parameters of type Object.

  2. Configure the AS2 application with the receive operation to work with a new or existing account, or select the Auto Detect option for the application.

  3. Map the contentStream and node parameters of the Pipeline Input signature defined in step 1 with the AS2 application’s receiveInput parameter.

  4. Select the Enable FlowService to be invoked over HTTP option on the FlowService Overview page. An endpoint URL for this FlowService is generated.

  5. Share this endpoint URL with your partner to enable the partner to send AS2 messages.

EDI

Availability: FlowServices only

Use the predefined operations in the Electronic Data Interchange (EDI) application to parse, validate, and transform EDI messages received from the webMethods.io B2B application. Use these transformed messages to create orchestrations.

This application requires you to have access to the webMethods.io B2B product instance.

The following predefined operations are available for EDI application:

Operation Description
addGroupEnvelope Adds a functional group header to an EDI message according to the UN/EDIFACT, ANSI X12, UCS, or VICS standards.
addInterchangeEnvelope Adds an interchange control header to an EDI message according to the UN/EDIFACT, ANSI X12, UCS, or VICS standards.
convertDocumentToEDIMessage Converts a document to an EDI message.
convertEDIMessageToDocument Converts an EDI message that is stream or string into a document.
createTradacomsMessage Creates a TRADACOMS message containing the STX header segment, payload, and the END segment.
formatConfiguration Validates and creates a format configuration based on the input provided for each format service.
formatDate Format the input value based on the provided input and output date format.
formatDecimal Formats exponential decimal values based on the operationType.
formatNumber Formats given numeric value by adjusting decimal character based on the operationType.
formatTime Formats the input value based on the provided input and output time format.
generateFunctionalAcknowledgement Creates a functional acknowledgment (FA) that acknowledges all levels of an input EDI document.
getDelimiter Returns the first delimiter character found in the input characterString.
getEDIString Creates a complete EDI transaction set (either String or InputStream type) from an EDI transaction set header segment.
getFirstKey Returns the name of the first key present in the input Document Doc.
nullifyIfBlank Returns null or blank based on the blankOrNull value when the input is null or contains only blank spaces.
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.

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

  testIndicator String (optional) Whether to indicate production or test mode.
    Value Meaning
    P Production. This is the default Value.
    T Test.
    I Information.
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.
  testIndicator String (optional) Indicates the testing parameters.
    Value Meaning
    1 Indicates that the interchange is a test.
    2 Indicates that test only the syntax of the structure.
    3 Returns the request without any change.
    4 Returns the response without any change except for this data element changing from 3 to 4.

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).
txnCtlNumber String The value of the control number to set in the outbound transaction.
formatConfiguration Document Array (Optional) Format configuration for each format service.
  Key Description
  formatName String Name of the format service.
  internalFormat String (Optional) The format required by your internal application (for example, your back-end system).

Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat.

  externalFormat String (Optional) The format required by the EDI standard you are using. If you are using the EDI ANSI standard format, you should not change the setting.

Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat.

  applyFormat String (Optional) Indicates whether the convertEDIMessageToDocument or convertDocumentToEDIMessage services should apply the converted value.
    true The service validates and updates the document to reflect the converted value.
    false The service validates, but does not update the document with the converted value.
 
Note: The input Document Array mapped to the formatConfiguration must be the output of EDI formatConfiguration operation.

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.
formatConfiguration Document Array (Optional) Format configuration for each format service.
  Key Description
  formatName String Name of the format service.
  internalFormat String (Optional) The format required by your internal application (for example, your back-end system).

Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat.

  externalFormat String (Optional) The format required by the EDI standard you are using. If you are using the EDI ANSI standard format, you should not change the setting.

Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat.

  applyFormat String (Optional) Indicates whether the convertEDIMessageToDocument or convertDocumentToEDIMessage services should apply the converted value.
    true The service validates and updates the document to reflect the converted value.
    false The service validates, but does not update the document with the converted value.
 
Note: The input Document Array mapped to the formatConfiguration must be the output of EDI formatConfiguration operation.

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.

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.

formatConfiguration

Validates and creates a format configuration based on the input provided for each format service.

A format service formats the value of a field and optionally validates the field against restrictions defined in the format service. EDI connector uses format services to convert field values into a different format as required by your system. For example, a format service can change the format of a date field from YYYYMMDD to MMDDYYYY or data from the EDI standard into a different format used by your internal application. Format services are associated with fields in EDI document type.

The following EDI operations use format services to convert the EDI field values as defined in the EDI document type:

  1. convertDocumentToEDIMessage - Converts a document which contains the internal document format to EDI standard message.
  2. convertEDIMessageToDocument - Converts an EDI standard message to document which contains the internal document format.

Note: If a field in EDI document type does not have a values, then the associated format service does not run.

To modify format conversion related configuration, use formatConfiguration operation.

By default, the external format configuration represents the EDI ANSI standard format. You must update the configuration, so that it reflects the EDI standard you are using and the formats of your internal application, for the system to accurately convert field values from one format to another.

Below are the default format configurations used by convertDocumentToEDIMessage and convertEDIMessageToDocument when formatConfiguration is not passed explicitly to the input.

Format Name Default internalFormat value Default externalFormat value Description
formatDate6 MM/dd/yy yyMMdd Converts the date format from MM/dd/yy to yyMMdd
formatDate8 MM/dd/yyyy yyyyMMdd Converts the date format from MM/dd/yyyy to yyyyMMdd
formatDecimal #.########## #.#####E0 Converts the input to a decimal value
formatTime4_4 HH:mm HHmm Converts the timestamps from HH:mm format to HHmm
formatTime4_6 HH:mm:ss HHmmss Converts the timestamps from HH:mm:ss format to HHmmss
formatTime4_8 HH:mm:ss.SS HHmmssSS Converts the timestamps from HH:mm:ss.SS format to HHmmssSS
formatTime6_6 HH:mm:ss HHmmss Converts the timestamps from HH:mm:ss format to HHmmss

Input Parameters

 
input Document Array Format configuration for each format service.
  Key Description
  formatName String Name of the format service.
  internalFormat String (Optional) The format required by your internal application (for example, your back-end system).

Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat.

  externalFormat String (Optional) The format required by the EDI standard you are using. If you are using the EDI ANSI standard format, you should not change the setting.

Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat.

  applyFormat String (Optional) Indicates whether the convertEDIMessageToDocument or convertDocumentToEDIMessage services should apply the converted value.
    true The service validates and updates the document to reflect the converted value.
    false The service validates, but does not update the document with the converted value.

Output Parameters

 
formatConfiguration Document Array (Optional) Format configuration for each format service.
  Key Description
  formatName String Name of the format service.
  internalFormat String (Optional)The format required by your internal application (for example, your back-end system).

Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat.

  externalFormat String (Optional) The format required by the EDI standard you are using. If you are using the EDI ANSI standard format, you should not change the setting.

Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat.

  applyFormat String (Optional) Indicates whether the convertEDIMessageToDocument or convertDocumentToEDIMessage services should apply the converted value.
    true The service validates and updates the document to reflect the converted value.
    false The service validates, but does not update the document with the converted value.
hasError String Indicates whether any error exists in the input.
  true Indicates an error in the input received that needs correction.
  false Indicates no error in the input received.
errorMessage String(Optional) The error message describing the formatting error.

formatDate

Formats the input value based on the specified input and output date format.

Input Parameters

 
value String The field value to format.
inputFormat String The date format that represents the input value. Follows the conventions described in the Java class java.text.SimpleDateFormat.
outputFormat String The date format that represents the output formattedvalue after conversion.

Follows the conventions described in the Java class java.text.SimpleDateFormat.

Output Parameters

 
formattedValue String The field value after applying outputFormat.
isValueError Boolean Indicates whether the value can be formatted or not.
  • True. The value cannot be formatted.
  • False. The value can be formatted.
errorMessage String (Optional) The error message describing the formatting error.

formatDecimal

Formats exponential decimal values based on the operationType.

Input Parameters

 
value String The field value to format.
operationType String Indicates the type of operation to apply to the input value. Select one of the below two operations:
  • writeValueToFormat. Formats any non-exponential numeric value to an exponential decimal format.
  • readAsFormattedValue. Formats any exponential decimal value into a non-exponential numeric value.
decimalChar String (Optional) The character that represents the decimal. The default decimal character is '.'.

Output Parameters

 
formattedValue String The field value with appropriate formatting applied.
isValueError Boolean Indicates whether the value can be formatted or not.
  • True. The value cannot be formatted.
  • False. The value can be formatted.
errorMessage String (Optional) The error message describing the formatting error.

formatNumber

Formats the given numeric value by adjusting the decimal character based on the operationType.

Input Parameters

 
value String The numeric value to format.
operationType String Indicates the type of operation to apply to the input value. Select one of the below two operations:
  • writeValueToFormat. Formats the value by placing a decimalChar after the decimalCount number of characters.
  • readAsFormattedValue. Formats the value by placing a decimalChar before the decimalCount number of characters.
decimalCount String Determines the number of decimals from the value that need to be formatted.
decimalChar String (Optional) The character that represents the decimal. The default decimal character is '.'.

Output Parameters

 
formattedValue String The field value with appropriate formatting applied.
isValueError Boolean Indicates whether the value can be formatted or not.
  • True. The value cannot be formatted.
  • False. The value can be formatted.
errorMessage String (Optional) The error message describing the formatting error.

formatTime

Formats the input value based on the specified input and output time format.

Input Parameters

 
value String The field value to be formatted.
inputFormat String The date format that represents the input value follows the conventions described in the Java class java.text.SimpleDateFormat.
outputFormat String The date format that represents the output formattedvalue after conversion follows the conventions described in the Java class java.text.SimpleDateFormat.
pad String Indicates whether to pad the value with zeros, when the value is shorter than the inputFormat. The default option is true.
  • True. Pad with zeros.
  • False. Do not pad with zeros.

Output Parameters

 
formattedValue String The field value after applying outputFormat.
isValueError Boolean Indicates whether the value can be formatted or not.
  • True. The value cannot be formatted.
  • False. The value can be formatted.
errorMessage String (Optional) The error message describing the formatting error.

generateFunctionalAcknowledgement

Creates a functional acknowledgment (FA) that acknowledges all levels of an input EDI document. This operation takes an EDI document as input, performs validation and compliance check, and creates an FA as output.

Input Parameters

 
ediMessage String (Optional) An unparsed EDI document for which you want to generate an FA. Specify a value for either ediMessage or ediDocument.
ediDocument Document (Optional) A parsed EDI document (an IData object) for which you want to generate an FA. This must include the error results. This is typically the output from the processEnvelope EDI operation. Specify a value for either ediMessage or ediDocument.
delimiters Document (Optional) Delimiters used in the outbound FA. If you do not specify delimiters, the operation uses the delimiters from the document it is acknowledging.
  Key Description
  segment String The segment terminator for the FA, for example, +. The default is the ' character.
  field String The field separator for each EDI segment for example, !. The default is the + character.
  subfield String The separator for composite elements, for example, ^. The default is the : character.
  release String Character used to ignore a record, field, or subfield delimiter in a field. If a release character occurs in a field or subfield before the delimiter, it will be prefixed with this character in the output.
functionalAckRequest String (Optional) Indicates the manner to handle potentially conflicting information in the EDI interchange header of the inbound document. For ANSI X12, the inbound document specification is in ISA14. For UN/EDIFACT, the inbound document specification is in UNB09. Specify one of the following:
  Value Meaning
  yes The FA is generated regardless of FA specification in the input EDI interchange header.
  no If no and the input EDI interchange header specifies that an FA is not required, the FA is not generated.
  dependOnInput The FA is generated based on the FA specification in the input EDI interchange header.
functionalAckLevel String (Optional) The level at which to acknowledge. If any errors occur at the level you select, the FA lists those errors at the level selected. Specify one of the following:
  Value Meaning
  default Acknowledge at the envelope level (group for ANSI X12 and interchange for UN/EDIFACT).
  transactionSet Acknowledge at the transaction set level (ANSI X12 only).
  segment Acknowledge at the segment level (ANSI X12 only).
  element Acknowledge at the element level (ANSI X12 only).
generateControlNumber String (Optional) Indicates how you want the operation to obtain the control number it uses in the interchange and group headers of the generated FA. Specify one of the following:
  Value Meaning
  fromInboundDocument Use the control number from the corresponding header in the EDI document that is being acknowledged. For example, if generating an FA for a group in an ANSI X12 document, use the control number from the group header of that group for the control number of the FA.
  random The operation randomly generates a control number.
addGroup String (Optional) Indicates whether you want to add group segments to the ANSI X12 or UN/EDIFACT FA (e.g., a 997 or a UN/EDIFACT CONTRL).
  Value Meaning
  true Add a group to the FA.
  false Do not add a group to the FA.
addInterchangeEnvelope String (Optional) Whether you want to add an interchange envelope to the FA.
  Value Meaning
  true Add an interchange to the FA. This is the default. For ANSI X12, if you add an envelope, you will automatically get the group.
  false Do not add an interchange to the FA.
syntaxErrorStatus String (Optional) Indicates how you want the operation to report the syntax error status for a transaction, group, or UN/EDIFACT interchange. The syntax error status indicates whether there are syntax errors, for example, missing mandatory elements, violation of syntax rules, invalid field lengths, code list violations, or segment repeat counts exceeded.
  The operation uses the syntax error status along with the logical error status and child transaction rejected status (if applicable) to determine the FA status for a transaction, group, or UN/EDIFACT interchange.
  Specify one of the following to indicate how you want the EDI operation to report syntax errors:
  Value Meaning
  rejected The syntax error status is reported as "rejected" if syntax errors are encountered. Specify rejected if you want to reject elements that have syntax errors.
  accepted, but errors were noted The syntax error status is reported as accepted, but errors were noted if syntax errors are encountered. Specify accepted, but errors were noted if you want to know whether there are syntax errors, but do not want to reject an element because of them.
  accepted The syntax error status is always reported as "accepted" regardless of any syntax errors that might be encountered. Specify accepted, but errors were noted if you do not want to check for syntax errors.
logicalErrorStatus String (Optional) Indicates how you want the operation to report the logical error status for a transaction, group, or UN/EDIFACT interchange. The logical error status indicates whether there are logical errors, for example:
  • The control number in a header does not match the control number in the corresponding trailer, or
  • The segment count in a trailer does not have an accurate group, transaction, or segment count.

The operation uses the logical error status along with the syntax error status and child transaction rejected status (if applicable) to determine the FA status for a transaction, group, or UN/EDIFACT interchange.

Specify one of the following to indicate how you want the operation to report logical errors:

  Value Meaning
  rejected The logical error status is reported as "rejected" if logical errors are encountered. Specify rejected if you want to reject elements that have logical errors.
  accepted, but errors were noted The logical error status is reported as accepted, but errors were noted if logical errors are encountered. Specify accepted, but errors were noted if you want to know whether there are logical errors, but do not want to reject an element because of them.
  accepted The logical error status is always reported as "accepted" regardless of any logical errors that might be encountered. Specify accepted if you do not want to check for logical errors.
childTransactionRejectedStatus String (Optional) Indicates how you want the operation to report the child transaction rejected status for a group or UN/EDIFACT interchange. The child transaction rejected status indicates whether child elements of a group or UN/EDIFACT interchange have an FA status of rejected. Specify one of the following:
  Value Meaning
  rejected Reports the child transaction rejected status as:
  • rejected if the FA status of any of the child transactions is rejected.
  • accepted, but errors were noted if the FA statuses of all child transactions are "accepted" and accepted, but errors were noted.
  • accepted if the FA statuses of all the child transactions are accepted.
  partially accepted Reports the child transaction rejected status as:
  • rejected if the FA statuses of all of the child transactions are rejected.
  • partially accepted if the FA status of at least one child transaction is rejected, but the FA status of other child transactions are accepted or accepted, but errors were noted.
  • accepted if the FA statuses of all the child transactions are accepted.
  accepted, but errors were noted Reports the child transaction rejected status as:
  • accepted, but errors were noted if the FA status any child transaction is rejected or accepted, but errors were noted.
  • accepted if the FA statuses of all the child transactions are accepted.
documentType String (Optional) The substandard of the EDI standard. Use this parameter in conjunction with ediDocuments. Valid values are EANCOM, UCS, UNEDIFACT, VICS, X12, and ODETTE.
encoding String (optional) The encoding of the data passed to the ediMessage parameter.
Note: When the generateFunctionalAcknowledgement operation is invoked manually, the value of this parameter is passed to the ediMessage parameter in both the convertToString and the convertToValue operations, as well as the generateFunctionalAcknowledgement operation.
additionalInfo Document (Optional; for use with ODETTE only) Additional information about the input message, to be used in the outbound FA.
  Value Meaning
  code String A qualification and identification of the purpose and function of a text segment. Maximum length: 3 characters.
  text String Text. Maximum length: 70 characters.
messageIdentifier Document (Optional) Specifies details to include in the CONTRL message.
  Value Meaning
  versionNumber String Specifies the following values in the output CONTRL message to determine the schema to use:
  • UNH02/S00902 (second subfield in the second field)
  • UNG07/S00801 (first subfield in the second field, if present)
  releaseNumber String Specifies the following values in the output CONTRL message to determine the schema to use:
  • UNH02/S00903
  • UNG07/S00802 (if present)
  controllingAgency String Specifies the following values in the output CONTRL message:
  • UNH02/S00904
  • UNG07/S00803 (if present)
  associationCode String Specifies the following values in the output CONTRL message:
  • UNH02/S00905
  • UNG07/S00804 (if present)
  codeListDirectoryVersionNumber String Specifies the following values in the output CONTRL message:
  • UNH02/S00906
  messageTypeSubFunctionIdentification String Specifies the following values in the output CONTRL message:
  • UNH02/S00907
 
  • If no value is provided for VersionNumber, ReleaseNumber, or ControllingAgency, these input fields takes the values from the input document.
  • versionNumber and releaseNumber determine the schema to use, as follows:
    • If you specify values for both fields, the schema used will be EDIFFSchema.%s_standard%.V%MessageIdentifier/VersionNumber%%MessageIdentifier/ ReleaseNumber%:TCONTRL.
    • If you specify only the value of versionNumber, the schema used will be EDIFFSchema.%s_standard%.V%MessageIdentifier/VersionNumber% :TCONTRL.
    • If you specify only the value of ReleaseNumber, the default schema is used, but the UNH02/S00903 field in the output CONTRL message is populated with the value of the releaseNumber field.
generateAnyway String (Optional) Specifies whether the generateFunctionalAcknowledgement operation should throw a com.wm.ff.parse.ParseException exception when a delimiter is missing at the envelope level of an EDIFACT message.
  Value Meaning
  true Generate a negative CONTRL message and do not throw an exception.
Note: If you set this parameter to true, you must also assign the values for the CONTRL message header fields in UNH02.
  false Throw the exception
com.wm.ff.parse.
ParseException. This is the default option.
UNH02_messageIdentifier Document (Optional) Values to assign to the CONTRL message header fields if generateAnyway is set to true.
  Key Description
  S00902_versionNumber String The version number of the CONTRL message. For example, to set the version number of the CONTRL message to "D," set the value of S00902_versionNumber to D.
  S00903_releaseNumber String The release number of the CONTRL message. For example, to set the release number of the CONTRL message to "96A," set the value of S00903_releaseNumber to 96A.
  S00904_controllingAgency String The controlling agency of the CONTRL message. For example, to set the version number of the CONTRL message to "UN," set the value of S00904_controllingAgency to UN.
  S00905_associationCode String (optional) The association assigned code, 1 to 6 characters in length, for the CONTRL message.

Output Parameters

 
functionalAcknowledgement String List The outbound FA.
Note: UN/EDIFACT and ODETTE CONTRLs both use the version 4 UN/EDIFACT CONTRL error codes.
summaryDocument Document List Summary of information about the interchanges, groups, and transactions from the input EDI document.

getDelimiter

Returns the first delimiter character found in the input characterString.

Input Parameters

 
characterString String Input string from which the first delimiter is identified. Input string can represent any of the following values:
  • A character (for example, Normal characters - '!' or Any special characters - '\r\n').
  • Hexadecimal value (for example, 0X09).
  • Octal value (for example, 009).
  • Unicode characters (for example, \uXXXX, where XXXX represents the unicode value of the character).

Output Parameters

 
charOut String The delimiter character found in the input characterString. Returns null when the input characterString is invalid.

getEDIString

Creates a complete EDI transaction set (either String or InputStream type) from an EDI transaction set header segment.

Input Parameters

 
Values Document The single EDI transaction set within a single interchange and a single functional group. This input object is part of the output of the processEnvelope operation.

Output Parameters

 
EDIstring Object A single EDI transaction set in String or InputStream type.

getFirstKey

Returns the name of the first key present in the input document Doc.

Input Parameters

 
Doc Document Input document from which the name of the first key is determined.

Output Parameters

 
firstKey String Name of the first key found in the Doc.

nullifyIfBlank

Returns null or blank based on the blankOrNull value when the input is null or contains only blank spaces.

Input Parameters

 
input String Input data.
blankOrNull String (Optional) Indicates whether to return blank or null if the input string is null or contains only blank spaces. The default value is null.
  Value Meaning
  blank Returns blank if the input is null or contains only blank spaces.
  null Returns null if the input is null or contains only blank spaces.

Output Parameters

 
output String Same data as input or null or blank based on the blankOrNull value.

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.

webMethods.io B2B

Availability: FlowServices only

The webMethods.io B2B application allows you to:

The following predefined operations are available for webMethods.io B2B application:

Operation Description
addTransactionContentPart Adds a new content part to a document.
changeUserStatus Changes the user status of a specified transaction.
constructSubmitInput Prepare the necessary input used for submitting the business documents to webMethods.io B2B product instance.
generateResponse Generates a response for the processing rule Call an integration action.
getAddresses Retrieves all addresses of a partner.
getContacts Retrieves all contacts of a partner.
getControlnumber Retrieves the control number from webMethods.io B2B to be used in outbound group, envelope, and transaction documents.
getCorporation Retrieves the corporation information of a partner.
getExtendedFields Retrieves a set of extended fields for a partner.
getFAReport Retrieves a list of transactions with reconciled functional acknowledgments, and generates a report.
getPartnerID Retrieves the partnerID for the partner.
getPartnerIdentities Retrieves all external IDs of a partner.
getRelatedTransactions Retrieves the related transactions based on a specific transactionID, with or without details from either the live or archive database.
getTaskInfo Retrieves the information related to the task.
getTransactionByDocumentID Retrieves the transactions based on a specific documentID in the given duration from either the live or the archive database.
getTPA Retrieves Trading Partner Agreement (TPA) information from webMethods.io B2B.
getTransactionContentParts Retrieves the necessary content parts of a transaction.
getTransactionSenderReceiver Retrieves the sender and receiver information for the specified document from the database.
log Adds an entry into the activity log.
parseContent Parses request content passed by the processing rule Call an integration action as bytes or String data type.
queryMorePartners Loops over the data cached from the queryPartners operation and returns the batchSize of data.
queryPartners Creates a query for partner profiles and returns the first batch of matching results.
queryTaskIDs Retrieves the task ids that satisfy a given criteria.
queryTransactions Retrieves the transactions that match the specified criteria.
relateTransactions Creates a relationship between two transactions.
resetQueryPartners Resets the queryLocator making it available for the next concurrent execution
restartTask Restarts a failed or stopped task.
reprocess Reprocess a document on webMethods.io B2B.
resubmit Resubmit a document to webMethods.io B2B
submit Submits the business documents to webMethods.io B2B product instance.
updateAttribute Updates the attribute for the chosen transaction.

addTransactionContentPart

Adds a new content part to a document.

Input Parameters

Output Parameters

changeUserStatus

Changes the user status of a specified transaction.

Input Parameters

Output Parameters

constructSubmitInput

Prepare the necessary input used for submitting the business documents to webMethods.io B2B product instance.

Input Parameters

Configuring an AS4 body

Document. To configure an AS4 body document. This is optional.

Configuring an AS4 attachments [ ]

Document List. To configure AS4 attachments. This is optional.

Configuring an AS4 params

Document. A document that provides parameters on how webMethods.io B2B recognizes and processes a AS4 document.
Configure AS4 params.

Configuring an RNIF body

Document. To configure an RNIF body document.

Configuring an RNIF attachments [ ]

Document List. To Configure a list of attachments to be use in RNIF message. This is optional.

Configuring an RNIF params

Document. A document that provides parameters on how webMethods.io B2B recognizes and processes a RNIF document. Configure RNIF params.

Output Parameters

Output of constructSubmitInput operation is the input parameters for submit operation. Refer Submit. for details.

generateResponse

Generates a response for the processing rule Call an integration action.

Input Parameters

Output Parameters

getAddresses

Retrieves all addresses of a partner.

Input Parameters

partnerID: String The internal identifier of the partner for which you want to retrieve the addresses.

Output Parameters

getContacts

Retrieves all contacts of a partner.

Input Parameters

partnerID: String The internal identifier of the partner for which you want to retrieve the contacts.

Output Parameters

getControlnumber

Retrieves the control number from webMethods.io B2B to be used in outbound group, envelope, and transaction documents. This control number can be used as an input for the operations in the EDI application.

Input Parameters

Output Parameters

controlNumber: String (optional) Control number returned from webMethods.io B2B for the outbound group, envelope, or transaction.

getCorporation

Retrieves the corporation information of a partner.

Input Parameters

partnerID: String The internal identifier of the partner for which you want to retrieve the corporate information.

Output Parameters

getExtendedFields

Retrieves a set of extended fields for a partner.

Extended fields are custom fields that you can define to maintain additional information about you partners. For example, you might want to define extended fields for preferred shipping method, cost centers, or customer codes.

Input Parameters

Output Parameters

getFAReport

Retrieves a list of transactions with reconciled functional acknowledgments, and generates a report. When generateReport input is set to true, the report is generated, but the list of transactions do not appear in the output.
You must continue to run the operation until the isIterate (output parameter) variable value is false. While iterating, iteratorCount must be 1 for the initial iteration and should be incremented by 1 for each of the subsequent iterations.

This operation fetches the transactions from the live dataSource only.

Input Parameters

Output Parameters

getPartnerID

Retrieves the partnerID for the partner.

Input Parameters

Output Parameters

partnerID: String. The internal identifier for a partner.

getPartnerIdentities

Retrieves all external IDs of a partner.

Input Parameters

partnerID: String. The internal identifier of the partner for which you want to retrieve the identities.

Output Parameters

getRelatedTransactions

Retrieves the related transactions based on a specific transactionID, with or without details from either the live or archive database.

Input Parameters

Output Parameters

getTaskInfo

Retrieves the information related to the task.

Input Parameters

Output Parameters

getTransactionByDocumentID

Retrieves the transactions based on a specific documentID in the given duration from either the live or the archive database.

Input Parameters

Output Parameters

getTPA

Retrieves Trading Partner Agreement (TPA) information from webMethods.io B2B.

Input Parameters

Output Parameters

getTransactionContentParts

Retrieves the necessary content parts of a transaction.
A content part can be a segment of a document or an attachment retrieved during the processing of submitted content.

Input Parameters

Output Parameters

getTransactionSenderReceiver

Retrieves the sender and receiver information for the specified document from the database.

Input Parameters

Output Parameters

log

Adds an entry into the activity log.

Input Parameters

Output Parameters

parseContent

Parses request content passed by the processing rule Call an integration action as bytes or String data type. For more information on Call an integration, see webMethods B2B Cloud Help

Input Parameters

Output Parameters

queryMorePartners

Loops over the data cached from the queryPartners operation and returns the batchSize of data.

Input Parameters

Output Parameters

queryPartners

Creates a query for partner profiles and returns the first batch of matching results.

Note: A user can execute 15 queries concurrently.

Input Parameters

If the field is left blank, then webMethods.io B2B returns all the above fields including the isEnterprise and partnerID fields. For details on these values, see getCorporation
By default, the query results contain isEnterprise and partnerID fields.

Output Parameters

queryTaskIDs

Retrieves the task ids that satisfy a criteria. The number of task ids retrievable from this service is limited to 1000.

Input Parameters

Output Parameters

queryTransactions

Retrieves the transactions that match the specified criteria.

Input Parameters

Output Parameters

relateTransactions

Creates one-way relationship between two transactions.

Note: To relate the transactions using relateTransactions, the transactions should be persisted in the live datasource.

Input Parameters

Output Parameters

Note: You can retrieve the related transactions by using getRelatedTransactions operation by specifying either the fromTransactionIDOr the toTransactionID as an input.

resetQueryPartners

Resets the queryLocator making it available for the next concurrent execution.

Note: The queryLocator reset involves clearing the cached results. If you do not reset a queryLocator, it remains active for 15 minutes. After which, webMethods.io B2B automatically resets it.

Input Parameters

Output Parameters

restartTask

Restarts a failed or stopped task.

Input Parameters

Output Parameters

reprocess

Reprocess the existing transactions of webMethods.io B2B based on the transaction IDs. This operation reprocesses the transactions asynchronously.

Input Parameters

Output Parameters

resubmit

Resubmits the existing transactions of webMethods.io B2B as new documents based on the transaction IDs. This operation resubmits the transactions asynchronously.

Input Parameters

Output Parameters

submit

Submits the business documents to webMethods.io B2B product instance.

webMethods.io B2B recognizes the type of document and processes it. Every document that you submit through this service is created as a new transaction in webMethods.io B2B.

Input Parameters

Note: This field is case-sensitive. Additionally, if you provide a type other than the one mentioned above, webMethods.io B2B identifies the document as unknown.

Output Parameters

updateAttribute

Updates the attribute for the chosen transaction.

Input Parameters

Output Parameters