EDI Outbound Bootstrap Business Process

The EDI Outbound Bootstrap business process is used by the EDI Outbound File System adapter and the EDI XML Outbound File System adapter to collect a file and then call the proper enveloping services based on the data found.

When to Use

The EDI Outbound Bootstrap business process is invoked by the EDI Outbound File System adapter to collect data (if you send EDI data) or the EDI XML Outbound File System adapter (if you send XML data), which you can use to automate your outbound EDI enveloping and translation.

What You Must Configure Prior to Using

Prior to using the EDI Outbound Bootstrap business process, you must configure the following:
  • Create a map to translate the outbound EDI data.
    Note: If you are sending XML data, you do not need a map because extraction occurs using the parameter values you configure in the EDI XML Outbound File System adapter.
  • If you are sending XML data, configure the five User Parameters on the EDI XML Outbound File System adapter. See EDI XML Outbound File System Adapter Configuration for more information.
  • Create an envelope for the type of data you will send (for example, ASC X12 data). See Creating Envelopes to Use with EDI Translation Business Processes for more information.
  • On the document (transaction-level) envelope, provide the name of the map (unless you are sending XML data). See Creating Envelopes to Use with EDI Translation Business Processes for more information.
  • On the envelope, configure the Extraction Options parameter to Extract to a file system directory. See Creating Envelopes to Use with EDI Translation Business Processes for more information.
  • On the envelope, configure the Data Extraction Directory and Data Extraction Filename parameters. See Creating Envelopes to Use with EDI Translation Business Processes for more information.
  • You may need to modify the predefined file system adapter configurations if you want to use a non-default option such as setting up a schedule to perform automatic file extraction. See Predefined EDI Translation File System Adapters for more information.
  • Divert your outbound files to the install_dir/edioutbound/collect directory (if you are sending EDI data) or the install_dir/edioutbound/collect_xml directory (if you are sending XML data).
  • For EDI data only, provide a Data Extraction map whose name is derived from the File System location where the input file is collected. You must create this map. If the input file is collected from the default directory (install_dir/edioutbound/collect), you should provide a Data Extraction map named EDIOUTBOUND_DOCEXTRACT. If you want to use multiple Data Extraction maps, you do so by nesting the maps in subfolders using a variation of the EDIOUTBOUND_DOCEXTRACT map name. For example, if the input file is dropped into directory install_dir/edioutbound/collect/folder1/folder2, the Data Extraction map must be named EDIOUTBOUND_folder1_folder2_DOCEXTRACT. More generally, if the input file is dropped into directory install_dir/edioutbound/collect/folder1/folder2/…/folderN, the map used for Data Extraction must be named EDIOUTBOUND_folder1_folder2_…_folderN_DOCEXTRACT.
  • All five EDI XML Outbound File System Adapter parameters should be left empty.

Outbound Process Flow Using EDI Data to a File System Directory

The EDI Outbound Bootstrap business process is initiated as part of the following outbound process flow when you a file is placed in the default collection directory:
  1. A file is dropped into the default directory (install_dir/edioutbound/collect).
  2. The EDI Outbound File System adapter calls the EDI Outbound Bootstrap business process.
  3. Determines that the data is EDI.
  4. Provide a Document Extraction map named EDIOUTBOUN D_DOCEXTRACT, according to the File System path where the input file is collected. If you want to use multiple Data Extraction maps, you do so by nesting the maps in subfolders using a variation of the EDIOUTBOUND_DOCEXTRACT map name. For example, if the input file is dropped into directory install_dir/edioutbound/collect/folder1/folder2, the Data Extraction map must be named EDIOUTBOUND_folder1_folder2_DOCEXTRACT. More generally, if the input file is dropped into directory install_dir/edioutbound/collect/folder1/folder2/…/folderN, the map used for Data Extraction must be named EDIOUTBOUND_folder1_folder2_…_folderN_DOCEXTRACT.
  5. The Document Extraction service extracts each individual document, and puts it into the business process context. Additionally, you have the option of having the extracted documents batched, EDI encoded, and EDI enveloped.
  6. Starts the EDI Outbound File System adapter.
  7. Calls the For Each Document service, which incrementally processes the documents. Each time the service runs, it makes the next document in the document set the primary document. This enables business processes to contain loops that operate on each document in turn.
  8. Once each document is translated, it again calls the EDI Outbound File System adapter.
  9. Starts the appropriate enveloping service for the specified standard—one for each document (for example, it calls the ACH Envelope service for an ACH document)—and uses the envelopes you created.
    Note: The envelope specifies what to do with the document once it is enveloped, or specifies that the business process determines the document's disposition.
  10. Places the enveloped documents in the default directory (install_dir/edioutbound/extract).

Outbound Process Flow Using EDI Data to a Mailbox

The following example outbound process flow occurs when you send a file to the default mailbox (EDIOutboundCollectionMailbox):
  1. A file is collected from the default mailbox (EDIOutboundCollectionMailbox).
  2. The EDIOutboundCollectionMailbox default routing rule calls the EDIOutboundBootstrap business process.
  3. Determines that the data is EDI.
  4. Provide a Document Extraction map named EDIOUTBOUND_DOCEXTRACT, according to the mailbox path where the input file is collected. If you want to use multiple Data Extraction maps, you do so by nesting the maps in subfolders using a variation of the EDIOUTBOUND_DOCEXTRACT map name. For example, if the input file is dropped into directory install_dir/edioutbound/collect/folder1/folder2, the Data Extraction map must be named EDIOUTBOUND_folder1_folder2_DOCEXTRACT. More generally, if the input file is dropped into directory install_dir/edioutbound/collect/folder1/folder2/…/folderN, the map used for Data Extraction must be named EDIOUTBOUND_folder1_folder2_…_folderN_DOCEXTRACT.
  5. The Document Extraction service extracts each individual document and puts it into the business process context. Additionally, you have the option of having the extracted documents batched, EDI encoded, and EDI enveloped.
  6. Starts the EDI Outbound File System adapter.
  7. Calls the For Each Document service, which incrementally processes the documents. Each time the service runs, it makes the next document in the document set the primary document. This enables business processes to contain loops that operate on each document in turn.
  8. Once each document is translated, it again calls the EDI Outbound File System adapter.
  9. Starts the appropriate enveloping service for the specified standard—one for each document (for example, it calls the ACH Envelope service for an ACH document)—and uses the envelopes you created.
    Note: The envelope specifies what to do with the document once it is enveloped, or specifies that the business process determines the document's disposition.
  10. Places the enveloped documents in the default mailbox to be sent to your trading partner (EDIOutboundExtractionMailbox).

If exceptions occur when running the EDI Outbound Bootstrap business process, Sterling B2B Integrator generates an EDI Compliance Report.

Outbound Process Flow Using XML Data to a File System Directory

During outbound XML processing, Sterling B2B Integrator takes a batch of documents, breaks them into the component documents without using maps (although maps are required to perform EDI translation), envelopes the documents, and then processes the resulting batch of documents in the manner you specify.

The following example outbound process flow for an XML document occurs when:
  1. A file is dropped into the default directory (install_dir/edioutbound/collect_xml).
  2. The EDI XML Outbound File System adapter calls the EDIOutboundBootstrap business process.
    Note: The five User Parameters that you configure for the EDI XML Outbound File System adapter determine how to process the primary document.
  3. Determines that the data is XML.
  4. The Document Extraction service extracts each individual document and puts it into the business process context. Additionally, you have the option of having the extracted documents batched, EDI encoded, and EDI enveloped.
  5. Starts the appropriate enveloping service for the specified standard—one for each document (for example, it calls the ACH Envelope service for an ACH document)—and uses the envelopes you created.
    Note: The envelope specifies what to do with the document once it is enveloped, or specifies that the business process determines the document's disposition.
  6. Places the enveloped documents in the default directory (install_dir/edioutbound/extract).

Outbound Process Flow Using XML Data to a Mailbox

The following example outbound process flow for an XML document occurs when:
  1. A file is sent to the default mailbox (EDIOutboundCollectionMailbox).
  2. The EDIOutboundCollectionMailbox default routing rule calls the EDIOutboundBootstrap business process.
  3. Determines that the data is XML.
  4. The Document Extraction service extracts each individual document and puts it into the business process context. Additionally, you have the option of having the extracted documents batched, EDI encoded, and EDI enveloped.
  5. Starts the appropriate enveloping service for the specified standard—one for each document (for example, it calls the ACH Envelope service for an ACH document)—and uses the envelopes you created.
    Note: The envelope specifies what to do with the document once it is enveloped, or specifies that the business process determines the document's disposition.
  6. Places the enveloped documents in the default mailbox to be sent to your trading partner (EDIOutboundExtractionMailbox).

If exceptions occur when running the EDI Outbound Bootstrap business process, Sterling B2B Integrator generates an EDI Compliance Report.