ActivityResultsScreen

This Business Rule allows configuration of the ActivityResultsScreen and defines how to display the Activity Results.

ActivityResultsScreen: Elements and Attributes
Element/Tag ParentTag Attribute Definition

<ActivityResultsScreen>

   

The opening and closing tag of the ActivityResultsScreen Business Rule.

<Accounting>

   

Optional:

This attribute controls the display of the accounting fields on the Accounting tab of the Activity Results screen. In absence of this tag, the current default columns would be displayed.

 

Default : AccountNumber| Description | Debit/Credit | Amount

<Allocations>

 

 

 

Optional element:   

The opening and closing tag for this section in the business rule.

 

SHOWORIGINAL

Required attribute:   

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

 

Values: Yes ,No or Math

No: The original allocations do not display; only the final allocations display. This value represents the default behavior when the rule is not configured.

Yes: The original allocations display, in addition to the final allocations.

Math: accepts a math with either Yes or No values

Note: If original allocations are not available, an error message will be displayed to the user.

<FundDisplay>

     

<DisplayChildFunds>

   

Determines whether or not to display child funds.

 

Yes or No

<Valuation>    

Optional Element:

This element provides instructions about the elements that may be displayed on the Valuation tab of the Activity Results screen.

<NegativeCashValue>    

Required Attribute:

This element indicates the screen should display the sub-total NegativeCashValue. This element controls the display of the negative cash value as well as the label name.

<PositiveCashValue>    

Required Attribute:

This element indicates the screen should display the sub-total PositiveCashValue. This element controls the display of the positive cash value as well as the label name.

<Table> <Accounting>  

Optional:

Controls the display of results. This tag format results in a table.

<Column> <Table>  

Required, Repeatable element:

The container element for column configuration.

<Display> <Column>  

Required:

Defines the header for the table column.

<Name> <Column>  

Required:

Specifies the database column in which the field values are stored.

 

Name of the Dynamic field.

For Fixed fields, the following fixed names should be used :

Fixed name :

  • AccountNumber: To display Account Number

  • Description: To display the accounting entry description

  • DebitCredit: To display whether the amount is debited or credited.

  • Amount: To display the accounting amount

  • FundName: To display the fund name associated with the accounting record

  • SuspenseNumber: To display the suspense number associated with the accounting record

  • OriginalAmount: To display the Original Amount

  • ExchangeRate: To display the Exchange Rate

  • ExchangeDate: To display the Exchange Date

  • MarketMaker: To display the Market maker name

<DataType> <Column>  

Required:

Defines the datatype of the field.

 

Text, Integer,Float,TextArea,Money, Radio,Check

<Group> <Column>  

Required:

Indicates the table/screen that stores the field being referenced. 

<FixedFields> <Disbursement>  

Optional:

The opening and closing tag of the Fixed Fields section.

 

If this section is not configured or the element is not provided by configuration, then  the system uses current functionality in regards to the listed fixed fields. That is the DisbursementScreen BR controls the presentation.

<Hidden> <Field>  

Optional:

Indicates if fixed field should be hidden.

Controls the visibility of the field on the screen.

 

Yes: Field is hidden from user.

No: Field is visible.

Default is No.

<Display> <Field>  

Required:

Provides the label text that will display on the screen. 

 

Literal text.

<Expanded> <Field>  

Optional:   

Expand the area of the field take-up an entire row on UI.

 

Yes: Field is expanded.

No: Field is not expanded. Default is No.

<Disbursement> <ActivityResultsScreen>  

Optional:

This is used to define the behaviour of the disbursement tab on the ActivityResults screen

<Fields> <Disbursement>  

Optional:

The opening and closing tag of the Fields section.

 

If this section is not configured or the element is not provided by configuration, then  the system uses current functionality in regards to the listed fields. That is the DisbursementScreen BR controls the presentation.

<Field>

<Fields>

<FixedFields>

 

Required:

This would define the ability to hide or expand the a field.

The field element is a child element of both <Fields> and <FixedFields> parent elements

<Name> <Field>  

Required:

It provides the name of the field that we are either expanding or hiding

 

To define Field Name.For Fixed fields, the following fixed names should be used :

  • DisbursementNumber: To display the disbursement number

  • DisbursementDate: To display the disbursement date

  • DisbursementStatus: To display the disbursement status.

  • DisbursementType: To display the type of disbursement.

  • DisbursementAmount: To display the disbursement amount.

  • TypeCode: To display the code values

  • ClientRole: To display the client role

  • ClientName: To display the client name

  • TaxID: To display the tax ID of the client

  • Address: To display the client address

  • CheckNumber: To display the check number

  • MiddleInitial: To display the middle name of the client

  • FirstName: To display the first name of the client

  • LastName: To display the last name of the client

  • CompanyName: To display the company name

  • Sex: To display the gender of the client

  • DateOfBirth: To display the date of birth of the client

  • DateOfDeath: To display the date of death of the client

  • Email: To display the email address of the client

  • Prefix: To display the name prefix of the client

  • Suffix: To display the name suffix of the client

  • NetAmount: To display the net amount being disbursed

  • Withholding fields: To display the corresponding fields of withholding section of Disbursement XML data

<Datatype> <FixedFields>

 

Required:

A classification identifying one of various types of data which provide general definition to the appropriate values, the operations that can be performed on the type and how the value is stored

  • Combo: Combination/drop down field.

    Note: Bold and Italics tags are not applicable to "Combo" type fields.

  • Date:  Date field with calendar icon.

  • Money:  Displays a monetary value along with its currency code and Calculator icon.

  • Radio:  Mutually exclusive options. Selecting one automatically unselects the others.

  • Text:  Free form entry.

XML Schema

<ActivityResultsScreen>
<Allocations SHOWORIGINAL="[Yes|No|variable]"></Allocations>
<FundDisplay>
<DisplayChildFunds>[Yes|No]</DisplayChildFunds>
</FundDisplay>
<Valuation>
<NegativeCashValue>[label]</NegativeCashValue>
<PositiveCashValue>[label]</PositiveCashValue>
</Valuation>
<Accounting>
<Table>
<Column ALIGN="[LEFT|CENTER|RIGHT]">
<Display>[header for the table column]</Display>
<Group>[database table]</Group>
<Name>[fixed field | dynamic field]</Name>
<DataType>[Text|Integer|Float|TextArea|Money|Radio|Check]</DataType>
</Column>
<Column>...</Column>
</Table>
</Accounting>
</ActivityResultsScreen>

XML Schema 1

<ActivityResultsScreen>
<Allocations SHOWORIGINAL="[Yes|No|variable]"></Allocations>
<FundDisplay>
<DisplayChildFunds>[Yes|No]</DisplayChildFunds>
</FundDisplay>
<Valuation>
<NegativeCashValue>[label]</NegativeCashValue>
<PositiveCashValue>[label]</PositiveCashValue>
</Valuation>
<Disbursement>
<FixedFields>
<Field>
<Name>[field name]</Name>
<Display>[literal]</Display>
<Datatype></Datatype>
<Hidden>[Yes|No]</Hidden>
<Expanded>[Yes|No]</Expanded>
</Field>
<Field>...</Field>
</FixedFields>
<Fields>
<Field>
<Name>[field name]</Name>
<Display>[literal]</Display>
<Datatype></Datatype>
<Hidden>[Yes|No]</Hidden>
<Expanded>[Yes|No]</Expanded>
</Field>
<Field>...</Field>
</Fields>
</Disbursement>
</ActivityResultsScreen>

XML Example 1

<ActivityResultsScreen>
<Allocations SHOWORIGINAL="Yes"></Allocations>
<FundDisplay>
<DisplayChildFunds>Yes</DisplayChildFunds>
</FundDisplay>
</ActivityResultsScreen>

XML Example

<ActivityResultsScreen>
<Disbursement>
<FixedFields>
<Field>
<Name>OriginalDisbursementNumber</Name>
<Display>Original Disbursement Number</Display>
<DataType>Text</DataType>
<Hidden>No</Hidden>
</Field>
<Field>
<Name>OriginalCheckNumber</Name>
<Display>Original Check Number</Display>
<DataType>Text</DataType>
<Hidden>Yes</Hidden>
</Field>
<Field>
<Name>Activity:TotalFederalWithholding</Name>
<Display>Total Federal Withholding</Display>
<DataType>Money</DataType>
<Hidden>No</Hidden>
<Expanded>Yes</Expanded>
</Field>
<Field>
<Name>Activity:TotalStateWithholding</Name>
<Display>Total State Withholding</Display>
<DataType>Money</DataType>
<Hidden>No</Hidden>
<Expanded>Yes</Expanded>
</Field>
</FixedFields>
<Fields>
<Field>
<Name>OriginatingTransactionName</Name>
<Display>Originating Activity</Display>
<DataType>Text</DataType>
<Disabled>Yes</Disabled>
</Field>
<Field>
<Name>PaymentDate</Name>
<Display>Payment Date</Display>
<DataType>Date</DataType>
</Field>
<Field>
<Name>CheckNumber</Name>
<Display>Check Number</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>Status</Name>
<Display>Status</Display>
<DataType>Combo</DataType>
<Query TYPE="SQL">SELECT AsCode.CodeValue, AsCode.ShortDescription FROM AsCode WHERE AsCode.CodeName = 'AsCodeDisbursementStatus'</Query>
</Field>
<Field>
<Name>PaidDate</Name>
<Display>Paid Date</Display>
<DataType>Date</DataType>
</Field>
<Field>
<Name>PayeeType</Name>
<Display>Payee Type</Display>
<DataType>Combo</DataType>
<Query TYPE="SQL">SELECT AsCode.CodeValue, AsCode.ShortDescription FROM AsCode WHERE AsCode.CodeName = 'AsCodeRole'</Query>
</Field>
<Field>
<Name>Payee</Name>
<Display>Payee(s)</Display>
<DataType>Combo</DataType>
<Query TYPE="SQL">SELECT AsRole.RoleGUID, AsClient.FirstName||' '||AsClient.LastName||AsClient.CompanyName FROM AsRole JOIN AsClient ON AsClient.ClientGUID = AsRole.ClientGUID WHERE AsRole.PolicyGUID = '[PolicyGUID]'</Query>
</Field>
<Field>
<Name>Address</Name>
<Display>Address</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>CheckDate</Name>
<Display>Check Date</Display>
<DataType>Date</DataType>
</Field>
<Field>
<Name>LastUpdatedDate</Name>
<Display>Last Updated Date</Display>
<DataType>Date</DataType>
<Hidden>Yes</Hidden>
</Field>
</Fields>
</Disbursement>
</ActivityResultsScreen>

Transaction XML Example

When original Allocation deriving value from math variable, when is set to 'Yes'

<MathVariable VARIABLENAME="ActivityAllocation" TYPE="VALUE" DATATYPE="TEXT">Yes</MathVariable>

When original Allocation deriving value from math variable, when is set to 'No'

<MathVariable VARIABLENAME="ActivityAllocation" TYPE="VALUE" DATATYPE="TEXT">No</MathVariable>