Large Document Handling

Edit online

When processing the business documents, IBM® webMethods B2B loads the content of a document in its memory. For large documents, this may lead to memory constraints. These constraints are noticeable when IBM webMethods B2B runs a query on EDI or XML documents during the document recognition or when it tries to perform pre-processing or processing actions.

IBM webMethods B2B removes these constraints with a process to handle large documents. It saves the content of large documents in a temporary space, reads the content in fragments, and processes the document by retrieving a specified number of bytes as configured in the Runtime options.

When large document handling is enabled in your tenant, you must configure the property Large document threshold in IBM webMethods B2B > Settings > Runtime options > General > Large Document Handling.

Specify when IBM webMethods B2B must consider a document as a large document. When IBM webMethods B2B receives a document that matches the specification, it processes the document as a large document.

Enabling Large Document Handling

Edit online

To enable the IBM webMethods B2B large document handling feature, contact IBM support team.

Defining Size for Large Documents

Edit online

The threshold limit for a large document is defined below:

  • Maximum limit: A document is considered large if it exceeds 31457280 bytes (30 MB). IBM webMethods B2B supports the payload up to 500 MB.

  • Minimum limit: Any document at least 1048576 bytes (1 MB) can be considered large. You must configure the value you want in the Runtime options.

  • Default Value: The default value is 5242880 bytes (5MB).

You must also set the Query threshold, which is the maximum size of the payload IBM webMethods B2B reads to run the queries defined in an XML or EDI document type.

For more information, see Configuring Runtime Options.

Channel for Large Documents

Edit online

When IBM webMethods B2B large document handling is enabled in your tenant, two endpoint URLs for the inbound channel appear.

For more information, see Creating a Channel.

Points to Note

Edit online
  • When you call an integration from IBM webMethods B2B to IBM webMethods Integration, the content for the large document is null. To view the content of the large document, you must call getTransactionContentParts from IBM webMethods B2B operations in IBM webMethods Integration.
  • You must set the contentType in submit operation to application/EDI for VDA payloads.
  • IBM recommends that you use application/EDIStream for Large documents for the contentType in submit operation.
  • Operations convertDocumentToEDIMessage, convertEDIMessageToDocument, and processEnvelope support the processing of large documents. For more information about detailed changes for large documents in EDI connector.
  • In the webMethods.io B2B Connector:
    • For the addTransactionContentPart operation, you must set the input parameter readContentAs as type stream for a payload over 5 MB.
    • For the submit operation, you must set the input parameter readContentAs as type stream for a payload over 5 MB.
  • IBM recommends you not to submit multiple large documents simultaneously for processing.

IMPORTANT All the enhancements in webMethods.io B2B Connector will work as expected with IBM webMethods Integration with Connector Monthly Releases (CMR) 36.

Limitations

Edit online

  • IBM does not provide a IBM webMethods Cloud Container support for large-document handling.

  • You cannot view and download the content of the large document through Partner Portal.

  • EDI transaction size must not exceed 50 MB.

  • When a large EDI payload is submitted with the Validate document structure enabled in IBM webMethods B2B, you might receive a timeout error if there is no response from IBM webMethods Integration within 5 minutes.

  • IBM webMethods B2B does not support:

    • the validation for XML and flat file large documents.

    • the verification of the digital signature for XML large documents.

    • the processing and re-processing of cXML documents as large documents.

      Workaround: Change the value configured in the Large document threshold field as per the cXML payload size or higher, and re-process the document.

    • EDI standards VDA and Tradacoms for large documents.