webMethods B2B

Creates the recipient partner profile and channel in webMethods B2B Integration with the details that are retrieved from the retrievePeppolParticipantDetails operation.

The following list explains a few details about the Peppol:

• The partner name is the CNAME of the certificate. CNAME refers to the subject common name (CN) in the Peppol Access Point public certificate that is issued to the recipient Access Point by the Peppol organization. It is located in the certificate's Details tab under Subject > CN.
• The formats for the externalID value are CNAME(participantID) and participantID. The participant ID format is identifierScheme:identifierValue. These values are configured for ID type IDType urn:FDC:peppol.eu:2017:identifiers:ap in the corresponding partner profile. webMethods B2B Integration supports a maximum of 128 characters for the externalID. This includes 9 characters for CNAME, 4 characters for scheme, 3 miscellaneous characters (open brace, close brace, and colon), and 112 characters for participant ID.

  For example, ABC000012(9944:abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzab​cdefghijklmnopqrstuvwxyz12345678) and 9944:abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmn​opqrstuvwxyz12345678.

  If the external ID exceeds 128 characters, webMethods B2B Integration truncates it to 128 characters, which may cause the transaction to fail. You can view the full value in the description.

• The certificate is configured for encryption and signing in the corresponding profile. If the partner exists in webMethods B2B Integration, the certificate is updated in the corresponding partner profile.
• An outbound AS4 channel is created. If an outbound AS4 channel already exists in webMethods B2B Integration and the endpointURL input parameter changes, the new endpoint URL is updated in the corresponding channel. The format for the channel name is DeliverToPeppolPartner_CNAME(identifier). webMethods B2B Integration supports a maximum of 128 characters for the name of the channel. This includes 23 characters of DeliverToPeppolPartner_, 9 characters for CNAME, 4 characters for scheme, 3 miscellaneous characters (open brace, close brace, and colon), and 89 characters for participant ID.

  If the channel name exceeds 128 characters, webMethods B2B Integration truncates it to 128 characters. You can view the full name in the description.

The caCertificateChain input field is optional. Peppol issues the matching root and intermediate certificates, which are used by default. The certificate varies based on the production or test environment.

Input parameters

participantID-String

Peppol participant identifier. For example, 9915:test.

certificate-Object

A byte array that represents the signing X509 certificate (a java.security.cert.X509Certificate) of the recipient access point.

caCertificateChain-Object

A byte array that represents the X509 certificate (a java.security.cert.X509Certificate) of the issuer of the certificate.

forceUpdateCertificate-String

Indicates whether to update the certificate in webMethods B2B Integration partner profile. The default value is true.

endpointUrl-String

Endpoint URL of the recipient.

Output parameters

toPartyId-String

PartyId of the recipient partner.

partnerId-String

InternalID of the recipient webMethods B2B Integration partner profile.

errors-String

Specifies an error message while processing a document.

Adds a new content part to a document.

Input parameters

transactionID

String. The transaction ID of the document to which you want to add a new content part.

partName

String. The name of the content parts.

readContentAs

String. Data forms in which content field value is passed.

bytes

The value is bytes.

string

The value is a string.

stream

The value is stream. If the payload is more than 5 MB, you must use readContentAs as a stream.

content

Object. The content of the part you want to add to the document.

mimeType

String. The MIME type of the content part. You can set the character type encoding with MIME type. The default character set is UTF-8. The mimeType and content are not validated to be compatible with each other.

Output parameters

isUpdated

Boolean. The parameter indicates whether the content is added or not.

partIndex

Integer. The position of the content part that is added. The maximum partIndex value allowed is 1000.

operationWarnings

Document List. Details of the warning.

message

String. Specifies the warning message.

key

String. Specifies a predefined warning key.

Changes the user status of a specified transaction.

Input parameters

transactionID

String. Transaction ID of the document in exchange.

userStatus

String. The user status for a transaction. For example, New, Open or Fixed. The character length limit is 255.

Output parameters

isUpdated

String. The parameter indicates whether the operation changed the user status of a transaction.

true

The operation changed the user status of the transaction.

false

The operation has not changed the status of the transaction.

Prepare the necessary input used for submitting the business documents to webMethods B2B Integration.

Input parameters

type

String. The input parameter type that is generated for AS2, AS4, RNIF20, RNIF11 or cXML.

DoctypeName

String. The name of the document type. The input parameter DoctypeName is case-sensitive.

• For AS4 push, use ebMS 3.0 UserMessage.
• For AS4 pull, use ebMS 3.0 PullRequest Signal.
• For RNIF, it is the xml document type based on the PIP.
• For cXML, it is the xml document type.

SenderID

String. Required for AS4, and cXML. Sender identity value from the partner profile. For example, 123456789.

SenderIDType

String. Required for AS4, and cXML. Sender identity type from the partner profile. For example, DUNS, DUNS+4.

ReceiverID

String. Required for AS4, and cXML. Receiver identity value from the partner profile. For example, 123456789.

ReceiverIDType

String. Required for AS4, and cXML. Receiver identity type from the partner profile. For example, DUNS, DUNS+4.

ConversationID

String. Required for RNIF when acting as a responder. The set of related messages that create a conversation between two partners. In an AS4 message, when the value is not specified, the system generates a unique ID. The value maps to Messaging/UserMessage/CollaborationInfo/ConversationId.

otherParams

Document. (Optional) Other keys that you need to pass as params in the submit service.

as2

Document. Required for AS2 type document. Configure the AS2 parameters.

body

Document. (Optional) AS2 body document. For more information about inputContent, readContentAs, contentType, encoding, and otherHeaders see, input parameters of submit operation.

attachments

Document List. (Optional). For more information about name, inputContent, readContentAs, contentType, encoding and otherHeaders see, the submit operation.

headers

Document. (Optional) Add the key and value strings of the header to the payload.

params

Document. A document that provides parameters on how webMethods B2B recognizes and processes an AS2 document.

as2SenderID

String. (Optional) The EDIINT AS2 identity value that is included as the AS2-From header of the EDIINT message, when webMethods B2B Integration sends a document using an AS2 outbound channel. The EDIINT AS2 identity must be associated with the partner.

If no value is configured for the as2SenderID parameter, webMethods B2B Integration selects any EDIINT AS2 identity value from the partner profile and includes it as the AS2-From header.

as2ReceiverID

String. (Optional) The EDIINT AS2 identity value that is included as the AS2-To header of the EDIINT message, when webMethods B2B Integration sends a document using an AS2 outbound channel. The EDIINT AS2 identity must be associated with the partner.

If no value is configured for the as2ReceiverID parameter, webMethods B2B Integration selects any EDIINT AS2 identity value from the partner profile and includes it as the AS2-To header.

as4

Document. Required for AS4 type document. Configure the AS4 parameters.

body

Document. (Optional) AS4 body document. For more information, see configuring AS4 body.

attachments

Document List. (Optional) AS4 attachments. For more information, see configuring AS4 attachments.

params

Document. A document that provides parameters on how webMethods B2B recognizes and processes an AS4 document. See configuring AS4 params.

rnif

Document. Required for RNIF type document. Configure the RNIF parameters.

body

Document. RNIF body document. For more information, see configuring RNIF body.

attachments

Document List. (Optional) List of attachments to be used in RNIF message. For more information, see configuring RNIF attachments.

headers

Document. (Optional) Add the key and value strings of the header to the payload for an outbound message.

params

Document. A document that provides parameters on how webMethods B2B recognizes and processes an RNIF document. See configuring RNIF params.

cXML

Document. Required for cXML type document. Configure the cXML parameters.

body

Document. cXML body document. For more information about inputContent, readContentAs, contentType and encoding see, input parameters of submit operation.

attachments

Document List. (Optional). For more information about name, inputContent, readContentAs, contentType, encoding and otherHeaders see, submit_attachments.

params

Document. A document that provides parameters on how webMethods B2B recognizes and processes a cXML document.

payloadID

String. A unique number of the document.

userAgent

String. Optional. The software or application that processes the cXML data. For example, Ariba Network, Procure Software 3.3.

sharedSecret

String. The password the sender shares with the receiver for security or authentication purpose.

sync

String. The parameter indicates whether the message is synchronous or asynchronous. true indicates the synchronous message (Two-way/Sync for replying). false indicates the asynchronous message (One-way messages).

deploymentMode

String. Optional. The parameter indicates whether the request is a test request or a production request. The valid values are test or production.

sender

Document. Optional. Sender of the cXML document. Sends the sender identity as cXML-From value when using cXML out channel in webMethods B2B. Add the idType and idValue to recognize and verify the identity of the sender who has initiated the HTTP connection for processing the cXML message.

idType

String. Identity type from the partner profile. For example, DUNS, DUNS+4.

idValue

String. Identity value from the partner profile. For example, 123456789.

receiver

Document. Optional. Receiver of the cXML document. Sends the receiver identity as cXML-To value when using cXML out channel in webMethods B2B. Add the idType and idValue to recognize and verify the identity of the receiver of the cXML message.

idType

String. Identity type from the partner profile. For example, DUNS, DUNS+4.

idValue

String. Identity value from the partner profile. For example, 123456789.

Configuring an AS4 body

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

name

String. (Optional when only body is sent) Name of the payload content.

xmlInputContent

Object. XML content to submit to webMethods B2B for processing. The input is sent as SOAP BODY.

readContentAs

String. Data type in which xmlInputContent field value is accepted.

bytes

xmlInputContent is read as bytes.

string

xmlInputContent is read as a string.

encoding

String. (Optional) Type of character set used for encoding xmlInputContent value. Encoding can be any IANA registered character set. The default value is UTF-8.

partInfo

Document. (Optional) AS4 payload part information.

schemaLocation

String. (Optional) URI of the schema. The value of this parameter maps to the location attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.

schemaVersion

String. (Optional) Version of the schema. The value of this parameter maps to the version attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.

schemaNamespace

String. (Optional) Target namespace of the schema. The value of this parameter maps to the namespace attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.

description

String. (Optional) Description of the content. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/Description element.

properties

Document List. (Optional) List of name and value pairs that are sent along with the message. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties element.

Note: For the final AS4 payload of MimeType application/octet-stream, then add the property name PayloadMimeType and value as application/octet-stream.

name

String. Name of the property. The value of this parameter maps to the name attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.

value

String. Value of the property. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.

Configuring AS4 attachments

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

name

String. Name of the attachment content.

inputContent

Object. Content of the attachment. It is sent as SOAP attachments.

readContentAs

String. Data types in which the inputContent field value is passed.

bytes

inputContent is read as bytes.

string

inputContent is read as a string.

contentType

String. Content type of the attachment. For example, application/zip if the attachment is a compressed file.

encoding

String. (Optional) Encoding of the attachment. The default value is UTF-8.

partInfo

Document. (Optional) AS4 attachment part information.

schemaLocation

String. (Optional) URI of the schema. The value of this parameter maps to the location attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.

schemaVersion

String. (Optional) Version of the schema. The value of this parameter maps to the version attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.

schemaNamespace

String. (Optional) Target namespace of the schema. The value of this parameter maps to the namespace attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.

description

String. (Optional) Description of the content. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/Description element.

properties

Document List. (Optional) List of name value pairs that are sent along with the message. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties element.

Note: For the final AS4 payload of MimeType application/octet-stream, then add the property name PayloadMimeType and value as application/octet-stream.

name

String. Name of the property. The value of this parameter maps to the name attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.

value

String. Value of the property. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.

Configuring AS4 params

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

messageId

String. (Optional) Unique identifier of the message. When a value is not specified, the system generates a unique messageId. When the messageID is generated, the value of this parameter maps to Messaging/UserMessage/MessageInfo/MessageId.

soapAction

String. (Optional) Value of the action parameter in the MIME type.

pmodeId

String. (Optional for push request) TPA agreement ID.

push

Document. (Required when DoctypeName is ebMS 3.0 UserMessage) AS4 push document.

sync

Boolean. (Optional) Synchronous or asynchronous push request. The default value is false. Valid values are:

true. Synchronous push reply (Used in MEP binding Two-Way/Sync for replying).

false. Asynchronous push request (Used in MEP bindings for requesting).

refToMessageId

String. (Required when sync is true). Identifier used in two-way MEPs where the responding MSH user message refers to the initiating MSH user message.

toPartyIdRole

String. (Required when pmodeId or agreementRef is not specified) Initiator or responder role of the party in the message exchange.

fromPartyIdRole

String. (Required when pmodeId or agreementRef is not specified) Initiator or responder role of the party in the message exchange.

agreementRef

String. (Required when pmodeId is not specified) The value to use for the submit request. When pmodeId and agreementRef value is empty, then a tuple of From/PartyId, From/Role, To/PartyId, To/Role, Service and Action is used to identify the TPA agreement.

service

String. (Required when PmodeId or agreementRef is not specified) Name of the service used to identify the RequestUM leg used for the current transaction.

action

String. (Required when PmodeId or agreementRef is not specified) Name of action used to identify the RequestUM leg used for the current transaction.

serviceType

String. (Optional) Name of the service type that indicates how the sender and receiver interprets the service element. If no value is provided for this parameter, the service parameter must be a URI.

messageProperties

Document List. (Optional) List of name and value pairs that are sent along with the message. These pairs map to the property child elements within Messaging/UserMessage/MessageProperties.

name

String. The name of the property.

value

String. The value of the property.

type

String. (Optional) The type of property.

endpointUrl

String. The endpoint URL of the recipient. It retrieves from the operation retrievePeppolParticipantDetails

Note: When exchanging documents over the peppol network, configuring the endpointUrl is mandatory, as it is used to send the documents in real time.

pull

Document. (Required when DoctypeName is ebMS 3.0 PullRequest Signal) AS4 pull document.

mpc

String. (Optional) Indicates MPC (Message partitioning channel) from where to pull the queued message. Default MPC is used when not specified.

simpleSelectionItems

Document List. (Optional) Select a list of simple elements.

element

String. The name of the element that must be retrieved. This parameter refers to refToMessageId, conversationId, agreementRef, service and action.

elementvalue

String. The value of the element.

attributeList

Document List. (Optional) A list of attributes.

element

String. The name of the attribute.

elementvalue

String. The value of the attribute.

complexSelectionItems

Document List. (Optional) Select a list of complex elements.

element

String. The name of the element that must be retrieved. This parameter refers to From, To, and MessageProperties.

elementvalue

String. The value of the element.

attributeList

Document List. (Optional) A list of attributes. Provide the details.

childItems

Document List. (Optional) A list of child items.

element

String. The name of the child item.

elementvalue

String. The value of the child item.

attributeList

Document List. (Optional) List of attributes.

element

String. The name of the attribute.

elementvalue

String. The value of the attribute.

Configuring an RNIF body

Document. To configure an RNIF body document.

xmlInputContent

Object. XML content to submit to webMethods B2B for processing.

readContentAs

String. Data types in which the inputContent field value is passed.

bytes

xmlInputContent is read as bytes.

string

xmlInputContent is read as a string.

encoding

String. (Optional) Encoding of the body content.

Configuring an RNIF attachments

Document List. To configure a list of attachments to be use in an RNIF message. Configuring RNIF attachments [ ] is optional.

name

String. Name of the attachment content

inputContent

Object. Content of the attachment.

readContentAs

String. Data types in which the inputContent field value is passed.

bytes

inputContent is read as bytes.

String

inputContent is read as a string.

contentType

String. Content type of the attachment.

encoding

String. (Optional) Encoding of the attachment.

Document. A document that provides parameters on how webMethods B2B Integration recognizes and processes an RNIF document.

rnif20

Document. Configure the parameters:

pipInfo (rnif20)

Document. (Optional) Document that represents RNIF 2.0 Partner Interface Processes Information (PIP).

senderFocalRole (rnif20)

String. Validator of GlobalPartnerRoleClassificationCode tag describing fromRole in the service header. For valid values, see the fromService and fromRole details in the PIP specification corresponding to the running PIP, activity or action.

receiverFocalRole (rnif20)

String. Validator of GlobalPartnerRoleClassificationCode tag describing toRole in the service header. For valid values, see the toService and toRole details in the PIP specification corresponding to the running PIP, activity or action.

processCode (rnif20)

String. Code or name of the PIP. For example, 3A4.

processVersion (rnif20)

String. Version of the PIP process. Select either 1.1 or 1.4.

transactionCode (rnif20)

String. Transaction associated with each RosettaNet PIP document.

actionCode (rnif20)

String. Query action associated with each RosettaNet PIP document.

enableSyncResponse (rnif20)

Boolean. (Optional) Indicates if the transaction expects a sync response. Valid values are:

true-The transaction is expecting a sync response.

false-The transaction is not expecting a sync response.

The default value is false.

response (rnif20)

Document. (Optional) Composite object containing the parameters.

messageTrackingID (rnif20)

String. Unique instance identifier to identify the message.

inReplyToGlobalBusinessActionCode

String. (Optional) Action associated with request RosettaNet PIP document for which response is sent.

initiatingPartnerLocationID

String. Location ID of the partner for which response is sent.

rnif11

Document. Configure the parameters:

pipInfo

Document. (Optional) Document that represents RNIF 1.1 Partner Interface Processes Information (PIP).

senderFocalRole

String. Validator of GlobalPartnerRoleClassificationCode tag describing fromRole in the service header. For valid values, see the fromService and fromRole details in the PIP specification corresponding to the running PIP, activity or action.

receiverFocalRole

String. Validator of GlobalPartnerRoleClassificationCode tag describing toRole in the service header. For valid values, see the toService and toRole details in the PIP specification corresponding to the running PIP, activity or action.

processCode

String. Code or name of the PIP. For example, 3A4.

processVersion

String. Version of the PIP process. Select either 1.1 or 1.4.

transactionCode

String. Transaction associated with each RosettaNet PIP document.

actionCode

String. Query action associated with each RosettaNet PIP document.

response

Document. (Optional) Composite object containing the parameters.

actionIdentityInstanceIdentifier

String. Unique instance identifier to identify the message.

inReplyToGlobalBusinessActionCode

String. (Optional) Action associated with request RosettaNet PIP document for which response is sent.

Output parameters

The output of constructSubmitInput operation is the input parameters for submit operation. See submit operation for details.

Creates the input signature for the validate operation.

Input parameters

type

String. The type of standard to use for validation. For example, hipaa.

inputContent

Object. (Optional) Content to submit to webMethods B2B Integration for validation.

readContentAs

String. (Optional) Data type of the inputContent.

bytes

inputContent is read as bytes.

string

inputContent is read as string.

stream

inputContent is read as stream.

hipaa

Document. (Optional) Select the configuration specific to HIPAA standard.

split

Boolean. (Optional). Splits the valid and invalid HIPAA data in separate files after the validation. The default is false.

• true. Split valid and invalid hipaa data into separate files after the validation.
• false. Do not split the data into separate files.

reportFormat

String. (Optional). The format of the validation report. Valid options are XML, HTML, and both. The default value is XML.

htmlReport

Document. (Optional). Select the configuration to get the report in HTML format.

• showError. The default is yes.
• showWarning. The default is yes.
• showInformation. The default is yes.
• showIgnore. The default is yes.

Note: When you select hipaa for the input parameter type, you must configure the values in the input parameters inputContent and readContentAs.

Output parameters

operationError

Document. (Optional). Error details if the operation fails.

• message: String. The error message.
• key: String. A predefined error key.
• errorStackTrace: String. Stack trace of the error.

type

String. The type of standard used for validation.

params

Document. The input parameters of the validate operation based on the type selected.

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. webMethods B2B Integration does not ensure the sequence of retrieved contentPartNames. You must validate the sequence of the partName before you map the contentPartNames further in the flow service pipeline.

Input parameters

transactionID

String. Transaction ID of the transaction for which content parts related to the specified contentPartNames are retrieved.

contentPartNames

String list. (Optional) Names of the content parts that are retrieved. If the parameter value is empty or if this parameter is not specified, all content parts of the transaction are retrieved.

Output parameters

contentResponse

Document. Response that contains the content parts associated with valid contentPartNames for the specified transactionID.

contentParts

Document List. The fields the content part retrieved from the transaction has:

partName

String. Name of the contentPart.

partIndex

Integer. Index of the contentPart. The index starts from zero.

length

Integer. Content length in bytes.

encoding

String. Character set in which the content is encoded.

mimeType

String. Mime type of the content.

largeDocument

String. Whether it is a high-volume document.

content

Stream. The content payload of the contentPart.

count

Integer. The count of the valid content parts that are retrieved from the transaction.

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

Input parameters

inputContent

Object. Content data sent as part of the integration response after encoding.

readContentAs

String. Data types in which the inputContent field value is passed.

bytes

inputContent is read as bytes.

string

inputContent is read as a string.

contentType

String. Content-Type passed corresponds to the inputContent field. For example, application/EDI, application/x12, text/plain.

attachments

Document List. (Optional) List of attachments sent as part of integration response, if any.

name

String. Name of the attachment.

inputContent

Object. Content of the attachment.

readContentAs

String. Data types in which the inputContent field value is passed.

bytes

inputContent is read as bytes.

string

inputContent is read as a string.

contentType

String. Content type of the attachment. For example, application/zip if the attachment is a compressed file.

encoding

String. (Optional) Encoding of the attachment. The default value is UTF-8.

otherHeaders

Document. (Optional) Add key and value strings of the header to the attachment.

headers

Document. (Optional) Headers sent as part of the integration response, if any.

errorCode

String. Value of error code passed as part of integration response.

errorMessage

String. Value of error message passed as part of integration response.

encoding

String. Type of character set used for encoding inputContent value. Encoding can be any IANA registered character set. Default UTF-8.

Output parameters

response

Document. The response is a composite object containing the parameters:

content

String. Encoded in Base64. Value is specified in the encoding.

type

String. Value specified in contentType.

encoding

String. Type of encoding used to encode the inputContent. Value is specified in the encoding.

attachments

Document. List of attachments received from the input parameter attachments, if any.

headers

Document. Headers received from the input parameter headers.

error

Document. Error is a composite object containing the fields:

code

String. Error code received from the input. The value is specified in errorCode.

message

String. Error message associated with the input. Value is specified in errorMessage.

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

addresses

Document List. A list of addresses, each containing the details:

addressLine1

String. The first line of the address.

addressLine2

String. The second line of the address.

addressLine3

String. The third line of the address.

city

String. The city specified for the address.

country

String. The country for the address.

zipCode

String. The postal code for the address.

stateProvince

String. The state or province for the address.

addressType

String. Type of address. For example, the corporate or contact address of the partner.

partnerID

String. The internal identifier of the partner.

extendedFields

Document List. The extended fields for the address.

Note: If there are no extended fields for the group, then this field appears blank.

name

String. The name of the extended field.

value

String. The value of the extended field.

Retrieves the channel details from the channel name.

Input parameter

channelName

String. Name of the channel provided in webMethods B2B.

Output parameters

channel

Document. Details of the channel:

id

String. Endpoint URL of the channel.

name

String. Name of the channel.

description

String. Description of the channel.

state

String. State of the channel. The status can be Active or Inactive.

channeltype

String. Type of the channel. For example, HTTP-OUT, HTTP-IN, AS4-OUT, AS4-IN, AS2-OUT or AS2-IN.

scope

String. The channel for receiving or sending the document. The scope can be IN or OUT.

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

contacts

Document List. List of contact details each containing the information:

firstName

String. The given name of the contact.

lastName

String. The surname of the contact.

role

String. The role of the contact in the organization.

type

String. The type of contact. For example, technical contact or administrative contact.

email

String. The email address of the contact.

faxNumber

String. The facsimile number of the contact.

telephoneExtension

String. The telephone extension of the contact.

telephone

String. The telephone number of the contact.

partnerID

String. The internal identifier of the partner.

address

Document List. The address of the contact. For the various address fields, see getAddresses.

extendedFields

Document List. The extended fields for contacts.

Note: If there are no extended fields for the group, then this field appears blank.

name

String. The name of the extended field.

value

String. The value of the extended field.

Retrieves the control number from webMethods B2B Integration 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

type

String. The control number type.

ENVELOPE

For an interchange control number.

Group

For group control numbers, type the value set in the Group field of control number definition in webMethods B2B Integration . For example, for ANSI X12 4010 850, type PO.

transaction

For transaction control number.

increment

String. (Optional) Updates the control number in the database to use the next control number for group and envelope documents. For transactions, control numbers are incremented.

pad

String. (Optional) If enabled, returns a nine-digit control number by appending leading zeros if the length is fewer than nine digits. If not enabled, returns the control number as retrieved. For transactions, control numbers are padded.

scope

Document. (Optional) Scope is applicable to groups and interchange documents.

senderIdentityValue

String. For ANSI X12 and UN/EDIFACT, the external ID of the partner (e.g., sender's D-U-N-S number). For TRADACOMS, the sender name specified in the transmission.

senderQualifier

String. For ANSI X12 and UN/EDIFACT, the EDI ID qualifier for the sender (e.g., 01 for D-U-N-S). For TRADACOMS, the sender code specified in the transmission.

receiverIdentityValue

String. For ANSI X12 and UN/EDIFACT, the external ID of the partner (e.g., receiver's D-U-N-S number). For TRADACOMS, the receiver name specified in the transmission.

receiverQualifier

String. For ANSI X12 and UN/EDIFACT, the EDI ID qualifier for the receiver (e.g., 01 for D-U-N-S). For TRADACOMS, the receiver code specified in the transmission.

standard

String. The EDI standard associated with the control number. Specify one of: X12, UNEDIFACT, VICS, UCS, EANCOM, ODETTE, TRADACOMS, or VDA.

mode

String. (Optional) The mode associated with the control number. Specify one of the following mode:

Production

Default mode.

Test

Test mode.

Custom

Custom mode.

Note: For TRADACOMS, the valid value is Production only.

version

String. (Optional) Version of the EDI standard for the control number. For example, 4010. For TRADACOMS envelope, use 1. For TRADACOMS batch, use the version number of the file type (e.g., ORDHDR:5 → version 5).

Output parameters

controlNumber

String. (Optional) Control number returned from webMethods B2B webMethods B2B Integration for the outbound group, envelope, or transaction.

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

corporate

Document List. The corporate information of a partner:

corporationName

String. The name of the corporation.

orgUnitName

String. The name of the organizational unit within the corporation.

status

String. The status of the partner in your webMethods B2B webMethods B2B Integration. This value can be Active or Inactive.

isEnterprise

Boolean. Indicates whether the partner profile represents the enterprise profile.

true

It is an enterprise profile.

false

It is not an enterprise profile.

partnerID

String. The internal identifier of the partner.

extendedFields

Document List. The extended fields for the corporation.

Note: If there are no extended fields for the group, then this field appears blank.

name

String. The name of the extended field.

value

String. The value of the extended field.

Retrieves a set of extended fields for a partner.

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

Input parameters

partnerID

String. The internal identifier of the partner for which you want to retrieve the extended fields.

groupName

String. (Optional) The group for which you want to retrieve the extended fields. Specify the name of the field group associated with the extended fields to retrieve.

Corporation

Retrieves corporation extended fields.

Contact

Retrieves contact extended fields.

Delivery

Retrieves delivery extended fields.

ExternalID

Retrieves IDs extended fields.

Address

Retrieves addresses extended fields.

Custom

Retrieves custom extended fields.

Note: Apart from the standard field groups, you can also specify the groups created under the Field Groups section in webMethods B2B webMethods B2B Integration.

Output parameters

groups

Document List. The extended field group details of the extended fields.

name

String. The group name for the extended field.

id

String. The ID of the group.

fields

Document List. The list of extended fields within the group.

name

String. The name of the extended field.

value

String. The value of the extended field.

Note: If the group you selected has no extended fields, then this field appears blank.

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, the iteratorCount must be 1 for the initial iteration and incremented by 1 for each of the subsequent iterations.

This operation fetches the transactions from the live dataSource.

Input parameters

startTime

String. The start date and time of the transaction. The format for the date and time should be yyyy-MM-ddTHH:mm:ss.SSSZ. For example: 2022-11-01T05:57:36.942Z.

endTime

String. The end date and time of the transaction. The format for the date and time should be yyyy-MM-ddTHH:mm:ss.SSSZ. For example, 2022-11-01T05:57:36.942Z

faStartTime

String. (Optional) The start date and time of the FA for the transaction. The format for the date and time should be yyyy-MM-ddTHH:mm:ss.SSSZ. For example, 2022-11-01T05:57:36.942Z.

faEndTime

String. (Optional) The end date and time of the FA for the transaction. The format for the date and time should be is yyyy-MM-ddTHH:mm:ss.SSSZ. For example, 2022-11-01T05:57:36.942Z.

senderID

String List. (Optional) The partner IDs of the sender for the transaction.

receiverID

String List. (Optional) The partner IDs of the receiver for the transaction.

senderIdentity

Document List. (Optional) The external IDs of the sender for the transaction.

code

The ID type. For more information, see Partner Profile ID Types.

value

The value of an external ID configured for the ID type.

receiverIdentity

Document List. (Optional) The external IDs of the receiver for the transaction.

code

The ID type. For more information, see Partner Profile ID Types.

value

The value of an external ID configured for the ID type.

Note: You should configure either senderID and receiverID or senderIdentity and receiverIdentity. When you configure all four input parameters, the senderID and receiverID take precedence for processing the getFAReport operation.

faStatus

String List. (Optional) FA status of the transaction. The accepted values are:

• ACCEPT
• ACCEPT_ERROR
• ACCEPT_PARTIAL
• DISABLE
• DUPLICATE
• DUPLICATE_FA
• ERROR
• FA_ERROR
• INTERCHANGE_RECEIVED
• NONE
• REJECT

groupType

String. (Optional) The group header code of the document. For example, PO, IN.

groupVersion

String. (Optional) Group version of the document. For example, 4010, 5010.

limit

Number. (Optional) Number of transactions retrieved per execution. The default and the maximum limit for the input value is 1000.

iteratorCount

Number. (Optional) The count must be incremented until the value for the output parameter isIterate is false. The default value is 1.

generateReport

String. (Optional) Generates a FA report.The possible values are true and false. The default value is false.

format

String. (Optional) Format of the report. Values: CSV, JSON, HTML. The default format is CSV.

Output parameters

totalCount

Number. Total count of transactions.

isIterate

Boolean. Indicates whether the transactions are present after the iteration. Run this operation until the last transaction matches the input criteria.

transactions

Document List. Details of the transaction created in webMethods B2B Integration.

transactionID

String. Internal unique identifier for the document.

documentTypeName

String. Document type name for the recognized document.

senderName

String. Display name of the sender.

receiverName

String. Display name of the receiver.

envelopeID

String. Envelope control number.

groupID

String. Group control number.

transactionSetID

String. Transaction set control number.

groupType

String. Group header code For example, PO, IN.

groupVersion

String. Group version of the document.

transactionTimestamp

String. Time the transaction was logged. For example, Feb 18, 2019, 08:45:02 PM.

faTimestamp

String. Time the FA was sent. For example, Feb 18, 2019, 08:45:02 PM.

faStatus

String. Functional acknowledgment (FA) status of the transaction.

relatedTransactionID

String. Internal ID of the related transaction.

report

String. The generated FA report.

Retrieves the list of ID types from webMethods B2B Integration.

Output parameters

operationError

Document. Error details if the operation fails to run.

message

String. The error message.

key

String. A predefined error key.

errorStackTrace

String. Stack trace of the error.

response

Document. The response of the operation.

idTypes

Document. The list of ID types from webMethods B2B webMethods B2B Integration.

name

String. Name of the ID type.

codes

String. Codes of the ID type.

Retrieves the partnerID for the partner.

Input parameters

identityTypeValue

String. The identity type value for a partner.

identityTypeName

String. The identity type name for a partner For example, DUNS, DUNS+4, EULER, User Defined 3, User Defined 2, User Defined 1, webMethods Internal, Mutually defined.

Output parameters

partnerID

String. The internal identifier for a partner.

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

identities

Document List. The details of the identities of the partner.

type

String. The type of identity. For example, duns, duns+4.

value

String. The value of identity.

code

String. The code for the type of the identity. For example, 1, 2, 3.

partnerID

String. The internal identifier of the partner.

extendedFields

Document List. The extended fields for the identities.

Note: If there are no extended fields for the group, then this field appears blank.

name

String. Name of extended field to use in the criteria.

value

String. The extended fields to match.

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

Input parameters

transactionID

String. The transaction ID for which you want to retrieve the related transactions.

dataSource

String. The data source where the transaction resides. The default value is live. The possible values are:

live

Retrieves the transaction from the live data source.

archive

Retrieves the transaction from the archive data source.

Warning: This data source parameter is removed in the upcoming releases. Do not use in production.

includeTransactionDetails

Boolean. Includes transaction details such as senderID, receiverID, documentTypeID, userStatus, transactionStatus, and customAttributes when set to true. Default is false.

Output parameters

relatedTransactions

Document array. All the related transactions pertaining to the transactionID.

transactionID

String. The transaction ID of the related transactions.

relationship

String. The relationship set by the relateTransactions operation or a system-set value.

details

Document. Included when includeTransactionDetails is true.

senderID

String. The senderID associated with the transaction.

receiverID

String. The receiverID associated with the transaction.

documentTypeID

String. The business document ID of the transaction.

userStatus

String. The user status associated with the transaction.

transactionStatus

String. The processing status of the transaction.

customAttributes

String. The custom attributes associated with the transaction.

Retrieves the information related to the task.

Input parameters

dataSource

String. (Optional) Specifies whether to look for the mentioned transaction in the live database or the archive database. The possible options are live and archive. The default value is live.

Warning: This data source parameter is removed in the upcoming releases. Do not use in production.

taskID

String. Internal ID of the task for which you want to retrieve the information.

Output parameters

taskType

String. Describes the type of task.

QueueName

String. The queue for which the task must deliver.

transactionID

String. The internal ID of the document to which the task is related.

taskStatus

String. The current status of the task.

timeCreated

String. The time when the task was created. Displayed in ISO 8601 format with UTC time zone, For example, 2018-11-24T19:30:00Z.

timeUpdated

String. The time when the task was updated. Displayed in ISO 8601 format with UTC time zone, For example, 2018-11-24T19:30:00Z.

receiverID

String. The internal ID for the receiver of the transaction associated with this task.

senderID

String. The internal ID for the sender of the transaction associated with this task.

Retrieves the transaction attributes from the internal ID.

Input parameters

transactionID

String. Transaction ID from webMethods B2B Integration.

includeAttributes[]

Document List. Includes the attributes to retrieve the details, based on the attributeName.

attributeName

String. Retrieves the attribute details such as name and value for the transaction-related attributes.

Output parameters

operationError

Document. Error details if the operation fails.

message

String. The error message.

key

String. A predefined error key.

errorStackTrace

String. Stack trace of the error.

attributes[]

Document List. The attributes name and value retrieved.

name

String. Name of the attribute.

Value[]

String. (Optional). Values of the attribute.

dataType

String. (Optional). Data type of the attribute.

systemAttribute

Boolean. (Optional). Indicates whether it is a system or custom attribute.

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

Input parameters

documentID

String. Document ID for which you want to get the transaction from webMethods B2B Integration.

duration

String. The time duration between which you want to search for the transaction (currentTime - duration). Format must be of the form nM, nH, nD where n is a positive number (1–9999999999). Valid ranges are 1M to 10080M, 1H to 168H, and 1D to 7D. Total duration must not exceed 7 days.

dataSource

String. (Optional, default: live) Search in either the live or archive transactions list.

Warning: This data source parameter is removed in the upcoming releases. You must not use it in production.

Output parameters

operationError

Document. Error details if the operation fails to run.

message

String. The error message.

key

String. A predefined error key.

errorStackTrace

String. Stack trace of the error.

transaction

Object. The internal document ID to which the task is related.

transactionID

String. The transaction ID for which you want to retrieve the related transactions.

senderID

String. The sender ID associated with the transaction.

receiverID

String. The receiver ID associated with the transaction.

documentTypeID

String. The business document ID of the transaction.

transactionStatus

String. The processing status of the transaction.

userStatus

String. The user status associated with the transaction.

receivedDate

String. The date on which the transaction was created.

exists

Boolean. Checks for any transaction found for the document ID in the specified duration.

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

Input parameters

senderID

String. The internal ID of the trading partner that has the sender role in the transaction that the TPA governs. To specify the unknown partner, use Unknown.

receiverID

String. The internal ID of the trading partner that has the receiver role in the transaction that the TPA governs. To specify the unknown partner, use Unknown.

agreementID

String. The agreement ID of the TPA.

direction

String. (Optional) Indicates whether the operation searches for a TPA where the sender and receiver are switched if a TPA with the specified sender or receiver does not exist. Valid values are:

true

The operation looks for a TPA where the sender or receiver is as specified.

false

If a TPA with the specified sender or receiver does not exist, the operation switches the specified sender and searches for the TPA where the sender matches the receiver and the receiver matches the sender. Returns the TPA when found. False is the default value.

Output parameters

tpa

Document. (Optional) The retrieved TPA as an IData object.

senderID

String. The internal identifier for the trading partner that has the sender role in the TPA.

receiverID

String. The internal identifier for the trading partner that has the receiver role in the TPA.

agreementID

String. An application-specific identifier for the TPA.

created

String. The time that webMethods B2B Integration created the TPA.

lastModified

String. The time that webMethods B2B Integration last updated the TPA either when the TPA was created or last updated.

status

String. The agreement status of the TPA, indicating whether the TPA is a draft or final version and whether the agreement is active. Valid values:

Proposed

The TPA is in draft status.

Agreed

The TPA is in final status.

Disabled

The TPA is not enabled.

templateID

String. TPA template that defines the blueprint of the TPA, establishing the TPA parameters and values.

dataStatus

String. Indicates whether you can update the values in tpaData. Used when status is Agreed. Valid values:

Modifiable

The data in tpaData can be modified.

Non-modifiable

The data in tpaData cannot be modified.

tpaData

Document. Contains the data for the TPA.

version

String. The version number of the TPA.

tpaID

String. A unique ID for the TPA that webMethods B2B Integration generates.

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. webMethods B2B Integration does not ensure the sequence of retrieved contentPartNames. You must validate the sequence of the partName before you map the contentPartNames further in the flow service pipeline.

Input parameters

transactionID

String. ID of the transaction for which content parts related to specified contentPartNames are retrieved.

compartmentalizes

String list. (Optional) Names of the content parts that are retrieved. If empty or not used, all content parts of this transaction are retrieved.

loadContentAs

String. Identifies how the contentResponse/contentParts/content needs to be loaded.

bytes

Content is loaded as bytes.

string

Content is loaded as a string.

dataSource

String. (Optional) Specifies whether the transaction needs to be looked up in the live (production) or archive database.

live

The transactionID is looked up in the live (production) database tables. Default option.

archive

The transactionID is looked up in the archive database tables.

Warning: This data source parameter is removed in the upcoming releases. You must not use it in production.

formatData

Boolean. (Optional) Displays the format of the data in the output.

true

Formats to default EDI payload.

false

Unformatted EDI payload.

Output parameters

contentResponse

Document. Response containing content parts associated with valid contentPartNames for the specified transactionID.

contentParts

Document List. Fields retrieved from the transaction content part.

partName

String. Name of the contentPart.

partIndex

Integer. Index of the contentPart. Starts from zero.

length

Integer. Content length in bytes.

encoding

String. Character set in which content is encoded.

mimeType

String. Mime type of the content.

content

Object. The content payload of the contentPart. Determined by the loadContentAs parameter.

count

Integer. Count of valid content parts retrieved from the transaction.

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

Input parameters

transactionID

String. The transaction ID for which you want to get the sender and receiver details.

dataSource

String. Specifies whether to look for the mentioned transaction in the live database or the archive database.

Warning: This data source parameter is removed in the upcoming releases. It must not be used in production.

Output parameters

sender

Document. A subset of sender information based on the values set in sender.

partnerID

String. The ID of the partner for which you want to fetch.

corporationName

String. The name of the corporation.

orgUnitName

String. The name of the organizational unit within the corporation.

isEnterprise

Boolean. Indicates whether the partner profile is the enterprise itself. Value can be true or false.

status

String. The status of the partner in your webMethods B2B Integration instance. Value can be Active or Inactive.

receiver

Document. A subset of receiver information based on the values set in sender.

partnerID

String. The ID of the partner for which you want to fetch.

corporationName

String. The name of the corporation.

orgUnitName

String. The name of the organizational unit within the corporation.

isEnterprise

Boolean. Indicates whether the partner profile is the enterprise itself. Value can be true or false.

status

String. The status of the partner in your webMethods B2B Integration instance. Value can be Active or Inactive.

Adds an entry into the activity log.

Input parameters

type

String. (Optional) The type of activity log entry. Supported types are: ERROR, WARNING, and MESSAGE.

category

String. (Optional) The category for the activity log entry. webMethods B2B Integration supports the following categories or any custom value:

General

Any unspecified error messages and warnings.

Processing

Processing a document using a processing rule.

message

String. A brief message for the activity log entry. The value can be a string with maximum of 240 characters.

Note: webMethods B2B Integration displays an error message when you exceed the character limit.

details

String. (Optional) A detailed message about the reason for adding the activity log entry. The value can be a string with a maximum of 1024 characters.

Note: webMethods B2B Integration displays an error message when you exceed the character limit.

transactionID

String. The transaction ID of the document created in webMethods B2B Integration related to this activity log entry.

partnerID

String. (Optional) The internal ID of the partner related to this activity log entry.

content

Object. (Optional) The payload content for the activity log. The content can be up to 2 MB.

Note: If the content exceeds 2 MB, webMethods B2B Integration displays an error message.

readContentAs

String. (Optional) Data types in which the content field value is passed.

bytes

The content is read as bytes.

string

The content is read as a string.

encoding

String. (Optional) The character set in which the value of the content is encoded. Specify an IANA-registered character set. For example, UTF-8 and ISO-8859-1. Default is UTF-8.

Output parameters

success

Boolean. Indicates whether the activity log is added for the provided transaction ID. Valid values are:

true

Indicates that the activity log entry is added successfully.

false

Indicates that the addition of activity log entry has failed.

Parses request content passed by the processing rule Call an integration action as bytes or string data type. For more information, see in webMethods B2B Integration documentation.

Input parameters

inputContent

String. Content passed in the integration request.

loadContentAs

String. Data type in which the outputContent field value is passed.

bytes

outputContent is generated as bytes.

string

outputContent is generated as a string.

Output parameters

outputContent

Object. Content data corresponds to the data type option set for the loadContentAs field.

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

Input parameters

queryLocator

String. The ID of the query. You can use this ID to view the query results. You obtain this ID from the queryPartners operation.

Output parameters

done

Boolean. Indicates whether the query has more rows to retrieve.

size

String. The total number of records retrieved in the query result.

records

List. The list of partner profiles. Based on the values set in resultField, you can view the following information:

corporationName

String. Name of the corporation.

orgUnitName

String. The name of the organizational unit within the corporation.

status

String. The status of the partner in your webMethods B2B instance. This value can be Active or Inactive.

isEnterprise

Object. Indicates whether the partner profile represents the Enterprise profile.

partnerID

String. The internal identifier of the partner.

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

Input parameters

batchSize

String. (Optional) The maximum number of profiles present in each batch. Valid range: 20–500. The default is 100.

Note: If you provide a value outside the specified range, then webMethods B2B Integration displays an error message.

criteria

Document. (Optional) The criteria to filter the query results.

isOrQuery

String. Whether the join condition between fields is OR (true) or AND (false). Default is false.

fields

Document list. The criteria to filter the results for fields such as corporationName, orgUnitName. Each field can have multiple criteria. For example, orgUnitName IS NOT NULL AND orgUnitName = ABC*, where orgUnitName is the field name, IS NOT NULL and '=' are the operators, AND is the join condition (isOrQuery), and ABC* is the value. With this criteria, webMethods B2B Integration selects all the profiles for which the organization unit name is not null and the name starts with ABC.

fieldName

String. The name of the field for which you specify the filter criteria in the criteria variable. Valid values are-corporationName, orgUnitName, status.

isOrQuery

String. Whether the join condition for the filter criteria in the criteria variable is AND or OR. Valid values are true (OR) or false (AND). The default value is false.

criteria

String. Filter criteria for the fieldName.

operator

String. The operator for the filter criteria. Valid values are-IS NULL, IS NOT NULL, =, and < > (not equal to)

value

String. The value for the filter criteria. You can use the wildcard * in searches to match one or more characters, or the wildcard question mark (?) to match one character. For example, to search for data ending with abc, specify the value as *abc. Similarly, to search for data starting with ab and ending with c with length 4, specify the value as ab?c.

sortOrder

Document List. (Optional) Field name and order for sorting.

fieldName

String. The field name for sorting. Valid values are: corporationName, orgUnitName, status.

isAscending

Document. Sorting order of the result. Valid values: ASC (ascending), DESC (descending).

resultFields

String List. (Optional) List of fields in the result set. Valid values: corporationName, orgUnitName, status

Note: If the field is blank, then webMethods B2B Integration returns all the mentioned fields including the isEnterprise and partnerID fields. For details on the values, see getCorporation operation. By default, the query results contain isEnterprise and partnerID fields.

Output parameters

queryLocator

String. The ID of the query ran for which results are retrieved. It is used in queryMorePartners operation to retrieve subsequent sets of records from the query results when the value of done is false. Similarly, it is also used in resetQueryPartners operation to release the queryLocator.

done

Boolean. Indicates whether more rows are available. The result is used in the queryMorePartners operation.

true

No more rows to retrieve.

false

More rows are available to retrieve.

records

List. The list of partner profiles. Based on the values set in the resultField, you can view the information:

corporationName

String. Name of the corporation.

orgUnitName

String. Name of the organizational unit within the corporation.

status

String. Status of the partner in your webMethods B2B Integration instance. The valid values are: Active, Inactive.

isEnterprise

Boolean. Indicates whether the profile represents the Enterprise profile. The valid values are: true, false.

partnerID

String. Internal identifier of the partner.

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

Input parameters

dataSource

String. (Optional) Specifies whether to look for the mentioned transaction in the live database or the archive database. The possible options are live and archive. The default value is live.

Warning: This data source parameter is removed in the upcoming releases. It must not be used in production.

criteria

Document. (Optional) Criteria to identify task IDs.

dateRange

Document. (Optional) Contains start and end date, compared with task creation time.

startDate

String. (Optional) Start date in ISO format with UTC time zone. For example, 2018-11-24T19:30:00Z.

endDate

String. (Optional) End date in ISO format with UTC time zone. For example, 2018-11-24T19:30:00Z.

isOrQuery

String. (Optional) Indicates whether the join condition for the filter criteria that you specify in the fields variable is AND or OR. The possible options are-true and false. The default value is false.

fields

Document List. (Optional) Criteria for a field.

fieldName

String. (Optional) Name of the field for which you specify the filter criteria. The possible values are-taskType, taskStatus, queueName, transactionID. This field appears empty by default.

isOrQuery

String. (Optional) Whether the join condition for the filter criteria in the criteria variable is AND or OR. The possible options are and false. The default value is false (AND).

fieldCriteria

Document List. (Optional) The filter criteria. Each field can have more than one filter criteria. For example, queueName IS NULL AND queueName = ?AG*, where queueName is the field name, IS NULL and '=' are the operators, AND is the join condition, and IGNORED is the value.

operator

String. Operator for the fieldCriteria. The valid values depend on the field type of the fieldName variable. The possible values are-IS NULL, IS NOT NULL, =, < >.

value

String. (Optional) Value for the filter. Use `?` for single-character wildcard and `*` for multi-character wildcard.

sortOrder

Document List. (Optional) The column name by which the results must be sorted.

fieldName

String. (Optional) Column name for sorting.

orderDirection

String. (Optional) The order by which the results must be sorted (ascending or descending). The possible values are-ASC and DESC. The default value is ASC.

Output parameters

taskIDs

String. List of tasks retrieved. A maximum of 1000 are returned even if the value in `count` is higher.

count

String. Total number of task IDs matching the criteria.

Retrieves the transactions that match the specified criteria.

Input parameters

batchNumber

Integer. (Optional) Specifies the batch number from which transactions must be retrieved. The default value is 1.

batchSize

String. (Optional) Specifies the number of transactions to retrieve from each batch. Possible values are 5, 10, 20, and 50. The default value is 10.

criteria

Document. Criteria to retrieve transactions.

dateRange

Document. Date range to retrieve the transactions. The maximum date range that you can set is for 7 days. You must specify the date range.

startDate

String. The format of start date should be in ISO format in the UTC time zone. For example, YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ.

endDate

String. The format of end date should be in ISO format in the UTC time zone. For example, YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ.

fields

Document List. (Optional). Specifies the field name and field criteria used to filter the transactions. Within the same field parameter, the filter criteria condition is OR. When the field parameters are varied, the filter criteria condition is AND.

fieldName

String. The name of the field for which you want to filter the transactions. Possible values are senderID, receiverID, documentTypeID, transactionStatus, ConversationID, DocumentID, GroupID, internalID, Original SenderID, Original Receiver ID, Task Status and userStatus.

Note: Apart from the standard fields such as senderID, receiverID, documentTypeID, transactionStatus, userStatus, a maximum of five other fieldName entries are allowed.For DATETIME attribute, the ISO format is in UTC time zone (For example, YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ)

The attributes with list data type are not supported for this operation.

fieldCriteria

Document. Criteria for the field specified in the fieldName parameter.

operator

String. The supported operators are:

No

value operators-IS NULL and IS NOT NULL. If you provide any values, those values are ignored.

Single

value operators-BEFORE and AFTER. This parameter is applicable for DATE type attributes. If you provide a list of multiple values, only the first value is considered for evaluation and the rest are ignored.

Multi

value operators-EqualsTo(=) and NotEqualsTo(<>). The NotEqualsTo(<>) operator does not apply to DATE type attributes.

value

StringList. The values for the field specified in the fieldName parameter.

Note: A maximum of 20 values are allowed.

includeAssetsInfo

Boolean. (Optional). Retrieves the transactions related to sender, receiver and document type details in the response based on the flag. Possible values are-True and False. The default value is False.

includeAttributes

Document List. (Optional) Includes the attributes to retrieve the details for, based on the attributeName.

attributeName

String. Retrieves the attribute details such as name and value for the transaction-related attributes. The possible values are-senderID, receiverID, documentTypeID, transactionStatus, userStatus, Comment, ConversationID, DocumentID, GroupID, internalID, Original SenderID, Original Receiver ID and Task Status.

Note: Apart from the standard fields such as senderID, receiverID, documentTypeID, transactionStatus, userStatus, a maximum of five other fieldName entries are allowed.

The attributes with list data type are not supported for this operation.

Output parameters

transactions

Document List. List of transactions that match the specified criteria.

transactionID

String. The transaction ID for which you want to retrieve the related transactions.

senderID

String. Sender ID associated with the transaction.

receiverID

String. Receiver ID associated with the transaction.

documentTypeID

String. The business document ID of the transaction.

transactionStatus

String. Processing status of the transaction.

userStatus

String. User status associated with the transaction.

receivedDate

String. Date when the transaction was created.

assetsInfo

Document. Retrieves the transaction of the related sender, receiver and business document type.

sender

Document. A subset of the sender information.

id

String. The ID of the partner.

corporationName

String. The name of the corporation of the partner.

orgUnitName

String. The organization unit name of the partner.

enterprise

Boolean. The parameter indicates whether the partner is the enterprise. Possible values are-True and False.

status

String. The status of the partner on webMethods B2B Integration.

deleted

Boolean. The parameter indicates whether the partner profile is deleted. Possible values are-True and False.

receiver

Document. Receiver information.

id

String. The ID of the partner.

corporationName

String. The name of the corporation of the partner.

orgUnitName

String. The organization unit name of the partner.

enterprise

Boolean. The parameter indicates whether the partner is the enterprise. Possible values are-True and False.

status

String. The status of the partner on webMethods B2B. Possible values are-Active and Inactive.

deleted

Boolean. The parameter indicates whether the partner profile is deleted. Possible values are-True and False.

documentType

Document. Business document type information.

id

String. The ID of the business document.

name

String. The name of the business document.

description

String. The description of the business document.

status

String. The status of the business document in webMethods B2B Integration.

attributes

Document. Retrieves the name and value of the attribute based on the attributeName string in the includeAttributes document list as key and value pair in the format.

totalBatches

Integer. Total number of transaction batches matching the criteria.

totalCount

Integer. Specifies the total number of transactions that match the criteria. The maximum count for the matching transactions is 10,000.

operationError

Document. Error details if the operation fails.

message

String. Error message.

key

String. Predefined error key.

errorStackTrace

String. Stack trace of the error.

The operation creates a one-way relationship between two transactions.

Input parameters

fromTransactionID

String. The internal ID of the transaction from which the relationship must be established.

toTransactionID

String. The internal ID of the transaction to which the relationship is established.

relationship

String. A string describing the relationship. The maximum string length should not exceed 255 characters.

Output parameters

isUpdated

Boolean. Indicates whether the relationship was created.

true

The service successfully established the relationship.

false

The service did not establish the relationship.

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

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

Input parameters

queryLocator

String. The ID of the query obtained from the queryPartners operation. You obtain this ID from the queryPartners operation.

Output parameters

status

Boolean. Indicates whether reset is complete or not.

Restarts a failed or stopped task.

Input parameters

taskID

String. The internal identifier of the task.

Output parameters

isTriggered

Boolean. The flag that indicates whether the restart is triggered. The possible values are-true and false.

• true. The restart is triggered.
• false. The restart is not triggered.

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

Input parameters

transactionIDs

String List. List of transaction IDs of webMethods B2B to reprocess. You can get the transactionID when you submit a document to webMethods B2B Integration. The maximum number of transaction IDs you can reprocess is 1000.

Output parameters

result

Document List. List of outputs for all the transactionIDs.

• transactionID-String. Transaction ID of the document that was reprocessed.
• success-Boolean. The value is true if the transaction is successfully initiated to reprocess. Otherwise, its value is false.
• error-Document. (Optional) If success is false, then this error document appears in the output.

  code-String. Error code when the transaction reprocessing fails.

  message-String. Error message when the transaction reprocessing fails.

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

Input parameters

transactionIDs

String List. List of transactionIDs of webMethods B2B to resubmit. You can get the transactionID when you submit a document to webMethods B2B Integration. The maximum number of transaction IDs you can resubmit is 1000.

Output parameters

result

Document List. List of outputs for all the transactionIDs.

• transactionID- String. Transaction ID of the document that was resubmitted.
• success-Boolean. The value is true if the transaction is successfully initiated to resubmit. Otherwise, its value is false.
• error-Document. (Optional) If success is false, then this error document appears in the output.

  code-String. Error code when the transaction resubmission fails.

  message-String. Error message when the transaction resubmission fails.

Retrieves the details (for example, endpoint address, and recipient certificate) of the Peppol recipient participant. This service retrieves the details of both production and test participants.

Input parameters

participantID

String. Peppol participant identifier. For example, 9915:test.

isProduction

String. Retrieves the details of the participants. Valid values are:

true

Retrieves the details from the production environment.

false

Retrieves the details from the test environment.

documentType

String. List of the document type you can exchange. If any of the document type is not available in the list, provide the corresponding Peppol document type identifier value.

processIdentifier

String. List of the Peppol process identifier value. If any of the process identifiers is not available in the list, provide the input as:. For example, if cenbii-procid-ubl is the Peppol identifier scheme and urn:www.cenbii.eu:profile:bii01:ver1.0 is the Peppol identifier value, then the processIdentifier value must be cenbii-procid-ubl::urn:www.cenbii.eu:profile:bii01:ver1.0.

Output parameters

endpointUrl

String. The endpoint recipient URL.

certificate

Object. Holds the complete signing X509 certificate of the recipient access point. A byte array that represents the signing X509 certificate (a java.security.cert.X509Certificate).

description

String. A human-readable description of the endpoint.

activationDate

String. The activation date of the endpoint. A missing activation date must be interpreted as valid since forever.

expirationDate

String. The expiration date of the endpoint. A missing expiration date must be interpreted as valid until eternity.

contactUrl

String. Represents a link to human-readable contact information. It can be an email address.

informationUrl

String. A URL to human-readable documentation. For example, a website contains XML schemas, WSDLs, schematrons and other relevant resource links.

Submits the business documents to webMethods B2B Integration.

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

Input parameters

inputContent

Object. Content to submit to webMethods B2B Integration for processing.

readContentAs

String. Data types in which inputContent field value is accepted.

bytes

inputContent is read as bytes.

string

inputContent is read as a string.

stream

inputContent is read as a stream. If the payload is over 5 MB, you must use readContentAs as a stream.

contentType

String. Specifies the type of content. The valid inputs for HIPAA document types are application/EDIStream and application/EDI.

text/xml

Content is read as an XML input.

application/EDIStream

Content is read as an EDI InputStream. For high-volume EDI documents. you must use application/EDIStream.

application/EDI

Content is read as EDI input.

application/x12

Content is read as X12 input.

application/UNEDIFACT

Content is read as UNEDIFACT input.

application/x

wmflatfile. Content is read as Flat file input.

Note: This field is case sensitive. Also, if you provide a type other than the one mentioned earlier, webMethods B2B Integration identifies the document as unknown. You must set the contentType to application/EDI for VDA payloads

encoding

String. Type of character set used for encoding inputContent value. This character set can be any IANA registered. The default value is-UTF-8

otherHeaders

Document. Includes custom headers in the AS2 body of EDIINT document when it is delivered through the AS2 channel. These custom headers are visible only when the document has a multipart body.

params

Document. A document that provides parameters to govern how webMethods B2B recognizes and processes a document based on a Pipeline Variable you configure in the Pipeline Input. For XML documents, you can optionally add the fields as a pipeline variable:

DoctypeName

String. The name of the document type. This field is case-sensitive. The DoctypeName field identifies the document type to use, bypassing document recognition and eliminating the overhead of searching for the webMethods B2B Integration document type.

processingRuleName

The name of the processing rule. This field is case-sensitive. The processingRuleName field identifies the processing rule to use, thus bypassing the processing rule lookup and eliminating the overhead of searching for a processing rule.

bypassRouting

Indicates whether webMethods B2B Integration uses a processing rule to process the document. Valid values are:

true

Disables the processing rule routing.

false

Enables the processing rule routing.

pipelineMatching

Allows you to pass the key-value pair defined in an XML document. These variables are used to identify webMethods B2B Integration document type for processing. For more information about pipeline matching, see Adding RosettaNet PIP Document Adding RosettaNet PIP document in webMethods B2B Integration documentation.

For RosettaNet Partner Interface Processes (PIPs), add the fields as a Pipeline Variable:

rnif20

Document. RNIF document.

pipInfo

Document. Document that represents RNIF Partner Interface Processes Information (PIP).

senderFocalRole

Role of the initiating partner, for example, the Buyer. This field validates the GlobalPartnerRoleClassificationCode tag describing fromRole in the service header. For valid values, see the fromService and fromRole details in the PIP specification corresponding to the running PIP, activity or action.

receiverFocalRole

Role of the fulfiller partner, for example, the Seller. This field validates the GlobalPartnerRoleClassificationCode tag describing toRole in the service header. For valid values, see the toService and toRole details in the PIP specification corresponding to the running PIP, activity or action.

processCode

Code or name of the PIP, such as 3A4 (request Purchase order). Refer title page of the PIP specification document for the code or name of the PIP.

processVersion

Version of the PIP process, such as 1.1 or V01.03. Refer title page of the PIP specification document for the PIP Version Identifier.

transactionCode

Transaction associated with each RosettaNet PIP document. For example, create Purchase order. For details of transaction code refer to the Table 3-2-Business Activity Descriptions of the PIP specification document.

actionCode

Action associated with each RosettaNet PIP document. For details on business action refer Table 4-2-Business Action-Business Document Mapping of the PIP specification document.

enableSyncResponse

The parameter indicates if the transaction is expecting a sync response. By default it is not enabled.

response

Document. The response is a composite object containing the parameters. The document contains the following fields:

messageTrackingID

Tracking ID of the request message for which webMethods B2B sends the response.

inReplyToGlobalBusinessActionCode

Action associated with request RosettaNet PIP document, for which webMethods B2B Integration sends the response.

initiatingPartnerLocationID

Location ID of the partner. The initiating partner location ID-//ServiceHeader/ProcessControl/KnownInitiatingPartner/PartnerIdentification/locationID/Value for which webMethods B2B Integration sends the response.

For EDI documents, you can optionally add the field as a pipeline variable:

EDICustomDocument

String. Configure EDICustomDocument and provide the custom document type name, when you want webMethods B2B Integration to recognize the EDI document as the custom document type. For example, assuming X12 4010 850_Custom is the document type configured in webMethods B2B Integration, when you add a value for EDICustomDocument as X12 4010 850_Custom, webMethods B2B Integration recognizes this incoming document as X12 4010 850_Custom.

autoGenerateFA

String. Configure autoGenerateFA and set the value to true, when you want to auto generate the FA in webMethods B2B Integration. By default, the FA is generated at the interchange level. To generate the FA at group or transaction level, you must update the EDI TPA field FAGeneration/splitFAOption in webMethods B2B.

You can configure the autoGenerateFA in webMethods B2B connector submit operation and in webMethods B2B Integration EDI TPA. The value specified in the connector operation will take precedence over the TPA value.

• In most of the cases, ConversationID overrides the messageTrackingID, inReplyToGlobalBusinessActionCode and initiatingPartnerLocationID, as this information is retrieved from the request message.
• To retain the same name for the document in webMethods B2B Integration, you must define an input parameter named fileName. Define an I/O parameter in the pipeline of the Flow service on webMethods Integration. You must then map the fileName to the input parameter called params.

  For more information about define i/o see, Input and output fields

headers

Document. (Optional) Add the key and value strings of the header to the payload.

attachments

Document List. (Optional) Attachments for a message.

name

String. Name of the attachment.

inputContent

Object. Content of the attachment.

readContentAs

String. Data types in which the inputContent field value is passed.

bytes

inputContent is read as bytes.

string

inputContent is read as String.

stream

inputContent is read as a stream. If the payload is over 5 MB, you must use readContentAs as stream.

contentType

String. Content type of the attachment. For example, application/zip if the attachment is a compressed file.

encoding

String. (optional) Encoding of the attachment. The default value is UTF-8.

otherHeaders

Document. (Optional) Add the key and value strings of the header to the attachment.

endpointUrl

String. The endpoint URL of the recipient. It retrieves from the wm.ip.estd.as4.peppol:getReceiverDetails service.

Output parameters

transaction

Document. Contains the information about the transaction created in the webMethods B2B Integration.

transactionID

String. Transaction ID of the document created in webMethods B2B.

senderID

String. Sender ID of the document.

receiverID

String. Receiver ID of the document.

documentTypeID

String. Internal ID of the document type in webMethods B2B.

userStatus

String. User-defined status of the document.

transactionStatus

String. Status of the transaction submitted in webMethods B2B.

customAttributes

Document. Extracted custom attributes from inputContent. The key is the attribute name and the value is the attribute value.

The operation updates the attribute for the chosen transaction.

Input parameters

transactionID

String. Internal ID of the transaction.

isSystem

Boolean. The parameter indicates whether the attributes collection is a system or custom. Options are true or false. If isSystem is true, system attributes are expected. If it is false, then custom attributes are expected.

atttributes

Document List. (Optional) Attributes to be added or updated or deleted. The default value is empty.

attributeName

String. (Optional) Name of the document attribute for which you want to add or update or delete values. The default value is empty.

value

String. (Optional) Value for provided attribute name. Specify NONE as the value to drop the attribute entry within the transaction. The default value is empty.

allowInsertion

String. (Optional) Indicates whether to allow insertion of attribute value from the transaction. The valid options are true or false. The default value is false (AND).

atomicUpdate

String. (Optional) Indicates whether to allow the update of all the attributes as an atomic operation. (All or none or partial). The valid options are true or false. The default value is false (AND).

orderedUpdate

Document List. (Optional) if atomicUpdate is false, indicates whether to allow the ordered update of attribute value from the transaction. Valid options are true or false. The default value is false (AND).

Output parameters

updatedResponse

Document List. List of attribute updated response and statuses.

status

String. Value for status of the attribute update such as success, error, partial success.

attribute

Document List. List of attribute name, status and error.

attributeName

String. Name of document attribute for which you want to add or update, or delete values.

status

String. Value for status of the update such as failed, added, updated or deleted.

error

Document. Indicates the error information such as key, message and stack trace.

operationError

Document. Indicates the error information such as key, message and stack trace if an attribute update fails.

Validates messages in webMethods B2B Integration runtime.

The output of the constructValidateInput operation is the input parameter for the validate operation. For more information, see constructValidateInput.

Input parameters

type

String. The type of standard to use for validation. For example, hipaa.

params

Document. Input parameters as per the type selected.

Output parameters

response

Document. (Optional). The response of the operation is based on the type selected.

isValid

String. Checks the validity of HIPAA message.

• true. No errors were found during validation.
• false. Errors were found during validation.

hipaa

Document. (Optional). Document details.

functionalAck997. String. (Optional).

implementationAck999. String. (Optional).

transactionValidationAck277A. String. (Optional).

technicalAckTA1. String.

htmlReport. String. (Optional).

xmlReport. String.

invalidData. String. (Optional).

validData. String. (Optional).

hipaaIData. Document.

ISA[]

ISA segment document array.

• GS[]. GS segment array.
  • GE. GE segment array.
• IEA. IEA segment array.

errorMessage. Document. (Optional). The error message describes the error when validating the message.

operationError

Document. (Optional) Error details if the operation fails.

• message. String. The error message.
• key. String. A predefined error key.
• errorStackTrace. String. Stack trace of the error.