This page (revision-41) was last changed on 26-Nov-2021 10:22 by Kevin Higgs

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

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
41 26-Nov-2021 10:22 10 KB Kevin Higgs to previous

Page References

Incoming links Outgoing links
IMUC
IMUC

Version management

Difference between version and

At line 3 added one line
[{Image src='IMUC.JPG' width='360' align='right' link='attach/IMUC/IMUC.JPG'}]
At line 4 removed one line
UserCalcs may be defined within the Define UserCalcs (IMUC) form. This screen will allow you to create the lines, variables, commands, etc. for each UserCalc. The definition data for the Define User Calculations screen is stored in the [P2K_AM_USER_CALCS] tables.
At line 6 changed one line
;[User Calc|USER_CALC_CODE]: This field refers to the user-defined name given to the UserCalc. Once the UserCalc has been created it can be edited, however, you can not edit it once the UserCalc is in production. You have to Un-Publish it on [IMUCA] first. As with Benefit and Attendance UserCalcs, we recommend that a naming convention be used for Workflow UserCalcs. For example, AT is used for the Attendance application, BE for the Benefits application and WF for the Workflow application. This will allow for efficient queries once the UserCalc list becomes large. See [special characters|NAMING CONVENTION AND STANDARDS] section for naming rules.
UserCalcs may be defined within the Define UserCalcs (IMUC) form. This screen will allow
you to create the lines, variables, commands, etc. for each UserCalc. The definition data for the Define User Calculations screen is stored in the [P2K_AM_USER_CALCS] tables.
At line 8 changed one line
;[Description|DESCRIPTION]: The description field may be used to further define the purpose of the UserCalc in more detail than is available in the UserCalc name.
;[User Calc|USER_CALC_CODE]: This field refers to the user-defined name given to the UserCalc. Once the UserCalc has been created it can be edited, however, you can not edit it once the UserCalc is in production. You have to Un-Publish it on [IMUCA] first. As with Benefit and Attendance UserCalcs, we recommend that a naming convention be used for Workflow UserCalcs. For example, AT is used for the Attendance application, BE for the Benefits application and WF for the Workflow application. This will allow for efficient queries once the UserCalc list becomes large. See [special characters|Naming Convention] section for naming rules.
At line 10 removed one line
;[Product|PRODUCT_CODE]: The product indicates which module the UserCalc has been defined for. For example, PR-Payroll, BE-Benefits, AT- Attendance, FC-Forecasting & Costing and WF-Workflow.\\ \\With respect to Workflow, this field specifies the table code on which the workflow trigger is located. This field should be identical to the name of the "Table" in [IMWA]. In all cases except workflow, it is the application that controls which fields in which tables will be accessible by the UserCalc. For example, in an Attendance UserCalc, the Leave Accrual Table would be accessible, but not benefits information.\\ \\NOTE In the NG system (5.01+), the PRODUCT field can not be changed once it has been added. This was done to avoid issues/errors arising from building a user calc for one product and then changing it to another.
At line 12 added 6 lines
;[Description]: The description field may be used to further define the purpose of the UserCalc in more detail than is available in the UserCalc name.
;[Product]: The product indicates which module the UserCalc has been defined for. For example, PR-Payroll, BE-Benefits, AT- Attendance, FC-Forecasting & Costing and WF-Workflow.
With respect to Workflow, this field specifies the table code on which the workflow trigger is located. This field should be identical to the name of the "Table" in [IMWA]. In all cases except workflow, it is the application that controls which fields in which tables will be accessible by the UserCalc. For example, in an Attendance UserCalc, the Leave Accrual Table would be accessible, but not benefits information.
At line 18 changed one line
;[User Calc Type|USER_CALC_TYPE]: The 'type' of UserCalc defines what values may be used/passed between UserCalcs and what capabilities may be performed. Three types are available:
;[Type|USER_CALC_TYPE]: The 'type' of UserCalc defines what values may be used/passed between UserCalcs and what capabilities may be performed. Three types are available:
At line 21 changed one line
|Calculations| Used as the main program area, and may call Qualifiers and Functions in order to perform some kind of customized action or operation. Calculations are only performed in the Payroll Calculation, and Forecasting and Costing applications.
|Calculations| Used as the main program area, and may call Qualifiers and Functions in order to perform some kind of customized
action or operation. Calculations are only performed in the Payroll Calculation, and Forecasting and Costing applications.
At line 24 removed one line
At line 28 changed 2 lines
|Secondary WF |This option tells the Workflow engine that this User Calc is ONLY to be called from another user calc and should NOT be fired on its own by the triggering product.
|Pro-Active WF|If the user calc is used for Pro-Active Workflow, then this must be selected. Using this selection will allow the [UMPWF] to execute the user calc.
|Secondary WF |This option tells the Work Flow engine that this User Calc is ONLY to be called from another user calc and should NOT be fired on its own by the triggering product.
At line 31 changed 5 lines
;[WF Firing Sequence|USER_CALC_SEQUENCE]: not used by the system;
;[Compile|ACT_COMPILE_USER_CALC]: This button allows the user to check the syntax of a UserCalc by creating the SQL code. This step does not ensure accuracy of the UserCalc, it merely checks that there are no UserCalc language errors such as incorrect syntax or infinite loops. This button is only available when the status of the UserCalc is 'Under Construction'.
;[Pre-Publish|ACT_PUBLISH_UC_IMUC]: When the UserCalc has been Compiled, the UserCalc may be 'pre-published'. This will change the status from 'Under Construction' to 'To Be Published'. Once in this status, the UserCalc may be officially published in [IMUCA]. \\If a user has taken a copy of an 'In Production' UserCalc and wishes to test it without losing the original UserCalc, then they may publish it. This means that wherever the original UserCalc is referenced, Personality will now use the newly published version.
;[Compile]: This button allows the user to check the syntax of a UserCalc by creating the SQL code. This step does not ensure accuracy of the UserCalc, it merely checks that there are no UserCalc language errors such as incorrect syntax or infinite loops.
;[Pre-Publish]: If the user is signed-on as 'P2K' then a UserCalc may be re-published directly in the IMUC form if it was already 'In Production' and needed to be re-validated. If a user has taken a copy of an 'In Production' UserCalc and wishes to test it without losing the original UserCalc, then they may publish it. This means that wherever the original UserCalc is referenced, Personality will now use the newly published version.
;[View]: [CLEANUP]
At line 37 changed one line
!!Lines tab
[{Image src='IMUC_Lines.JPG' width='360' align='right' link='attach/IMUC/IMUC_Lines.JPG'}]
!!Lines
At line 41 changed 21 lines
;[Line|USER_CALC_LINE]: This field defines the sequential order in which the UserCalcs will follow instructions. (00010, 00020, etc.)
;[CMD|COMMAND_CODE]: Commands are used to perform operations within a UserCalc. See detailed descriptions in the [User Calc Commands|UC COMMANDS] section.
;[Type 1|OPERAND1_TYPE]: Operand Types declare what value the Operand will have and how to process it within the UserCalc. See detailed descriptions in the [Operand Types|UC OPERAND TYPES] section.
;[Operand 1|OPERAND1_LK]: Operand 1 is typically used to store the result of any line of a UserCalc, or to compare to a value in Operand2.
;[OPER|OPERATOR_CODE]: Operators are the action to be taken in regard to the command issued and the operands indicated. See detailed description in the [Operators|UC OPERATORS] section.
;[Type^2|OPERAND2_TYPE]:Operand Types declare what value the Operand will have and how to process it within the UserCalc.
;[Operand 2|OPERAND2_LK]:Operand2 is used to compare values or assign values.
;[Type^3|OPERAND3_TYPE]:Operand Types declare what value the Operand will have and how to process it within the UserCalc.
;[Operand 3|OPERAND3_LK]:Operand 3 is used, when necessary, to further define Operand 2, or in mathematical operations.
;[If Goto|GOTO_LINE]: The ''If Goto'' field must be completed for every line. For any IF, FREQ, PPE, BOM, or EOM command there must be a true path (If Goto), and a false path (Else Goto).\\ \\The ''If Goto'' field tells the UserCalc program which line to proceed to in a __True__ situation. In a situation without a true and false path (i.e. Let PC 110 Equal +12), only the ''If Goto'' field is mandatory.\\ \\If the ''If Goto'' column is double-clicked on the user will be taken to that line.
;[Line|COMMAND_LINE]: (00010, 00020, etc.)
This field defines the sequential order in which the UserCalcs will follow instructions.
;CMD: See detailed descriptions in the [User Calc Commands|UC Commands] section.
;[OT|OPERANDn_TYPE]: OT is Operand Type. Operands must have a ‘Type’. This type is defined in the field before each Operand. See detailed descriptions in the [Operand Types] section.
;[Operand|OPERANDn]: Operand1 is typically used to store the result of any line of a UserCalc, or to compare to a value in Operand2. Operand2 is used to compare values or assign values.Operand 3 is used, when necessary, to further define Operand 2, or in mathematical operations.
;OPER Operators are the action to be taken in regard to the command issued and the operands indicated. See detailed description in the [Operators|UC Operators] section.
;[If Goto|GOTO_LINE]: The ''If Goto'' field must be completed for every line. For any IF, FREQ, PPE, BOM, or EOM command there must be a true path (If
Goto), and a false path (Else Goto). • The ''If Goto'' field tells the UserCalc program which line to proceed to in a __True__ situation. In a situation without a true and false path (i.e. Let PC 110 Equal +12), only the ''If Goto'' field is mandatory. If the ''If Goto'' column is double-clicked on the user will be taken to that line.
At line 63 changed 2 lines
;[Description]: To make UserCalcs more easily read and maintained, a Notes field has been provided. Notes should be used to explain the calculations made and the logic of the UserCalc. If the user calc is used for workflow emails, the text of the email body is added here. The text used in the description should not use ORACLE RESERVED words or special characters.
;[Description]: To make UserCalcs more easily read and maintained, a Notes field has been provided. Notes should be used to explain the calculations made and the logic of the UserCalc.
At line 66 changed 2 lines
!!Variables tab
Data from the Variables tab is stored in [P2K_AM_USER_CALC_VARIABLES] table. Variables are used as temporary working storage to hold values required by the UserCalc. See the [User Calc Variables|$C_VARIABLE] Section.
[{Image src='IMUC_Variables.JPG' width='360' align='right' link='attach/IMUC/IMUC_Variables.JPG'}]
!!Variables
Data from the Variables tab is stored in [P2K_AM_USER_CALC_VARIABLES] table. Variables are used as temporary working storage to hold values required by the UserCalc. See the [User Calc Variables|UC Variables] Section.
At line 71 changed one line
;[Length|VARIABLE_LENGTH]:The number of characters used to make up the length of the variable is stated here.
;[Length|VARIABLE_LENGTH]:Description [CLEANUP]
At line 73 changed one line
!!Globals tab
[{Image src='IMUC_Globals.JPG' width='360' align='right' link='attach/IMUC/IMUC_Globals.JPG'}]
!!Globals
At line 75 changed 7 lines
Global values are used to hold information between UserCalcs. Data for UserCalc Global Variables is stored in the [P2K_AM_USER_CALC_GLOBALS] table. See the page [Global Variables|$G_VARIABLE] for additional information on Global Variables.
;[Name|GLOBAL_NAME]:This is a user-defined name for the variable.
;[Type|GLOBAL_TYPE]:The user may choose Boolean, Number, Char(acter) or Date as the type of variable to be stored.
;[Scope|USER_CALC_SCOPE]:This provides for the ability to alter the 'Life' of a Global Variable. They can be reset at the beginning of an employee, or at the beginning of a pay. This is needed when there are multiple pays for an employee in the same pay run (Multiple Assignments).
;[Initial Value|INITIAL_VALUE]:For Numeric types, the 'Initial Value' should be '0'.
;[Length|GLOBAL_LENGTH]: The number of characters used to make up the length of the variable is stated here.
!Section Headings within in each tab
;[FieldName]:Definition
At line 70 added 2 lines
[{Image src='IMUC_Commands.JPG' width='360' align='right' link='attach/IMUC/IMUC_Commands.JPG'}]
!!Commands
At line 84 changed 4 lines
!!Commands tab
Within the IMUC form users may view the commands that are available. Commands are used to perform operations within a UserCalc. See detailed descriptions in the [Commands|UC COMMANDS] section.
%%warning This tab is for viewing purposes only; you may not edit the data.%%
!Section Headings within in each tab
;[FieldName]:Definition
At line 89 changed 5 lines
!!Operators tab
Within the IMUC form users may view the operators that are available. An Operator denotes an action that is to be taken on the Operands indicated. See detailed descriptions in the [Operators|UC OPERATORS] section.
%%warning This tab is for viewing purposes only; you may not edit the data.%%
----
!!View SQL tab
[{Image src='IMUC_Operators.JPG' width='360' align='right' link='attach/IMUC/IMUC_Operators.JPG'}]
!!Operators
At line 95 changed one line
Once the UserCalc has been compiled, this tab will display the SQL query that is automatically created from the user calc lines.
!Section Headings within in each tab
;[FieldName]:Definition
At line 97 removed one line
%%warning
At line 99 changed 9 lines
please note that user calculations are limited to 30,000 bytes. If you have a usercalc that exceeds this volume it is recommended to use the "CALL" program to reduce the size, or to break the usercalculation into smaller logical components.
Bytes will also include logic called in the "Notes" section of the user calculation.%%
----
![Notes|Edit:Internal.IMUC]
[{InsertPage page='Internal.IMUC' default='Click to create a new notes page'}]
[CLEANUP]
This page (revision-41) was last changed on 26-Nov-2021 10:22 by Kevin HiggsTop