Suspense Element

Suspense tracks the flow of money as it is received by the carrier and then consumed by one or more Policy level activities. The existence of this element in the transaction configuration will add a Suspense tab on the Activity entry screen. One Suspense item must be selected or entered in this tab. As the Activity processes, the amount of payment is added to the "Attached" amount as long as it does not exceed the full suspense amount. This reduces or clears the amount available for subsequent "attachments". If a Suspense item's amount is not available to attach, an error will be generated.

SuspenseElement: Elements and Attributes

Element

Parent Element

Attribute

Description

<Suspense>

<Transaction>

  

Optional:

This element adds the Suspense tab to the Activity entry so the user may select or enter a Suspense item to associate with the Activity.  This element cannot exist in the same transaction definition as the <MultiSuspense> element.  The element's field reference contains the amount that will be attached.

Values:

field name
 

<Suspense>

OVERRIDABLE

Optional:

This attribute defines user capabilities upon generated errors.

Values:

  • No

    • default

    • If suspense errors are generated a user cannot override them.

  • Yes

    • Allows a user to override Suspense errors if they are generated.

  • Ignore

    • Suspense errors will not be generated.
 

<Suspense>

VALUE

Required:

This attribute defines how the invested amount compares to the unattached suspense amount.

Values:

  • Sufficient

    • The unattached amount in the suspense record is equal to or greater than the value of the field referenced by the <Suspense> element.

  • Equals

    • The unattached amount in the suspense record must match the value of the field referenced by the <Suspense> element.
 

<Suspense>

REQUIRED

Optional:

This attribute defines whether suspense must be associated with the activity.

Values:

  • Yes

    • default

    • This attribute requires that the user select a suspense record to associate with the activity.

  • No

    • There is no requirement for the user to select a suspense record to associate with the activity.
 

<Suspense>

AUTOENTRY

Optional:

This attribute defines the automatic creation of suspense detail.

Values:

  • No

    • default

    • The user will make a selection from existing suspense records.

  • Yes

    • The suspense record associated with the activity will be generated from the value of the field referenced by the <Suspense> element.

 

XML Schema

<Transaction>
...
<Suspense OVERRIDABLE="[No | Yes | Ignore]" VALUE="[Sufficient | Equals]" REQUIRED="[Yes | No]" AUTOENTRY="[No | Yes]">[field name]</Suspense>
...
</Transaction>

XML Example

<Transaction>
...
	<Fields>
		...
		<Field>
			<Name>PaymentAmount</Name>
			...
		</Field>
		...
	</Fields>
...
	<Suspense OVERRIDABLE="No" AUTOENTRY="No" VALUE="Sufficient">PaymentAmount</Suspense>
...
</Transaction>