Skip to main content

Rule Parameters

The entries from the wizard are visible on the Details and Parameters action bar. Navigate to the Parameters card to review or add additional parameters.

Rules Parameters

Generally, you want to make a parameter anytime a variable within your rule could vary, while the underlying logic would remain the same. Any parameter you create will be exposed as part of adding a rule to a Pay Group, thereby offering the opportunity to override its value.

A good example is a rounding rule where the number of minutes may vary from use to use.

Conversely, not all components of a rule are appropriate as a parameter. There may be constants which you declare and use within a rule which should not be exposed outside of the rule. These would make sense when the value would not vary from implementation to implementation.

A good example is the FLSA overtime rule, whereby 40 is 40..no reason to expose as it won't change.

Adding a Rule Parameter

info

Use the Add Parameter button on the top of the parameters list to create a new parameter, or tap an existing parameter to review

The following form items are presented when creating a rule parameter:

ItemDescription
Parameter nameThis is the name for your variable. For legibility and keeping rule parameters easily distinguishable from function parameters, we like to use initial caps, and use "_" or nothing instead of spaces to separate words.
Parameter Data TypeThis is the type of data to be used for the parameter. See Field Types for more details
Default ValueOptional; the default value for the parameter if not overridden by the Pay Group
CommentsA detailed description of the parameter and its use

After creating all parameters, we are ready to start the rule workflow.