Text Document Appender Service

The Text Document Appender service adds a string at the end of a document in a business process.

The following table provides an overview of the Text Document Appender service:

Category Description
System name Text Document Appender Service
Graphical Process Modeler (GPM) categories All Services
Description Use the Text Document Appender service to add a string at the end of a document in a business process.
Business usage You receive a document from a trading partner or the document is a translated document. You might need to add a string to the document to process it. The Text Document Appender service allows you to add a string to the document.
Usage examples The document that you received from a trading partner does not have a line terminator in the document. The Text Document Appender allows you to add a line terminator which is required for processing the document.
Preconfigured? No
Requires third-party files? No
Platform availability All supported Sterling B2B Integrator platforms
Related services None
Application requirements N/A
Initiates business processes? No
Invocation This service is added as a step in a business process. When you invoke the business process, the Text Document Appender service adds the specified string at the end of the primary document.
Business process context considerations None
Returned status values Returned status values:
  • Success
  • Error
Restrictions N/A
Persistence level System Default
Testing considerations None

Configuring the Text Document Appender Service

To configure the Text Document Appender service, you must specify settings for the following fields in the GPM:

Field Description
appendString Specify the string value to be added at the end of the primary document. Valid value is any string. Required.

Output from Service to Business Process

The following table contains the parameter passed from the Text Document Appender service to the business process:

Parameter Description
appendString Specify the string value to be added at the end of the primary document. Valid value is any string. Required.

Output from Business Process to Service

The Text Document Appender service adds the string value that you specify in the appendString paramater at the end of the primary document. If no primary document is available, the Text Document Appender service creates a primary document and adds the string value that you specify in the appendString parameter to the primary document.

Business Process Example

The following example business process illustrates by using the Text Document Appender service:

<process name="default">
 <operation name="Text Document Appender">
   <participant name="TextAppender"/>
   <output message="DocAppendInputMessage">
     <assign to="appendString">Append String</assign>
     <assign to="." from="*"></assign>
   </output>
    <input message="inmsg">
     <assign to="." from="*"></assign>
   </input>
  </operation> 
</process>