Import Credit, Rollup, Classification, and Participant Assignment Rules using Import Management
Using Import Management, you can create, update, or delete rules, rules assignments, and qualifying criteria records by importing .CSV files with data in the specified format.
You can import these types of rules:
-
Direct Credit Rules
-
Rollup Credit Rules
-
Classification Rules
-
Participant Assignment Rules
-
Team Credit Rules
-
Analyst Hierarchy
Create the Source .CSV File and Your Import
Three objects are available for importing rules.
-
The Incentive Rules object is used to import just the rule hierarchy. This translates to the Overview tab in the rules UI and applies to all the rule types.
-
The Incentive Rule Assignments object is used to import just the objects that are assigned to an existing rule. For example, participants assigned to credit rules, credit categories assigned to a classification rule, and roles assigned to a participant assignment rule. This translates to the Assignments tab in the rules UI and applies to all the rule types.
-
The Incentive Rule Attribute Values object is used to import attributes and attribute values applicable to a rule. This translates to the Qualifying Criteria tab in the rules UI and applies only to certain rule types which have qualifying criteria like direct credit rules, classification rules, and participant assignment rules.
Download the template file and change the data for your import. If rules need to be copied from one environment and imported to another using Import Management, create BI reports in the source environment to extract data in the template format and import it into the target environment.
-
Navigate to
. -
Select the object you plan to import and click Download to get the template.
-
Edit the downloaded file and be sure to include valid values for all required attributes.
-
Navigate to
. -
You can create a mapping before you import your file or use automatic mapping if the column headers are unchanged from the template.
Rules Import Sample Data and Tips
Here's sample data for importing rules.
Column Headers |
Sample Values |
---|---|
OrgName |
Vision Operations |
UsageName |
Crediting |
RuleNumber |
CR_100001 |
Name |
USA West |
Description |
West Regions of USA |
StartDate |
1/1/2020 |
EndDate |
12/31/2020 |
EnabledFlag |
(no entry) |
Rank |
(no entry) |
NumWinners |
(no entry) |
ParentRuleNumber |
CR_100000 |
ParentName |
USA |
ActionCode |
(no entry) |
Follow these tips:
-
UsageName is to specify what type of rule you're importing. It's a best practice to keep different rule types in separate files. Here are the valid Usage Names:
-
Crediting
-
Rollup Hierarchy
-
Classification
-
Participant Assignments
-
Team
-
Analyst Hierarchy
-
-
If a RuleNumber isn't provided, the import generates a rule number during the import.
-
If not a root node, then either ParentRuleNumber or ParentName should be present.
-
Use DELETE for ActionCode to delete a rule. For inserts and updates, ActionCode can be blank. The import uses the rule number or name to determine if you're updating or inserting a record by comparing with existing records.
Rule Assignments Import Sample Data and Tips
Here's sample data for importing rule assignments.
Column Headers |
Sample Values |
---|---|
RuleNumber |
CR_100001 |
Name |
USA West |
AssignedObjectType |
INDIVIDUAL |
AssignedObjectName |
John Smith |
EmailAddress |
john_smith@test_customer.com |
HrPrimaryWorkerNumber |
(no entry) |
HrPersonNumber |
(no entry) |
PartyNumber |
(no entry) |
AssignedObjectId |
56001 |
StartDate |
1/1/2020 |
EndDate |
6/30/2021 |
SplitPct |
100 |
RevenueType |
REVENUE |
RollupFlag |
N |
SummaryFlag |
(no entry) |
GroupMemberCreditFlag |
(no entry) |
RuleAssignmentId |
(no entry) |
ActionCode |
(no entry) |
Follow these tips:
-
Either RuleNumber or Name should be present.
-
AssignedObjectType only needs to be populated for Direct Credit rules.
-
EmailAddress, HrPrimaryWorkerNumber, HrPersonNumber, and PartyNumber are additional identifiers for participants. They're only applicable to Direct Credit Rules, Rollup Credit Rules, and Team Credit Rules.
-
The Assigned Object columns refer to the object assigned to the rule. So for Direct Credit Rules, Rollup Credit Rules, and Team Credit Rules this object is the Participant. For Classification Rules, this is the Credit Category. For Participant Assignment Rules, this is the Role.
-
Only populate a column if it's valid for the type of rule assignment you're importing. For example, if you're importing a credit category assignment to a classification rule, then only the rule and object identifying columns need to be populated.
-
The ActionCode should be DELETE in case you want to delete a rule assignment. For inserts and updates, ActionCode need not be populated since the import will use the Rule identifier (name or number), the Object identifier (name, ID, or other identifier in case of participants) and StartDate (if applicable) to figure out if you're updating or inserting a record, based on whether the values you pass exist or not.
Rule Attribute Values Sample Data and Tips
Here's sample data for importing rule attribute values.
Rule Number |
Name |
Attribute Name |
Operator name |
LowValue |
HighValue |
RuleAttr ValueID |
ActionCode |
---|---|---|---|---|---|---|---|
10101 |
(no entry) |
Postal Code |
Between |
90210 |
94568 |
(no entry) |
(no entry) |
10101 |
(no entry) |
State |
Equal to |
CA |
(no entry) |
(no entry) |
(no entry) |
10102 |
(no entry) |
State |
Equal to |
NY |
(no entry) |
(no entry) |
(no entry) |
10102 |
(no entry) |
State |
Equal to |
NJ |
(no entry) |
(no entry) |
(no entry) |
Follow these tips:
-
Either RuleNumber or Name exist.
-
HighValueChar only needs to be present when you're using a Between operator and need to specify a range of From and To values.
-
Update can't be done. Delete and insert when you need to update.
-
ActionCode should be DELETE in case you want to delete a rule attribute value. If you want to delete an entire qualifying attribute along with all the attribute values, enter one row with the rule identifier (name or number) and the attribute along with an ActionCode of DELETE.