!!!UserCalcs

*[Purpose of UserCalcs|PURPOSE_OF_USERCALCS]
*[UserCalc Types|USERCALC_TYPES]
*[Where to Use UserCalcs|WHERE_TO_USE_USERCALCS]
*[How to Plan a UserCalc|HOW_TO_PLAN_A_USERCALC]
*[UserCalc Conventions|USERCALC_CONVENTIONS]
*[Further UserCalc Naming Conventions|FURTHER_USERCALC_NAMING_CONVENTIONS]
**[Function UserCalcs|FURTHER_USERCALC_NAMING_CONVENTIONS#Function UserCalcs]
**[Qualification UserCalcs|FURTHER_USERCALC_NAMING_CONVENTIONS#Qualification UserCalcs]

!!!Define UserCalcs
----
*[Define UserCalc Access|IMUC]

!!!Commands
----
*[Commands|COMMANDS]
*[Most Common Commands|MOST_COMMON_COMMANDS]
**[IF - If Comparison|IF_COMMAND]
**[LET - Let One Value Be Another|LET_COMMAND]

*[Frequency Commands|FREQUENCY_COMMANDS]
**[ANN - Anniversary Check|ANN_COMMAND]
**[BOM - Beginning of the Month Check|BOM_COMMAND]
**[EOM - End of the Month Check|EOM_COMMAND]
**[FREQ - Frequency Check|FREQ_COMMAND]
**[PPE - Pay Period Date Check|PPE_COMMAND]

*[Auxiliary Commands|AUXILIARY_COMMANDS]
**[CALL - Call Another UserCalc|CALL_COMMAND]
**[MSG - Sends a Message to the UPCALC Report|MSG_COMMAND]

*[Completion Commands|COMPLETION_COMMANDS]
**[EXIT - Exit the UserCalc|EXIT_COMMAND]
**[RET - Return a Value to Another UserCalc or Program|RET_COMMAND]
**[XPPT - Exit the Pay Point and the UserCalc|XPPT_COMMAND]

*[Workflow Commands|WORKFLOW_COMMANDS]
**[ACT - Initiate a Workflow Action event|ACT_COMMAND]
**[STOP - Raise an exception (stops save)|STOP_COMMAND]

----
!!!Operand Types

Users need to declare the type of the Operand string being entered. These types consist of Variables, Constants, Database Items, Elements, and Pay Components.
*[UC Operand Types|UC OPERAND TYPES]




!!!Operators
----
*[Operator|OPERATOR]

*[Arithmetic Operators|ARITHMETIC_OPERATORS]
**[Add Operator|ADD_OPERATOR]
**[Subtract Operator|SUB_OPERATOR]
**[Multiply Operator|MLT_OPERATOR]
**[Divide Operator|DIV_OPERATOR]
**[Modulus Operator|MOD_OPERATOR]
**[Percent Operator|PRC_OPERATOR]
**[Maximum Operator|MAX_OPERATOR]
**[Minimum Operator|MIN_OPERATOR]

*[Rounding Operators|ROUNDING_OPERATORS]
**[Round Nearest Operator|RDN_OPERATOR]
**[Round Up Operator|RDU_OPERATOR]
**[Round Down Operator|RDD_OPERATOR]
**[Truncate Operator|TRNC_OPERATOR]

*[Conversion Operators|CONVERSION_OPERATORS]
**[Convert to a Date Operator|DATE_OPERATOR]
**[Convert to a Character Operator|CHAR_OPERATOR]
**[Convert to a Number Operator|NUM_OPERATOR]
**[Employee's Wage Operator|WAGE_OPERATOR]

*[Date Operators|DATE_OPERATORS]
**[Day Operator|DAY_OPERATOR]
**[Month Operator|MTH_OPERATOR]
**[Years Operator|YRS_OPERATOR]
**[Days Between Operator|DBT_OPERATOR]
**[Months Between Operator|MBT_OPERATOR]
**[Years Between Operator|YBT_OPERATOR]

*[Relative Date Operators|RELATIVE_DATE_OPERATORS]
**[Beginning of Day Operator|BD_OPERATOR]
**[Beginning of Week Operator|BW_OPERATOR]
**[End of Week Operator|EW_OPERATOR]
**[Beginning of Month Operator|BM_OPERATOR]
**[End of Month Operator|EM_OPERATOR]
**[Beginning of Year Operator|BY_OPERATOR]
**[End of Year Operator|EY_OPERATOR]

*[Comparison Operators|COMPARISON_OPERATORS]
**[Equals Operator|EQ_OPERATOR]
**[Element Pay Line Values Operator|ELPL_OPERATOR]
**[Pay Component Pay Line Value Operator|PCPL_OPERATOR]
**[Not Equal To Operator|NE_OPERATOR]
**[Greater Than Operator|GT_OPERATOR]
**[Greater Than or Equal To Operator|GE_OPERATOR]
**[Not Greater Than Operator|NG_OPERATOR]
**[Less Than Operator|LT_OPERATOR]
**[Less Than or Equal to Operator|LE_OPERATOR]
**[Not Less Than Operator|NL_OPERATOR]
**[In (List) Operator|IN_OPERATOR]
**[Not In (List) Operator|NN_OPERATOR]
**[Is Between Operator|IB_OPERATOR]
**[Is Not Between Operator|NB_OPERATOR]
**[Is Like Operator|LIKE_OPERATOR]

!!!Administer UserCalcs
----
The Administer UserCalcs form is where UserCalc are controlled. The administration of UserCalcs also involves an expanded knowledge of the Status of UserCalcs.
*[IMUCA Administer UserCalc|IMUCA]
*[UserCalc Statuses|USERCALC_STATUSES]
*[Publishing UserCalcs|PUBLISHING_USERCALCS]
*[Copying an 'In Production' UserCalc|COPYING_INPRODUCTION_USERCALC]
*[Editing an 'In Production' UserCalc|EDITING_INPRODUCTION_USERCALC]
*[List UserCalcs|LIST_USERCALCS]

!!!Sample UserCalcs
----
These are examples of some commonly needed UserCalcs. This is not the only way of coding the UserCalcs, and after discussion with your consultant, the best approach may require alternative set up.

*[AT - No Time Allowed to be Taken for 6 Months|AT_SAMPLE_USERCALC]
*[BE- 401K Maximum|BE_SAMPLE_USERCALC]
**[401K Maximum Amount|BE_SAMPLE_USERCALC#401K Maximum Amount]
**[401K Maximum Deduction|BE_SAMPLE_USERCALC#401K Maximum Deduction]
*[PR - Disbursement Message|PR_SAMPLE_USERCALC]
*[PR - FLSA Adjustment|PR_FLSA_SAMPLE_USERCALC]

!!!UserCalc Quick Reference Guide
*[Type: Function|USERCALC_TYPE_FUNCTION]
*[Type: Qualifier|USERCALC_TYPE_QUALIFIER]