Spawns Element
The Spawns element generates subsequent transactions based on defined criteria. Includes the values of the fields in the activity it is spawning.
The following spawn codes are supported:
- 01 - Spawn immediately (use current Activity Effective Date)
- 02 - Spawn one year from current activity date
- 03 - Spawn on a specific date (Uses FIELD attribute to hold the spawn date)
- 04 - Spawn on next business date from current activity date
- 05 - Spawn one month from current activity date
- 07 - Spawn 3 months from current activity date
- 09 - Spawn from policy collection (Uses FIELD attribute to hold the spawn date)
| Element/Tag | Attribute | Definition | Element/Attribute Value and Description |
|---|---|---|---|
|
<Spawns> |
|
This is the start and end element for the transaction. |
|
|
<Spawn>
|
|
Required element: Opening element that defines the transaction to spawn and its data. |
|
|
IF
|
Optional attribute: Condition that when true initiates the spawn. If not present spawn will generate under all conditions. Go to Operators available for EXPRESSION Writing to see what operators you may use for condition writing. |
String: |
|
|
<Transaction> |
Required element: Name of the transaction to be spawned. |
String: |
|
|
COLLECTION |
Defines the collection of SuspenseGUIDs and the specified amounts to be spawned. | This should be a MathVariable name. | |
|
CLIENT |
A Client GUID. Used when spawning activity to one client. Not applicable for SpawnCodes 06, 08, 09 or 10. | ||
|
CLIENTLISTQUERY |
SQL that returns multiple Client GUIDs. Used for spawning activities to multiple clients. Not applicable for SpawnCodes 06, 08, 09 or 10. |
SQL: |
|
|
POLICYFIELD |
|||
|
SCHEDULEGUID |
This attribute will populate the ScheduleGuid column in the AsActivity Table when spawning a new activity. MathVariable name. |
String: |
|
|
FIELD |
Required attribute: Variable defining the EffectiveDate of the spawn. |
String:
|
|
| SPAWNCODE |
Required attribute: As defined by codename in AsCodeSpawn in AsCode table. Determines effective date of spawned transaction. |
Code: '03'Note: Other spawn codes not supported. |
|
|
SPAWNDAY |
String |
||
|
SPAWNONREVERSAL |
Yes,No |
||
|
SQL |
A query with the result being a policy GUID. Applicable when the SpawnCode is 09. |
||
|
<Allocation>
|
|||
|
TYPE
|
Required attribute: |
Policy / Parent / Segment / Program |
|
| ProgramGUID | Optional element: When Type="Program".Specifies the ProgramGUID to which the Allocation has to be updated. | MathVarible/Activity Fields(Activity: <FieldName>) | |
|
<SpawnFields> |
|
Optional element: Opening and closing tags identify the SpawnField section of the spawn. |
|
|
<SpawnField> |
|
Required, Repeatable: Identifies and defines the fields that will be spawned and value populated when the activity processes. |
|
|
<From> |
|
Defines the value of the Activity field or MathVariable passed to the spawn. |
Name of ActivityField or MathVariable in the transaction. |
|
<To> |
|
Defines the field in the spawned activity to be populated. |
Name of ActivityField or MathVariable in the spawning transaction to receive value. |
|
<DataType> |
|
Defines the value of the DataType for the spawned Activity field. |
Check
|
|
<Suspense> |
TYPE |
A single suspense ticket to be spawned. Indicates the suspense is based on a suspense number. |
Number or GUID |
|
<MultiSuspense> |
TYPE |
Required:Multiple suspense tickets to be spawned. Defines the primary key type of the referenced variable. |
Number or GUID |
XML Example
<Spawns>
<Spawn>
<Transaction SPAWNCODE="03 FIELD="NextCycleDate">EntryReportByAccount</Transaction>
<SpawnFields>
<SpawnField>
<From>GroupByField</From>
<To>GroupBy</To>
<DataType>Text</DataType>
</SpawnField>
<SpawnField>
<From>NextCycleDate</From>
<To>FromDate</To>
<DataType>Date</DataType>
</SpawnField>
<SpawnFields>
<Allocation TYPE="Policy">02</Allocation>
</Spawn>
</Spawns>
Example of the use of an Activity Array
<Spawns>
<Spawn IF="SpawnActivityFlag = true">
<Activity>PolicyActivityArray</Activity>
<Spawn>
<Spawns>
