B2B Utils services

generateResponse

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

Note: generateResponse does not support extensive documents.
Input parameters
inputContent
Object. Content data that is sent as part of the integration response after encoding.
readContentAs
String. Data type in which the inputContent field value is passed.
  • bytes. inputContent is read as bytes.
  • string. inputContent is read as string.
contentType
String. Content-Type passed corresponds to the inputContent field. For example, application or EDI, application or x12, text or plain and so on.
attachments
Document List. (Optional) List of attachments sent as part of the integration response, if any.
name
String. Name of the attachment.
inputContent (attachment)
Object. Content of the attachment.
readContentAs (attachment)
String. Data type in which the inputContent field value is passed.
  • bytes. inputContent is read as bytes.
  • string. inputContent is read as string.
contentType (attachment)
String. Content type of the attachment. For example, application/compressed for ZIP files.
encoding
String. (Optional) Encoding of the attachment. The default value is UTF-8.
otherHeaders
Document. (Optional) Key-value pairs of headers added to the attachment.
  • headers: Document. (Optional) Headers sent as part of the integration response.
  • errorCode: String. Error code passed as part of the integration response.
  • errorMessage: String. Error message passed as part of the integration response.
  • encoding: String. Character set used for encoding inputContent. Default is UTF-8.
Output parameters
response
Document. The response is a composite object containing the parameters:
  • Content: String. Encoded in Base64. Value is specified in encoding.
  • type: String. Value specified in contentType.
  • encoding: String. Type of encoding used to encode inputContent. Value is specified in 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. Value is specified in errorCode.
  • message: String. Error message associated with the input. Value is specified in errorMessage.

constructSubmitInput

This operation is deprecated in the webMethods B2B application and now included as a B2B Utils built-in service in webMethods Integration. Modify your integration to use this operation in the B2B Utils instead of webMethods B2B.Prepare the necessary input that is used for submitting the business documents to webMethods B2B capability instance.

Input parameters for constructSubmitInput

  • 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 value 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.
  • preferredOutboundChannelID: String. Overrides the receiver’s preferred channel in webMethods B2B and sends the document that uses the channel ID specified in this parameter.

    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 following AS2 parameters:
    • body: Document. (Optional) AS2 body document. For more information to configure inputContent, readContentAs, contentType and encoding see, Input parameters of Submit operation in webMethods B2B.
    • attachments []: Document List. (Optional). For more information to configure AS2 attachments (name, inputContent, readContentAs, contentType, encoding, and otherHeaders).
    • 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. Sends the EDIINT AS2 identity as AS2-From value when using AS2 out channel in webMethods B2B.

      as2ReceiverID: String. Sends the EDIINT AS2 identity as AS2-To value when using AS2 out channel in webMethods B2B.

  • as4: Document. Required for AS4 type document. Configure the following AS4 parameters:
  • rnif: Document. Required for RNIF type document. Configure the following RNIF parameters:
  • cXML: Document. Required for cXML type document. Configure the following cXML parameters:
    • body: Document. cXML body document. For more information on configuring inputContent, readContentAs, contentType and encoding see, Input parameters of Submit operation in webMethods B2B .
    • attachments []: Document List. (Optional). For more information on configuring cXML attachments (name, inputContent, readContentAs, contentType, encoding, and otherHeaders) .
    • params: Document. A document that provides parameters on how webMethods B2B recognizes and processes a cXML document.

      Configuring cXML params.

      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. Indicates whether the message is synchronous or asynchronous. Valid values are:

      true. Synchronous message (Two-way/Sync for replying). false. Asynchronous message (One-way messages).

      deploymentMode: String. Optional. 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 (Optional). To configure an AS4 body document.

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.
stream
xmlInputContent is read as a stream.

If the payload exceeds 5 MB, recommends using readContentAs as stream.

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.
stream
inputContent is read as stream. If the payload exceeds 5 MB, recommends using readContentAs set to 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.
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 parameters

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

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.
stream
xmlInputContent is read as stream. recommends using readContentAs as stream.
encoding
String. (Optional) Encoding of the body content.

Configuring an RNIF attachments [ ]

Document List. (Optional). To Configure a list of attachments to be use in RNIF message. This 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.
stream
inputContent is read as stream. If the payload exceeds 5 MB, recommends using readContentAs as stream.
contentType
String. Content type of the attachment.
encoding
String. (Optional) Encoding of the attachment.

Configuring an RNIF parameters

Document. A document that provides parameters on how webMethods B2B recognizes and processes a 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.

parseContent

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

Note: parseContent does not support extensive document.
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.
encoding
String. Type of character set used for encoding inputContent value. This can be any IANA registered character set. Default UTF-8.
Output parameters
outputContent
Object. Content data corresponds to the data type option set for the loadContentAs field.