AS2
AS2 Predefined OperationsreceivesendConfiguring the Auto Detect OptionCreating an Endpoint URLAS2 (Applicability Statement 2) is a communication protocol developed by the Internet Engineering Task Force (IETF) for the exchange of business-to-business (B2B) transactions over the Internet securely. The AS2 application uses the HTTP transport protocol along with Multipurpose Internet Mail Extensions (MIME). The AS2 application governs the means of connection and exchange of data securely and reliably. Besides the advanced security features, the AS2 application offers the following additional benefits:
- Privacy
- Authentication
- Nonrepudiation of origin and receipt of the message
- Data integrity
The AS2 application provides a medium to exchange business data with partners by configuring an account in IBM webMethods Integration. The application supports the AS2 protocol versions 1.1 and 1.2.
Field | Description |
---|---|
Recipient Endpoint | The endpoint URL of the recipient. |
Authorization Type | The type of HTTP authorization scheme to use
for the connection. You can choose one of the following options:
|
From | The AS2 ID of the sender. |
To | The AS2 ID of the recipient. |
Preemptive Auth | Preemptive authentication of the recipient. The default value is false.
|
Response Timeout | The number of milliseconds the application waits for a response before canceling its attempt to connect to the back end. In case the network is slow or the back end processing takes longer than usual, increase the Response Timeout value. It is recommended to specify a value other than 0. If you specify 0, the application will wait indefinitely for a response. |
Retry Count on Response Failure | The number of times the application attempts to connect to the back end to read a response if the initial attempt fails. If an I/O error occurs, it will retry only if you have selected the Retry on Response Failure option. |
Retry on Response Failure | Whether the application should attempt to resend the request when the response has failed, even though the request was sent successfully. Select this option if you want to re-establish the connection. |
Trust store Alias | Select the alias name of the IBM webMethods Integration trust store configuration from the list. The trust store contains trusted certificates used to determine trust for the remote server peer certificates. Select New Certificate > New Truststore to add a new trust store from this list. |
Keystore Alias | Select the alias for the IBM webMethods Integration keystore configuration. This is a text identifier for the keystore alias. A keystore file contains the credentials (private key/signed certificate) that a client needs for authentication. Select New Certificate > New Keystore to add a new keystore from this list. |
Client Key Alias | Alias to the private key in the keystore file specified in the Keystore Alias field. The outbound connections use this key to send client credentials to a remote server. To send the client’s identity to a remote server, you must specify values in both, Keystore Alias and Client Key Alias fields. |
Hostname verifier | Select a hostname verifier implementation
for guards against man-in-the-middle (MITM) attacks from the list. The default
is
org.apache.http.conn.ssl.DefaultHostnameVerifier .
This enables hostname verification. Select
org.apache.http.conn.ssl.NoopHostnameVerifier
from the list to disable hostname verification.
|
Username | The name of the user account that the AS2 connection will use to connect to the AS2 provider. |
Password | The password for the user name provided in the Username field. |
Compression | Select this option to compress an outbound AS2 message. |
Sign Message | Select this option to sign an outbound AS2 message. |
Signing Algorithm | The signing algorithm to use for an outbound
AS2 message. The available options are:
|
Signing Keystore and Key Aliases | The keystore aliases and the key aliases in the keystore to use for signing an outbound AS2 message. |
Receive Signed Message | Select this option to receive a signed
inbound AS2 message. If you select this option and the incoming AS2 message is
not signed, then an
Insufficient message security error is
encountered and shared with the sender if MDN is requested by the sender.
|
Signature Verification Certificate | The certificate to use for verifying an inbound signed AS2 message. |
Encrypt Message | Select this option to encrypt an outbound AS2 message. |
Encryption Algorithm | The encryption algorithm to use for an
outbound AS2 message. The available options are:
|
Encryption Certificate | The certificate to use for encrypting an outbound AS2 message. |
Receive Encrypted Message | Select this option to receive an encrypted
inbound AS2 message. If you select this option and the incoming AS2 message is
not encrypted, then an
Insufficient message security error is
encountered and shared with the sender if MDN is requested by the sender.
|
Decryption Keystore and Key Aliases | The keystore aliases the key aliases in the keystore to use for decrypting an inbound AS2 message. |
Request MDN | Whether you want the recipient to return an
MDN to the sender.
You can select one of the following options:
|
Request Signed MDN | Select this option if you want the recipient
to sign an AS2 MDN.
Ensure that you also select an option in the Request MDN field if you want the recipient to sign and return an AS2 MDN. |
Asynchronous MDN Endpoint | Type your endpoint URL that accepts an inbound AS2 MDN if you selected the Asynchronous option for Request MDN. |
AS2 Version | Select the AS2 protocol version to use from the list. |
Enable Connection Pooling | Select this option if you want to enable connection pooling for a connection.
For more information, see Account configuration fields. |
Minimum Pool Size | The minimum number of connection objects that remain in the connection pool at all times, if connection pooling is enabled. For more information, see Account configuration fields. |
Maximum Pool Size | The maximum number of connection objects that can exist in the connection pool if connection pooling is enabled. For more information, see Account configuration fields. |
Pool Increment Size | The number of connections by which the pool will be incremented, up to the maximum pool size, if connection pooling is enabled and connections are needed. |
Block Timeout (msec) | The duration in milliseconds that IBM webMethods Integration waits to obtain a connection with the SaaS provider before the connection times out and returns an error. For more information, see Account configuration fields. |
Expire Timeout (msec) | The duration in milliseconds that an inactive connection can remain in the pool before it is closed and removed from the pool, if connection pooling is enabled. For more information, see Account configuration fields. |
Session Management | The session management scheme selection determines how a session or access token is handled for a given SaaS provider. For more information, see Account configuration fields. |
Session Timeout (min) | The duration in minutes that IBM webMethods Integration waits before refreshing a session. For more information, see Account configuration fields. |
Enable SNI | Server Name Indication (SNI) is an extension to the TLS protocol by which a client indicates which host name it is attempting to connect to at the start of the handshaking process. Enable this option if the SaaS provider offers SNI-based TLS connectivity, and if you want to connect to an SNI enabled SAAS provider to send the host name specified in the Server URL field, as part of the TLS SNI Extension server_name parameter. |
SNI Server Name | If you want to explicitly specify a host name to be included as a part of the SNI extension server_name parameter, in case the host name is other than the host name specified in the Server URL field, specify the host name value in the SNI Server Name field. |
AS2 Predefined Operations
The following predefined Applicability Statement 2 (AS2) operations are available:
- receive
- send
receive
Receives an AS2 message from a recipient.
You can perform the following configurations in the AS2 application using the receive service.
Input Parameters
contentStream | Object Receives an AS2
message of content type other than
application/xml .
|
|
node | Object Optional. Receives an
AS2 message of content type
application/xml only.
|
Output Parameters
status | String Status of an inbound message. | |||
statusMessage | String Processing status of an inbound message. | |||
request | Document Receives the raw stream, extracted payload, and attachments of an inbound message. | |||
stream | Object Raw output stream received by an application. | |||
headers | Document AS2 message headers. | |||
AS2-To | String AS2 ID of the recipient. | |||
AS2-From | String AS2 ID of the sender. | |||
Message-ID | String Message ID of the inbound message. | |||
AS2-Version | String AS2 protocol version used for the inbound message. | |||
Content-Type | String MIME content type of the inbound message. | |||
EDIINT-Features | String Optional features supported by the application. | |||
Receipt-Delivery-Option | String Optional. Sender's asynchronous MDN endpoint URL. | |||
Disposition-Notification-To | String Optional. Acknowledgment request for the inbound message. | |||
Disposition-Notification-Options | String Optional. Acknowledgment request to be signed for the inbound message. | |||
payload | Document Extracted payload that you receive. | |||
stream | Object Extracted payload stream. | |||
contentType | String Content type assigned to the payload. | |||
headers | Document Headers assigned to the payload. | |||
attachments | Document Array Optional. Attachments you receive with an inbound message, if any. | |||
stream | Object Output stream of the attachment. | |||
contentType | String Content type assigned to the attachment. | |||
headers | Document Headers assigned to the attachment. | |||
response | Document Sent MDN or received asynchronous MDN response. | |||
status | String Status of the sent or received MDN. | |||
statusMessage | String Status message of the sent or received MDN. | |||
receipt | Document Optional. Sent or received MDN. | |||
stream | Object Object stream of the sent or received MDN. | |||
headers | Document Headers of the sent or received MDN. | |||
AS2-To | String AS2 ID of the recipient. | |||
AS2-From | String AS2 ID of the sender. | |||
Message-ID | String Message ID of the inbound or outbound MDN. | |||
AS2-Version | String AS2 protocol version used for the inbound or outbound MDN. | |||
Content-Type | String MIME content type of the inbound or outbound message. |
send
Sends an AS2 message to a recipient’s defined endpoint.
Input Parameters
data | Document Payload you want to send. | |
stream | Object java.io.InputStream object you want map from EDI or XML data. | |
contentType | String Content type to
assign to an outbound message. The following options are available by default:
You can also type a custom value. |
|
otherHeaders | Document Optional. key and value strings of the header for an outbound message. | |
attachments | Document Array Optional. Attachments for a message, if any. | |
stream | Object java.io.InputStream object you want add to the attachment. | |
contentType | String Content type of the
attachment. For example,
application/zip if the attachment is a
.zip
file.
|
|
otherHeaders | Document Optional. key and value strings of the header you want to add to the attachment. | |
customHeaders | Document Optional. Custom headers you want to include in an AS2 message. | |
key | String Key for the custom header. | |
value | String Value for the customer header. |
Output Parameters
status | String Status of an outbound message. | |||
statusMessage | String Processing status of an outbound message. | |||
request | Document AS2 message sent to a recipient. | |||
stream | Object AS2 message stream. | |||
headers | Document Optional. AS2 message headers. | |||
AS2-To | String AS2 ID of the recipient. | |||
AS2-From | String AS2 ID of the sender. | |||
Message-ID | String Message ID of the outbound message. | |||
AS2-Version | String AS2 protocol version used for the outbound message. | |||
Content-Type | String MIME content type of the outbound message. | |||
EDIINT-Features | String Optional features supported by the application. | |||
Receipt-Delivery-Option | String Optional. Recipient's asynchronous MDN endpoint URL. | |||
Disposition-Notification-To | String Optional. Acknowledgment request for the outbound message. | |||
Disposition-Notification-Options | String Optional. Acknowledgment request to be signed for the outbound message. | |||
response | Document Received MDN response. | |||
status | String Status of the received MDN. | |||
statusMessage | String Status message of the received MDN. | |||
receipt | Document Optional. Received MDN. | |||
stream | Object Object stream of the received MDN. | |||
headers | Document Optional. Headers of the received MDN. | |||
AS2-To | String AS2 ID of the recipient. | |||
AS2-From | String AS2 ID of the sender. | |||
Message-ID | String Message ID of the inbound MDN. | |||
AS2-Version | String AS2 protocol version used for the inbound MDN. | |||
Content-Type | String MIME content type of the inbound message. |
Configuring the Auto Detect Option
You can select the Auto Detect option for the AS2 application to automatically identify an account based on the AS2-From and AS2-To headers of an inbound message.
This option enables the AS2 application to compare an account configured with From and To fields with the AS2-From and AS2-To headers of an inbound message and vice versa. In addition, specifying this option allows the use of an individual endpoint URL with multiple partners.
Creating an Endpoint URL
A sender requires a recipient’s endpoint URL to transfer AS2 messages. You must create an endpoint URL and share it with your partner to send AS2 messages to the endpoint URL.
To create an endpoint URL
- Create a Flow service. Ensure that you specify a signature with contentStream and node as input parameters of type Object. Alternatively, you can define a Document Type as a signature with contentStream and node as input parameters of type Object.
- Configure the AS2 application with the receive operation to work with a new or existing account, or select the Auto Detect option for the application.
- Map the contentStream and node parameters of the Pipeline Input signature defined in step 1 with the AS2 application’s receiveInput parameter.
- Select the Enable Flow service to be invoked over HTTP option on the Flow service Overview page. An endpoint URL for this Flow service is generated.
- Share this endpoint URL with your partner to enable the partner to send AS2 messages.
EDI
addGroupEnvelope addInterchangeEnvelope convertDocumentToEDIMessage convertEDIMessageToDocument createTradacomsMessage formatConfiguration formatDate formatDecimal formatNumber formatTime generateFunctionalAcknowledgement getDelimiter getEDIString getFirstKey nullifyIfBlank processEnvelopeUse the predefined operations in the Electronic Data Interchange (EDI) application to parse, validate, and transform EDI messages received from the IBM webMethods B2B application. Use these transformed messages to create orchestrations.
This application requires you to have access to the IBM webMethods B2B product instance. Operations convertDocumentToEDIMessage, convertEDIMessageToDocument, and processEnvelope supports the processing of large documents.
The following predefined operations are available for EDI application:
Operation | Description |
---|---|
addGroupEnvelope | Adds a functional group header to an EDI message according to the UN/EDIFACT, ANSI X12, UCS, or VICS standards. |
addInterchangeEnvelope | Adds an interchange control header to an EDI message according to the UN/EDIFACT, ANSI X12, UCS, or VICS standards. |
convertDocumentToEDIMessage | Converts a document to an EDI message. |
convertEDIMessageToDocument | Converts an EDI message that is stream or string into a document. |
createTradacomsMessage | Creates a TRADACOMS message containing the STX header segment, payload, and the END segment. |
formatConfiguration | Validates and creates a format configuration based on the input provided for each format service. |
formatDate | Format the input value based on the provided input and output date format. |
formatDecimal | Formats exponential decimal values based on the operationType. |
formatNumber | Formats given numeric value by adjusting decimal character based on the operationType. |
formatTime | Formats the input value based on the provided input and output time format. |
generateFunctionalAcknowledgement | Creates a functional acknowledgment (FA) that acknowledges all levels of an input EDI document. |
getDelimiter | Returns the first delimiter character found in the input characterString. |
getEDIString | Creates a complete EDI transaction set (either String or InputStream type) from an EDI transaction set header segment. |
getFirstKey | Returns the name of the first key present in the input Document Doc. |
nullifyIfBlank | Returns null or blank based on the blankOrNull value when the input is null or contains only blank spaces. |
processEnvelope | Accepts and processes the envelope of an ANSI X12/UN/EDIFACT/UCS/VICS/EANCOM EDI or TRADACOMS message and converts the envelope header segments to a document. |
addGroupEnvelope
Adds a functional group header to an EDI message according to the UN/EDIFACT, ANSI X12, UCS, or VICS standards.
Note:
- You must insert a value for either ediMessages or ediStream input parameter.
- When you insert the values for both ediMessages and ediStream input parameters, webMethods Module for EDI considers ediMessages as the input value.
- When an empty space is set for an ediMessage, the field value is considered as unset and the value set for ediStream is considered as an input value.
Input Parameters
ediMessages | String. (Optional). EDI messages to which a group envelope is added. | |
ediStream | Object. (Optional). EDI stream to which a group envelope is added. | |
documentType | String. Represents the standard of ediMessages. Configure either X12/UCS/VICS or UN/EDIFACT. | |
functionalIdentityCode | String. Functional ID Code of the EDI document. | |
senderQual | String. (Optional). EDI ID qualifier for the sender ID. It is used with sender. | |
sender | String. Identifies sender in the group envelope. For example, if you specify 01 for senderQual (indicating a D-U-N-S number), specify the D-U-N-S number for sender. | |
receiverQual | String. (Optional). EDI ID qualifier for the receiver ID. It is used with receiver. | |
receiver | String. Receiver to be identified in the group envelope. For example, if you specify 01 for receiverQual (indicating a D-U-N-S number), specify the D-U-N-S number for receiver. | |
grpCtlNumber | String. (Optional). Group control number of the EDI document. | |
agencyCode | String. (Optional). Responsible agency code as per EDI standard: T (default) or X . |
|
versionCode | String. EDI standard version and release code. For example, 4010 , 3040 . |
|
outputType | String. (Optional). The type of document output. The available options are string and stream. The default value is string. | |
x12/ucs/vics | Document. (Optional). When the document type is X12, UCS, or VICS, configure the following parameters: | |
Key | Description | |
timeFormat | String. (Optional). The time format for the GS 05 field of the EDI message. Supported time formats are HHmm, HHmmss, HHmmssD, and HHmmssDD. The default timeFormat is HHmm. Note: DD is the decimal seconds; decimal seconds are expressed as follows: D is tenths (0-9) and DD is hundredths (00-99). |
|
time | String Optional. Represents the time of an EDI message in the header interchange, field ISA10, and in the header group, field GS05. You can modify the time in the EDI payload. IBM webMethods B2B reflects the updated time in the EDI document. | un/edifact | Document. (Optional). When the document type is UN/EDIFACT, configure the following parameters: |
Key | Description | |
syntaxVersion | String. Syntax version of the envelope level. | |
releaseCode | String. (Optional). EDI message standard release code. For example, 96A , 97b . |
|
assignedCode | String. (Optional). EDI message standard assigned code. For example, OD , EN . |
|
password | String. (Optional). The recipient transmission reference password. | |
time | String Optional. Represents the time of an EDI message in the header interchange, field UNB04, sub-field S00402, and in the header group, field UNG04, sub-field S00402. You can modify the time in the EDI payload. IBM webMethods B2B reflects the updated time in the EDI document. | |
delimiters | Document. (Optional). Delimiters used in the EDI document: | |
Key | Description | |
segment | String. (Optional). Segment terminator for the EDI document. For example, \u000a .
Default |
|
field | String. (Optional). Field separator for each EDI segment. For example, exclamation mark (! ).
Default |
|
subfield | String. (Optional). Separator for composite elements. For example, caret (^ ).
Default |
|
release | String. (Optional). Release character for composite elements. For example, caret (^ ).
Default |
Output Parameters
ediMessage | String. (Optional). Contains the ediMessage. If the input parameter outputType is set to string, the value of this field populates. |
ediMessageStream | Object. (Optional). When the outputType input parameter is set to stream, the value appears for the parameter ediMessageStream. If the size of the EDI message is less than 1 MB, the value of ediMessageStream is java.io.ByteArrayInputStream . If the size of the EDI message is greater than 1 MB, the value ediMessageStream is com.wm.ff.util.AutoCloseReservationInputStream.
|
statusCode | String. Status code based on success or failure. |
statusMessage | String. Status message after executing the operation. |
addInterchangeEnvelope
Adds an interchange control header to an EDI message according to the UN/EDIFACT, ANSI X12, UCS, or VICS standards.
Note:
- You must insert a value for either ediMessages or ediStream input parameter.
- When you insert the values for both ediMessages and ediStream input parameters, webMethods Module for EDI considers ediMessages as the input value.
- When an empty space is set for an ediMessage, the field value is considered as unset and the value set for ediStream is considered as an input value.
Input Parameters
ediMessages | String. (Optional). EDI messages to which a group envelope is added. | ||
ediStream | Object. (Optional). EDI stream to which a group envelope is added. | ||
documentType | Either X12/UCS/VICS or UN/EDIFACT. | ||
senderQual | String. (Optional). EDI ID qualifier for the sender ID. It is used with sender. | ||
sender | String. The sender to be identified in the group envelope. For example, if you specify 01 for senderQual (indicating a D-U-N-S number), specify the D-U-N-S number for sender. | ||
receiverQual | String. (Optional). EDI ID qualifier for the receiver ID. It is used with receiver. | ||
receiver | String. The receiver to be identified in the group envelope. For example, if you specify 01 for receiverQual (indicating a D-U-N-S number), specify the D-U-N-S number for receiver. | ||
ctlNumber | String. (Optional). The interchange control number of the EDI document. | ||
ackRequested | String. (Optional). Indicates whether to request an acknowledgment for this interchange: | ||
Value | Meaning | ||
false | Do not request an acknowledgment.
Default false |
||
true | Requests an acknowledgment. | ||
outputType | String. (Optional). The type of document output. The available options are string and stream. The default value is string. | ||
delimiters | Document. (Optional). Delimiters used in the EDI document. | ||
Key | Description | ||
segment | String. Segment terminator for the EDI document. For example, \u000a .
Default |
||
field | String. Field separator for each EDI segment. For example, exclamation mark (! ).
Default |
||
subfield | String. Separator for composite elements. For example, caret (^ ).
Default |
||
release | String. (Optional). Release character for composite elements. For example, caret (^ ).
Default |
||
decimal | String. (Optional). Decimal character for composite elements. For example, caret (^ ). If UN/EDIFACT > unaSegmentRequired is true, the decimal delimiter is used.
Default |
||
X12/UCS/VICS | Document. When the document type is X12/UCS/VICS, assign values to the following parameters: | ||
Key | Description | ||
authQual | String. (Optional). Authorization qualifier for the interchange envelope. | ||
authInfo | String. (Optional). Authorization information for the interchange envelope. | ||
securityQual | String. (Optional). Security qualifier for the interchange envelope. | ||
securityInfo | String. (Optional). Security information for the interchange envelope. | ||
ctlVersion | String. Version of the EDI standard used, with a 00 prefix. For example, if version is 4010, specify 004010 . |
||
addLeadingZerosToCtlNumber | String. (Optional). (ANSI X12 only) Adds leading zeros to the interchange control number to make it a nine-digit number. | ||
Value | Meaning | ||
false | Do not add leading zeros to the interchange control number.
Default |
||
true | Add leading zeros to the interchange control number to make it a nine digit number. For example, 12 becomes 000000012 . |
||
repSeparator | String. (Optional). A separator for the repeated occurrences of a simple data element or a composite data structure. Field length: 1
Note: The repSeparator must be different from the record, field, or subfield delimiters.
|
||
messageAlignment | String. (Optional). Aligns the messages. | ||
Value | Description | ||
left | Left justify. | ||
right | Right justify. | ||
none | No justification.
Default |
||
testIndicator | String. (Optional). Whether to indicate production or test mode. | ||
Value | Meaning | ||
P |
Production. This is the default Value. | ||
T |
Test. | ||
I |
Information. | ||
time | String Optional. Represents the time of an EDI message in header interchange, field ISA10, and in header group, field GS05. You can modify the time in the EDI payload. IBM webMethods B2B reflects the updated time in the EDI document. | ||
UN/EDIFACT | Document. When the document type is UN/EDIFACT, assign values to the following parameters: | ||
Key | Description | ||
syntaxID | String. Syntax identifier. | ||
syntaxVersion | String. (Optional). Syntax version of the envelope level. | ||
password | String. (Optional). Recipient transmission reference password. | ||
passwordQual | String. (Optional). Recipient reference password qualifier. | ||
applReference | String. (Optional). Application reference. | ||
priority | String. (Optional). Processing priority code. | ||
agreementID | String. (Optional). Interchange agreement identifier. | ||
unaSegmentRequired | String. (Optional). Adds a UNA segment to the resulting final message. | ||
Value | Description | ||
true | Create UNA segment. | ||
false | Do not create UNA segment. | ||
directoryVersionNumber | String. (Optional). Type the directory version number in the UNB01/S00103 subfield of the EDIFACT envelope interchange header. | ||
characterEncoding | String. (Optional). Type the character encoding in the UNB01/S00104 subfield of the EDIFACT envelope interchange header. | ||
syntaxReleaseNumber | String. (Optional). Type the syntax release number in the UNB01/S00105 subfield of the EDIFACT envelope interchange header. | ||
senderInternalId | String. (Optional). Type the sender's internal ID in the UNB02/S00203 subfield of the EDIFACT envelope interchange header. | ||
senderInternalSubId | String. (Optional). Type the sender's internal sub ID in the UNB02/S00204 subfield of the EDIFACT envelope interchange header. | ||
receiverInternalId | String. (Optional). Type the receiver's internal ID in the UNB03/S00203 subfield of the EDIFACT envelope interchange header. | ||
receiverInternalSubId | String. (Optional). Type the receiver's internal sub ID in the UNB03/S00204 subfield of the EDIFACT envelope interchange header. | ||
testIndicator | String. (Optional). Indicates the testing parameters. | ||
Value | Meaning | ||
1 |
Indicates that the interchange is a test. | ||
2 |
Indicates that test only the syntax of the structure. | ||
3 |
Returns the request without any change. | ||
4 |
Returns the response without any change except for this data element changing from 3 to 4. | ||
time | String Optional. Represents the time of an EDI message in the header interchange, field UNB04, sub-field S00402, and in the header group, field UNG04, sub-field S00402. You can modify the time in the EDI payload. IBM webMethods B2B reflects the updated time in the EDI document. |
Output Parameters
ediMessage | String. (Optional). Contains the ediMessage. If the input parameter outputType is set to string, the value of this field populates. |
ediMessageStream | Object. (Optional). When the outputType input parameter is set to stream, the value appears for the parameter ediMessageStream. If the size of the EDI message is less than 1 MB, the value of ediMessageStream is java.io.ByteArrayInputStream . If the size of the EDI message is greater than 1 MB, the value ediMessageStream is com.wm.ff.util.AutoCloseReservationInputStream.
|
statusCode | String. Status code based on success or failure. |
statusMessage | String. Status message after executing the operation. |
convertDocumentToEDIMessage
Converts a document to an EDI message. When creating an orchestration with ConvertDocumentToEDIMessage, you must select the appropriate document type. This is for the structure of an ediDocument to appear in the pipeline data when you map with another ediDocument during orchestration. For the operation convertEDIMessageToDocument, the transaction size of the document is considered as the large document.
Input Parameters
ediDocument | Document. The ediDocument you want to convert to an EDI message. | ||
documentType | String. (Optional). Either Default or TRADACOMS. | ||
encoding | String. (Optional). The type of encoding used to write a message to the output file.
Default |
||
delimiters | Document. (Optional). Delimiters used in the outbound EDI document.
Note: This parameter is not applicable to TRADACOMS messages.
|
||
Key | Description | ||
segment | String. (Optional). Segment terminator character to be appended at the end of each record in the output string. | ||
field | String. (Optional). Field separator to be inserted between each field for each segment. | ||
subfield | String. (Optional). Separator for composite elements. | ||
release | String. (Optional). Release character to use as the escape character for composite elements. | ||
messageAlignment | String. (Optional). Aligns the messages. | ||
Value | Description | ||
left | Left justify. | ||
right | Right justify. | ||
none | No justification.
Default |
||
noEmptyTrailingFields | String. (Optional). Indicates whether to remove empty trailing fields from the output. | ||
Value | Description | ||
true | Removes empty trailing fields from the output. For example, AAA*01*02! (where ! is the segment terminator). |
||
false | This does not remove empty trailing fields. Instead it uses the field separator to denote an empty field. For example, AAA*01*02********! (where * is the field separator and ! is the segment terminator). |
||
txnCtlNumber | String. (Optional). The value of the control number to set in the outbound transaction. | ||
hasUndefData | String. (Optional). Processes the undefined output of the operation processEnvelope. Applicable for X12 and UNEDIFACT documents. The possible values are.
|
||
outputType | String. (Optional). The type of document output. The available options are string and stream. The default value is a string. | ||
formatConfiguration | Document Array. (Optional). Format configuration for each format service. | ||
Key | Description | ||
formatName | String. Name of the format service. | ||
internalFormat | String. (Optional). The format required by your internal application (for example, your back-end system).
Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat. |
||
externalFormat | String. (Optional). The format required by the EDI standard you are using. If you are using the EDI ANSI standard format, you should not change the setting.
Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat. |
||
applyFormat | String. (Optional). Indicates whether the convertEDIMessageToDocument or convertDocumentToEDIMessage services should apply the converted value. | ||
true | The service validates and updates the document to reflect the converted value. | ||
false | The service validates, but does not update the document with the converted value. | ||
Note
The input Document Array mapped to the formatConfiguration must be the output of EDI formatConfiguration operation.
|
Output Parameters
ediMessage | String. (Optional). Contains the ediMessage. If the input parameter outputType is set to string, the value of this field populates. |
ediMessageStream | Object. (Optional). When the outputType input parameter is set to stream, the value appears for the parameter ediMessageStream. If the size of the EDI message is less than 1 MB, the value of ediMessageStream is java.io.ByteArrayInputStream . If the size of the EDI message is greater than 1 MB, the value ediMessageStream is com.wm.ff.util.AutoCloseReservationInputStream.
| errors[] | String List. (Optional). Error messages describing the errors encountered during conversion. If there are no errors, then error[] is null. |
segmentCount | String. (Optional). The number of segments in the ediMessage. |
statusCode | String. Status code based on success or failure. |
statusMessage | String. Status message after executing the operation. |
convertEDIMessageToDocument
Converts an EDI message that is stream or string into a document. When creating an orchestration with ConvertEDIMessageToDocument, you must select the appropriate document type. This is for the structure of an ediDocument to appear in the pipeline data when you map with another ediDocument during orchestration.
Note:
- You must insert a value for either ediMessages or ediStream input parameter.
- When you insert the values for both ediMessage and ediStream input parameters, webMethods Module for EDI considers ediMessage as input value.
- The document is considered large based on its transaction size.
Input Parameters
ediMessage | String. (Optional). Contains the ediMessage. If the input parameter outputType is set to string, the value of this field populates. | ||
edistream | Object. (Optional). Contains the edistream. If the input parameter outputType is set to string, the value of this field populates. | ||
documentType | String. (Optional). Either Default or TRADACOMS | ||
encoding | String. (Optional). The encoding of the message passed into an ediMessage or edistream. | ||
delimiters | Document. Delimiters to parse the input message. If no delimiters are specified, then the parameter uses the default delimiter defined for the flat file schema.
Note: This parameter is not applicable to TRADACOMS messages.
|
||
Key | Description | ||
segment | String. Segment terminator used in the input message. | ||
field | String. Field separator used in the input message. | ||
subfield | String. Subfield separator used in the input message. | ||
release | String. Release character used in the input message. | ||
validate | String. (Optional). Validates the ediMessage. | ||
Value | Description | ||
true | Return errors describing how the given ediMessage violates the constraints described in the flat file schema. | ||
false | Do not return error messages describing how the ediMessage differs from the specified flat file schema. This is the default value. | ||
processOnlyTopLevelRecord | String. (Optional). Processes the segments one at a time or process all input data at one time. Specify true or false. | ||
Value | Meaning | ||
true | Starts processing segment structures with a top-level record as defined by the flat file schema. The parameter returns to the caller when it encounters another top-level record in the input data. | ||
false | Processes all input data at one time. This is the default value. | ||
ignoreSpaces | String. (Optional). Ignores white space from the beginning of the segments. Specify true or false. | ||
Value | Meaning | ||
true | Ignore white spaces. This is the default value. | ||
false | Use the segments as they are. Specify false when the data contains positional data records. | ||
repeatingFieldSeparator | String. (Optional). Inserts field separator between repeating fields of an EDI document.
Note: This parameter is not applicable to TRADACOMS messages.
|
||
formatConfiguration | Document Array. (Optional). Format configuration for each format service. | ||
Key | Description | ||
formatName | String. Name of the format service. | ||
internalFormat | String. (Optional). The format required by your internal application (for example, your back-end system).
Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat. |
||
externalFormat | String. (Optional). The format required by the EDI standard you are using. If you are using the EDI ANSI standard format, you should not change the setting.
Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat. |
||
applyFormat | String. (Optional). Indicates whether the convertEDIMessageToDocument or convertDocumentToEDIMessage services should apply the converted value. | ||
true | The service validates and updates the document to reflect the converted value. | ||
false | The service validates, but does not update the document with the converted value. | ||
Note
The input Document Array mapped to the formatConfiguration must be the output of EDI formatConfiguration operation.
|
Output Parameters
ediDocument | Document. The Document representation of the input ediMessage. | |
isValid | String. (Optional). Checks the validity of ediMessage. | |
Value | Description | |
true | validate input parameter was set to true and no errors were found. | |
false | validate input parameter was set to true and errors were found. | |
errors[] | Document List. (Optional). The validation errors, if any, that were found in edimessage.Validation errors are returned in errors only if validate is set to true and returnErrors is set to asArray or both . The list includes the path of the errors. |
|
statusCode | String. Status code based on success or failure. | |
statusMessage | String. Status message after executing the operation. |
createTradacomsMessage
Creates a TRADACOMS message containing the STX header segment, payload, and the END segment. When the validate parameter is set to true, EDI application validates the content of the message.
Note:
- You must insert a value for either tradacomsMessages or tradacomsStream input parameter.
- When you insert the values for both tradacomsMessages and tradacomsStream input parameters, webMethods Module for EDI considers tradacomsMessages as input value.
- When an empty space is set for tradacomsMessages, the field value is considered as unset and the value set for tradacomsStream is considered as an input value.
Input Parameters
STX | Document. The document representation of TRADACOMS STX segment. | |
includeRSGRSG | String. (Optional). Whether the service creates an RSGRSG (reconciliation) message in the output message. | |
Value | Description | |
true | Creates an RSGRSG message in the output message. This is the default value. | |
false | Does not create an RSGRSG message. | |
encoding | String. (Optional). The encoding format to use in the message. | |
tradacomsMessages | String. (Optional). The TRADACOMS payload. | |
tradacomsStream | Object. (Optional). The TRADACOMS message stream. | |
END | Document. The document representation of TRADACOMS END segment. | |
validate | String. (Optional). Validates the tradacomsMessages. | |
Value | Description | |
true | Returns errors describing how the given tradacomsMessages violates the constraints described in the flat file schema. | |
false | Does not return error messages describing how the tradacomsMessages differs from the specified flat file schema. This is the default value. | |
outputType | String. (Optional). The type of document output. The available options are string and stream. The default value is string. |
Output Parameters
ediMessage | Object. (Optional). Contains the EDI message. If the input parameter outputType is set to string, the value of ediMessage populates. | |
ediMessageStream | Object. (Optional). When the outputType input parameter is set to stream, the value appears for parameter ediMessageStream. If the size of the EDI message is less than 1 MB, the value of ediMessageStream is java.io.ByteArrayInputStream . If the size of the EDI message is greater than 1 MB, the value ediMessageStream is com.wm.ff.util.AutoCloseReservationInputStream.
| |
errors[] | String List.(Optional). Validation errors, if any, that are found in tradacomsMessages. Validation errors are returned only if validate is set to true. | |
isValid | String. Checks the validity of tradacomsMessages. | |
Value | Description | |
true | If the validate is set to true and no errors are found. | |
false | If the validate is set to true and there are errors. | |
statusCode | String. Status code based on success or failure. | |
statusMessage | String. Status message after performing the operation. |
formatConfiguration
Validates and creates a format configuration based on the input provided for each format service.
A format service formats the value of a field and optionally validates the field against restrictions defined in the format service. EDI connector uses format services to convert field values into a different format as required by your system. For example, a format service can change the format of a date field from YYYYMMDD to MMDDYYYY or data from the EDI standard into a different format used by your internal application. Format services are associated with fields in EDI document type.
The following EDI operations use format services to convert the EDI field values as defined in the EDI document type:
- convertDocumentToEDIMessage - Converts a document which contains the internal document format to EDI standard message.
- convertEDIMessageToDocument - Converts an EDI standard message to document which contains the internal document format.
To modify format conversion related configuration, use formatConfiguration operation.
By default, the external format configuration represents the EDI ANSI standard format. You must update the configuration, so that it reflects the EDI standard you are using and the formats of your internal application, for the system to accurately convert field values from one format to another.
Below are the default format configurations used by convertDocumentToEDIMessage and convertEDIMessageToDocument when formatConfiguration is not passed explicitly to the input.
Format Name | Default internalFormat value | Default externalFormat value | Description |
---|---|---|---|
formatDate6 | MM/dd/yy | yyMMdd | Converts the date format from MM/dd/yy to yyMMdd |
formatDate8 | MM/dd/yyyy | yyyyMMdd | Converts the date format from MM/dd/yyyy to yyyyMMdd |
formatDecimal | #.########## | #.#####E0 | Converts the input to a decimal value |
formatTime4_4 | HH:mm | HHmm | Converts the timestamps from HH:mm format to HHmm |
formatTime4_6 | HH:mm:ss | HHmmss | Converts the timestamps from HH:mm:ss format to HHmmss |
formatTime4_8 | HH:mm:ss.SS | HHmmssSS | Converts the timestamps from HH:mm:ss.SS format to HHmmssSS |
formatTime6_6 | HH:mm:ss | HHmmss | Converts the timestamps from HH:mm:ss format to HHmmss |
Input Parameters
input | Document Array. Format configuration for each format service. | ||
Key | Description | ||
formatName | String. Name of the format service. | ||
internalFormat | String. (Optional). The format required by your internal application (for example, your back-end system).
Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat. |
||
externalFormat | String. (Optional). The format required by the EDI standard you are using. If you are using the EDI ANSI standard format, you should not change the setting.
Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat. |
||
applyFormat | String. (Optional). Indicates whether the convertEDIMessageToDocument or convertDocumentToEDIMessage services should apply the converted value. | ||
true | The service validates and updates the document to reflect the converted value. | ||
false | The service validates, but does not update the document with the converted value. |
Output Parameters
formatConfiguration | Document Array. (Optional). Format configuration for each format service. | ||
Key | Description | ||
formatName | String. Name of the format service. | ||
internalFormat | String. (Optional). The format required by your internal application (for example, your back-end system).
Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat. |
||
externalFormat | String. (Optional). The format required by the EDI standard you are using. If you are using the EDI ANSI standard format, you should not change the setting.
Specify a string that follows the conventions described in the java class java.text. DecimalFormat and java.text.SimpleDateFormat. |
||
applyFormat | String. (Optional). Indicates whether the convertEDIMessageToDocument or convertDocumentToEDIMessage services should apply the converted value. | ||
true | The service validates and updates the document to reflect the converted value. | ||
false | The service validates, but does not update the document with the converted value. | ||
hasError | String. Indicates whether any error exists in the input. | ||
true | Indicates an error in the input received that needs correction. | ||
false | Indicates no error in the input received. | ||
errorMessage | String. (Optional). The error message describing the formatting error. |
formatDate
Formats the input value based on the specified input and output date format.
Input Parameters
value | String. The field value to format. |
inputFormat | String. The date format that represents the input value. Follows the conventions described in the Java class java.text.SimpleDateFormat . |
outputFormat | String. The date format that represents the output formattedvalue after conversion.
Follows the conventions described in the Java class |
Output Parameters
formattedValue | String. The field value after applying outputFormat. | |
isValueError | Boolean. Indicates whether the value can be formatted or not.
|
|
errorMessage | String. (Optional). The error message describing the formatting error. |
formatDecimal
Formats exponential decimal values based on the operationType.
Input Parameters
value | String. The field value to format. |
operationType | String. Indicates the type of operation to apply to the input value. Select one of the two operations below :
|
decimalChar | String. (Optional). The character that represents the decimal. The default decimal character is '.' . |
Output Parameters
formattedValue | String. The field value with appropriate formatting applied. | |
isValueError | Boolean. Indicates whether the value can be formatted or not.
|
|
errorMessage | String. (Optional). The error message describing the formatting error. |
formatNumber
Formats the given numeric value by adjusting the decimal character based on the operationType.
Input Parameters
value | String. The numeric value to format. |
operationType | String. Indicates the type of operation to apply to the input value. Select one of the below two operations:
|
decimalCount | String. Determines the number of decimals from the value that need to be formatted. |
decimalChar | String. (Optional). The character that represents the decimal. The default decimal character is '.' . |
Output Parameters
formattedValue | String. The field value with appropriate formatting applied. | |
isValueError | Boolean. Indicates whether the value can be formatted or not.
|
|
errorMessage | String. (Optional). The error message describing the formatting error. |
formatTime
Formats the input value based on the specified input and output time format.
Input Parameters
value | String. The field value to be formatted. |
inputFormat | String. The date format that represents the input value follows the conventions described in the Java class java.text.SimpleDateFormat . |
outputFormat | String. The date format that represents the output formattedvalue after conversion follows the conventions described in the Java class java.text.SimpleDateFormat . |
pad | String. Indicates whether to pad the value with zeros, when the value is shorter than the inputFormat. The default option is true.
|
Output Parameters
formattedValue | String. The field value after applying outputFormat. | |
isValueError | Boolean. Indicates whether the value can be formatted or not.
|
|
errorMessage | String. (Optional). The error message describing the formatting error. |
generateFunctionalAcknowledgement
Creates a functional acknowledgment (FA) that acknowledges all levels of an input EDI document. This operation takes an EDI document as input, performs validation and compliance check, and creates an FA as output.
Note:
- You must insert a value for either ediMessages or ediStream input parameter.
- When you insert the values for both ediMessage and ediStream input parameters, webMethods Module for EDI considers ediMessage as input value.
- When an empty space is set for an ediMessage, the field value is considered as unset and the value set for ediStream is considered as an input value.
Input Parameters
ediMessage | String. (Optional). An unparsed EDI document for which you want to generate an FA. Specify a value for either ediMessage or ediDocument. | |
ediStream | Object. (Optional). An unparsed EDI document for which you want to generate an FA. Specify a value for either edistream or ediDocument. | |
ediDocument | Document. (Optional). A parsed EDI document (an IData object) for which you want to generate an FA. This must include the error results. This is the output from the processEnvelope EDI operation. Specify a value for either ediMessage or ediDocument. | |
delimiters | Document. (Optional). Delimiters used in the outbound FA. If you do not specify delimiters, the operation uses the delimiters from the document it is acknowledging. | |
Key | Description | |
segment | String. The segment terminator for the FA, for example, +. The default is the ' character. | |
field | String. The field separator for each EDI segment for example, !. The default is the + character. | |
subfield | String. The separator for composite elements, for example, ^. The default is the : character. | |
release | String. Character used to ignore a record, field, or subfield delimiter in a field. If a release character occurs in a field or subfield before the delimiter, it is prefixed with this character in the output. | |
functionalAckRequest | String. (Optional). Indicates the manner to handle potentially conflicting information in the EDI interchange header of the inbound document. For ANSI X12, the inbound document specification is in ISA14. For UN/EDIFACT, the inbound document specification is in UNB09. Specify one of the following: | |
Value | Meaning | |
yes | The FA is generated regardless of FA specification in the input EDI interchange header. | |
no | If no and the input EDI interchange header specifies that an FA is not required, the FA is not generated. |
|
dependOnInput | The FA is generated based on the FA specification in the input EDI interchange header. | |
functionalAckLevel | String. (Optional). The level at which to acknowledge. If any errors occur at the level you select, the FA lists those errors at the level selected. Specify one of the following: | |
Value | Meaning | |
default | Acknowledge at the envelope level (group for ANSI X12 and interchange for UN/EDIFACT). | |
transactionSet | Acknowledge at the transaction set level (ANSI X12 only). | |
segment | Acknowledge at the segment level (ANSI X12 only). | |
element | Acknowledge at the element level (ANSI X12 only). | |
generateControlNumber | String. (Optional). Indicates how you want the operation to obtain the control number it uses in the interchange and group headers of the generated FA. Specify one of the following: | |
Value | Meaning | |
fromInboundDocument | Use the control number from the corresponding header in the EDI document that is being acknowledged. For example, if generating an FA for a group in an ANSI X12 document, use the control number from the group header of that group for the control number of the FA. | |
random | The operation randomly generates a control number. | |
addGroup | String. (Optional). Indicates whether you want to add group segments to the ANSI X12 or UN/EDIFACT FA (e.g., a 997 or a UN/EDIFACT CONTRL). | |
Value | Meaning | |
true | Add a group to the FA. | |
false | Do not add a group to the FA. | |
addInterchangeEnvelope | String. (Optional). Whether you want to add an interchange envelope to the FA. | |
Value | Meaning | |
true | Add an interchange to the FA. This is the default. For ANSI X12, if you add an envelope, you will automatically get the group. | |
false | Do not add an interchange to the FA. | |
syntaxErrorStatus | String. (Optional). Indicates how you want the operation to report the syntax error status for a transaction, group, or UN/EDIFACT interchange. The syntax error status indicates whether there are syntax errors. For example, missing mandatory elements, violation of syntax rules, invalid field lengths, code list violations, or segment repeat counts exceeded. | |
The operation uses the syntax error status along with the logical error status and child transaction rejected status (if applicable) to determine the FA status for a transaction, group, or UN/EDIFACT interchange. | ||
Specify one of the following to indicate how you want the EDI operation to report syntax errors: | ||
Value | Meaning | |
rejected | The syntax error status is reported as "rejected" if syntax errors are encountered. Specify rejected if you want to reject elements that have syntax errors. | |
accepted, but errors were noted | The syntax error status is reported as accepted, but errors were noted if syntax errors are encountered. Specify accepted, but errors were noted if you want to know whether there are syntax errors, but do not want to reject an element because of them. | |
accepted | The syntax error status is always reported as "accepted" regardless of any syntax errors that might be encountered. Specify accepted, but errors were noted if you do not want to check for syntax errors. | |
logicalErrorStatus | String. (Optional). Indicates how you want the operation to report the logical error status for a transaction, group, or UN/EDIFACT interchange. The logical error status indicates whether there are logical errors, for example:
The operation uses the logical error status along with the syntax error status and child transaction rejected status (if applicable) to determine the FA status for a transaction, group, or UN/EDIFACT interchange. Specify one of the following to indicate how you want the operation to report logical errors: |
|
Value | Meaning | |
rejected | The logical error status is reported as "rejected" if logical errors are encountered. Specify rejected if you want to reject elements that have logical errors. | |
accepted, but errors were noted | The logical error status is reported as accepted, but errors were noted if logical errors are encountered. Specify accepted, but errors were noted if you want to know whether there are logical errors, but do not want to reject an element because of them. | |
accepted | The logical error status is always reported as "accepted" regardless of any logical errors that might be encountered. Specify accepted if you do not want to check for logical errors. | |
childTransactionRejectedStatus | String. (Optional). Indicates how you want the operation to report the child transaction rejected status for a group or UN/EDIFACT interchange. The child transaction rejected status indicates whether child elements of a group or UN/EDIFACT interchange have an FA status of rejected. Specify one of the following: | |
Value | Meaning | |
rejected | Reports the child transaction rejected status as:
|
|
partially accepted | Reports the child transaction rejected status as:
|
|
accepted, but errors were noted | Reports the child transaction rejected status as:
|
|
documentType | String. (Optional). The substandard of the EDI standard. Use this parameter in conjunction with ediDocuments. Valid values are EANCOM , UCS , UNEDIFACT , VICS , X12 , and ODETTE . |
|
encoding | String. (optional). The encoding of the data passed to the ediMessage parameter.
Note: When the generateFunctionalAcknowledgement operation is invoked manually, the value of this parameter is passed to the ediMessage parameter in both the convertToString and the convertToValue operations, as well as the generateFunctionalAcknowledgement operation.
|
|
outputType | String. (Optional). The type of document output. The available options are string and stream. The default value is string. | |
additionalInfo | Document. (Optional; for use with ODETTE only) Additional information about the input message, to be used in the outbound FA. | |
Value | Meaning | |
code | String. A qualification and identification of the purpose and function of a text segment. Maximum length: 3 characters. | |
text | String. Text. Maximum length: 70 characters. | |
messageIdentifier | Document. (Optional). Specifies details to include in the CONTRL message. | |
Value | Meaning | |
versionNumber | String. Specifies the following values in the output CONTRL message to determine the schema to use:
|
|
releaseNumber | String. Specifies the following values in the output CONTRL message to determine the schema to use:
|
|
controllingAgency | String. Specifies the following values in the output CONTRL message:
|
|
associationCode | String. Specifies the following values in the output CONTRL message:
|
|
codeListDirectoryVersionNumber | String. (Optional). Specifies the following values in the output CONTRL message:
|
|
messageTypeSubFunctionIdentification | String. (Optional). Specifies the following values in the output CONTRL message:
|
|
|
||
generateAnyway | String. (Optional). Specifies whether the generateFunctionalAcknowledgement operation should throw a com.wm.ff.parse.ParseException exception when a delimiter is missing at the envelope level of an EDIFACT message. |
|
Value | Meaning | |
true | Generate a negative CONTRL message and do not throw an exception.
Note: If you set this parameter to true, you must also assign the values for the CONTRL message header fields in UNH02.
|
|
false | Throw the exception
ParseException. This is the default option. |
|
UNH02_messageIdentifier | Document. (Optional). Values to assign to the CONTRL message header fields if generateAnyway is set to true. | |
Key | Description | |
S00902_versionNumber | String. The version number of the CONTRL message. For example, to set the version number of the CONTRL message to "D," set the value of S00902_versionNumber to D . |
|
S00903_releaseNumber | String. The release number of the CONTRL message. For example, to set the release number of the CONTRL message to "96A," set the value of S00903_releaseNumber to 96A . |
|
S00904_controllingAgency | String. (Optional). The controlling agency of the CONTRL message. For example, to set the version number of the CONTRL message to "UN," set the value of S00904_controllingAgency to UN . |
|
S00905_associationCode | String. (optional). The association assigned code, 1 to 6 characters in length, for the CONTRL message. |
Output Parameters
Note: UN/EDIFACT and ODETTE CONTRLs both use the version 4 UN/EDIFACT CONTRL error codes.
functionalAcknowledgement | String List. (Optional). The outbound functional acknowledgement. If the input parameter outputType is set to string, the value of functionalAcknowledgement populates. |
functionalAcknowledgementStream | Object. (Optional). When the outputType input parameter is set to stream, the value appears for the parameter ediMessageStream. If the size of the EDI message is less than 1 MB, the value of ediMessageStream is java.io.ByteArrayInputStream . If the size of the EDI message is greater than 1 MB, the value ediMessageStream is com.wm.ff.util.AutoCloseReservationInputStream .
|
summaryDocument | Document List. Summary of information about the interchanges, groups, and transactions from the input EDI document. |
getDelimiter
Returns the first delimiter character found in the input characterString.
Input Parameters
characterString | String. Input string from which the first delimiter is identified. Input string can represent any of the following values:
|
Output Parameters
charOut | String. The delimiter character found in the input characterString. Returns null. when the input characterString is invalid. |
getEDIString
Creates a complete EDI transaction set (either String or InputStream type) from an EDI transaction set header segment.
Input Parameters
Values | Document. The single EDI transaction set within a single interchange and a single functional group. This input object is part of the output of the processEnvelope operation. |
Output Parameters
EDIstring | Object. A single EDI transaction set in String or InputStream type. |
getFirstKey
Returns the name of the first key present in the input document Doc.
Input Parameters
Doc | Document. Input document from which the name of the first key is determined. |
Output Parameters
firstKey | String. Name of the first key found in the Doc. |
nullifyIfBlank
Returns null or blank based on the blankOrNull value when the input is null or contains only blank spaces.
Input Parameters
input | String. Input data. | |
blankOrNull | String. (Optional). Indicates whether to return blank or null if the input string is null or contains only blank spaces. The default value is null. | |
Value | Meaning | |
blank | Returns blank if the input is null or contains only blank spaces. | |
null | Returns null if the input is null or contains only blank spaces. |
Output Parameters
output | String. Same data as input or null or blank based on the blankOrNull value. |
processEnvelope
Accepts and processes the envelope of an ANSI X12/UN/EDIFACT/UCS/VICS/EANCOM EDI or TRADACOMS message and converts the envelope header segments to a document. When creating an orchestration with processEnvelope, you must select the appropriate document type. This is for the structure of an ediDocument to appear in the pipeline data when you map with another ediDocument during orchestration.
Note:
- You must insert a value for either ediMessages or ediStream input parameter.
- When you insert the values for both ediMessage and ediStream input parameters, webMethods Module for EDI considers ediMessage as input value.
- When an empty space is set for an ediMessage, the field value is considered as unset and the value set for ediStream is considered as an input value.
Input Parameters
ediMessage | String. (Optional). Processes the input EDI message. Input must not have manual line breaks. | |
ediStream | Object. (Optional). Processes the input EDI stream. Input must not have manual line breaks. | |
validate | String. (Optional). Whether to validate the envelopes against a predefined flat file schema. | |
Value | Description | |
true | Validate the envelopes against a predefined flat file schema. | |
false | Does not validate the envelope. | |
complianceCheck | String. (Optional). Performs a compliance check against the interchange.
Note: This parameter is not applicable to TRADACOMS messages.
|
|
Value | Description | |
true | Perform a compliance check. The parameter stops executing after encountering the first error. This is the default value. | |
false | Does not perform the compliance check. | |
iterate | Boolean. (Optional). Indicates if the transactions are present for the iteration. Enable this parameter to iterate the multiple envelopes of an EDI document. | |
ediObject | Object. (Optional).ediObject is used for an internal purpose when iterate is set to true. The input parameter ediObject is auto mapped to the output parameter ediObject. |
Output Parameters
ediEnvelopeDocument | Document. Resulting EDI envelope document. | |
standard | String. The standard to which the EDI document adheres. For example, X12 or UNEDIFACT . |
|
ediObject | Object. (Optional). ediObject is used for an internal purpose when the input parameter iterate is set to true. You should not delete this parameter from the pipeline. The input parameter ediObject is auto mapped to the output parameter ediObject | |
hasMore | String. (Optional). Indicates the EDI message remaining to iterate. When you enable the input parameter iterate, and there is an additional message to iterate, the value for hasMore is true; otherwise; it is false. | |
hasError | String. Whether the validation or compliance check resulted in error. | |
Value | Description | |
false | If the validate is true, validation errors are retrieved from errorArray.Otherwise, it indicates errors from the compliance check. | |
true | No errors. | |
errors[] | Document List. (Optional). Validation errors, if any, that were found in edimessage. Validation errors are returned in errors only if validate is set to true -AND- returnErrors is set to asArray or both . The list includes the path of the errors. |
|
hasUndefData | String. (Optional). It is always set to true to process the data from the payload, it automatically maps when used in conjunction with the convertDocumentToMessage operation. | |
statusCode | String. Status code based on success or failure. | |
statusMessage | String. Status message after executing the operation. |
HIPAA
Supported HIPAA TransactionsconvertHipaaMessageToDocument convertDocumentToHipaaMessageHIPAA allows your organization to implement the HIPAA 5010 and 5010A standards comprehensively and at scale. HIPAA streamlines the healthcare industry by providing the functionality to validate HIPAA transactions and generates the appropriate acknowledgments.
Supported HIPAA Transactions
HIPAA supports the following document types:
Action | Description | Document types |
---|---|---|
270 Health Care Eligibility Benefit Inquiry | Determines whether a subscriber or dependent is eligible for certain claim benefits. |
|
271 Health Care Eligibility Benefit Response | Requests an inquiry about the health care benefits and eligibility associated with a subscriber or dependent. The response document contains eligibility status, maximum benefits, in-plan/out-of-plan benefits, and co-payments. |
|
276 Health Care Claim Status Request | Requests the status of a specified claim. |
|
277-A1 Health Care Information Status Notification | The health care payer notifies the status of the adjudication process to the requestor or requests more information regarding a health care claim. If the request matches more than one claim in the payer’s system, the response may include multiple claims. |
|
277-B3 Health Care Claim Acknowledgment | The health care payer acknowledges the claim of the requestor. |
|
278-A1 Health Care Service Review Information - Review | Sends a health care services request for review to the health care provider, payers, delegated UMO entities, and other providers. |
|
278-A3 Health Care Service Review Information - Response | Sends a health care services request for response to the health care provider, payers, delegated UMO entities, and other providers. |
|
820 Payroll Deducted and Other Group Premium Payment for Insurance Products | Initiates a payment for insurance products with or without the remittance detail that a premium receiver needs. |
|
834 Benefit Enrollment and Maintenance | Used to transfer enrollment information from the sponsor to a payer. |
|
835 Health Care Claim Payment/Advice | Sends an Explanation of Benefits (EOB) remittance advice or make a payment and send an EOB remittance advice from a health care payer to a health care provider, either directly or through a Depository Financial Institution (DFI). |
|
837-Q1A1 Health Care Claim - Professional | Insurance company submits healthcare claim billing information, encounter information, or both, from providers of health care services. |
|
837-Q3A2 Health Care Claim - Institutional | Insurance company submits healthcare claim billing information, encounter information, or both, from providers of health care services. |
|
837-Q2A2 Health Care Claim - Dental | Insurance company submits health care claim billing information, encounter information, or both, from providers of health care services. |
|
The following predefined operations are available for HIPAA application:
Operation | Description |
---|---|
convertHipaaMessageToDocument | Converts a HIPAA message into a HIPAA document type. |
convertDocumentToHipaaMessage | Converts a HIPAA document type into a HIPAA message. |
convertHipaaMessageToDocument
Converts a HIPAA message into a HIPAA document type. When creating an orchestration with convertHipaaMessageToDocument, you must select the appropriate document type. This is for the structure of a hipaaDocument to appear in the pipeline data when you map with another hipaaDocument during orchestration.
Input Parameters
- hipaaMessage: Object. HIPAA message that is to convert into a document. Message only as stream or string is accepted.
- encoding: String. Optional. The encoding of the message passed into hipaaMessage. Default character set is UTF-8.
Output Parameters
- hipaaDocument: Document. The document represents the HIPAA message.
- errorMessage: String. The error message describes the error when validating the message.
- statusCode: String. Status code based on the success or failure of the operation.
- statusMessage: String. Status message after executing the operation.
convertDocumentToHipaaMessage
Converts a HIPAA document type into a HIPAA message. When creating an orchestration with convertDocumentToHipaaMessage, you must select the appropriate document type. This is for the structure of a hipaaDocument to appear in the pipeline data when you map with another hipaaDocument during orchestration.
Input Parameters
- hipaaDocument: Document. The document represents the HIPAA message.
delimiters: Document. Optional. Use delimiters to create the output HIPAA message. If you do not specify a delimiter, the convertDocumentToHipaaMessage service uses the default delimiters. Delimiters must always be a single character.
- Segment: String. The segment terminator character to append to the end of each record in the output string.
- field: String. The field separator to insert between each field for each segment in the output string.
- subfield: String. The subfield separator to use for composite elements.
- release: String. The field separator to insert between repeating fields of a document.
Output Parameters
- hipaaMessage: String. The HIPAA message that is converted from the document.
- errorMessage: String. The error message describes the error when validating the message.
- statusCode: String. Status code based on the success or failure of the operation.
- statusMessage: String. Status message after executing the operation.
webMethods_io_B2B
addOrUpdatePeppolPartneraddTransactionContentPart changeUserStatus constructSubmitInput Configuring an AS4 bodyConfiguring AS4 attachments [ ]Configuring AS4 paramsConfiguring an RNIF bodyConfiguring an RNIF attachments [ ]Configuring an RNIF paramsdownloadTransactionContentParts generateResponse getAddresses getChannel getContacts getControlnumber getCorporation getExtendedFields getFAReport getIDTypeCodes getPartnerID getPartnerIdentities getRelatedTransactions getTaskInfo getTransactionByDocumentID getTPA getTransactionContentParts getTransactionSenderReceiver log parseContent queryMorePartners queryPartners queryTaskIDs queryTransactions relateTransactions resetQueryPartners restartTask reprocess resubmit retrievePeppolParticipantDetailssubmit updateAttributeThe IBM webMethods B2B application allows you to:
- Interact, accept requests, and build integrations for the IBM webMethods B2B product instance.
- Exchange business documents between trading partners.
The following predefined operations are available for IBM webMethods B2B application:
Operation | Description |
---|---|
addOrUpdatePeppolPartner | Creates the recipient partner profile and channel in IBM webMethods B2B with the certificate of the recipient. |
addTransactionContentPart | Adds a new content part to a document. |
changeUserStatus | Changes the user status of a specified transaction. |
constructSubmitInput | Prepare the necessary input used for submitting the business documents to IBM webMethods B2B product instance. Note: This operation is deprecated in the IBM webMethods B2B application and now included as a B2B Utils built-in service in IBM webMethods Integration. You must modify your integration to use this operation in the B2B Utils instead of the IBM webMethods B2B application. |
downloadTransactionContentParts | Downloads the necessary content parts of a transaction. This service is enabled only for enterprise production tenant where the payload separation is enabled. If the payload separation is not enabled, an unsupported operation error appears. |
generateResponse | Generates a response for the processing rule Call an integration action. Note: This operation is deprecated in the IBM webMethods B2B application and now included as a B2B Utils built-in service in IBM webMethods Integration. You must modify your integration to use this operation in the B2B Utils instead of the IBM webMethods B2B application. |
getAddresses | Retrieves all addresses of a partner. |
getChannel | Retrieves the channel details from the input channel name. |
getContacts | Retrieves all contacts of a partner. |
getControlnumber | Retrieves the control number from IBM webMethods B2B to be used in outbound group, envelope, and transaction documents. |
getCorporation | Retrieves the corporation information of a partner. |
getExtendedFields | Retrieves a set of extended fields for a partner. |
getFAReport | Retrieves a list of transactions with reconciled functional acknowledgments, and generates a report. |
getIDTypeCodes | Retrieves the list of ID types from IBM webMethods B2B. |
getPartnerID | Retrieves the partnerID for the partner. |
getPartnerIdentities | Retrieves all external IDs of a partner. |
getRelatedTransactions | Retrieves the related transactions based on a specific transactionID, with or without details from either the live or archive database. |
getTaskInfo | Retrieves the information related to the task. |
getTransactionByDocumentID | Retrieves the transactions based on a specific documentID in the given duration from either the live or the archive database. |
getTPA | Retrieves Trading Partner Agreement (TPA) information from IBM webMethods B2B. |
getTransactionContentParts | Retrieves the necessary content parts of a transaction. |
getTransactionSenderReceiver | Retrieves the sender and receiver information for the specified document from the database. |
log | Adds an entry into the activity log. |
parseContent | Parses request content passed by the processing rule Call an integration action as bytes or String data type. Note: This operation is deprecated in the IBM webMethods B2B application and now included as a B2B Utils built-in service in IBM webMethods Integration. You must modify your integration to use this operation in the B2B Utils instead of the IBM webMethods B2B application. |
queryMorePartners | Loops over the data cached from the queryPartners operation and returns the batchSize of data. |
queryPartners | Creates a query for partner profiles and returns the first batch of matching results. |
queryTaskIDs | Retrieves the task ids that satisfy a given criteria. |
queryTransactions | Retrieves the transactions that match the specified criteria. |
relateTransactions | Creates a relationship between two transactions. |
resetQueryPartners | Resets the queryLocator making it available for the next concurrent execution |
restartTask | Restarts a failed or stopped task. |
reprocess | Reprocess a document on IBM webMethods B2B. |
resubmit | Resubmit a document to IBM webMethods B2B |
retrievePeppolParticipantDetails | Retrieves the details (for example, endpoint address, recipient certificate) of peppol recipient participant. |
submit | Submits the business documents to IBM webMethods B2B product instance. |
updateAttribute | Updates the attribute for the chosen transaction. |
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.NoteThe 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, attachments of Submit.
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, attachments of Submit.
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.
Configuring an AS4 body
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.NoteFor the final AS4 payload of MimeType application/octet-stream, then add the property name PayloadMimeType and value as application/octet-stream.name: String. Name of the property.
The value of this parameter maps to the name attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.value: String. Value of the property.
The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.
Configuring AS4 attachments [ ]
Document List. To configure AS4 attachments. 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.NoteFor the final AS4 payload of MimeType application/octet-stream, then add the property name PayloadMimeType and value as application/octet-stream.name: String. Name of the property.
The value of this parameter maps to the name attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.value: String. Value of the property.
The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.
Configuring AS4 params
Document. A document that provides parameters on how 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.
NoteWhen 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.
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.
Configuring an RNIF body
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.
Configuring an RNIF attachments [ ]
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.
Configuring an RNIF params
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. Refer Submit. 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 isUTF-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.
DefaultUTF-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:
NoteIf 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:
NoteIf 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
.
- For an interchange control number, type
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
, orVDA
.mode: String. (optional) The mode associated with the control number. Specify one of the following:
Production
(default),Test
, orCustom
.NoteFor TRADACOMS, the only valid value isProduction
.version: String. (optional) Version of the EDI standard for the control number, for example,
4010
.
For a TRADACOMS envelope, it is the version is always1
. For a TRADACOMS batch, it is the version is the version number of the file type. For example, for the file typeORDHDR:5
, the version is5
.
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:
NoteIf 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.
NoteApart 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.
NoteIf 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 Partner Profile ID Types Mapping for EDI Documents. - value: The value of external ID configured for the ID type.
- code: 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 Partner Profile ID Types Mapping for EDI Documents. - value: The value of external ID configured for the ID type.
- code: 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
andfalse
. The default value isfalse
.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.
- idTypes: Document. The list of ID types from IBM webMethods B2B.
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:
NoteIf 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.
- senderID: String. The senderID 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.
- message: String. The error message.
- 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
ortrue
. - status. String. The status of the partner in your IBM webMethods B2B instance. The value can be either
Active
orInactive
.
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
ortrue
. - status. String. The status of the partner in your IBM webMethods B2B instance. The value can be either
Active
orInactive
.
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.
NoteIBM 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.
NoteIf 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.
NoteIf 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 Call an integration.
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.
encoding: String. Type of character set used for encoding inputContent value. This can be any IANA registered character set.
DefaultUTF-8
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:
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 IBM webMethods B2B. This value can be ActiveOr 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.
NoteIf 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).
- fieldName: String. The field name for sorting.
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
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 IBM webMethods 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 IBM webMethods B2B. This value can be ActiveOr Inactive.
- isEnterprise. Boolean Indicates if the partner profile represents the Enterprise profile. The values are trueOr 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
andfalse
. The default value isfalse
.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
true
andfalse
. The default value isfalse
(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.
Points to 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.
NoteA maximum of 20 values are allowed.
- 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.
- 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.
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.
Points to 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.
- 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.
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: [ Name : Value ].
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 {Peppol Identifier Scheme}::{Peppol Identifier Value}.
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.
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.
- pipInfo - Document.Document that represents RNIF Partner Interface Processes Information (PIP).
- 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.
Points to 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.
- DoctypeName - String. The name of the document type. This field is case-sensitive.
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 isUTF-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.
- Points to note:
- On the IBM webMethods B2B Transaction page, the name of the attachments and headers are preceded with a
$
sign.
For example, if an attachment with the namemyattachment
is submitted to IBM webMethods B2B, the attachment on the IBM webMethods B2B Transaction page is displayed with the name$myattachment
. - When headers are passed for an attachment using the
otherHeaders
input, on the IBM webMethods B2B Transaction page, the headers are displayed as new content part with the name that follows below syntax as$<Name of the attachment>-headers
.
For example, for an attachment with the namemyattachment
, if you pass some headers, then the headers document is displayed with the name$myattachment-headers
.
- On the IBM webMethods B2B Transaction page, the name of the attachments and headers are preceded with a
- 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.
params: Document. A document that contains parameters that IBM webMethods B2B uses to recognize and process a document.
operationWarnings: Document List. Details of the warning.
- message: String. Specifies the warning message.
- key: String. Specifies a predefined warning key.
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.
- attributeName: String. (Optional) Name of the document attribute for which you want to add or update or delete values.
allowDeletion: String. (Optional) Indicates whether to allow deletion of attribute value from the transaction.
Options are true or false.
Default value is false (AND).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.