You are here: Business Rules > Attached Rules > MaintainSuspense

MaintainSuspense

Description

The MaintainSuspense business rule will allow suspense field values to be changed and accounting generated through a collection of multiple suspense tickets. This rule is attached to a transaction and must be listed in TransactionBusinessRulePacket.

MaintainSuspense Atttribute/Element Table
Element/Tag Definition Attribute Element/Attribute Value and Description

<MaintainSuspense>

The opening and closing elements of this business rule.

    

<Tests>

Optional

The opening and closing elements holding one or more conditions that allow the rest of the rule to execute.

   

<Test>

Required, Repeatable

Designates a condition.

 

A conditional expression that must evaluate to a true or false value.

TYPE

Required

Expression

<SuspenseArrays>

Required

Identifies multiple sections of suspense updates.

    

<SuspenseArray>

Required, Repeatable

Identifies a section of suspense updates.

 

Array

Name of the MathVariable that holds an array of SuspenseGUIDS.

NAME

Required

Identifies the suspense records that may be affected by execution of this rule.

A MathVariable that contains an array of suspense GUIDs.

<GenerateAccounting>

Optional

Designates a section of the rule to allow accounting to be updated.

    

<SuspenseTestCollection>

Required

Identifies the collection used to generate accounting. Entries with a value of “True” will generate accounting.

  

A MathVariable of type collection. The keys are suspense GUIDs. These GUIDs must be present in the <SuspenseArray>. The values are text values of either “True” or “False”.

<CopyToSuspenseFields>

Optional

Designates a section of the rule where field updates are identified.

   

<Fields>

Required

The opening and closing elements that associates the fields and their updated values.

    

<Field>

Required, Repeatable

This element designates a suspense field definition block.

    

<FromCollection>

Required

Identifies the collection containing the suspense identities and their new values.

  

A MathVariable of type collection. The keys are suspense GUIDs. The GUIDs must be present in the <SuspenseArray>. The values are the updated data appropriate for the field identified in the <To> element.

<To>

Required

This is the Target Suspense field name.

  

The literal name of the field that will update.

<Suspense> 

Optional element;

The opening and closing tag of the Suspense section of the business rule.

Note:  This element is logically required. If this is omitted, then this business rule has no effect.

 

 

<SuspenseNumber> 

Required element;

MathVariable defining the Suspense number string.

 

Required element value;

String

<CloseSuspense> 

Optional element;

Specifies that the Suspense Record status should be set to Closed when the corresponding transaction is processed.

 

 

<Tests> 

Optional element;

Section of rule should be invoked.

 

 
 

Required /Repeatable element;

Condition to add role to a policy or a segment. If this condition is satisfied, the specified role will be added to the policy or a segment, otherwise the specified role will not be added.

TYPE

Required element value;

Expression

 An expression to specify a condition.

Optional attribute;

="Expression"

To indicate the type of the condition. 

<ShadowSuspense 

Optional element;

Specifies that the Suspense Record status should be set to Closed when the corresponding transaction is processed.

 

 

<Tests> 

Reference details in <CloseSuspense> section.

 

 

<OpenSuspense> 

Optional element;

Specifies that the Suspense Record status should be set to Open when the corresponding transaction is processed.

 

 

<Tests> 

Reference details in <CloseSuspense> section.

 

 

<GenerateAccounting> 

Optional element;

This element is used to indicate whether accounting should be performed for the Suspense records when the corresponding transaction is processed.

 

 

<Tests> 

Reference details in <CloseSuspense> section.

 

 

<GenerateAccountingOnReversal> 

Optional element;

This element is used to indicate whether the accounting should be performed when the corresponding transaction is recycled or reversed.

 

 

<Tests> 

Reference details in <CloseSuspense> section.

 

 

<OpenSuspenseOnReversal> 

Optional element;

This element is used to indicate whether a Closed Suspense should be put back to the Open Status upon reversing the Transaction.

 

 

<Tests> 

Reference details in <CloseSuspense> section.

 

 

<ShadowSuspenseOnReversal> 

Optional element;

This element is used to indicate whether the suspense should be shadowed upon the reversal of the transaction. This will prevent the suspense record from being used anymore.

 

 

<Tests> 

Reference details in <CloseSuspense> section.

 

 

<CloseSuspenseOnReversal> 

Optional element;

This element is used to indicate whether a Suspense record should be Closed upon reversing the transaction.

 

 

<Tests> 

Reference details in <CloseSuspense> section.

 

 

XML Example

<MaintainSuspense>
<Tests>
<Test TYPE="Expression">1=1</Test>
</Tests>
<SuspenseArrays>
<SuspenseArray NAME="SuspenseGuidArray">
<GenerateAccounting>
<SuspenseTestCollection>SuspenseTestCollection </SuspenseTestCollection>
</GenerateAccounting>
<CopyToSuspenseFields>
<Fields>
<Field>
<FromCollection> SuspenseSourceValueCollection</FromCollection>
<To>SuspenseTargetField</To>
</Field>
</Fields>
</CopyToSuspenseFields>
</SuspenseArray>
</SuspenseArrays>
<Suspense>

<GenerateAccounting>

<Tests> 

<Test>Yes = Yes</Test>

</Tests> 

</GenerateAccounting>

<GenerateAccountingOnReversal>

<Tests> 

<Test>Yes = Yes</Test> 

</Tests> 

</GenerateAccountingOnReversal>

<ShadowSuspenseOnReversal>

<Tests> 

<Test>Amount = AttachedAmount</Test> 

</Tests>

</ShadowSuspenseOnReversal>

</Suspense>

</MaintainSuspense>

XML Schema

<MaintainSuspense>
<Tests>
<Test TYPE="Expression">[conditional expression]</Test>
<Test TYPE="Expression">. . .</Test>
. . .
</Tests>
<SuspenseArrays>
<SuspenseArray NAME="[math variable]">
<GenerateAccounting>
<SuspenseTestCollection>[math variable]</SuspenseTestCollection>
</GenerateAccounting>
<CopyToSuspenseFields>
<Fields>
<Field>
<FromCollection>[math variable]</FromCollection>
<To>[math variable]</To>
</Field>
<Field>
. . .
</Field>
. . .
</Fields>
</CopyToSuspenseFields>
</SuspenseArray>
<SuspenseArray>
. . .
</SuspenseArray>
. . .
</SuspenseArrays>
</MaintainSuspense>

Copyright © 2009, 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices