Image Cash Letter Join Service

The Image Cash Letter Join service inserts variable length binary images (Type52 records) into Image Cash Letter documents. This service is typically used after translation to join the binary images previously split out by the Image Cash Letter Split service.

Note: This service does not enforce or validate the standard.

The following table provides an overview of the Image Cash Letter Join service:

System name
ImageCashLetterJoin
Graphical Process Modeler (GPM) categories
All Services, EDI
Description
The default behavior is to read through the PrimaryDocument looking for binary image data placeholder records (inserted by the Image Cash Letter Split service) and, if found, join the corresponding binary image back into the Image Cash Letter document. Alternatively, this service can be used to insert binary images based on truncated Type52 records (only contains fields 1-17).
Preconfigured?
A configuration of this service is created when the product is installed.
Platform availability
All supported Sterling B2B Integrator platforms
Related services
Image Cash Letter Split service
Application requirements
No
Initiates business processes?
None
Invocation
Runs as part of a business process.
Returned status values
  • Success (this status value is returned if the service successfully joined the binary images into the document)
  • Error (see below for list of errors)
    1. Not licensed for use
    2. No Primary Document or zero bytes
    3. No Placeholder records found
    4. No Type52 records found
    5. Missing Type52 record for image
    6. Missing Type52 record after Type50
    7. Invalid record length
    8. Image document not found
Restrictions
No

Implementing the Image Cash Letter Join Service

To implement the Image Cash Letter Join service, you just need to use the Image Cash Letter Join service in a business process.

Parameters Passed From Business Process to Service

The following table contains the parameters passed from the business process to the Image Cash Letter Join service:

join_bufferSize
This is the size of the buffer for reading data. If not specified, the default is 2048.
join_encoding
This specifies the encoding of the input PrimaryDocument. If not specified, the PrimaryDocument encoding is used (if set) or the system default is used.
join_inputRecLen
This indicates whether the input PrimaryDocument contains a record length for each record. If not specified, it defaults to true (indicating that the input contains the record length).
Note: The record length is always written to the output PrimaryDocument.
join_inputRecSepNum
This indicates whether the input PrimaryDocument contains record separators. If not specified, the default is zero (no separators). This behavior can be overridden by changing the value of this parameter (for example, if the file uses CR/LF record separator, set this parameter to join_inputRecSepNum=2).
join_outputRecSeps
This indicates whether each record written to the output PrimaryDocument will be followed by a record separator. If not specified, the default is none (no record separators). If you want each record written with a record separator, you must do so using two-byte hex characters (for example, join_outputRecSpes='0D0A' indicates the separator used is the carriage return/line feed).
join52
This indicates whether the service looks for placeholder records or Type52 records for image replacement. If not specified, it defaults to false, which instructs the service to look for placeholder records previously inserted by the Image Cash Letter Split service. If you want the service to use Type52 records, you must set this parameter to true. Furthermore, the Type52 records must contain fields 1-17 only and this service will fill in field18 (length of image data) and field19 (the image data). The images to be joined using the "join52=true" option must be in the ProcessData tree as follows:
<ProcessData>
<Images>
<Image1/>
<ImageN/>
</Images>
</ProcessData>
errorIfNothingToJoin
This determines whether an error is returned if no placeholder or Type52 records are found in the PrimaryDocument. The default is true (return an error if no placeholder or Type52 records are found), unless otherwise specified.