ActivityResultsScreen

This Business Rule provides the system with configuration to influence the data presentation of specific tabs on an Activity's result page. The rule can modify specific presentation qualities of the Allocations, the Allocation's Fund Names, Valuation, Disbursement and Accounting tabs. This rule must be attached to a transaction, but it does not process during activity processing so it should not be listed in TransactionBusinessRulePacket. The rule actually processes when a user opens an active Activity.

ActivityResultsScreen Elements and Attributes
Element Attributes Parent Element Description Element/Attribute Values
<ActivityResultsScreen>    

Required:

The opening and closing element of the ActivityResultsScreen Business Rule.

  

<Allocations>

   <ActivityResultsScreen>

Optional:

This is used to influence the data presentation on the Allocations tab of an Activity.

  

 

 SHOWORIGINAL <Allocations>

Required:

This attribute controls the display of the original allocations on the Allocation tab of the Activity Results screen.

Values:

  • No

    • default

    • Final Allocations will display and original Allocations will not display.

  • Yes

    • Final and original Allocations will display.

  • variable

    • Math variable name with the value of "Yes" or "No".

<FundDisplay>

   <ActivityResultsScreen>

Optional:

This is used to influence the fund names presented on the Allocations tab of an Activity.

  

<DisplayChildFunds>

   <FundDisplay>

Required:

The default funds displayed by the Activity are parent funds.  This element defines when the fund names displayed by the Activity are the child funds.

Values:

  • No

    • default

    • The activity displays parent funds.

  • Yes

    • The activity displays child funds.

<Valuation>

   <ActivityResultsScreen>

Optional:

This is used to influence the data presentation on the Valuation tab of an Activity.

  

<NegativeCashValue>

   <Valuation>

Required:

This element indicates the screen should display the Negative Cash Value as a Policy's sub-total and its label..

Values:

  • label

    • The literal text value to display as the label.

    • This value can be translated.

<PositiveCashValue>

   <Valuation>

Required:

This element indicates the screen should display the Positive Cash Value as a Policy's sub-total and its label.

Values:

  • label

    • The literal text value to display as the label.

    • This value can be translated.

<Disbursement>

   <ActivityResultsScreen>

Optional:

This is used to define the data presentation on the Disbursement tab of an Activity.  If this element is absent from the rule a default set of data will be presented.  The default data that may be presented are:  Disbursement Number, Disbursement Date, Disbursement Status, Distribution Type, Disbursement Amount and Payee's Role.

  

<FixedFields>

   <Disbursement>

Optional:

This element defines the fixed fields to display on the Disbursement tab of an Activity.  If this element is not configured in the rule, the DisbursementScreen provides the fields that will display on the Disbursement tab.

See the "Common <Field> definition" below.

The list of fields available to the <Field>'s <Name> element are:

DisbursementNumber

DisbursementDate

DisbursementStatus

Displayed value from AsCodeDisbursementStatus.

DisbursementType

Displayed value from AsCodeDisbursementType.

DisbursementAmount

CheckNumber

NetAmount

ClientRole

Displayed value from AsCodeRole.

TypeCode

Refers to client type

Displayed value from AsCodeClientType

ClientName

TaxID

MiddleInitial

FirstName

LastName

CompanyName

Sex

Displayed value from AsCodeClientSex.

DateOfBirth

DateOfDeath

Email

Prefix

Displayed value from AsCodeClientPrefix.

Suffix

Displayed value from AsCodeClientSuffix.

Address

Withholding fields configured in the transaction's <Disbursement> element.

  

<Fields>

   <Disbursement>

Optional:

This element defines the dynamic fields to display on the Disbursement tab of an Activity.

See the "Common <Field> definition" below.

The list of fields available to the <Field>'s <Name> element are any dynamic field names.

  

<Accounting>

   <ActivityResultsScreen>

Optional:

This is used to define the data presentation on the Accounting tab of an Activity.  If this element is absent from the rule a default set of data will be presented.  The default data that may be presented are:  Account Number, Description, Debit/Credit and Amount.

  

<Table>

   <Accounting>

Required:

This element establishes the presentation of a columnar layout.

  

<Column>

   <Table>

Required, Repeatable:

This element defines a single column to contain a field's data value.  This element is repeated to defined multiple columns for the table.

  

 

 ALIGN <Column>

Optional:

This attribute defines the alignment of the data value in the column.

Values:

  • LEFT

    • default

    • The data value is aligned to the left of the column.

  • CENTER

    • The center of the data value is aligned at the center of the column.

  • RIGHT

    • The data value is aligned to the right of the column.

<Name>

   <Column>

Required:

This element identifies the column name or dynamic field name from the source entity to present in the column.

Values:

  • Fields from AccountingDetail

    • AccountNumber

    • Description

    • DebitCredit

      • Displayed value from CodeDebitCredit

    • Amount

    • FundName

    • SuspenseNumber

  • Fields from AccountingDetailExchange

    • OriginalAmount

    • ExchangeRate

    • ExchangeDate

    • MarketMaker

  • Dynamic fields from AccountingDetailField

<Display>

   <Column>

Required:

This element provides the label for the column's header.

Values:

  • label

    • This value can be translated.

  

<DataType>

   <Column>

Required:

This element provides the data type of the data being presented.

Values:

  • Text

  • Date

  • Integer

  • Decimal

  • Money

  • Text

  • Area

  • Radio

  • Check

<Group>

   <Column>

Required:

This element provides the common table name where the field resides.

Values:

  • AccountingDetail

  • AccountingDetailField

  • AccountingDetailExchange
Common <Field> definition  

<Field>

  

<FixedFields> 

or

<Fields>

Required, Repeatable:

This element defines a single field to present or hide.

  

<Name>

  

<Field>

Required:

This element identifies the column name or dynamic field from the source entity to present on the screen.  The available values are listed by the containing <Field>'s parent element.

Values:

  • field name

  • column name

<Display>

  

<Field>

Required:

This element provides the label associated to the field.  This label can be translated.

Values:

  • label

    • This value can be translated.

<Hidden>

  

<Field>

Optional:

This element hides or shows the field on the screen.

Values:

  • No

    • default

    • The field will display on the screen.

  • Yes

    • The field is hidden.

<Expanded>

  

<Field>

Optional:

This element directs the system to expand the width of the field to occupy the all columns in the screen's presentation layout.  If the field's natural position is not in the left-most column, it moves to the next line and occupies the full width of the presentation layout.

Values:

  • No

    • default

    • The field occupies its position in a single column.

  • Yes

    • The field occupies the full width of the presentation's layout.

XML Schema

<ActivityResultsScreen>
    <Allocations SHOWORIGINAL="[No | Yes | variable]"></Allocations>
    <FundDisplay>
        <DisplayChildFunds>[No | Yes]</DisplayChildFunds>
    </FundDisplay>
    <Valuation>
        <NegativeCashValue>[label]</NegativeCashValue>
        <PositiveCashValue>[label]</PositiveCashValue>
    </Valuation>
    <Disbursement>
        <FixedFields>
            <Field>
                <Name>[field name]</Name>
                <Display>[label]</Display>
                <Hidden>[No | Yes]</Hidden>
                <Expanded>[No | Yes]</Expanded>
            </Field>
            <Field>...</Field>
        </FixedFields>
        <Fields>
            <Field>
                <Name>[field name]</Name>
                <Display>[label]</Display>
                <Hidden>[No | Yes]</Hidden>
                <Expanded>[No | Yes]</Expanded>
            </Field>
            <Field>...</Field>
        </Fields>
    </Disbursement>
    <Accounting>
        <Table>
            <Column ALIGN="[LEFT | CENTER | RIGHT]">
                <Name>[AccountNumber | Description | DebitCredit | Amount | FundName | SuspenseNumber]</Name>
                <Display>[label]</Display>
                <DataType>[Text | Integer | Decimal | Money]</DataType>
                <Group>AccountDetail</Group>
            </Column>
            <Column ALIGN="[LEFT | CENTER | RIGHT]">
                <Name>[OriginalAmount | ExchangeRate | MarketMaker | ExchangeDate]</Name>
                <Display>[label]</Display>
                <DataType>[Text | Date | Decimal | Money]</DataType>
                <Group>AccountDetailExchange</Group>
            </Column>
            <Column ALIGN="[LEFT | CENTER | RIGHT]">
                <Name>[field name]</Name>
                <Display>[label]</Display>
                <DataType>[Text | Date | Decimal | Money | TextArea | Radio | Check]</DataType>
                <Group>AccountDetailField</Group>
            </Column>
            <Column>...</Column>
        </Table>
    </Accounting>
</ActivityResultsScreen>

XML Example

<ActivityResultsScreen>
    <Allocations SHOWORIGINAL="Yes"></Allocations>
    <FundDisplay>
        <DisplayChildFunds>Yes</DisplayChildFunds>
    </FundDisplay>
    <Valuation>
        <NegativeCashValue>Negative CV</NegativeCashValue>
        <PositiveCashValue>Positive CV</PositiveCashValue>
    </Valuation>
    <Accounting>
        <Table>
            <Column>
                <Name>AccountNumber</Name>
                <Display>Account</Display>
                <DataType>Text</DataType>
                <Group>AccountingDetail</Group>
            </Column>
            <Column>
                <Name>DebitCredit</Name>
                <Display>Debit / Credit</Display>
                <DataType>Text</DataType>
                <Group>AccountingDetail</Group>
            </Column>
            <Column>
                <Name>FundName</Name>
                <Display>Fund</Display>
                <DataType>Text</DataType>
                <Group>AccountingDetail</Group>
            </Column>
            <Column>
                <Name>SuspenseNumber</Name>
                <Display>Suspense</Display>
                <DataType>Integer</DataType>
                <Group>AccountingDetail</Group>
            </Column>
        </Table>
    </Accounting>
</ActivityResultsScreen>
 
OR
 
<ActivityResultsScreen>
    <Accounting>
        <Table>
            <Column>
                <Name>AccountNumber</Name>
                <Display>Account</Display>
                <DataType>Text</DataType>
                <Group>AccountingDetail</Group>
            </Column>
            <Column>
                <Name>Description</Name>
                <Display>Description</Display>
                <DataType>Text</DataType>
                <Group>AccountingDetail</Group>
            </Column>
            <Column>
                <Name>DebitCredit</Name>
                <Display>Debit / Credit</Display>
                <DataType>Text</DataType>
                <Group>AccountingDetail</Group>
            </Column>
        </Table>
    </Accounting>
    <Disbursement>
        <FixedFields>
            <Field>
                <Name>DisbursementNumber</Name>
                <Display>Number</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>DisbursementDate</Name>
                <Display>Date</Display>
                <DataType>Date</DataType>
            </Field>
            <Field>
                <Name>DisbursementAmount</Name>
                <Display>Amount</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>DisbursementStatus</Name>
                <Display>Status</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>DisbursementType</Name>
                <Display>Distribution Type</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>ClientRole</Name>
                <Display>Role</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>ClientName</Name>
                <Display>Name</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>TaxID</Name>
                <Display>Tax Id</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>Address</Name>
                <Display>Address</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>CheckNumber</Name>
                <Display>Check Number</Display>
                <DataType>Text</DataType>
                <Hidden>Yes</Hidden>
            </Field>
        </FixedFields>
        <Fields>
            <Field>
                <Name>AccountNumber</Name>
                <Display>Account</Display>
                <DataType>Text</DataType>
                <Group>AccountingDetail</Group>
            </Field>
        </Fields>
    </Disbursement>
</ActivityResultsScreen>