This page (revision-31) 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
31 26-Nov-2021 10:22 11 KB JEscott to previous
30 26-Nov-2021 10:22 11 KB JEscott to previous | to last
29 26-Nov-2021 10:22 11 KB RForbes to previous | to last
28 26-Nov-2021 10:22 11 KB JEscott to previous | to last DEFINE_WF_USERCALC ==> DEFINE WF USERCALC
27 26-Nov-2021 10:22 11 KB JEscott to previous | to last
26 26-Nov-2021 10:22 11 KB JEscott to previous | to last
25 26-Nov-2021 10:22 11 KB JEscott to previous | to last
24 26-Nov-2021 10:22 11 KB JEscott to previous | to last
23 26-Nov-2021 10:22 11 KB JEscott to previous | to last
22 26-Nov-2021 10:22 11 KB JMyers to previous | to last
21 26-Nov-2021 10:22 11 KB JMyers to previous | to last

Page References

Incoming links Outgoing links
DEFINE WF USERCALC
DEFINE WF USERCALC

Version management

Difference between version and

At line 20 changed 2 lines
;[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.
;[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.
At line 23 changed 2 lines
;[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.%%information 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.%%
;[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.%%information 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 29 changed one line
|To Be Published|This status value indicates that the UserCalc is ready for publishing. You can not set the user calc to this value manually.
|To Be Published|This status value indicates that the UserCalc is ready for publishing. You can not set the UserCalc to this value manually.
At line 34 changed one line
|Calculations|These are used by the main program and may call Qualifiers and Functions in order to perform a customized action or operation. The Payroll, Forecasting & Costing and Workflow modules exclusively use calculations.
|Calculations|These are used by the main program and may call Qualifiers and Functions in order to perform a customized action or operation. The [Payroll|MODULE-PR), [Forecasting & Costing|MODULE-FC] and [Workflow|MODULE-WF] modules exclusively use calculations.
At line 36 changed one line
|Functions|These are used to perform a calculation or query and return a value to the calculation. The Benefits and Attendance modules exclusively use "Functions".
|Functions|These are used to perform a calculation or query and return a value to the calculation. The [Benefits|MODULE-BE] and [Attendance|MODULE-AT] modules exclusively use functions.
At line 38 changed one line
;[Return Value|RETURN_VALUE_TYPE]:The "Return Value" is used by Functions and Qualifiers to define what type of value will be returned by the Function or Qualifier UserCalc.;:If the UserCalc type is set to Calculation, then no return value is indicated. This field will automatically be grayed out once this type has been selected and the cursor has been tabbed to the next field.;:Since Workflow UserCalcs are always of the type "Calculation", they will not return a value.
;[Return Value|RETURN_VALUE_TYPE]:The "Return Value" is used by functions and qualifiers to define what type of value will be returned by the Function or Qualifier UserCalc.;:If the UserCalc type is set to 'Calculation', then no return value is indicated. This field will automatically be grayed out once this type has been selected and the cursor has been tabbed to the next field.;:Since Workflow UserCalcs are always of the type "Calculation", they will not return a value.
At line 42 changed 2 lines
|Disbursement Message|Not used for Work Flows - see [UserCalc|MODULE-UC] for more details on this usage.
|Secondary WF|This option tells the Work Flow engine that this UserCalc is ONLY to be called from another UserCalc and should NOT be fired on its own by the triggering product.
|Disbursement Message|Not used for workflows - see [UserCalc|MODULE-UC] for more details on this usage.
|Secondary WF|This option tells the workflow engine that this UserCalc is ONLY to be called from another UserCalc and should NOT be fired on its own by the triggering product.
At line 58 changed one line
(Line 200 must also exist in this example)
;:(Line 200 must also exist in this example)
At line 60 changed one line
It is useful to increment line numbers to the next 100 or 1000 at the start of each section of logic. This will make your UserCalc easier to read and maintain by future users.
;:It is useful to increment line numbers to the next 100 or 1000 at the start of each section of logic. This will make your UserCalc easier to read and maintain by future users.
At line 62 changed 2 lines
;[CMD|]:Commands are used to perform operations within a UserCalc.
%%information Please refer to the User Calculations manual for a detailed description of the existing commands available.%%
;[CMD|]:Commands are used to perform operations within a UserCalc.%%information Please refer to the [User Calculations|USERCALC] section for a detailed description of the existing commands available.%%
;:There are two commands that are available and strictly used for workflow. These are: ACT and STOP.
At line 65 removed 2 lines
There are two commands that are available and strictly used for Workflow. These are: ACT and STOP.
At line 70 changed one line
The ACT command is unique in that once it has been selected Type 1, OPER and Type 3 fields are defaulted with the values AC, LOG, and RT respectively, as indicated in the diagram below.
;:The ACT command is unique in that once it has been selected Type 1, OPER and Type 3 fields are defaulted with the values AC, LOG, and RT respectively, as indicated in the diagram below.
At line 74 changed one line
;[Type 1 (Operand Type 1)|]:Operands must have a type. For example, DB, AC, V, etc…
;[Type 1 (Operand Type 1)|]:Operands must have a type. For example, DB, AC, V, etc…%%information Please refer to the [User Calculations|USERCALC] section for a detailed description of the existing operand types available.%%
At line 76 changed one line
%%information Please refer to the User Calculations manual for a detailed description of the existing operand types available.%%
;:The following table indicates five special operand types that are available for workflow.
At line 78 changed 4 lines
The following table indicates five special operand types that are available for workflow.
|Old Value (OV)| This refers to the Old Value of the item being referenced in the Operand.
|New Value (NV)| This refers to the New Value of the item being referenced in the Operand.
|Old Value (OV)| This refers to the Old Value of the item being referenced in the operand.
|New Value (NV)| This refers to the New Value of the item being referenced in the operand.
At line 92 changed one line
In the case were the CMD is ACT, Operand1 displays the name of the workflow action event that was created in [IMWA].
;:In the case were the CMD is ACT, Operand1 displays the name of the workflow action event that was created in [IMWA].
At line 94 changed one line
Clicking on the "Operand 1" LOV button will bring up a list from which a selection can be made.
;:Clicking on the "Operand 1" LOV button will bring up a list from which a selection can be made.
At line 96 changed one line
;[OPER|]:Operators are the actions that need to be taken in regards to the command being issued and the operands indicated.:;i.e. Add, Divide, convert to a Character, Beginning of Day, etc. %%information Please refer to the User Calculations manual for a detailed description of the existing operators that are available.%% :;The LOG Operator is a new operator that is available strictly for Workflow and ONLY for the ACT CMD; it is used to log the workflow action event. :;When the "ACT" command is selected this value automatically defaults into this field.
;[OPER|]:Operators are the actions that need to be taken in regards to the command being issued and the operands indicated.
;:i.e. Add, Divide, convert to a Character, Beginning of Day, etc. %%information Please refer to the [User Calculations|USERCALC] section for a detailed description of the existing operators that are available.%%
;:The LOG Operator is a new operator that is available strictly for Workflow and ONLY for the ACT CMD; it is used to log the workflow action event.
;:When the "ACT" command is selected this value automatically defaults into this field.
At line 98 changed 3 lines
;[Type 2 (Operand Type 2)|]:
%%information Please refer to the User Calculations manual for a detailed description of the existing operand types that are available.%%
In most cases, when the "ACT" command is selected, this field will need to refer to an operand type that references a constant. Typically the operand type used is $S - System Constant.
;[Type 2 (Operand Type 2)|]:In most cases, when the "ACT" command is selected, this field will need to refer to an operand type that references a constant. Typically the operand type used is $S - System Constant.%%information Please refer to the [User Calculations|USERCALC] section for a detailed description of the existing operand types that are available.%%
At line 102 removed 3 lines
;[Operand 2|]:Operand 2 is used to compare values or assign values.
%%information Please refer to the User Calculations manual for a detailed description of the existing operands that are available.%%
With respect to the ACT CMD, this field will hold a date value. Once the value in Type 2 has been entered, click on the Operand 2 LOV button to obtain a list of values to choose from.
At line 106 changed 2 lines
;[Type 3|]:
%%information:Please refer to [User Calculations|Module-UC] for a detailed description of the existing operand types that are available.%%
;[Operand 2|]:Operand 2 is used to compare values or assign values.%%information Please refer to the [User Calculations|USERCALC] section for a detailed description of the existing operands that are available.%%
;:With respect to the ACT CMD, this field will hold a date value. Once the value in Type 2 has been entered, click on the Operand 2 LOV button to obtain a list of values to choose from.
At line 109 changed one line
When the "ACT" command is selected, "RT" will always default in. RT refers to 'Recipient Type'.
;[Type 3|]:When the "ACT" command is selected, "RT" will always default in. RT refers to 'Recipient Type'.%%information Please refer to [User Calculations|USERCALC] for a detailed description of the existing operand types that are available.%%
At line 111 changed 3 lines
;[Operand 3|]:%%information Please refer to the User Calculations manual for a detailed description of the existing operands that are available.%%
This field indicates the recipient who is to receive this workflow action event.
Depending on what event recipient is selected in IMWA a list of values is available once the Operand3 button is clicked.
;[Operand 3|]:This field indicates the recipient who is to receive this workflow action event.%%information Please refer to the [User Calculations|USERCALC] section for a detailed description of the existing operands that are available.%%
At line 115 changed 2 lines
If GOTO
Please refer to the User Calculations manual for a detailed explanation. The two new workflow commands ACT and STOP require an "If GOTO" value to be indicated.
;:Depending on what event recipient is selected in [IMWA] a list of values is available once the Operand3 button is clicked.
At line 118 changed 2 lines
Else GOTO
Please refer to the User Calculations manual for a detailed explanation. The two new workflow commands ACT and STOP do NOT take an "Else GOTO" value.
;[If GOTO|]:Please refer to the [User Calculations|USERCALC] section for a detailed explanation. The two new workflow commands ACT and STOP require an "If GOTO" value to be indicated.
At line 121 changed 2 lines
Description
This is the area where the user will write the messages to be used in the Workflow Action Events (i.e. emails or online messages).
;[Else GOTO|]:Please refer to the [User Calculations|USERCALC] section for a detailed explanation. The two new workflow commands ACT and STOP do NOT take an "Else GOTO" value.
At line 124 changed one line
In the example above, the UserCalc calls the workflow action "NEW EE EMAIL" at line 200. This action has been set up to notify a manager, via email of a new hire (done in IMWA). The actual content of the email is taken from the 'Description' section.
;[Description|DESCRIPTION]:This is the area where the user will write the messages to be used in the Workflow Action Events (i.e. emails or online messages).
At line 126 changed one line
This text is customizable.
;:In the example above, the UserCalc calls the workflow action "NEW EE EMAIL" at line 200. This action has been set up to notify a manager, via email of a new hire (done in IMWA). The actual content of the email is taken from the 'Description' section.
At line 128 changed one line
In this example, the employee's name, hire date and Assignment title are stated in the email sent to the manager. This information is referenced (within double brackets << >>) in the notes section. The field is built with the table alias and column name. Note that it must be a table that is accessible via either the NV/OV or DB Types. The email from the example above that is received by the manager will look similar to:\\ \\
;:This text is customizable.
At line 130 changed 6 lines
… This e-mail notification has been sent to you from the Human Resources system, to inform you that Jack Smith has joined our organization. Jack is scheduled to begin work on 01-Feb-2007 as a Patient Care Manager.…\\ \\
The following items are examples of what can be referenced in the Description; they MUST be referenced as follows: \\
<<eid.first_name>> - states the employee's first name \\
<<eid.last_name>> - states the employee's last name \\
<<eem.hire_date>> - states the employee's hire date
;:In this example, the employee's name, hire date and Assignment title are stated in the email sent to the manager. This information is referenced (within double brackets << >>) in the notes section. The field is built with the table alias and column name.%%information Note that it must be a table that is accessible via either the NV/OV or DB Types.%% The email from the example above that is received by the manager will look similar to:\\
;: … This e-mail notification has been sent to you from the Human Resources system, to inform you that Jack Smith has joined our organization. Jack is scheduled to begin work on 01-Feb-2007 as a Patient Care Manager.…\\
;:The following items are examples of what can be referenced in the Description; they MUST be referenced as follows: \\
;:<<eid.first_name>> - states the employee's first name \\
;:<<eid.last_name>> - states the employee's last name \\
;:<<eem.hire_date>> - states the employee's hire date
This page (revision-31) was last changed on 26-Nov-2021 10:22 by JEscottTop