This page (revision-54) was last changed on 26-Nov-2021 10:22 by JEscott

This page was created on 26-Nov-2021 10:22 by JMyers

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note
54 26-Nov-2021 10:22 2 KB JEscott to previous
53 26-Nov-2021 10:22 2 KB JEscott to previous | to last PUBLISHING_USERCALCS ==> PUBLISHING USERCALCS
52 26-Nov-2021 10:22 2 KB JEscott to previous | to last
51 26-Nov-2021 10:22 2 KB JEscott to previous | to last
50 26-Nov-2021 10:22 2 KB JEscott to previous | to last
49 26-Nov-2021 10:22 2 KB JEscott to previous | to last LIST_USERCALCS ==> RMUC
48 26-Nov-2021 10:22 2 KB JEscott to previous | to last
47 26-Nov-2021 10:22 2 KB JEscott to previous | to last OPERATOR ==> UC OPERATORS
46 26-Nov-2021 10:22 2 KB JEscott to previous | to last
45 26-Nov-2021 10:22 2 KB JEscott to previous | to last
44 26-Nov-2021 10:22 2 KB JEscott to previous | to last
43 26-Nov-2021 10:22 3 KB JEscott to previous | to last
42 26-Nov-2021 10:22 2 KB JEscott to previous | to last
41 26-Nov-2021 10:22 2 KB JEscott to previous | to last

Page References

Incoming links Outgoing links
CONFIGURATION-UC
CONFIGURATION-UC

Version management

Difference between version and

At line 2 changed 7 lines
A UserCalc is a set of user-defined instructions that tells the execution program ([UPCALC], [UFCALC], etc.) to perform an action or operation. This is a powerful feature as it enables you to customize other Personality applications to a high degree.
A UserCalc can perform different kinds of operations, such as arithmetic calculations, comparisons of different items, date checks and calculations, and issue warning messages. It can be run with specified frequency for a defined group of employees, or used to detect a specific set of conditions.
A UserCalc may be simple (e.g. issue a warning if an employee's total earnings is greater than $1 million), or complex (e.g. detect an employee's anniversary and perform a special vacation accrual).
*[UserCalc Types|USERCALC TYPES]
----
*[Purpose of UserCalcs|PURPOSE_OF_USERCALCS]
*[UserCalc Types|USERCALC_TYPES]
At line 11 changed one line
*[UserCalc Conventions|USERCALC CONVENTIONS]
*[UserCalc Conventions|USERCALC_CONVENTIONS]
At line 9 added 2 lines
**[Function UserCalcs|FURTHER_USERCALC_NAMING_CONVENTIONS#Function UserCalcs]
**[Qualification UserCalcs|FURTHER_USERCALC_NAMING_CONVENTIONS#Qualification UserCalcs]
At line 14 removed one line
----
At line 13 added 2 lines
----
*[Define UserCalc Access|IMUC]
At line 17 changed 7 lines
*Define User Calcs ([IMUC])
*User Calc Commands
** [List of User Calc Commands|USER CALC COMMANDS]
*User Calc Operand Types
**[UC Operand Types|UC OPERAND TYPES]
*User Calc Operators
**[User Calc Operators|UC OPERATORS]
!!!Commands
----
*[Commands|COMMANDS]
*[Most Common Commands|MOST_COMMON_COMMANDS]
**[IF - If Comparison|IF_COMMAND]
**[LET - Let One Value Be Another|LET_COMMAND]
At line 23 added 21 lines
*[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
At line 26 changed one line
!!!Administer UserCalcs
Users need to declare the type of the Operand string being entered. These types consist of Variables, Constants, Database Items, Elements, and Pay Components.
At line 47 added 113 lines
For example, the string “BIWEEKLY” could represent a Processing Frequency, a database item such as a Group Code or even another UserCalc.
Operand Types declare what value the Operand will have, and how to process it within the UserCalc.
*[Variables|VARIABLES]
**[SC - User Variable|SC_VARIABLE]
**[$F - Processing Frequency|$F_VARIABLE]
**[$G - Global Variable|$G_VARIABLE]
**[$L - List|$L_VARIABLE]
**[$P - Parameter|$P_VARIABLE]
**[$S - System Constant|$S_VARIABLE]
**[$V - System Variable|$V_VARIABLE]
**[FT - Pension Factor|FT_VARIABLE]
**[V - Local Variable|V_VARIABLE]
*[Constants|CONSTANTS]
**[A - Alphanumeric|a_CONSTANT]
**[B - Boolean|b_CONSTANT]
**[D - Date|d_CONSTANT]
**[N - Number|N_CONSTANT]
*[Database|DATABASE]
**[DB - Database Field|DB_FIELD]
**[WB - Wage Basis|WB_DATABASE]
**[UC - UserCalc Calculation|UC_DATABASE]
**[UF - UserCalc Function/Qualifier|UF_DATABASE]
*[UserCalc Elements|USERCALC_ELEMENTS]
**[EC - Current Element Value|EC_ELEMENT]
**[EF - Fiscal to Date Element Value|EF_ELEMENT]
**[EM - Month to Date Element Value|EM_ELEMENT]
**[EP - Period to date Element Value|EP_ELEMENT]
**[EQ - Quarter to Date Element Value|EQ_ELEMENT]
**[ET - Transaction to Date Element Value|ET_ELEMENT]
**[EY - Year to Date Element Value|EY_ELEMENT]
*[Pay Components|PAY_COMPONENTS]
**[PT - Transactions To Date PC Value|PT_PAY_COMPONENT]
**[PY - Year-to-date PC Value|PY_PAY_COMPONENT]
*[Statistics|STATISTICS]
**[S - Statistical Component Value|S_STATISTIC]
*[Workflow Operand Types|UC_WORKLFOW]
**[OV - Old Value|OV_WORKFLOW]
**[NV - New Value|NV_WORKFLOW]
**[AC - Action Code|AC_WORKFLOW]
**[RT - Recipient Type|RT_WORKFLOW]
**[LOG - Log a workflow action event|LOG_WORKFLOW]
!!!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|Q_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
----
At line 29 changed one line
*Publish User Calculations ([IMUCA])
*[IMUCA Administer UserCalc|IMUCA]
At line 31 changed one line
*[Publishing UserCalcs|PUBLISHING USERCALCS]
*[Publishing UserCalcs|PUBLISHING_USERCALCS]
At line 34 changed 3 lines
*List of UserCalcs ([RMUC])
----
!!!Sample UserCalcs
*[List UserCalcs|LIST_USERCALCS]
At line 38 changed 2 lines
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.
!!!Sample UserCalcs
*Introduction
At line 42 changed 2 lines
**[401K Maximum Amount|BE_SAMPLE_USERCALC#401K Maximum Amount]
**[401K Maximum Deduction|BE_SAMPLE_USERCALC#401K Maximum Deduction]
**401K Maximum Amount
**401K Maximum Deduction
At line 46 removed 4 lines
----
!!!UserCalc Quick Reference Guide
*[Type: Function|USERCALC_TYPE_FUNCTION]
*[Type: Qualifier|USERCALC_TYPE_QUALIFIER]
At line 51 changed 4 lines
----
![Notes|Edit:Internal.CONFIGURATION-UC]
[{InsertPage page='Internal.CONFIGURATION-UC' default='Click to create a new notes page'}]
!!!UserCalc Quick Reference Guide
*Type: Function
*Type: Qualifier
This page (revision-54) was last changed on 26-Nov-2021 10:22 by JEscottTop