This is version 1 2 3 4 5 . It is not the current version, and thus it cannot be edited.

Back to current versionRestore this version

COMMANDS#

Commands are used to perform operations within a UserCalc. Commands that are available are:

Most Common Commands#

IF and LET are used very frequently when creating UserCalcs.

• IF - If Comparison
• LET - Let One Value Be Another

Frequency Commands#

Testing when a UserCalc or part of a UserCalc should be executed can be done several different ways:

• ANN - Anniversary Check, Checking if the anniversary of a date falls within a pay period
• BOM - Beginning of the Month Check, Checking if the beginning of a month falls within a pay period
• EOM - End of the Month Check, Checking if the end of a month falls within a pay period
• FREQ - Frequency Check, Checking if the pay header being calculated meets a specific processing frequency
• PPE - Pay Period Date Check, Checking if a specific date falls within a pay period

Auxiliary Commands#

Two of the commands will execute additional logic outside of the initial UserCalc. The Call command will execute another UserCalc, and the Message command will issue a message in the UPCALC report.

• CALL - Call Another UserCalc
• MSG - Sends a Message to the UPCALC Report

Completion Commands#

There are three commands that will end a UserCalc.

• EXIT - Exit the UserCalc, For Calculation UserCalcs use the Exit command, or under very rare circumstances, use the Exit the Pay Point and the UserCalc command.
• RET - Return a Value to Another UserCalc or Program, For Function or Qualifier UserCalcs use the Return a Value command.
• XPPT - Exit the Pay Point and the UserCalc, For Calculation UserCalcs use the Exit command, or under very rare circumstances, use the Exit the Pay Point and the UserCalc command.

Workflow Commands#

• ACT - Initiate a Workflow Action event
• STOP - Raise an exception (stops save)