Allocations

This component runs the Corporate Allocation Setup (CAD) function.

Note: The Navigator function has been restructured at SunSystems 6.2 and consequently the payload has changed. The new SDM function for Allocations consists of an Allocation Definition Header and child Allocation Steps. The old xml tag names have been retained where possible and are now split over parent and child.

Methods

Closed
Driver Type: SASI
Use this method to amend the status of one or more allocations to Closed.
CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more allocations. An allocation is created if it does not exist and amended if it does.
Delete
Driver Type: SASI
Use this method to delete one or more allocations.
DeleteChildData
Driver Type: SASI
Use this method to delete Allocation Step(s) defined in the payload but leaves the parent allocation definitions in place.
Hidden
Driver Type: SASI
Use this method to amend the status of one or more allocations to Hidden.
Open
Driver Type: SASI
Use this method to amend the status of one or more allocations to Open.
Query
Driver Type: Export
You can use this method to obtain allocation details or to extract allocation data from SunSystems.
SuspendedHeld
Driver Type: SASI
Use this method to amend the status of one or more allocations to Suspended/Held.

Mandatory fields

For all methods, a value must be supplied for the Allocation Definition Code - payload element <VSsrfmscAld_AldDefnCode> except for the Query method where it is optional.

In addition, if creating or amending Allocation Step data, or using the DeleteChildData method, then the Allocation Sequence Number - payload element <VSsrfmscAld_AldSeqNum> must be supplied.

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

  • Allocation Step.