What is an SSC Payload File?

Often referred to as a 'payload', an SSC payload file is simply a text file in XML format. A payload contains the XML elements and data values used by SSC at runtime to import, update or export data from the SunSystems database.

Each SSC component has a payload definition controlling the data items that you can specify for that particular component. All components have a set of one or more methods that SSC uses at runtime to execute, such as Create, Amend or Query.

Input Payload

An input payload contains the XML elements and their data values that SSC processes at runtime. Input payloads generally have a common structure. However, those used by the Query and Process methods are different.

注意：Rounding may occur on import if an input payload contains a numeric value that is not of the same format as the SunSystems field for which it is destined (for example, the Credit Limit field in a Chart of Accounts record).

Output Payload

At runtime, SSC processes the input payload file and generates an output payload file (also in XML format), that records the success or failure of the records contained in the input file and the data item values that were written to or retrieved from database during execution.

Log File

If you choose to use Transfer Desk to run your payload, SSC creates a log file (also in XML format) at runtime. This contains logging information.