Input Payloads Structure
The input payload structures required by the Query and Process methods are different.
Note: The input payload for some business
components such as Customer, Item, and Supplier, consists of elements that are maintained
by other business components. For example,
<AddressCode>,
<AddressCode1> are included in the Customer input payload, while
they are maintained using business component 'Address'. For this reason, creating or
amending records using other components' elements is not possible. For example, you create
a new customer record using the customer input payload; in the input payload you include a
new address record. When the transfer process is complete, a new customer is created and
stored into the Customer table, however, an address record is not created in the Address
table. There is no message to advise if this occurs during the transfer process. The following table shows the structure of an input payload for the Accounts component. It is representative of the majority of input payloads.
| <?xml version="1.0" encoding="UTF-8"?> | An input payload must start with an XML declaration. |
| <SSC> | The XML declaration must be followed by an <SSC> element. |
| <ErrorContext> | Identifies what type of error handling is active for this payload file and overrides any system-wide defaults. |
| <ErrorOutput>.</ErrorOutput> | Overrides the SSC installation default for the amount of message detail that SSC generates whenever a message is sent. |
| <ErrorThreshold>.</ErrorThreshold> | Overrides the SSC installation default for the types of messages that appear in the output payload. |
| </ErrorContext> | |
| <User> | Identifies the SunSystems user name and must be provided for authentication. It specifies the User Id under which the payload runs. |
| <Name>.</Name> | This User Id specified here must exist in SunSystems as an Operator defined in Security before running the payload. |
| </User> | |
| <SunSystemsContext> | This element provides top level information for validation and applies to all transactions contained in the <Payload> element. Depending on the component, this element is where you specify the Business Unit, Budget or Ledger code for the payload. |
| <BusinessUnit>.</BusinessUnit> | |
| </SunSystemsContext> | |
| <Payload> | A high level element used to flag the start of the payload records. |
| <Accounts> | A high level element used to flag the start of a single payload record. (Only a single Account record element is shown here). |
| <AccountCode>.</AccountCode> | |
| </Accounts> | |
| </Payload> | |
| </SSC> | An input payload must end with an </SSC> element. |