Rulesets

The Rulesets form is used to assign individual rules to rulesets. Individual rules are created on the Calc Rule form. Each ruleset can contain multiple rules.

Before you can assign rules to a ruleset you must create the ruleset. To do so, click the button next to the Ruleset Name field and select Add from the pop-up menu. See Create a New Ruleset for more information.

The context and order of the rules determines how they are executed (see below). You can use the Move Up and Move Down buttons to change the order of the rules.

How Rules are Executed

Attendance and PaidRate Rulesets: The rule listed at the top of the form is executed first. All qualified rules will be processed for all transactions. However, if the system encounters the "Stop Processing" operand, it will stop processing any further rules from that point for that transaction.

Export Rulesets: The rule listed at the top of the form is executed first. All rules will be processed for all transactions. If a transaction satisfies more than one rule, the last executed rule will apply.

Pay Rules: The rule listed at the top of the form is executed first. Once a condition is met for a transaction, the system will not continue to the next rule for that transaction.

Rulesets Field Descriptions

Context Name

The Context Name is used to categorize rules based on their function. For example, rules used to select data for an export are part of the ExportRuleset context. The available contexts are listed below.

Context Name	Applicable Use
AccrualRuleset	The Accrual Rules determine how and when balances, which are used to offset employee time off, should be accrued. These rulesets are assigned to the time reporter's Balance Policy. The ACCRUAL service uses the settings in the person’s Balance Policy to create and add time to person balance records. See Accrual Rules Operands for a list of the various operands.
Analytics	The Analytics rules are used to calculate Key Performance Indicators - Efficiency, Productivity, and Utilization - for one or more employees over a specified date range. This KPI data can be viewed in the KPI Dashboard portlets and the KPI Report. The Analytics rulesets are assigned to Ruleset Profiles which are connected to events via a Process Policy. See Analytics Rules Operands for a list of the various operands.
AttendanceRewardRuleset	The Attendance Reward Rules are used by the ATTENDANCE_REWARD service to determine a person’s eligibility to receive an attendance reward, as well as any attendance violations. See Attendance Reward Rules Operands for information on the operands used to create these rules.
AttendanceRuleset	Attendance Rules determine how an event shall post on employee timecards when the event occurs. The rulesets are assigned to the time reporter's Attendance Policy. Note that the event in question must also be enabled in the time reporter's Attendance Policy in order to post. See Attendance Rules Operands for a list of the various operands.
AuxiliaryHoursRuleset	The Auxiliary Hours Rules determine how Auxiliary (Bonus) Hours will be calculated. These rulesets are assigned to the person’s Pay Policy. The LABOR_ALL_MT service uses this ruleset to calculate Auxiliary Hours. See Auxiliary Hours Rules Operands for a list of the various operands.
DisciplineBalanceContext	The Discipline Balance Rules are used by the DISCIPLINE_BALANCE service to add points to, add levels to, and reduce the points in your Discipline Balance Codes. See Discipline Balance Operands for information on the operands used to create these rules. When defining the Discipline Balance rulesets, you should organize them according to the tasks of the DISCIPLINE_BALANCE service (BALANCE_ACCUMULATION, BALANCE_LEVELS, and BALANCE_REDUCTION). These rulesets will be assigned to the Discipline Ruleset, Level Ruleset Name, and Reduction Ruleset settings in a Discipline Balance Policy. For example, the ruleset that will be processed by the BALANCE_ACCUMULATION task of the DISCIPLINE_BALANCE service (the Discipline Ruleset in the Discipline Balance Policy) should be designed to look for discipline violations in the timecard (e.g., unexcused absences) and add the appropriate number of points to the Discipline Balance Code.
ExportRuleset	Export Rules determine when and how data is grouped and extracted from the system tables. The Export Rulesets are available to select on the Export form when configuring an export. The data itself is extracted via the Run Export button on the Export form or via a service instance. The rule listed on top is executed first. However, all rules will be processed for all transactions. If a transaction satisfies more than one rule, only the last rule will apply. See Export Rules Operands for a list of the various operands.
MessagingRuleset	Messaging Rules allow you to create messages for specific business conditions. For example, a company may want to send a warning message to employees who have been tardy at least three days in the current pay period. These rulesets are assigned to a Message Definition which is assigned to a Message Policy. The Message Policy can then be assigned to one or more persons. Refer to the Messaging feature topic for more information. See Messaging Rules Operands for a list of the various operands.
PaidRateRuleset	Paid Rate rules determine how a transaction’s payroll and labor rates will be calculated. The rules in the PaidRateRuleset will be used to calculate the PAID_PERSON_PAY and PAID_PERSON_LABOR rates. See Trans Rate for a description of the various rates that are stored with a transaction. See Paid Rate Rules Operands for a list of the various operands for this ruleset.
PayRulesRuleset	The Pay Rules Rulesets determine how hours should be classified on the timecard via the Time Classification service. Pay Rules Rulesets are assigned to Pay Policies via the Pay Policy form. The rule listed on top is executed first. Once a condition is met for a transaction, the system will not continue to the next rule for that transaction. See Pay Rules Operands for a list of the various operands.
PostProcessEventRuleset	The Post Process Event rules determine whether an employee will receive a Post Process Event. A “Post Process” event is an event that posts automatically after a person clocks out, adding extra time to the day. For example, an employee may receive bonus hours at the end of the day after working a minimum number of hours. Or, an employee may receive additional time after clocking out to account for time needed to clean up before going home. See Post Process Event Rule Operands for information about the operands used to create these rules.
PVEValidationRuleset	The PVEValidationRulesets are used to define custom event validations. The operands will check for specific charge element values, person data, or other information while an event is being posted, and perform the appropriate action (stop processing, give validation error, etc.) You can assign the PVEValidationRulesets or the individual rules to a Custom Validation. This Custom Validation can then be assigned to an event using the Validation tab of the Events form. See PVE Validation Rules Operands for a list of the various operands.
TimecardCheckRuleset	The TimecardCheckRuleset is used to check an employee’s timecard for hours exceptions, such as reported time that is different from the scheduled hours and time posted on an unscheduled day. This ruleset is added to a person’s Sign Policy and is applied when an employee or supervisor signs a timecard. See Timecard Check for more information on this feature. See Timecard Check Rules Operands for a list of the various operands that make up these rules.

Ruleset Name

Unique name that identifies the common purpose of the one or more rules that are grouped together.

Rule Name

Identifies the individual rule name that is listed in the ruleset you are viewing. The rule is created and configured on the Calc Rule form.

System Required

If this box is checked, the record is system required and cannot be deleted.

Enabled

The Enabled checkbox is available when you add a rule to a ruleset. If this box is checked, the rule is active.

Update Date, Updated By

These fields display when the record was created or updated, and the person who created or updated the record.

Find a Ruleset

Click Main Menu > Configuration > Rules > Rulesets.
Select the Context Name of the ruleset.
Use the Ruleset Name field to select the ruleset you want to view.

You can select the ruleset from the drop-down list.

You can also click the button next to the Ruleset Name field and select Lookup from the pop-up menu. On the Ruleset form that opens, select the Ruleset Name in the grid and click OK. The ruleset will display in the Ruleset Name field.
Click Find.

The rules in the selected ruleset will appear in the middle of the form.

The rules are listed in the order they are to be executed. Use the Move Up and Move Down buttons at the top of the form to reorder the rules.

Click View Rule to view a selected rule.

Create a New Ruleset

Click Main Menu > Configuration > Rules > Rulesets.
Select the Context Name of the ruleset you are defining.
Click the button next to the Ruleset Name field and select Add from the pop-up menu. The Ruleset form opens.
Enter a Ruleset Name. The Context Name field will display the context you selected in step 2.
If you only want to create this ruleset, click Save.
If you want to save this ruleset and create another ruleset, click Save and Add. The Ruleset form will stay open so you can create another ruleset with a different name.

Note: You can also Copy an existing ruleset and add or delete rules from it.

Add a Rule to a Ruleset

Click Main Menu > Configuration > Rules > Rulesets.
Select the Context Name and Ruleset Name to which you want to add a rule.
Click Add.

The Add Rulesets pop-up window opens.
Select the Rule Name you want to add.
To keep the rule enabled, check the Enabled box.
If you only want to add this rule to the ruleset, click If you only want to add this rule to the ruleset, click Save. The rule will be added as the last record in the list of rules.. The rule will be added as the last record in the list of rules.
If you want to save this rule and add another rule to the ruleset, click Save and Add. The Add Rulesets form will stay open so you can select another rule to add to the ruleset. The rules you add will be added to the end of the list of rules.

Once you have configured a ruleset, it must be assigned in order for the rules to take effect. Export Rulesets are assigned to an Export name via the Export form. PayRules Rulesets are assigned to Pay Policies via the Pay Policy form.

Delete a Rule from a Ruleset

Click Main Menu > Configuration > Rules > Rulesets.
Select a Context Name and Ruleset Name and click Find.

The rules in the selected ruleset will appear in the middle of the form.
Select the rule you want to remove and click Delete.
Click OK to confirm the action.

Move Rules Up/Down

The context and order of the rules in a ruleset determines how the rules are executed. See How Rules are Executed.

To change the order of the rules in a ruleset:

Click Main Menu > Configuration > Rules > Rulesets.
Select a Context Name and Ruleset Name and click Find.

The rules in the selected ruleset will appear in the middle of the form.
Select a rule.
Click the Move Down arrow to move the rule down. Click the Move Up arrow to move the rule up.

View a Rule

Click Main Menu > Configuration > Rules > Rulesets.
Select a Context Name and Ruleset Name and click Find.

The rules in the selected ruleset will appear in the middle of the form.
Select a rule and click View Rule.

The Calc Rule Builder form opens showing the IF and THEN clauses that make up the rule. Click Cancel to close this form.

Copy a Ruleset

When you copy a ruleset, the individual rules in the ruleset will also be copied to the duplicate ruleset. The rules in the duplicate ruleset will be in the same order and have the same Enabled setting as the original ruleset.

Click Main Menu > Configuration > Rules > Rulesets.
Select the Context Name of the ruleset you want to duplicate.
Click the button next to the Ruleset Name field and select Maintain from the pop-up menu. The Ruleset form opens.
Select the ruleset you want to duplicate and click Copy.
Enter a new Ruleset Name. The Context Name field will display the context you selected in step 2.
If you only want to save this ruleset, click Save.
If you want to save this ruleset and make another copy of the ruleset, click Save and Add. The Copy Ruleset form will stay open so you can save another copy of the ruleset with a different name.

Delete a Ruleset

Click Main Menu > Configuration > Rules > Rulesets.
Select the Context Name of the ruleset you want to delete.
Click the button next to the Ruleset Name field and select Maintain from the pop-up menu. The Ruleset form opens.
Select the ruleset you want to delete.
Click Delete.