This component runs the Account Allocations (ACA) function with
restrictions on the allocation marker values that can be set.
It does not cater for any of the actions other than Posting. There are three
types of posting actions: Post by Base, Posting by Transaction and Post by Fourth Currency.
For details of usages, see the Note at the foot of this topic. The Allocate method uses the
Action All action if the ActionAllSettings
node is supplied in the input
payload - for details see the Note under the Allocate method.
Methods
- Allocate
- Driver Type: SASI
- Use this method to update one ore more allocation markers only. All
lines satisfying the selection criteria will have the allocation marker set to the
specified value. Note that some allocation marker values are excluded for SSC. The
permitted allocation marker values are:
-
- 0-9 - Numeric markers
- space - Not Allocated
- C - Correction
- F - Force
- R - Reconciled
- W - Withhold
- Y - To be Allocated
-
Note: From version 6.1.0, the
Allocate method uses the Action All if the new node
ActionAllSettings
is supplied in the input payload. Action All allows you to update multiple allocation
markers at once. The following example shows how the new node should be presented in
the input payload:
<Payload>
<AccountAllocations>
<ActionAllSettings>
<AllocationMarkerFrom> </AllocationMarkerFrom>
<AllocationMarkerTo>1</AllocationMarkerTo>
</ActionAllSettings>
<SelectionCriteria>
<AccountCode>64001</AccountCode>
<AllocationMarker> </AllocationMarker>
</SelectionCriteria>
</AccountAllocations>
<AccountAllocations>
<ActionAllSettings>
<AllocationMarkerFrom>1</AllocationMarkerFrom>
<AllocationMarkerTo>2</AllocationMarkerTo>
</ActionAllSettings>
<SelectionCriteria>
<AccountCode>64001</AccountCode>
<AllocationMarker>Y</AllocationMarker>
</SelectionCriteria>
</AccountAllocations>
</Payload>
The new node and Action All do not affect current users. The
Allocate method still works with the previous version of the input payload.
Therefore:
- If
ActionAllSetting
is presented in the input payload, then the
Action method uses Action All to update more than one allocation marker at a
time.
- If
NewSettings
is presented only, the Action method works as
before.
- The transfer process is
aborted if neither
ActionAllSettings
or
NewSettings
are presented in the payload.
Note: From
SunSystems 6.2 the tag
IncludeRough
, which is used to
indicate Provisional Transaction Selection, has been updated.
The
values now accepted are Y, <space> and R where <space> is the
default value:
Value |
Description |
Y |
Include all |
<space> |
Exclude Provisional |
R |
Provisional Only |
- Attach
- Driver Type: SASI
- Use this method to attach Standard Text and/or Ledger Notes to ledger
lines. Selection criteria should be defined as for other methods (i.e.
AccountAllocations\SelectionCriteria\AccountCode
is mandatory). It is
recommended that a journal range is also supplied to improve performance
(AccountAllocations\SelectionCriteria\JournalNumberFrom
and
JournalNumberTo
) otherwise SSC will have to scan through data for all journal entries
for the specified account code in order to find a match. A new node has been added to
the payload in order to provide the data for the Attach method.
-
<JournalData>
<Line>
<JournalLineNumber>.</JournalLineNumber>
<JournalNumber>.</JournalNumber>
<Note>
<InternalOnly>.</InternalOnly>
<SequenceNumber>.</SequenceNumber>
<Text>.</Text>
</Note>
<StandardText>
<Description>.</Description>
<LanguageCode>.</LanguageCode>
<LookupCode>.</LookupCode>
<Paragraph1>.</Paragraph1>
<Paragraph2>.</Paragraph2>
<Paragraph3>.</Paragraph3>
<Paragraph4>.</Paragraph4>
<Paragraph5>.</Paragraph5>
<ShortHeading>.</ShortHeading>
<StandardTextClassCode>.</StandardTextClassCode>
<StandardTextCode>.</StandardTextCode>
</StandardText>
</Line>
</JournalData>
- Both
JournalLineNumber
and
JournalNumber
are mandatory for the Attach method as these specify
the line for which the data is to be attached. If the method is being used to attach
Standard Text then StandardTextClassCode
and
StandardTextCode
must be supplied. If the standard text supplied in
the payload does not exist then it is created. However, it is not possible to amend
existing standard text by this method: existing standard text is attached by key only
and any non-key fields in the SSC
payload are ignored. Standard text can be amended using the Standard Text Language
Variants function from SunSystems or the SSC component
StandardTextLanguageVariants
.
-
Note: SSC only supports the creation of Ledger
Notes at present and there is no attempt to check if the payload data matches an
existing note. The SequenceNumber
in the payload is not used – the
new note has a system generated sequence number. <Text>
is
mandatory when attaching a Note.
- Update
- Use this method to update one ore more eligible fields from the extract results form,
from ACA in Navigation Manager. All lines satisfying the selection criteria will have
all of the new settings applied. The new value for allocation marker has the same
restricted set of values as for the Allocate method.
-
Note: General Description and
General Date fields must first be defined in Additional Field Setup with
Amendable in Account Allocations selected, in order for new
General Description / Date payload values to be applied using the Update
method.
Note: From
SunSystems 6.2 the tag
IncludeRough
, which is used to indicate Provisional Transaction
Selection, has been updated.
The values now accepted are Y, <space> and
R, where <space> is the default value:
Value |
Description |
Y |
Include all |
<space> |
Exclude provisional |
R |
Provisional only |
Mandatory fields
Some fields may be mandatory for the method you are using.
- All methods
- For all methods, a value must be supplied for:
- Account Code (selection account code) - payload element
AccountAllocations\SelectionCriteria\AccountCode
- Allocate
- The Allocate method requires either to supply the allocation marker payload
element:
AccountAllocations\NewSettings\AllocationMarker
- or both from and to markers used by Action All:
AccountAllocations\ActionAllSettings\AllocationMarkerFrom
AccountAllocations\ActionAllSettings\AllocationMarkerTo
- Update
- The Update method requires at least one update value to be set - i.e. at least one
entry in
AccountAllocations\NewSettings
.
Note: You can control the allocation processing using these flags:
-
AccountAllocations\FlagOptions\AllowClosedSuspendedAccountCode
- if this is
set to Y this will allow the allocation if the account code used
is closed/suspended.
-
AccountAllocations\FlagOptions\OverrideAllocations
- if
this is set to Y this will allow you to override any allocations in progress and the
allocation process will continue.