TransactionReferenceSetup

This component runs the Transaction References (TRS) function. It allows the user to create, amend and delete as well as query Transaction Reference Setup.

Methods

Closed
Driver type: SASI
Use this method to change the status of a transaction reference setup to Closed.
CreateAsDraft
Driver type: SASI
Use this method to create a draft transaction reference.
CreateOrAmend
Driver type: SASI
Use this method to setup Transaction Reference if it does not exist, and to amend it if it exists. Whereas the Create and Amend method require the user to know whether the setup does or does not exist, this method can be used if the user is unsure.
Delete
Driver type: SASI
Use this method to delete a Transaction Reference Setup from SunSystems.
Hidden
Driver type: SASI
Use this method to change the status of a transaction reference setup to Hidden.
Open
Driver type: SASI
Use this method to change the status of a transaction reference setup to Open.
RangeDelete
Driver type: SASI
Use this method to delete a range of records from Transaction Reference Setup.
Query
Driver type: Export
Use this method to extract transaction reference setup details from SunSystems.
Suspended/Held
Driver type: SASI
Use this method to change the status of a transaction reference setup to Suspended/Held.

Mandatory fields

When setting up Transaction Reference you must supply:

  • Transaction Reference Format - payload element <TransactionReferenceFormatCode>
  • At least one of the Part type: using number stream or input by Operator at Runtime - payload element <Part1Type>, <Part2Type>, <Part3Type>
  • Section Length - payload element <SectionLength>
  • At least one of Part Value: for example Number Stream Code - payload element <Part1Value>, <Part2Value>, <Part3Value>.
  • Description or Short Heading - payload element <Description> or <ShortHeading>
  • Format Analysis - payload element <FormatAnalysis>
Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.

Related data

None.