Manage Calculation Rules

Owned by Copy Page Tree (Unlicensed)
Last updated: Aug 08, 2023 by Pamela Totas (Deactivated)
3 min read

You can manage the Eagle Analytics calculation rules for analytics functions. You can view/edit, create, duplicate, and delete rules.

View / Edit a Calculation Rule

You can view and edit several calculation rule attributes, including the calculation name, description, the securities affected, and the calculation formula.

To view and edit a calculation rule:

  1. In the Setup workspace, in the left navigation pane, click Rules.
    You see the Rules workspace with the list of all available calculation rules.

  2. Scroll down to the rule you wish to view or edit.

  3. On the toolbar, click Edit.
    You see the Editing Rule Definition dialog box.

  4. Review and edit the information you wish to change and click Next.
    You see the Editing Rule Securities dialog box.

  5. Review and edit the securities filter information you wish to change and click Next.
    You see the Editing Rule Calculations dialog box with the names and descriptions on the input and output arguments.

  6. Review and edit the argument information you wish to change. Options include:
    –  Calculation. This option selects the calculation used by this rule. When you change this selection, the remaining options are pre-filled with the inputs and outputs defined for the calculation.
    –  Input. This option specifies the argument IDs of the input arguments expected by the calculation.
    –  Output. This option specifies the database fields that store the calculation results.

  7. Click Save, or click Back to view the previous dialog box.
    You see the refreshed list of available rules.

Create a Calculation Rule

You can create a calculation rule in the New Rule panel.

To create a new calculation rule:

  1. From the Setup workspace, click Rules in the left navigation.
    You see the Rules workspace with the list of available calculation rules.

  2. On the toolbar, click Create New.
    You see the Creating New Rule panel.

  3. In the ID text box, enter a unique identifier. If you leave this option blank, the system assigns a unique identifier.

  4. In the Name text box, enter a name for the calculation.

  5. In the Description text box, optionally enter a description of the calculation.

  6. Set Enabled to allow the use of this rule by the system. Or, clear the check box to block use of this rule.

  7. Set the Analytics Type check box.
    You can choose Security Level, Cash Flow, or Trade Level types of analytics.

  8. Set the Include Pricing Center Demand check box, if required.

  9. Set the Fail Rule when 0 Securities Processed check box, if required.

  10. Click Next.You see the Editing Rule Securities dialog box.

  11. Specify the securities filter information you wish to use for the rule. Options include:
    –  Security. This is a required option that filters the securities to process.
    –  Entity Criteria. This option filters the entities to process by As Of Date and Entity ID.

  12. Click Next.
    You see the Editing Rule Calculations dialog box with the names and descriptions on the input and output arguments.

  13. Specify the calculations you wish to use for the rule. Options include:
    –  Calculation. This option selects the calculations used by this rule. When you change this selection, the remaining options are pre-filled with the inputs and outputs defined for the calculation.
    –  Input. This option specifies the argument IDs of the input arguments expected by the calculation.
    –  Output. This option specifies the database fields that store the calculation results.

  14. Click Save, or click Back to view the previous dialog box.
    You see the refreshed list of available rules.

Duplicate a Calculation Rule

You can create a duplicate calculation rule.

Eagle recommends that you use calculation copies to preserve the integrity of the initial Eagle Analytics migration package.

To copy the calculation rule to a new filename:

  1. From the Setup workspace, click Calculations in the left navigation. You see the Calculations workspace with the list of all available calculation rules.

  2. Scroll down to the calculation rule you wish to duplicate.

  3. On the toolbar, click Duplicate.
    You see the Duplicate dialog box.

  4. Enter a new rule name and click OK.
    You see the refreshed list of available rules.

Delete a Calculation Rule

You can delete a previously created calculation rule.

To delete a calculation rule:

  1. From the Setup workspace, click Calculations in the left navigation.
    You see the Calculations workspace with the list of all available calculation rules.

  2. Scroll down to the calculation rule you wish to delete.

  3. On the toolbar, click Delete.
    You see a dialog box reconfirming that you want to delete this calculation rule.

  4. Click Yes to delete the calculation rule, or click No to keep the rule.
    You see the refreshed list of available rules.