webMethods_io_B2B

addOrUpdatePeppolPartner

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

• The partner name is the CNAME of the certificate. CName is the subject common name (CN) in the Peppol Access Point public certificate issued to the recipient Access Point by the Peppol organization. It is located in the details tab of the certificate Subject > CN field.
• The externalID value is in the format CNAME(participantID) and participantID, configured under IDType urn:FDC:peppol.eu:2017:identifiers:ap in the corresponding partner profile. For example: POP000143(0151:79000024733) and 0151:79000024733.
• The certificate is configured under certificates for encryption and signing in the corresponding profile. When the partner already exists in IBM webMethods B2B, the certificate gets updated in the corresponding IBM webMethods B2B partner profile.
• An outbound AS4 channel is created. When the outbound AS4 channel already exists in IBM webMethods B2B, and there is a change in the input parameter endpointURL, the new endpoint URL gets updated in the corresponding IBM webMethods B2B channel.

The caCertificateChain input field is optional. The matching root and intermediate certificates issued by Peppol are used as 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. (Optional). A byte array that represents the X509 certificate (a java.security.cert.X509Certificate) of the issuer of the certificate.
• forceUpdateCertificate: String. (Optional). Indicates whether to update the certificate in IBM webMethods B2B 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 IBM webMethods B2B partner profile.
• errors: String. Specifies an error message while processing a document.

addTransactionContentPart

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 form in which content field value is passed.
  • bytes. If the value is bytes.
  • string. If the value is string.
  • stream. If the value is stream. IBM recommends you to use readContentAs as stream if the size of the payload is over 5 MB.
• 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. Default character set is UTF-8.
  Note: The mimeType and content are not validated to be compatible with each other.

Output Parameters

• isUpdated: Boolean. Indicates whether the content is added or not.
• partIndex: Integer. The position of the content part 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.

changeUserStatus

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. Character length limit is 255.

Output Parameters

• isUpdated: String. Indicates if 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.

constructSubmitInput

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

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. This 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 following AS2 parameters:
  • body: Document. (Optional) AS2 body document. For more information to configure inputContent, readContentAs, contentType and encoding see, Input parameters of Submit.
  • attachments []: Document List. (Optional). For more information to configure AS2 attachments (name, inputContent, readContentAs, contentType, encoding and otherHeaders) see, the submit operation.
  • headers: Document. (Optional) Add key and value strings of the header to the payload.
  • params: Document. A document that provides parameters on how IBM webMethods B2B recognizes and processes a AS2 document.

    as2SenderID: String. Sends the EDIINT AS2 identity as AS2-From value when using AS2 out channel in IBM webMethods B2B.

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

• as4: Document. Required for AS4 type document. Configure the following AS4 parameters:
  • body: Document. (Optional) AS4 body document. See Configuring AS4 body.
  • attachments []: Document List. (Optional) AS4 attachments. See Configuring AS4 attachments .
  • params: Document. A document that provides parameters on how IBM webMethods B2B recognizes and processes a AS4 document. See Configuring AS4 params.
• rnif: Document. Required for RNIF type document. Configure the following RNIF parameters:
  • body: Document. RNIF body document. See Configuring RNIF body.
  • attachments []: (Optional) Document List. List of attachments to be used in RNIF message. See Configuring RNIF attachments .
  • headers: Document. (Optional) Add key and value strings of the header to the payload for an outbound message.
  • params: Document. A document that provides parameters on how IBM webMethods B2B recognizes and processes a RNIF document. See Configuring RNIF params.
• 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.
  • attachments []: Document List. (Optional). For more information on configuring cXML attachments (name, inputContent, readContentAs, contentType, encoding and otherHeaders) see, submit_attachments.
  • params: Document. A document that provides parameters on how IBM 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 if 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 IBM 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 IBM 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.

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

• name: String. (Optional when only body is sent) Name of the payload content.
• xmlInputContent: Object. XML content to submit to the IBM webMethods B2B product instance for processing. This 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 string.
• encoding: String. (Optional) Type of character set used for encoding xmlInputContent value. This 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.

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

• name: String. Name of the attachment content.
• inputContent: Object. Content of the attachment. It is sent as SOAP attachments.
• readContentAs: String. Data type in which inputContent field value is passed.
  • bytes. inputContent is read as bytes.
  • string. inputContent is read as string.
• contentType: String. Content type of the attachment. For example, application/zip if the attachment is .zip 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.

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

• messageId: String. (Optional) Unique identifier of the message. When 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. 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. For no agreementRef element in the final payload, agreementRef and pmodeId values in the service input and TPA agreement field should be empty.
  • service: String. (Required when PmodeId or agreementRef is not specified) Name of the service use to identify the RequestUM leg used for the current transaction. IBM webMethods B2B uses the service and action parameters to determine which RequestUM leg to use for the current transaction. IBM webMethods B2B compares the value of this parameter to the value of leg/businessInfo/service that is configured in all RequestUM legs of the TPA. The RequestUM leg that contains a match for both the service and action parameters is the leg that will be used for the current transaction. When there is only one RequestUM leg configured in the TPA, the service parameter does not have to be defined.
  • action: String. (Required when PmodeId or agreementRef is not specified) Name of action use to identify the RequestUM leg used for the current transaction. IBM webMethods B2B uses the service and action parameters to determine which RequestUM leg to use for the current transaction. IBM webMethods B2B compares the value of this parameter to the value of leg/businessInfo/action that is configured in all RequestUM legs of the TPA. The RequestUM leg that contains a match for both service and action is the leg that will be used for the current transaction. When there is only one RequestUM leg configured in the TPA, the action parameter does not have to be defined.
  • serviceType: String. (Optional) Name of the service type that indicates how the sender and receiver will interpret 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 zero or more Property child elements within Messaging/UserMessage/MessageProperties.

    name: String. The name of property.

    value: String. The value of property.

    type: String. (Optional) The type of property.

  • endpointUrl: String. Endpoint address 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 has to 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 has to 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 below details:

    element: String. The name of the attribute.

    elementvalue: String. The value of the attribute.

    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.

Document. To configure an RNIF body document.

• xmlInputContent: Object. XML content to submit to the IBM webMethods B2B product instance for processing.
• readContentAs: String. Data type in which inputContent field value is passed.
  • bytes. xmlInputContent is read as bytes.
  • string. xmlInputContent is read as String.
• encoding: (Optional) String. Encoding of the content body.

Document List. 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 type in which inputContent field value is passed.
  • bytes. inputContent is read as bytes.
  • String. inputContent is read as String.
• contentType: String. Content type of the attachment.
• encoding: (Optional) String. Encoding of the attachment.

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

• rnif20: Document. Configure the following parameters:
  • pipInfo: (Optional) Document. Document that represents RNIF 2.0 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 executing 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 executing 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.

    enableSyncResponse: (Optional) Boolean. The flag to indicate that the transaction is expecting a sync response. Valid values are:

    true: The transaction is expecting a sync response.

    false: The transaction is not expecting a sync response. This is by default.

  • response: (Optional) Document. Response is a composite object containing the parameters.

    messageTrackingID: String. Unique instance identifier to identify message.

    inReplyToGlobalBusinessActionCode: (Optional) String. Action associated with request RosettaNet PIP document, for which IBM webMethods B2B sends the response.

    initiatingPartnerLocationID: String. Location ID of the partner. The initiating partner location ID: //ServiceHeader/ProcessControl/KnownInitiatingPartner/PartnerIdentification/locationID/Value for which IBM webMethods B2B sends the response.

• rnif11: Document. Configure the following parameters:
  • pipInfo: (Optional) Document. Document that represents RNIF 1.1 Partner Interface Processes Information (PIP).

    senderFocalRole: String. Validator of 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 executing PIP, activity, or action.

    receiverFocalRole: String. Validator of 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 executing 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:(Optional)Document. Response is a composite object containing the parameters.

    actionIdentityInstanceIdentifier: String. Unique instance identifier to identify message.

    inReplyToGlobalBusinessActionCode: (Optional) String. Action associated with request RosettaNet PIP document, for which IBM webMethods B2B sends the response.

Output Parameters

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

downloadTransactionContentParts

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. IBM webMethods B2B does not ensure the sequence of retrieved contentPartNames. IBM recommends that you 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 content part retrieved from the transaction has the following fields:

    partName: String. Name of the contentPart.

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

    length: Integer. Size of the content 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 large document or not.

    content: Stream. The content payload of the contentPart.

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

generateResponse

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

Input Parameters

• inputContent: Object. Content data sent as part of integration response after encoding.
• readContentAs: String. Data type in which 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 inputContent field. For example, application/EDI, application/x12, text/plain and so on.
• 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 type in which inputContent field value is passed.

    bytes. inputContent is read as bytes.

    string. inputContent is read as String.

  • contentType: String. Content type of the attachment. For example, application/zip if the attachment is .zip file.
  • encoding: String. (Optional) Encoding of the attachment. 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. This can be any IANA registered character set. Default UTF-8.

Output Parameters

• response: Document. 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 the 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.

getAddresses

Retrieves all addresses of a partner.

Input Parameters

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

Output Parameters

• addresses: Document List. List of addresses, each containing the following 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 ZIP code or postal code for the address.
  • stateProvince: String. The state or province for the address.
  • addressType: String. Type of address. For example, corporate or contact address of the partner.
  • partnerID: String. The internal identifier of the partner.
• extendedFields: Document List. The extended fields for the address. Each extended field is in the following structure:
  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.

getChannel

Retrieves the channel details from the channel name.

Input Parameter

channelName: String. Name of the channel provided in IBM 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.

getContacts

Retrieves all contacts of a partner.

Input Parameters

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

Output Parameters

• contacts: Document List. List of contact details each containing the following information:
  • firstName: String. The first name of the contact.
  • lastName: String. The last name 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 e-mail 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. Each extended field is in the following structure:
  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.

getControlnumber

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

Input Parameters

• type: String. The control number type.
  • For an interchange control number, type ENVELOPE.
  • For group control numbers, type the value set in the Group field of Control number definition in IBM webMethods B2B. For example, for ANSI X12 4010 850, type PO.
  • For transaction control number, type transaction.
• 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 always incremented.
• pad: String. (optional) If enabled, returns a nine digit control number by appending leading zeroes if the length of control number is less than nine digits. If disabled, it returns the control number as retrieved from the table. For transactions, control numbers are always padded.
• scope: Document. (optional) This is applicable only to groups and interchange documents.
• senderIdentityValue: String. For ANSI X12 and UN/EDIFACT, the external ID of the partner. For example, the sender's D-U-N-S number. For TRADACOMS, it is the sender name specified in the transmission.
• senderQualifier: String. For ANSI X12 and UN/EDIFACT, the EDI ID qualifier for the sender, for example, 01 for a D-U-N-S number. For TRADACOMS, it is the sender code specified in the transmission.
• receiverIdentityValue: String. For ANSI X12 and UN/EDIFACT, the external ID of the partner, for example, the receiver's D-U-N-S number. For TRADACOMS, it is the receiver name specified in the transmission.
• receiverQualifier: String. For ANSI X12 and UN/EDIFACT, the EDI ID qualifier for the receiver, for example, 01 for a D-U-N-S number. For TRADACOMS, it is the receiver code specified in the transmission.
• standard: String. The EDI standard associated with the control number. Specify one of the following: X12, UNEDIFACT, VICS, UCS, EANCOM, ODETTE, TRADACOMS, or VDA.
• mode: String. (optional) The mode associated with the control number. Specify one of the following: Production (default), Test, or Custom.
  Note: For TRADACOMS, the only valid value is Production.
• version: String. (optional) Version of the EDI standard for the control number, for example, 4010. For a TRADACOMS envelope, it is the version is always 1. For a TRADACOMS batch, it is the version is the version number of the file type. For example, for the file type ORDHDR:5, the version is 5.

Output Parameters

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

getCorporation

Retrieves the corporation information of a partner.

Input Parameters

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

Output Parameters

• corporate: Document List. Contains the following 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 IBM webMethods B2B. This value can be Active or Inactive.
  • isEnterprise: Boolean Indicates if the partner profile represents the enterprise profile. Valid values are:

    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. Each extended field has the following structure:
  Note: If there are no extended fields for the group, then this field appears blank.

  name: String. The name of extended field.

  value: String. The value of the extended field.

getExtendedFields

Retrieves a set of extended fields for a partner.

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

Input Parameters

• 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. You can specify one of the following standard field groups:
  • 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 above standard field groups, you can also specify the groups created under the Field Groups section in IBM webMethods B2B.

Output Parameters

• groups: Document List. The extended field group details of the extended fields. Each extended field group is in the following format:
  • 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. Following are the fields:

    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.

getFAReport

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

This operation fetches the transactions from the live dataSource only.

Input Parameters

• 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 of the transaction.
• senderIdentity: Document List. (Optional). The external IDs of the sender for the transaction.
  • code: The ID type. For more information on the supported list of codes, see (/saas/webmethods-b2b/webmethods_io_b2b_online_help/chapter14/#re-profile_id_types_mapping).
  • value: The value of external ID configured for the ID type.
• receiverIdentity: Document List. (Optional). The external IDs of the receiver of the transaction.
  • code: The ID type. For more information on the supported list of codes, see (/saas/webmethods-b2b/webmethods_io_b2b_online_help/chapter14/#re-profile_id_types_mapping).
  • value: The value of external ID configured for the ID type.

• faStatus: String List. (Optional). FA status of the transaction. The following are the accepted values:
  • ACCEPT
  • ACCEPT_ERROR
  • ACCEPT_PARTIAL
  • DISABLE
  • DUPLICATE
  • DUPLICATE_FA
  • ERROR
  • FA_ERROR
  • INTERCHANGE_RECEIVED
  • NONE
  • REJECT
• groupType: String. (Optional). 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). The number of transactions retrieved as an output per execution of this operation. 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. The possible formats are CSV, JSON, and HTML. The default format is CSV.

Output Parameters

• totalCount: Number. Total count of transactions.
• isIterate: Boolean. Indicates if the transactions are present after the iteration. Run this operation until the last transaction matches the input criteria.
• transactions: Document List. Indicates the details of the transaction created in IBM webMethods B2B.
• transactionID: String. The ID of the transaction. This is an internal unique identifier for the document.
• documentTypeName: String. Document type name for the recognized IBM webMethods B2B document type.
• senderName: String. The partner display name of the sender of the document.
• receiverName: String. The partner display name of the receiver of the document.
• envelopeID: String. The envelope control number.
• groupID: String. The group control number.
• transactionSetID: String. The transaction set control number.
• groupType: String. The group header code. For example, PO, IN.
• groupVersion: String. The group version of the document.
• transactionTimestamp: String. The time at which the transaction was logged. For example, Feb 18, 2019, 08:45:02 PM.
• faTimestamp: String. The time at which the FA was sent. For example, Feb 18, 2019, 08:45:02 PM.
• faStatus: String. Functional Acknowledgement (FA) status of the transaction.
• relatedTransactionID: String. Internal ID of the related transaction.
• report: String. The generated FA report.

getIDTypeCodes

Retrieves the list of ID types from IBM webMethods B2B.

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 IBM webMethods B2B.

  name: String. Name of the ID type.

  codes: String. Codes of the ID type.

getPartnerID

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.

getPartnerIdentities

Retrieves all external IDs of a partner.

Input Parameters

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

Output Parameters

• identities: Document List. Contains the following 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 *. Each extended field has the following structure:
  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.

getRelatedTransactions

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 will be removed in the upcoming releases. It is not intended to be used in production.
• includeTransactionDetails: Boolean. Includes the transaction details such as senderID, receiverID, documentTypeID, userStatus, transactionStatus, and customAttributes when you set the value to true. The default value 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 that either you set using the relateTransactions operation, or a system-set relationship string value.
  • details: Document The details that are included when you set the includeTransactionDetails to true. The details are as follows:

    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.

getTaskInfo

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 will be removed in the upcoming releases. It is not intended to be used 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 has to 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. The time is displayed in the ISO 8601 format with UTC time zone, for example, 2018-11-24T19:30:00Z.
• timeUpdated: String. The time when the task was updated. The time is displayed in the ISO 8601 format with UTC timezone, for example, 2018-11-24T19:30:00Z
• receiverID: String. The internal ID for the receiver. Receiver refers to the receiver of the transaction to which this task is associated.
• senderID: String. The internal ID of the sender. Sender refers to the sender of the transaction to which this task is associated.

getTransactionByDocumentID

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

Input Parameters

• documentID: String. Document ID for which you want to get the transaction from IBM webMethods B2B.
• duration: String. The time duration with respect to the current time between which you want to search for the transaction (currenttime - duration). The format of the duration must be of the form nM, nH, nD and n should be a positive number ranging from 1 to 9999999999. The valid ranges are: 1M-10080M, 1H to 168H, and 1D to 7D, not exceeding a duration of 7 days in total.
• dataSource: String. (optional - default live) Search in either the live or archive transactions list.
  Warning: This data source parameter will be removed in the upcoming releases. It is not intended to be used 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 given duration.

getTPA

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

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 sender or the receiver does not exist. Valid values are:
  • true. The operation only looks for a TPA where the sender or receiver are as specified.
  • false. (Default value) 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 specified receiver and the receiver matches the specified sender. Returns the TPA if found.

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 IBM webMethods B2B created the TPA.
  • lastModified: String. The time that IBM webMethods B2B last updated the TPA either when the TPA was created or last updated.
  • status: String. The agreement status of the TPA, which indicates whether the TPA is a draft or final version and whether the agreement is active or not. Valid values are:

    Proposed. The TPA is in draft status.

    Agreed. The TPA is in the final status.

    Disabled. The TPA is in disabled state.

  • templateID: String. TPA template that defines the blueprint of the TPA, that is, establishes the TPA parameters and values.
  • dataStatus: String. Indicates if you can update the values in tpaData. This field is only used when status is Agreed. Valid values are:

    Modifiable. The data in tpaData can be modified.

    Non-modifiable. The data in tpaData cannot be modified.

  • tpaData: Document. It contains the data for the TPA.
  • version: String. The version number of the TPA.
  • tpaID: String. A unique ID for the TPA that IBM webMethods B2B generates.

getTransactionContentParts

Retrieves the necessary content parts of a transaction. A content part can be a segment of a document or an attachment retrieved during the processing of submitted content. IBM webMethods B2B does not ensure the sequence of retrieved contentPartNames. IBM recommends that you validate the sequence of the partName before you map the contentPartNames further in the flow service pipeline.

Input Parameters

• transactionID: String. ID of transaction for which content parts related to specified contentPartNames are retrieved.
• contentPartNames: String. list (Optional) Names of the content parts that are retrieved. If either the parameter value is empty or if this parameter is 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) database or the archive database.
  • live. The transactionID is looked up in the live (production) database tables. This is chosen as the default option if no value is specified.
  • archive. The transactionID is looked up in the archive database tables. Warning: This data source parameter will be removed in the upcoming releases. It is not intended to be used in production.

• formatData: Boolean (Optional) Displays the format of the data in the output.Valid values are:
  • true. Formats to default EDI payload.
  • false. Unformatted EDI payload.

Output Parameters

• contentResponse: Document. Response that contains content parts associated with valid contentPartNames for the specified transactionID.
  • contentParts: Document List. Content part retrieved from the transaction has the following fields:- partName: String. Name of the contentPart. - partIndex: Integer. Index of the contentPart. The index starts from zero. - length: Integer. Size of the content 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. The type of content is determined by the loadContentAs parameter.
  • count: Integer. The count of valid content parts that are retrieved from the transaction.

getTransactionSenderReceiver

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 will be removed in the upcoming releases. It is not intended to be used in production.

Output Parameters

• sender: Document. A subset of sender information. Based on the values set in the sender, you can view the following information:
  • 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 if the partner profile is the enterprise itself. The value can be either false or true.
  • status. String. The status of the partner in your IBM webMethods B2B instance. The value can be either Active or Inactive.

• receiver: Document. A subset of receiver information. Based on the values set in the sender, you can view the following information:
  • 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 if the partner profile is the enterprise itself. The value can be either false or true.
  • status. String. The status of the partner in your IBM webMethods B2B instance. The value can be either Active or Inactive.

log

Adds an entry into the activity log.

Input Parameters

• type: String. (Optional) The type of activity log entry. The supported types are: ERROR, WARNING, and MESSAGE.
• category: String. (Optional) The category for the activity log entry. IBM webMethods B2B supports either the following categories or any custom value:
  • General. Any unspecified error messages and warnings.
  • Processing. Processing a document using a processing rule to be used.
• message: String. A brief message for the activity log entry. The value can be a string with maximum of 240 characters.
  Note: IBM webMethods B2B 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 maximum of 1024 characters.
  Note: If IBM webMethods B2B displays an error message when you exceed the character limit.
• transactionID: String. The transaction ID of the document created in IBM webMethods B2B product instance 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 maximum size of the content is 2 MB.
  Note: If the content size exceeds 2 MB, IBM webMethods B2B displays an error message.
• readContentAs: String. (Optional) Data type in which content field value is passed.
  • bytes. content is read as bytes.
  • string. 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.

parseContent

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

Input Parameters

• inputContent: String. Content passed in the integration request.
• loadContentAs: StringData type in which 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.

queryMorePartners

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 additional rows to retrieve. Valid values are:

• 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 the 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 IBM webMethods B2B. This value can be Active Or Inactive.
  • isEnterprise. Object. Indicates if the partner profile represents the Enterprise profile.
  • partnerID. String. The internal identifier of the partner.

queryPartners

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. You can provide a value between 20 and 500. The default is 100.
  Note: If you provide a value outside the specified range, then IBM webMethods B2B displays an error message.
• criteria: Document (Optional) The criteria to filter the query results. Provide the following details:
  • isOrQuery. String. Whether the join condition for the filter criteria that you specify in between the fields variable is true (OR) or false (AND). 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, IBM webMethods B2B will select 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. The filter criteria for fieldName. Each document in the document list contains the following variables:

    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 ? 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) The field name by which the results must be sorted. Each document in the document list contains the following variables:
  • fieldName: String. The field name for sorting.

    corporationName

    orgUnitName

    status

  • isAscending - Document. The order by which the result set must be sorted (ascending or descending). The valid values are ASC (ascending) or DESC (descending).
• resultFields: String list. (Optional) The list of fields in the result set. Valid values are:
  • corporationName
  • orgUnitName
  • status

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

Output Parameters

• queryLocator: String. The ID of the executed query 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 the query has additional rows to retrieve. This is used in the queryMorePartners operation. Valid values are:
  • true. There are no additional rows to retrieve.
  • false. There are additional rows to retrieve.

• records: List. The list of partner profiles. Based on the values set in the 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 IBM webMethods B2B. This value can be Active Or Inactive.
  • isEnterprise. Boolean Indicates if the partner profile represents the Enterprise profile. The values are true Or false, indicating an enterprise or non-enterprise respectively.
  • partnerID. String. The internal identifier of the partner.

queryTaskIDs

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 will be removed in the upcoming releases. It is not intended to be used in production.
• criteria: Document. (Optional) Criteria to identify task IDs.
  • dateRange: Document. (Optional) Contains start and end date which are compared with the task creation time.

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

    endDate: String. (Optional) Indicates the end date. Specify the 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) Indicates the 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. The operator for the filter criteria. The valid values depend on the field type of the fieldName variable. The possible values are: IS NULL, IS NOT NULL, =, <,>.

    value: String. (Optional) The value for the filter criteria. ? should be used 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) The column name for sorting.
  • orderDirection: String. (Optional) The order by which the results set must be sorted (ascending or descending). The possible values are: ASC and DESC. The default value is ASC.

Output Parameters

• taskIDs: String. List List of task retrieved. Only a maximum of 1000 are returned even if the value mentioned in the count field is higher.
• count: String. Total number of task IDs that were identified by the criteria.

queryTransactions

Retrieves the transactions that match the specified criteria.

Input Parameters

• batchNumber: Integer. (Optional). Specifies the batch number from which the 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 the transactions. Specify the following:
• dateRange: Document. Date range to retrieve the transactions. The maximum date range 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 UTC timezone. 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 UTC timezone. 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 timezone (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 fieldName parameter.

    operator: String. The supported operators are:

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

    Single-value operators: BEFORE and AFTER. These are applicable only for DATE type attributes. Note that 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. 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.
• 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. Indicates if the partner is the enterprise. Possible values are: True and False.
  • status: String. The status of the partner on IBM webMethods B2B.
  • deleted: Boolean. Indicates if the partner profile is deleted. Possible values are: True and False.
  • receiver: Document. A subset of the 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. Indicates if the partner is the enterprise. Possible values are: True and False.
  • status: String. The status of the partner on IBM webMethods B2B. Possible values are: Active and Inactive.
  • deleted: Boolean. Indicates if the partner profile is deleted. Possible values are: True and False.
  • documentType: Document. A subset of the 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 IBM webMethods B2B.
  • attributes: Document. Retrieves the name and value of the attribute based on the attributeName string in includeAttributes document list as key and value pair in the format: .
• totalBatches: Integer. Specifies the total number of transaction batches that match the specified 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 to run.
  • message: String. Specifies the error message.
  • key: String. Specifies a predefined error key.
  • errorStackTrace: String. Specifies the stack trace of the error.

relateTransactions

Creates a one-way relationship between two transactions.

Input Parameters

• fromTransactionID: String. The internal ID of the transaction that indicates from which transaction the relationship must be established.
• toTransactionID: String. The internal ID of the transaction that indicates to which transaction the relationship is established.
• relationship: String. A string that describes the relationship. The maximum string length should not exceed 255 characters.

Output Parameters

• isUpdated: Boolean. The flag that indicates if the relationship is created. The possible values are true and false.
  • true. The service established the relationship.
  • false. The service did not establish the relationship.

resetQueryPartners

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.

restartTask

Restarts a failed or stopped task.

Input Parameters

• taskID: String. The internal identifier of the task.

Output Parameters

• isTriggered: Boolean. The flag that indicates if the restart is triggered. The possible values are: true and false.
  • true. The restart is triggered.
  • false. The restart is not triggered.

reprocess

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

Input Parameters

• transactionIDs: String List. List of transaction IDs of IBM webMethods B2B to reprocess. You can get the transactionID when you submit a document to IBM webMethods B2B. 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.

resubmit

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

Input Parameters

• transactionIDs: String List. List of transactionIDs of IBM webMethods B2B to resubmit. You can get the transactionID when you submit a document to IBM webMethods B2B. 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.

retrievePeppolParticipantDetails

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 identifier 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.

submit

Submits the business documents to IBM webMethods B2B product instance.

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

Input Parameters

• inputContent: Object. Content to submit to the IBM webMethods B2B product instance for processing.
• readContentAs: String. Data type in which inputContent field value is accepted.
  • bytes. inputContent is read as bytes.
  • string. inputContent is read as string.
  • stream. inputContent is read as stream. IBM recommends you to use readContentAs as stream if the size of the payload is over 5 MB.
• contentType: String.Specifies the type of content.
  • text/xml. Content is read as an XML input.
  • application/EDIStream. Content is read as an EDI InputStream. IBM recommends to use application/EDIStream for large EDI documents.
  • 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. Additionally, if you provide a type other than the one mentioned above, IBM webMethods B2B 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 can be any IANA registered character set. Default: UTF-8
• params: Document. A document that provides parameters to govern how IBM 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 following fields as a Pipeline Variable :
  • DoctypeName - String. The name of the document type. This field is case-sensitive. The DoctypeName field identifies the IBM webMethods B2B document type to use, thus bypassing document recognition and eliminating the overhead of searching for the IBM webMethods B2B 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 IBM webMethods B2B 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 IBM webMethods B2B document type for processing. For more information on pipeline matching, refer Adding RosettaNet PIP Document in IBM webMethods B2B documentation.

  For RosettaNet Partner Interface Processes (PIPs), add the following 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, 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 executing PIP, activity, or action. For details on partner role, refer Table 3-1 : Partner role description of the PIP specification document.

    receiverFocalRole - Role of the fulfiller partner, for example, 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 executing PIP, activity, or action. For details on partner role, refer Table 3-1 : Partner role description of the PIP specification document.

    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 - Indicates if the transaction is expecting a sync response. Disabled by default.

  • response. Document. Response is a composite object containing the parameters. It contains the following fields:

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

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

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

  For EDI documents, you can optionally add the following field as a Pipeline Variable:

  • EDICustomDocument - String. Configure EDICustomDocument and provide the custom document type name, when you want IBM webMethods B2B to recognize the EDI document as the custom document type. For example, assuming X12 4010 850_Custom is the document type configured in IBM webMethods B2B, when you add a value for EDICustomDocument as X12 4010 850_Custom, IBM webMethods B2B 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 IBM webMethods B2B. 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 IBM webMethods B2B.

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

  Note:

  • 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 IBM webMethods B2B, you must define an input parameter named fileName. You can do this by defining an I/O parameter in the pipeline of the Flow service on IBM webMethods Integration. You must then map the fileName to the input parameter called params.

    For more information on Define i/o see, Input and Output Fields Declaration

• headers: Document. (Optional) Add 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 type in which inputContent field value is passed.

    bytes. inputContent is read as bytes.

    string. inputContent is read as String.

    stream. inputContent is read as stream. IBM recommends you to use readContentAs as stream if the size of the payload is over 5 MB.

  • contentType: String. Content type of the attachment. For example, application/zip if the attachment is .zip file.
  • encoding: String. (optional) Encoding of the attachment. Default value is UTF-8.
• otherHeaders: Document. (optional) Add key and value strings of the header to the attachment.
• endpointUrl: String. Endpoint address of the recipient. It retrieves from the wm.ip.estd.as4.peppol:getReceiverDetails service.

Output Parameters

• transaction: Document. Contains the following information about the transaction created in the IBM webMethods B2B product instance.
  • transactionID: String. Transaction ID of the document created in the IBM webMethods B2B product instance.
  • senderID: String.Sender ID of the document.
  • receiverID: String. Receiver ID of the document.
  • documentTypeID: String. Internal ID of the document type in the IBM webMethods B2B product instance.
  • userStatus: String. User-defined status of the document.
  • transactionStatus: String.Status of the transaction submitted in the IBM webMethods B2B product instance.
  • customAttributes: Document. Extracted custom attributes from inputContent. Key is the attribute name and value is the attribute value.

updateAttribute

Updates the attribute for the chosen transaction.

Input Parameters

• transactionID: String. Internal ID of the transaction.
• isSystem: Boolean. Indicates whether the attributes collection is system or custom. Options are true or false. If isSystem is true, only 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. Default value is empty.
  • attributeName: String. (Optional) Name of the document attribute for which you want to add or update or delete values. 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. Default value is empty.

• allowInsertion: String. (Optional) Indicates whether to allow insertion of attribute value from the transaction. Options are true or false. 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). Options are true or false. 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. Options are true or false. 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 only if an attribute updation fails.