If Document Tracking is enabled, there are two ways of re-injecting a failed document back into the flow.

  • Directly from the document list
  • Retrieving from the search results page

Both the above are explained with the help of an example below.

The figure below shows a sample flow Event Process1 which has Document Tracking enabled on various ports.

Figure 1: Example Event Process1

As per the above figure, the ports below have Document Tracking enabled:

  • Feeder1 OUT_PORT
  • Display2 IN_PORT

Following events happen in sequence:

  1. A message that is sent from Feeder1 will be sent through Display1 to DB1.
  2. DB1 will process the message and send the result to Display2.
  3. If DB1 fails to process this message the message will be sent to EXCEPTION_PORT of DB1 which will send the exception message to Display2.
  4. Every successful message will be registered as completed in the Dashboard > Document Tracking > Application Documents tab.

The figure below shows the first message sent for which processing has been successfully completed.

Figure 2: Successful document processing

Every failed document gets added to the exception documents count under the same tab. The figure below shows the failed document which is added to the exception count.


The document may or may not be counted as complete depending on the configuration of the work flow. In the example above, whether the document fails or not, the work flow will be completed and the completed count will be incremented regardless of the exception.

Figure 3. Failed document processing

There are three ways in which the document can be re-injected

Re-injection through the regular document listing

As per the example specified in the section above, the second document failed to get processed. From the listing of the documents for Event_Process1, select the second document as shown in the figure below.

Figure 4: Selecting Failed document

On selection of the second document, the places where the document was tracked is listed as well as the message content at these points. As per the example, the document will be tracked at four places and hence four listings will be seen for the document.

Follow the steps below to successfully re-inject the document:

Locate the EXCEPTION_PORT document. This is the error document that was tracked at the EXCEPTION_PORT.


EXCEPTION_PORT document is not the document to be re-injected, but the one tracked at a point before this.

Figure 5: Exception document

The Component where the document failed can be identified from the EXCEPTION_PORT document. Locate the correct point of re-injection. Go back to the flow and refer to all the ports that have Document Tracking enabled.

When going backwards in the flow, the first port which is tracked before the EXCEPTION_PORT at which the exception document was received is the best point to re-inject the document. In the current example, since the IN_PORT of the DB component is the port that is document tracked right before the EXCEPTION_PORT, the IN_PORT becomes the best place to re-inject the document (refer to Figure 1 for the flow diagram).

From this point, there are two ways to re-inject the document.

Choose from This Document

Steps below indicate the first method that can be used to re-inject the document:

  1. Select the re-inject icon of the document with DB as the component and the Originating State as the IN_PORT and select the This Document option.

    Figure 6: Re-injecting the document directly

  2. Click the Re-inject button on the window displayed after making changes to the document (if any)

    Figure 7. Document content displayed during re-injection

  3. In the JMS Configuration screen, change the configurations as per installation and click the Publish button; the document for reprocessing gets reinjected. The message will be resent to the DB Component to reprocess.

    Figure 8. The JMS Configuration screen

Choose From Workflow

  1. Select the Chose Document from Same Workflow option after selecting Re-inject on the failed document.

    Figure 9. Choose Document from Same Workflow

  2. A list of places at which the failed document was tracked gets displayed.

    Figure 10: List of place at which the failed document was tracked

  3. Select the document to be re-injected and click the Proceed with Selected Document button
  4. This will open the document that was tracked at the IN_PORT in a pop-up window.
  5. Follow the Steps 2 and 3 above.

Choose from Original Document

This option is to re-inject the original message originating from exception ports by taking out the original message from the error message at the exception port and auto re-injecting the messages.


The Original Document option appears only in the Re-inject option for the ON_EXCEPTION Originating State (See the figure below).

The advantage of this option is that the exception port always gets the error messages and when the error occurs at any point, it re-injects the original document that failed sending to the component for reprocessing.

In the first two methods of reinjection, previous ports had to be tracked. While choosing from original document, since exception ports are tracked by default, re-injection is always possible, thereby having the document back in the system.

Perform the actions below to enable the same:

  1. Select the re-inject icon of the document with DB as component and Originating State as ON_EXCEPTION and select the Original Document option.

    Figure 11: Re-injecting document directly

  2. Click the Re-inject button on the pop-up window after making changes to the document (if any).

    Figure 12: Document content display during re-injection

  3. In the JMS Configuration screen, change the configurations as per the installation and click the Publish button; this will re-inject the document for reprocessing.The message will be resent to the DB Component to reprocess.

    Figure 13: The JMS Configuration screen

Re-injecting Document from the Search tab

Follow the steps below to re-inject the document from the Search tab.

  1. From the application documents listing, copy the Workflow ID of the failed document.
  2. Go to Dashboard > Document Tracking > Search and click the Filter SBW Documents button present at the upper-right part of the screen..

    Figure 14: Search Filter

  3. A search parameters window is displayed. Provide the Workflow ID copied above in the Workflow Instance ID field and click Search.

    Figure 15: Search with Workflow ID

  4. All the points at which the document was tracked get listed.

    Figure 16: Search Result - List of tracking points for the document

  5. Click the re-inject button of the document to re-inject it and follow the steps given in the Choose from This Document section to re-inject the document at the correct point.
Adaptavist ThemeBuilder EngineAtlassian Confluence