Manage crediting rules

From the Crediting Rules screen, you can view the status of crediting rules, edit crediting rule details, manually run crediting rules, and update their status.

Note

The crediting rules that display in the list depends on your role's permissions.

View crediting rules

Use the Team hierarchy menu on the Crediting Rules screen to view only rules that apply to a given level or node of the hierarchy. All Teams is selected by default and shows every crediting rule you have permission to view. You can also filter by status or a selected level.

Filters

Filter by Level: This allows you to apply filters in conjunction with the hierarchy level selected in the team hierarchy panel.

• Selected Level: The level of the team hierarchy that is currently selected.

• Next Level Only: The group of nodes in the level below but not their child nodes, if they exist.

• All Child Levels: All child nodes below the selected node.

Filter by Status: There are three statuses available for crediting rules. These statuses are controlled by clicking on the three dots next to each rule.

• Active: Crediting rule is live and will be run during any scheduled jobs.

• Inactive: Crediting rule is not active.

• Archived: Crediting rule is no longer in use and will not be activated at any point, but may have commissions calculated against it which requires historical data to be maintained.

Manage crediting rules

1. On the Crediting Rules screen, find the crediting rule you want to update.

2. Click the menu ⋮ and select an option to make changes to the crediting rule, as needed:

   • Edit Details

   • Edit Configuration

   • Run Rule

   • Activate or Deactivate

   • Archive or Unarchive

   • Delete

     Note

     Optional. You can edit plan details, active and deactivate, or archive and unarchive a crediting rule from within the plan:

     1. Select the plan.

     2. Click the menu ⋮ next to Save.

Edit details

1. Click Edit Details.

2. On the Edit Crediting Rule Details window, update the Name, Categories, Plans, or Description, as needed. Refer to Create a crediting rule for information on the available fields.

3. Click Save Changes when finished.

Edit configuration

1. Click Edit Configuration.

   

2. On the crediting rule configuration page, make changes to Commission Events and Credit & Payees sections, or view Transactions, as needed.

3. Click Save & Exit when finished.

Run rule

Crediting rules are processed in batches at a set time. This option manually triggers the crediting rule to run if you need a crediting rule to run outside of the automated run cycle.

1. Click Run rule.

2. To view updates to the crediting rule transactions, click Rule Configuration > Transactions.

Activate or deactivate

1. Select the available option:

   • Activate to activate a crediting rule that has been deactivated.

   • Deactivate to deactivate a crediting rule that is active.

Archive or unarchive

1. Select the available option:

   • Archive to archive a crediting rule.

   • Unarchive to unarchive a crediting rule that was archived.

   Note

   When you unarchive a crediting rule, it will retain the status it had prior to when it was archived. For example, if a crediting rule was active and then archived, if you unarchive that crediting rule it will be active.

Delete

1. Click Delete.

2. In the confirmation window, type DELETE.

3. Click Confirm.

   Warning

   Deleting a crediting rule cannot be undone. Crediting plans that have commissions calculated against them cannot be deleted. If you wish to retain the crediting rule, but do not want it available to run, select Deactivate or Archive.