Image Cash Letter Split Service
The Image Cash Letter Split service removes variable length binary images (Type52 records) from Image Cash Letter documents. This service is typically used before translation.
Note: This service does not enforce or validate the standard.
The following table provides an overview of the Image Cash Letter Split service:
- System name
- ImageCashLetterSplit
- Graphical Process Modeler (GPM) categories
- All Services, EDI
- Description
- Removes variable length binary images (Type52 records) from Image Cash Letter documents. This service is typically used before translation and it replaces the Type52 record with a fixed length placeholder record that begins with |CheckImage followed by a number of the image file created in ProcessData (for example, |CheckImage1, |CheckImage2, and so forth). This default behavior can be changed to strip Type52 records and the image data separately by setting the workflow parameter split52=true. In this case, the textual portion of the record is added as an attribute of the image document.
- 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 Join 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)
- Not licensed for use
- No Primary Document or zero bytes
- Unexpected record type
- Invalid record length
- Image document not found
- Restrictions
- No
Implementing the Image Cash Letter Split Service
To implement the Image Cash Letter Split service, you just need to use the Image Cash Letter Split 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 Split service:
- split_bufferSize
- This is the size of the buffer for reading data. If not specified, the default is 2048.
- split_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.
- split_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 split_inputRecSepNum=2).
- split_outputRecSeps
- This indicates whether each record written to the output PrimaryDocument will be followed by a record separator. The default record separator used is hex 0x0A(line feed). If you want to specify a different record separator, you must do so using two-byte hex characters (for example, split_outputRecSeps=”0D0A” indicates the separator used is carriage return/line feed).
- split_outputRecLen
- This indicates whether the record lengths will be written to the output PrimaryDocument for each record. If not specified, it defaults to true (the record lengths are written to the output PrimaryDocument for each record).
- split52
- This specifies whether the Type52 record is removed from the PrimaryDocument as one entity. If not specified, it defaults to false. If you want the Type 52 record and image data removed separately, you must set this parameter to true (which will add the textual portion of the record as an attribute of the image document).
- errorIfNothingToSplit
- This determines whether an error is returned if no Type52 records are found in the PrimaryDocument. The default is true (return an error if no Type52 records are found), unless otherwise specified.