Analytics Rules Operands

This operand adds the value from the IF statement to an accumulator.

Parameters:

Accumulator Name = Select the accumulator to which you are adding the value in the IF statement. Available options are KPI_ATTENDANCE, KPI_EARNED, and KPI_PRODUCTION.

Period Offset = Indicates the pay period from which the value specified in the IF statement will be accumulated. Enter the offset value to determine the pay period. For example, enter 0 to add to the accumulator for the current pay period, or enter 1 to add to the accumulator for the previous pay period.

Value = Enter a value to add to the accumulator, or right-click this parameter and select an operand to calculate the value.

 

This operand is used to add the hours from the IF statement to a KPI accumulator.

For example, this operand can be used to add hours to the KPI_EARNED accumulator in order to calculate KPI Efficiency and Productivity.

Parameters:

Accumulator Name = Select the accumulator to which you are adding the hours specified in the IF statement. Available options are KPI_ATTENDANCE, KPI_EARNED, and KPI_PRODUCTION.

Value = Enter a value to add to the accumulator, or right-click this parameter and select an operand to calculate the value.

In the example below, the Accumulator Name is KPI_EARNED and the remaining text in the operand is the Value:

Add To KPI Accumulator (KPI_EARNED, Get Transaction Quantity (Quantity completed) Multiply Get Transaction Standard In Seconds (Labor standard per piece))

 

Returns a value from a specified accumulator for a specific pay period.

Parameters:

Accumulator Name = Select the accumulator from which to retrieve the value. Available options are KPI_ATTENDANCE, KPI_EARNED, and KPI_PRODUCTION.

Period Offset = Indicates the pay period from which the value specified in the IF statement will be accumulated. Enter the offset value to determine the pay period. For example, enter 0 to add to the accumulator for the current pay period, or enter 1 to add to the accumulator for the previous pay period.

 

Returns a value from a specified KPI accumulator for the current pay period. The value of this operand is expressed in seconds; the value of the Get Hours From KPI Accumulator is expressed in hours.

Parameters:

Accumulator Name = Select the KPI accumulator from which to retrieve the value: KPI_ATTENDANCE, KPI_EARNED, or KPI_PRODUCTION.

 

Returns a value from a specified accumulator for a specific pay period.

Parameters:

Accumulator Name = Select the accumulator from which to retrieve the value. Available options are KPI_ATTENDANCE, KPI_EARNED, and KPI_PRODUCTION.

Period Offset = Indicates the pay period from which the value specified in the IF statement will be accumulated. Enter the offset value to determine the pay period. For example, enter 0 to add to the accumulator for the current pay period, or enter 1 to add to the accumulator for the previous pay period.

 

Returns a value from a specified KPI accumulator for the current pay period. The value of this operand is expressed in hours; the value of the Get Amount From KPI Accumulator operand is expressed in seconds.

Parameters:

Accumulator Name = Select the KPI accumulator from which to retrieve the hours: KPI_ATTENDANCE, KPI_EARNED, or KPI_PRODUCTION.

 

Gets the total hours durations (sum of durations in trans_action_duration table) for the specified transactions.

For example:

IF:
Is Event Type(Labor)
THEN:
Add To KPI Accumulator(KPI_PRODUCTION, Get Total Duration())

 

Gets the quantity amount for a transaction. Use the Quantity Type parameter to specify which quantity value to return.

Parameters:

Quantity Type = Select the type of quantity to return (Quantity Started, Quantity Completed, Quantity Rejected, etc.).

 

Returns the labor or setup standard (number of hours it takes to complete a certain quantity) for a transaction. If the transaction does not have a value for the specified standard, a value of zero will be returned.

This operand measures the transaction standard in hours per piece. Use the Get Transaction Standard in Seconds operand to measure the standard in seconds.

Parameters:

Standard Type = Use this parameter to specify which type of standard to return: Labor Standard Hours, Labor Standard Per Piece, or Setup Standard Hours.

If you select Labor Standard as your parameter, the value returned will be divided by the Labor Standard Basis. If the Labor Standard Basis is 0.0 it will be treated as “1.”

 

Returns the labor or setup standard (number of seconds it takes to complete a certain quantity) for a transaction. If the transaction does not have a value for the specified standard, a value of zero will be returned.

This operand measures the transaction standard in seconds. Use the Get Transaction Standard operand to measure the standard in hours per piece.

Parameters:

Standard Type = Use this parameter to specify which type of standard to return: Labor Standard Hours, Labor Standard Per Piece, or Setup Standard Hours.

If you select Labor Standard as your parameter, the value returned will be divided by the Labor Standard Basis. If the Labor Standard Basis is 0.0 it will be treated as “1.”

 

Checks to see if a transaction includes a specific labor or setup standard. Returns a value of true or false.

Parameters:

Standard Type = Select the type of standard to check for: Labor Standard Hours, Labor Standard Per Piece, or Setup Standard Hours.

 

Checks for a specific event by name.

Parameters:

Event Name = Determines which event will be considered by this rule. The available options are defined in the Events form.

 

Checks for a specific event sub-type.

Parameters:

Event Sub Type = Determines which event sub type will be considered by this rule. The available options are Event Types and Sub Types as defined in the Event Type form.

 

Checks for a specific event type.

Parameters:

Event Type = Determines which event type will be considered by this rule. Select Attendance, Labor, Location, or Material.

 

Checks if the posted event is unpaid. The default hours classification for unpaid time is U (Pay Code UNP).

 

Use this operand to select a value that is the opposite of a specified value.

Parameters:

Value = Enter a value in this field or right-click and choose an operand to calculate this value.

In the following example, Not is used to include all Labor events and exclude all Clock events:

IF:
Is Event Type(Labor)
Or
Not(Is Event Sub Type( Attendance (Clock)))
THEN:
Add To KPI Accumulator(KPI_ATTENDANCE, Get Total Duration())

 

Use this operand to round a specified value.

Parameters:

Value = Enter a decimal value in this field or right-click the field and select an operand that will calculate the value.

Decimal Place = Enter the integer that represents the decimal precision to which you are rounding.

Rounding Direction = Select Nearest, Up, or Down.

 

This THEN operand will stop processing all rules in the ruleset for the person and post date, even if there are more rules in the ruleset that are sequenced after this rule.

 

This operand is a “catch all” operand that always returns a value of True. If you need a rule to fire regardless of circumstances, set the IF clause to be just the True() operand.