Calculation Rules

Search

The search feature allows you to search for a specified text string anywhere within the Calculation Rule's Display Name or Internal Name.

1. Optionally, in the search field near the top of Calculation Rules screen, enter the desired text string.

2. Optionally, from the "Status" drop-down menu, select an Calculation Rule status (or "Any status").  

3. Optionally, from the "Group" drop-down menu, select an Calculation Rule Group (or "Any Group").  

4. Optionally, from the "Activity Type" drop-down menu, select one or more Activity Types on which the Calculation Rule is based (or "Any Activity Type").  

5. Optionally, from the "Effectivity" drop-down menu, select an Calculation Rule effectivity (or "Any effectivity").  

6. Press Enter, or click the search button (magnifying glass icon).

7. The Calculation Rules screen is refreshed to show only the Calculation Rules that meet your search criteria. Please note that if you enter multiple search criteria, the platform displays only the Calculation Rules that meet ALL criteria.

8. To remove all search criteria, click the remove button ("X" icon).

Expand / Collapse

All Calculation Rules are displayed beneath a sub-heading that indicates the Calculation Rule Group. Optionally, you can expand / collapse a Calculation Rule Group by clicking the minus-sign or plus-sign icon next to the Calculation Rule name.

To create a new Calculation Rule:

1. In the "Enter Display Name" field, enter the Display Name value for the new Calculation Rule.

2. Click create to display the "Edit Calculation Rule" pop-up window.

3. The "Display Name" field is populated with the value you entered above; optionally edit this value.

4. The "Internal Name" is automatically populated based on the Display Name value. This field is disabled by default. To edit the Internal Name, check edit internal name.  A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

5. In the "Description" field, enter a description of the Calculation Rule.

6. From the "Rule Grouping" drop-down menu, select the Calculation Rule Group to which this new Rule should be assigned.

7. Click into the "Activity Type" field, and select an Activity Type from the drop-down menu. Repeat this step as needed to assign additional Activity Types to this Calculation Rule.

8. From the "Metric" drop-down menu, select the Metric that this Calculation Rule will calculate.

9. Click save.

Define the Condition

When the Member performs the Activity specified for a Calculation Rule, the platform checks the Condition, which is represented as a logical expression. The Calculation Rule is invoked only if this Condition is satisfied.

Note: The use of Conditions is optional. If the Condition is not defined, the Calculation Rule will apply to every individual who performs the assigned Activity Type.

To define the Calculation Rule Condition

1. Find the desired Calculation Rule on the Calculation Rules screen.

2. Click the Edit icon within the Condition column to display the Conditions pop-up window.

3. Click the Add button (plus-sign icon) and select "Add Rule."

4. From the first drop-down menu, select the desired field.

5. Select a mathematical operator.  

6. Enter or select a value.

7. Repeat the above steps as needed to define more Rules.

8. Once you define more than one Rule, select the logical operator. From the "Include customers that meet" drop-down menu above the list of Rules, select either:

• All of the following (i.e., an AND operator)

• Some of the following (i.e., an OR operator)

9. Optionally, to clear all Rules from this Condition, click remove condition.

10. If you need to define additional Conditions for this Calculation Rule, click add condition. Repeat the above steps to define the Rule, or Rules, for the Condition.

Note: Instead of defining a Rule through the user interface, you can provide code to perform more complex query logic. Enter your custom code in the Advanced Expression field.

11. Click save.

When defining the Rules for the Condition, you can optionally organize the Rules into a Group to create more sophisticated logical statements.

1. Within the Conditions pop-up window, click the Add button (plus-sign icon) and select "Add Rule Group."

2. Follow the steps described above to define the Rule, or Rules, within the Group, as well as the Group's logical operator.

3. If you need to delete a Group (and all Rules within it), click the Delete icon within the Group.  

4. Click save.

Define the Calculation

The Calculation specifies the mathematical formula for the Metric. If the Condition is met, the platform calculates the appropriate adjustment to the Member's Metric value.

Note: Defining the Calculation requires knowledge of the Groovy programming language.  

1. Find the desired Calculation Rule on the Calculation Rules screen.

2. Click the Edit icon within the Calculation column to display the "Calculation Rule" pop-up window.

3.  Next to Authoring Mode, select "Expression."

Note: This Help topic doesn't cover the Template authoring mode.

4. In the Expression field, enter the Groovy expression.

5. Optionally, click validate expression to validate the Groovy code. A message is displayed, indicating the results of the validation.

6. Click save.

To edit the status and Effectivity Period for a Calculation Rule:

1. Find the desired Calculation Rule on the Calculation Rules screen.

2. Click the Edit icon within the Status column to display the Calculation Rule pop-up window.  

3. From the "Status" drop-down menu, select the Calculation Rule status.

4. Make any necessary changes to the Calculation Rule's overall effectivity. Valid values are:

• Always: This Calculation Rule doesn't expire.

• Schedule: Enter a start date and end date. Optionally, check "Recurring" to use a recurring schedule. Select the desired schedule from the "Recurring Schedule" drop-down menu, or define a new recurring schedule (see below for details on that process).

5. Click save.  

Define a New Recurring ScheduleDefine a New Recurring Schedule

 

After you've created a Calculation Rule, you must deploy the Calculation Rule metadata. When you deploy the Calculation Rules metadata to the server, the process automatically deploys the metadata for ALL modified Calculation Rules.  

1. From the "Actions" menu in the top-right corner, select "Validate Earn Rules Metadata."

Note: You can deploy metadata immediately, but the best practice is to validate the Calculation Rules logic before deploying metadata to ensure no incorrect expression code gets deployed to the server that could cause issues.

2. If the validation step passes, you'll see a message that says, "Earn Rules metadata is valid." If the validation step fails, you'll receive an error message; review and correct your Earn Rules expressions, then retry the validation step.

3. Click deploy earn rules metadata.

4. If the deployment was successful, you'll see a message that says, "Earn Rules metadata as been deployed."

To see the details of what Calculation Rules metadata has been deployed:

1. From the "Actions" menu in the top-right corner of the screen, select "View Deployed Earn Rules." The "View Snapshot" pop-up window is displayed.

2. Click the plus-sign to expand the message to view additional details, such as the total number of deployed Calculation Rules. You can also drill in deeper, to see details of each deployed Calculation Rules (Calculation Rule name, type, conditions, etc.).

3. When finished, click the "X" icon to close the pop-up window.

The sequence in which the Calculation Rules appear within a Calculation Rule Group controls the sequence in which the platform executes the Calculation Rules in that Group. For example, if you have five Calculation Rules within a Group, and that Group is configured to use the "Execute only first applicable rule" strategy, the platform will interrogate the first Calculation Rule in the Group. If that condition fails, the platform will move on to the second Calculation Rule, and so forth.

To rearrange the Calculation Rules:

1. To the left of the desired Calculation Rule, click and hold on the "handle" area.

2. Drag-and-drop the Calculation Rule to its desired new sequence.

Note: You can't drag-and-drop an Calculation Rule into a different Rule Group. To change a Calculation Rule's inclusion in a Group, you must edit its properties (see below for more details on this process).

To edit the properties of a Calculation Rule:

1. Find the desired Calculation Rule on the Calculation Rules screen.

2. Within the appropriate column ("Calculation Rule," "Condition," "Calculation," or "Status" ) of the desired Calculation Rule, click the edit icon. The corresponding pop-up window is displayed.

3. Make any necessary changes to the Calculation Rule properties.

4. Click save.  

To delete a Calculation  Rule:

1. Find the desired Calculation Rule on the Calculation Rules screen.

2. Within the right-most column of the desired Calculation Rule, click the Delete icon. A confirmation dialog box is displayed.

3. Click confirm.

The platform allows you to copy a Calculation Rule to use as the basis for a new Calculation Rule. To copy a Calculation Rule:

1. Find the desired Calculation Rule on the Calculation Rules screen.

2. Within the right-most column of the desired Calculation Rule, click the Copy icon. The system creates a new Calculation Rule. The default name of the new Calculation Rule is the name of the original Calculation Rule, followed by a counter, such as "(1)."  

[Details coming soon]

To download the underlying JSON code for all Calculation Rules:

1. From the "Actions" menu in the top-right corner of the screen, select either "Download JSON" or "Download JSON (Batch)."

2. The JSON code for all Calculation Rules in your account is displayed in a separate browser tab.