Transaction insert bean
The transaction insert bean is the primary facility to add transactions to an existing Transaction Server batch (ICL).
The payload class name for the transaction insert bean is
com.ibm.paydir.ima.txacc.app.bridge.payment.PaymentInsertBean.
By using the bean, a user can build a completely new transaction to be inserted into a specified batch (ICL). The response for the update returns the new payment ID of the inserted item. For all of the non-control items that are inserted, the batch (ICL) totals (and segment totals if the transaction is given a segment ID) are updated to reflect the additional item that was added.
The inserted transaction appears at the end of the balance order of the batch (ICL). The balance order is the order of transactions in a batch (ICL). This order is originally the order in which the batches (ICLs) were captured or loaded. Once a transaction is inserted into the batch (ICL) or moved within the batch (ICL), the balance order for the batch (ICL) is different from the captured or loaded order. There is no way to alter this behavior using the transaction insert bean by itself. If the user wants to insert a transaction in a position other than at the end of the batch (ICL), the block insert bean must be used. Refer to Block insert bean for more information.
When requested, the transaction insert bean returns ACTION_INSERT as its action code value. The caller can
use the mutator methods that are shown in the following table to configure the transaction insert bean.
| Method name | Takes data type | Description |
|---|---|---|
| setSegmentId | Long | Sets a segment ID for this transaction. The default is NULL. |
| setAssignISN | Boolean | Sets the assign ISN flag for this transaction. The default is false. Setting this
indicator to true causes the inserted transaction to be assigned an item sequence number (ISN) after
insertion. The ISN is assigned based on the following criteria.
|
| setTrackingNumber | Short | Sets the transaction tracking number. The default is 0. |
| setHeaderBytes | Byte[] | Sets the transaction image resource header bytes. The default is NULL. |
| setRecordType | Short | Sets the transaction record type code. The default is 0. |
| setDocumentType | Short | Sets the transaction document type code. The default is 0. |
| setPocketNumber | Short | Sets the transaction pocket number. The default is 0. |
| setCurrencyCode | String | Sets the transaction currency code. The default is USD. |
| setDuplicate | Short | Sets the transaction duplicate setting. The default is 0. |
| setDuplicateReviewedId | String | Sets the transaction duplicate review operator ID. |
| setAutoSelect | Boolean | Sets the transaction automatic selection indicator. The default is false. |
| setControlDocument | Boolean | Sets the transaction control document indicator. The default is false. |
| setCreditItem | Boolean | Sets the transaction credit indicator. The default is false. |
| setOnusItem | Boolean | Sets the transaction on us indicator. The default is false. |
| setSuspect | Boolean | Sets the transaction suspect indicator. The default is false. |
| setSuspectReviewedId | String | Sets the transaction suspect review operator ID. The default is NULL. |
| setClearingChannel | Short | Sets the transaction clearing channel code. The default is 0. |
| setAutoCorrect | String | Sets the automatically corrected specification. The default is NULL. |
| setUserCode | Short | Sets the transaction user code. The default is 0. |
| setUserField | String | Sets the transaction user field. The default is NULL. |
| setEndpointId | String | Sets the transaction endpoint ID. The default is NULL. |
| setEndpointType | Short | Sets the transaction endpoint type code. The default is NULL. |
| setImageRequested | Boolean | Sets the transaction image requested indicator. The default is false. |
| setArchived | Boolean | Sets the transaction archived indicator. The default is false. |
| setPosted | Boolean | Sets the transaction posted indicator. The default is false. |
| setDeleted | Boolean | Sets the transaction deleted indicator. The default is false. |
| setVectorExtracted | Boolean | Sets the transaction vector extracted indicator. The default is false. |
| setRepairable | Boolean | Sets the transaction repairable indicator. The default is false. |
| setReviewable | Boolean | Sets the transaction reviewable indicator. The default is false. |
| setValidationError | Boolean | Sets the validation error indicator. The default is false. |
| setValReviewedId | String | Sets the transaction validation review ID. The default is NULL. |
| setHoldover | Boolean | Sets the transaction holdover field. The default is false. |
| setMicrField | Short, String/Byte[] | Sets the indexed transaction codeline field. The default is NULL. |
| setMicrFieldValidFlag | Short idx, Boolean | Sets the indexed transaction codeline validity field. The default is false. |
| setOrigMicrAmount | String | Sets the transaction original MICR amount field. The default is NULL. |
| setOrigMicrOnUs | String | Sets the transaction original MICR on us field. The default is NULL. |
| setOrigMicrRT | String | Sets the transaction original MICR transit routing field. The default is NULL. |
| setOrigMicrEPC | String | Sets the transaction original MICR EPC field. The default is NULL. |
| setOrigMicrAuxOnUs | String | Sets the transaction original MICR auxiliary on us field. The default is NULL. |
| setOcrMicrAmount | String | Sets the transaction OCR MICR amount field. The default is NULL. |
| setOcrMicrPC | String | Sets the transaction OCR MICR PC field. The default is NULL. |
| setOcrMicrAccount | String | Sets the transaction OCR MICR account field. The default is NULL. |
| setOcrMicrField4 | String | Sets the transaction OCR MICR field 4. The default is NULL. |
| setOcrMicrRT | String | Sets the transaction OCR MICR transit routing field. The default is NULL. |
| setOcrMicrEPC | String | Sets the transaction OCR MICR EPC field. The default is NULL. |
| setOcrMicrAuxOnUs | String | Sets the transaction OCR MICR auxiliary on us field. The default is NULL. |
| setImgCompFailedIIA | String | Sets the transaction failed for image integrity analysis field. The default is blank. |
| setImgCompFailedIQA | String | Sets the transaction failed for image compliance field. The default is blank. |
| setImgCompFailedTIFF | String | Sets the transaction failed for TIFF field. The default is blank. |
| setPrimaryComplianceCondition | Short | Sets the transaction primary image compliance condition code. The default is 0. |
| setPrimaryConditionView | Short | Sets the transaction primary image condition view. The default is NULL. |
| setConvertingBankRT | String | Sets the transaction converting bank transit routing. The default is NULL. |
| setOriginSequenceNumber | String | Sets the transaction original sequence number. The default is NULL. |
| setCaptureDate | Timestamp | Sets the transaction capture date. The default is NULL. |
| setCaptureSequenceNumber | String | Sets the transaction capture sequence number. The default is NULL. |
| setDeposAvailDays | Short | Sets the transaction presentment availability days field. The default is 0. |
| setPresAvailDays | Short | Sets the transaction presentment availability days field. The default is 0. |
| setDeposItemBillingCD | String | Sets the transaction deposit billing code field. The default is NULL. |
| setPresItemBillingCD | String | Sets the transaction item billing code field. The default is NULL. |
| setBofdOrigRouting | String | Sets the transaction bank of first deposit transit routing field. The default is NULL. |
| setBofdBusinessDate | String | Sets the transaction bank of first deposit business date field. The default is NULL. |
| setBofdSequenceNumber | String | Sets the transaction bank of first deposit sequence number field. The default is NULL. |
| setBofdOrigRoutingVal | Boolean | Sets the transaction bank of first deposit transit routing validity indicator. The default is false. |
| setBofdBusinessDateVal | Boolean | Sets the transaction bank of first deposit business date validity indicator. The default is false. |
| setBofdSequenceNumberVal | Boolean | Sets the transaction bank of first deposit sequence number validity indicator. The default is false. |
| setNumTimesReturned | Short | Sets the transaction number of times returned value. The default is 0. |
| setAccumId | String | Sets the transaction accumulator ID. The default is NULL. |
| setFrontBlackWhiteImage | Byte[] | Sets the front black and white image. The default is NULL. |
| setRearBlackWhiteImage | Byte[] | Sets the rear black and white image. The default is NULL. |
| setFrontGreyScaleImage | Byte[] | Sets the front gray scale image. The default is NULL. |
| setRearGreyScaleImage | Byte[] | Sets the rear gray scale image. The default is NULL. |
| setFbwGrade | Char | Sets the front black and white image grade. The default is 0. |
| setFgsGrade | Char | Sets the front gray scale image grade. The default is 0. |
| setRbwGrade | Char | Sets the rear black and white image grade. The default is 0. |
| setRgsGrade | Char | Sets the rear gray scale image grade. The default is 0. |
The insert transaction request builds a brand new row in the payment table and attaches a version 1 item
row to it. The item row has the transaction details that are initially specified by using the mutator methods
for the bean.
Note: The insert bean action is not used because this ID value is created as a result of the
transaction insertion itself. Setting its value has no effect on the insertion. Querying the insert bean for
the payment ID being affected by the insert simply returns a zero (0) or any other value assigned using the
corresponding bean mutator method.