ChartofAccountsResults
This business rule is used to write results to AsAccountingDetailField table. This additional information is client specific and is used for various accounting purposes. In addition, this business rule is also used to override the default Account Number with specific Account Number format. The account number format option is not supported in the this release.
Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
---|---|---|---|
<ChartOfAccountsResults> |
The opening and closing tag of the rule. |
|
|
<TransactionAccounting> |
Optional Element: Describes how to get the value to write to an Accounting record. |
|
|
<Result> |
Required / Repeatable element: Describes how to get the value to write to an Accounting Record. |
NAME
|
Required Attribute: ="String" Name of the result. |
DISPLAY |
Optional Attribute: ="String" Display name for results. |
||
CATEGORY |
Required Attribute: ="POLICY / FUND / MATH / VALUE / MAP" Used to determine how the value will be obtained to write to Accounting record(s). (i.e., the source from where the <AccountNumberFormat> ->Parts obtain values.) POLICY: To retrieve the value from AsPolicy and AsPolicyField. Any field from the Policy screen. FUND: To allow values defined in AsFund and AsFundField to be used as the result. Any Field/MathVariable from Fund screen. MATH: To retrieve the value from the transaction. Any MathVariable or ActivityField. VALUE: To specify the hard coded value as the result. MAP: Lets the user pick values from a set of values based on a set of criteria. Values are taken from AsMapGroup, AsMapCriteria and AsMapValue.
Note:It is recommended not to use type SQL if possible. |
||
CATEGORYFIELD |
Required Attribute: ="String" Name of field or MathVariable to use as the value of the Accounting field and the parts of Account Number format. Note: For CATEGORY="VALUE", the hardcoded values are mentioned in the CATEGORYFIELD attribute. For CATEGORY="MAP", the name of the map is mentioned in the CATEGORYFIELD attribute. |
||
<MapCriteria> |
Describes how to match a single criteria value in a map when the CATEGORY is set to MAP. Use as many of these elements as needed to match a value in the map table.
Note: Only applicable when CATEGORY is set to MAP. |
NAME |
Required Attribute: ="String" Name of the criteria value in the map to match to. |
CATEGORY |
Required Attribute: ="POLICY / PLAN / FUND / COA / MATH" Describes how to get the value to match the criteria.
POLICY: To retrieve the value from AsPolicy and AsPolicyField. Any field from the Policy screen. PLAN: To retrieve values from AsPlan and AsPlanField. FUND: To allow values defined in AsFund and AsFundField to be used as the result. Any Field/MathVariable from Fund screen. COA: To retrieve the value from ChartOfAccountsScreen. Account Number defined for Entry. MATH: Any MathVariable or ActivityField. |
||
CATEGORYFIELD |
Required Attribute: ="String" Name of the field from CATEGORY attribute to use. |
||
WILDCARD |
Optional Attribute: ="String" Wildcard value that can optionally be used to ignore the criteria value for map value being searched. |
||
<SuspenseAccounting> |
Optional Element: Describes results that can be written for Suspense Accounting in the AsAccountingDetailField table. |
|
|
<Result> |
Required, Repeatable element: Describes how to get a value to write to the Accounting Record. |
NAME |
Required Attribute: ="String" Name of the result. |
DISPLAY |
Optional Attribute: ="String" Display name for results. |
||
CATEGORY |
Required Attribute: ="SUSPENSE / VALUE / SQL / MAP" Used to determine how value will be obtained to write to Accounting record(s) (i.e., the source from where the <AccountNumberFormat> ->Parts obtain values.) SUSPENSE: To retrieve the value from AsSuspense and AsSuspenseField. Any field from the Suspense screen. VALUE: To specify the hard coded value as the result. SQL: To retrieve the value from the SQL statement. SQL attribute must be present for this. MAP: Lets user pick values from a set of values based on a set of criteria. Values are taken from AsMapGroup, AsMapCriteria and AsMapValue. Note: It is recommended not to use type SQL if possible. |
||
CATEGORYFIELD |
Name of field of MathVariable to use as the value of the Accounting Field and the parts of Account Number format.
Note: Required for all the CATEGORY values other than SQL. The SQL statement is mentioned in the SQL attribute. For CATEGORY="VALUE", the hardcoded values are mentioned in the CATEGORYFIELD attribute. For CATEGORY="MAP", the name of the Map is mentioned in the CATEGORYFIELD attribute. |
||
SQL |
Required Attribute: ="SQL Stmt" SQL Statement from which the values should be retrieved. |
||
<MapCriteria> |
Describes how to match a single criteria value in a map when the CATEGORY is set to MAP. Use as many of these elements as needed to match a value in the map table.
Note: Only applicable when CATEGORY is set to MAP. |
NAME |
Required Attribute: ="String" Name of the criteria value in the map to match to. |
CATEGORY |
Required Attribute: ="COA / SUSPENSE" Describes how to get the value to match the criteria. COA: To retrieve the value from ChartOfAccountsScreen. Account Number defined for entry. SUSPENSE: To retrieve the value from AsSuspense and AsSuspenseField. Any Field from the Suspense screen. |
||
CATEGORYFIELD |
Required Attribute: ="String" Name of the field from CATEGORY attribute to use. |
||
WILDCARD |
Optional Attribute: ="String" Wildcard value that can optionally be used to ignore the criteria value for map value being searched. |
||
<AccountNumberFormats> |
Optional Element: Lists the account number formats that are available to the COA entries. Defines the account number format using the Parts syntax. The actual codes are defined in the AsMap table. |
|
|
<AccountNumberFormat> |
Required / Repeatable element: Describes how to assemble an account number. |
NAME |
Required Attribute:="String" Name to reference the AccountNumberFormat as. |
<Parts> |
Required element: List of parts that together forms the account number. |
|
|
<Part> |
Required / Repeatable element: Describes how to get each part of the account number. The text of this tag should be set to the name of the field from where the Part should take the value. |
TYPE |
Required element value: String Any Category Fields Required Attribute: ="COA / RESULT" Determines how the Part will be obtained . COA - To retrieve value from the ChartOfAccounts screen's Transaction/Account selection section. Account Number defined for entry. RESULT - To retrieve value from the ChartOfAccounts screen's Results section. |
XML Example
<ChartOfAccountsResults>
<TransactionAccounting>
<Result NAME="IssueState" DISPLAY="IssueState" CATEGORY="POLICY" CATEGORYFIELD="IssueStateCode"></Result>
<Result NAME="FundStatus" DISPLAY="Fund Status" CATEGORY="FUND" CATEGORYFIELD="StatusCode"></Result>
<Result NAME="TaxYear" DISPLAY="Tax Year" CATEGORY="MATH" CATEGORYFIELD="TaxYear"></Result>
<Result NAME="TestResultValue" DISPLAY="Test Result" CATEGORY="VALUE" CATEGORYFIELD="1111"></Result>
<Result NAME="MapTest" DISPLAY="Cost Center" CATEGORY="MAP" CATEGORYFIELD="COACenterCode">
<MapCriteria NAME="AccountingType" CATEGORY="COA" CATEGORYFIELD="AccountingType"/>
</Result>
</TransactionAccounting>
<SuspenseAccounting>
<Result NAME="PolicyNumber" DISPLAY="PolicyNumber" CATEGORY="SUSPENSE" CATEGORYFIELD="PolicyNumber"/>
<Result NAME="PolicyNumber" DISPLAY="PolicyNumber" CATEGORY="SUSPENSE" CATEGORYFIELD="PolicyNumber"></Result>
<Result NAME="TestResultValue" DISPLAY="Test Result" CATEGORY="VALUE" CATEGORYFIELD="1111"></Result> <Result NAME="TestResultValue" DISPLAY="Test Result" CATEGORY="VALUE" CATEGORYFIELD="1111"></Result>
<Result NAME="PayeeRole" DISPLAY="Payee Role" CATEGORY="SQL" SQL="SELECT ShortDescription FROM AsCode where CodeName = 'AsCodeRole' and CodeValue = '01'"></Result>
<Result NAME="MapTest" DISPLAY="Cost Center" CATEGORY="MAP" CATEGORYFIELD="COACenterCode">
<MapCriteria NAME="AccountingType" CATEGORY="COA" CATEGORYFIELD="AccountingType"/> <MapCriteria NAME="AccountingType" CATEGORY="COA" CATEGORYFIELD="AccountingType"/>
</Result>
</SuspenseAccounting>
</ChartofAccountsResults>