Updating an EDI document

Edit online

Modify or update the status, description, options and properties of a business document. You can also edit EDI Schema for X12 and UN/EDIFACT business documents.

About this task

The document properties impact the behavior of each node in an inbound document. For any inbound document that deviates from the properties set for each node, webMethods B2B generates appropriate validation errors in the Course of transaction. For information about how to set the validate option, see webMethods B2B operations in webMethods Integration documentation.

Note:

The updates to a business document on webMethods B2B are propagated to the webMethods Integration instance. Access these documents by using the EDI application on webMethods Integration.

Procedure

  1. In webMethods B2B , from the side navigation menu, click Assets > Business documents.
  2. Select an EDI document from the Business documents page.
  3. Update document properties, for a document that has a structure that is associated with it.
    1. Select the node in the document under the Document definition section and click the Document structure tab.
    2. In the Properties section, select the property to update.
    3. Modify the values for the properties.
      For a complete list of properties and their descriptions for records, composites, and fields, see EDI Document Properties.
  4. Click Update.
  5. Go to Attributes and select a node to which you want to add or modify an attribute to extract. For details about EDI document attributes, see Adding EDI document attributes.
  6. Click Update.
  7. Update Options and modify the following options to control the behavior of the business document.
    Options Description
    Enable processing rule routing Search for an appropriate processing rule and use the rule to process the document.
    Validate document structure Validates the structure of the inbound document against the available schema.
    XML Documents
    This option is disabled for the business documents that are created by using a sample XML. This option is also disabled for documents that do not have a corresponding schema available on webMethods Integration. The structure of these documents cannot be validated against the schema.
    EDI Documents
    This option is available for all EDI documents along with the default EDI documents that are available with webMethods B2B .

    When you enable Validate document structure for an existing EDI document and processing fails with the following error message even though the document type exists in webMethods B2B :

    Validation Service Failed: Document type schema <doctypeschemaname> does not exist. You must add/create the document type.

    Try the following options:
    • Click the Reset to standard icon to reset the document, or
    • Log in to webMethods Integration, navigate to Connectors > Predefined, expand EDI, and verify that the document appears in the list of document types, or
    • Log in to webMethods Integration, open any flow service where you added the EDI connector, select the operation ConvertMessageToDocument or ConvertDocumentToMessage, and click the dropdown to view the list of documents. Verify that the document appears in the list.
    The system resolves the issue in the next iteration of processing the document.
    Note: If you reset a document that uses a custom document type, the system reverts it to the original document type. You lose all custom changes.
    Persist document Saves the document.
    • Only unique documents. Save only unique documents to webMethods B2B .
    • All documents. Save all documents.
    This following list describes the parts of the documents that you can save:
    • Content. Save only the content part of the document.
    • Attributes. Save only the document attributes.
      Note: If you reprocess a document without saving document attributes, you might get unexpected results. Because if the attributes are not saved, the document does not match the intended processing rule. Instead, the document does match another processing rule, such as the Default rule, and webMethods B2B processes the actions that are defined in that rule.
    • Activity log. Save only the activity logs of the document.
  8. Click Update.