Integration Cloud 6.6.0 | Applications | Predefined Applications | webMethods.io B2B | Predefined Operations
 
Predefined Operations
The following predefined operations are available for webMethods.io B2B application:
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.
parseContent
Parses request content passed by the processing rule Call an integration action as bytes or string data type. For more information on Call an integration, see webMethods B2B Cloud Help
Input Parameters
inputContent
String Content passed in the integration request.
loadContentAs
String Data type in which 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.
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.
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:
Key
Description
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.
error
Document Error is a composite object containing the fields:
Key
Description
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.
submit
Submits the business documents to webMethods.io B2B product instance.
webMethods.io B2B recognizes the type of document and process it. Every document that you submit through this service is created as a new transaction in webMethods.io B2B.
Input Parameters
inputContent
Object Content to submit to webMethods.io B2B product instance for processing.
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 Specifies the type of content.
*text/xml. Content is read as an XML input.
*application/EDIStream. Content is read as an EDI InputStream.
*application/EDI. Content is read as EDI input.
*application/x12. Content is read as X12 input.
*application/UNEDIFACT. Content is read as UNEDIFACT input.
Note:
This field is case sensitive. Additionally, if you provide a type other than the one mentioned above, webMethods.io B2B identifies the document as unknown.
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 webMethods.io B2B recognizes and processes a document.
For XML documents, you can optionally add the following fields:
*DoctypeName - String The name of the document type. This field is case sensitive.
The DoctypeName field identifies the webMethods.io B2B document type to use, thus bypassing document recognition and eliminating the overhead of searching for the webMethods.io 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 webMethods.io 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 webMethods.io B2B document type for processing. For more information on pipeline matching, see the product help for webMethods.io B2B.
Output Parameters
transaction
Document Contains the following information about the transaction created in webMethods.io B2B product instance.
Key
Description
transactionID
String Transaction ID of the document created in webMethods.io 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 webMethods.io B2B product instance.
userStatus
String User-defined status of the document.
transactionStatus
String Status of the transaction submitted in the webMethods.io B2B product instance.
customAttributes
Document Extracted custom attributes from inputContent. Key is the attribute name and value is the attribute value.
params
Document A document that contains parameters that webMethods.io B2B uses to recognize and process a document.
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:
Key
Description
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.
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:
Key
Description
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.
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:
Key
Description
corporationName
String The name of the corporation.
orgUnitName
String The name of the organizational unit within the corporation.
status
String The status of the partner in your webMethods.io 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.
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.
Key
Description
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.
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 webMethods.io 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.
queryPartners
Creates a query for partner profiles and returns the first batch of matching results.
Note:
A user can execute 15 queries concurrently.
Input Parameters
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 webMethods.io 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, webMethods.io 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 webMethods.io B2B returns all the above fields including the isEnterprise and partnerID fields. For details on these values, see getCorporation
By default, the query results contain isEnterprise and partnerID fields.
Output Parameters
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.
size
String The total number of rows retrieved in the query result. The value is equal to the total number of records that webMethods.io B2B returns.
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 webMethods.io 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.
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:
*true . There are no additional rows to retrieve.
*false. There are additional rows to retrieve.
size
String The total number of records retrieved in the query result.
records
List The list of partner profiles.
Based on the values set in 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 webMethods.io 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.
resetQueryPartners
Resets the queryLocator making it available for the next concurrent execution.
Note:
The queryLocator reset involves clearing the cached results. If you do not reset a queryLocator, it remains active for 15 minutes. After which, webMethods.io B2B automatically resets it.
Input Parameters
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.
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. webMethods.io 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:
webMethods.io 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 the webMethods.io B2B displays an error message when you exceed the character limit.
transactionID
String The transaction ID of the document created in webMethods.io 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, webMethods.io 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.