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

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
37 26-Nov-2021 10:22 6 KB kparrott to previous
36 26-Nov-2021 10:22 4 KB jmyers to previous | to last
35 26-Nov-2021 10:22 4 KB jmyers to previous | to last
34 26-Nov-2021 10:22 4 KB jmyers to previous | to last
33 26-Nov-2021 10:22 4 KB JEscott to previous | to last
32 26-Nov-2021 10:22 4 KB JEscott to previous | to last
31 26-Nov-2021 10:22 4 KB JEscott to previous | to last
30 26-Nov-2021 10:22 4 KB JEscott to previous | to last
29 26-Nov-2021 10:22 4 KB JEscott to previous | to last
28 26-Nov-2021 10:22 4 KB JEscott to previous | to last
27 26-Nov-2021 10:22 4 KB JEscott to previous | to last
26 26-Nov-2021 10:22 4 KB JEscott to previous | to last
25 26-Nov-2021 10:22 4 KB JEscott to previous | to last HOW TO DEFINE USER PROCEDURES ==> USER PROCEDURES
24 26-Nov-2021 10:22 4 KB JEscott to previous | to last
23 26-Nov-2021 10:22 4 KB JEscott to previous | to last
22 26-Nov-2021 10:22 4 KB JEscott to previous | to last
21 26-Nov-2021 10:22 4 KB JEscott to previous | to last

Page References

Incoming links Outgoing links
IMPC
IMPC

Version management

Difference between version and

At line 1 changed one line
[{TableOfContents }]
!!!Define User Procedure
Procedures are special functions that invoke other functions. They are defined on the Define User Procedures [IMPC] form.
At line 3 changed 13 lines
!!!Define User Procedures
A [procedure|USER PROCEDURES] is a type of user definable function that links together two or more system functions into a business procedure or workflow.
Typically, complex processes like enrolling employees into benefit plans, multiple record changes like getting married, or post-hire processes are good candidates for definition as a procedure.
The procedure form is divided into two parts: a "header" component that defines general aspects of the procedure and the "procedure steps" component that defines the individual functions that make up the procedure.
The step information has some overflow information below.
The definition data for the Define User Procedure screen is stored in the [P2K_AM_FUNCTIONS], [P2K_AM_EXECUTION_RIGHTS] and [P2K_AM_PROCEDURE_STEPS] tables.
For more information on procedures see the pages titled [How to Define Procedures|USER PROCEDURES] and [Examples of Procedures|PROCEDURE EXAMPLES].
\\ \\
Each [procedure|PROCEDURES] consists of a procedure header and procedure steps. The step information has some overflow information below.\\ \\
At line 18 changed one line
;[Procedure Name|FUNCTION_NAME]:This field is a code that uniquely identifies the [procedure|USER PROCEDURES] (e.g. NEWHIRE). Procedure Name is a mandatory 30 character alphanumeric field assigned by you. Procedure Names should not contain any spaces or special characters such as !, @, #, $, %, ^, &, *, ?, /, \, etc. Dashes (-) and underscores (_) are allowed.
;[Procedure Name|PROCEDURE_NAME]:This field is a code that uniquely identifies the [procedure|PROCEDURES] (e.g. NEWHIRE). Procedure Name is a mandatory 30 character alphanumeric field assigned by you. Procedure Names should not contain any spaces or special characters such as !, @, #, $, %, ^, &, *, ?, /, \, etc. Dashes (-) and underscores (_) are allowed.
At line 20 changed one line
;[Description|DESCRIPTION]:This field describes the purpose of the procedure.
;[Description|DESCRIPTION]:This field describes the purpose of the [procedure|PROCEDURES]. Description is an optional 50 character alphanumeric field assigned by you.
At line 22 changed one line
;[Product|PRODUCT_CODE]:This field identifies the module that the procedure belongs to (e.g. CM, HR, AT, BE,PR, ...).
;[Product|PRODUCT_CODE]:This field identifies the module that the [procedure|PROCEDURES] belongs to (e.g. CM, HR, AT, BE,PR, ...). Product is a mandatory field based on the [P2K_AM_PRODUCTS] table.
At line 24 changed one line
;[Subject Table|TABLE_NAME]:This field identifies the main context of the procedure (e.g. [P2K_HR_IDENTITIES] indicates that the procedure is related to a person). This field is used for procedures that make use of a header. \\ \\
;[Subject Table|TABLE_NAME]:This field identifies the main context of the [procedure|PROCEDURES] (e.g. [P2K_HR_IDENTITIES] indicates that the procedure is related to a person). This field is not currently functional. Subject Table is an optional field based on the [P2K_AM_TABLE_DETAILS ]table. \\ \\
At line 26 changed 2 lines
!!Procedure Steps tab
;[Seq #|STEP_SEQUENCE]: This field is used to order the procedure steps. The value does not matter; it is the order that counts. It is advisable to increment the step sequences by 10 to allow for insertion of new steps.
!!Procedure Steps
;[Seq #|STEP_SEQUENCE]: This field is used to order the [procedure|PROCEDURES] steps. The value does not matter; it is the order that counts. It is advisable to increment the step sequences by 10 to allow for insertion of new steps. Step_Sequence is an optional 5 digit number assigned by you.
At line 29 changed one line
;[Function Name|FUNCTION_NAME]:This field identifies the function that the procedure step invokes (e.g. [IEID]).
;[Function Name|FUNCTION_NAME]:This field identifies the function that the [procedure|PROCEDURES] step invokes (e.g. IEID). Function_Name is a mandatory field based on the [P2K_AM_FUNCTIONS] table.
At line 31 changed one line
;[Description|DESCRIPTION]:This field describes the function that the procedure step invokes (e.g. Maintain Identity Information). This field defaults from the Function Name that is entered.
;[Description|DESCRIPTION]:This field describes the function that the [procedure|PROCEDURES] step invokes (e.g. Maintain Identity Information). Description is an optional field based on the [P2K_AM_FUNCTIONS] table. This field defaults from the Function Name that is entered.
At line 33 changed one line
;[Mandatory|MANDATORY]: This field is a toggle that indicates whether the procedure step is mandatory.
;[Mandatory|MANDATORY]: This field is a toggle that indicates whether the [procedure|PROCEDURES] step is mandatory.
At line 35 changed one line
;[Display Find|DISPLAY_FIND]: If this toggle is ON, the Find line will show on the procedure, thus allowing users to select or change the focus of the procedure. This should not be enabled for steps in a procedure that also has a HEADER defined in [IMFD], unless it is on the very first step. For more information on the use of this toggle with the HEADER please see the page [How to Define User Procedures|USER PROCEDURES]
;[Create Allowed|CREATE_ALLOWED]:This field is a toggle that indicates whether the [procedure|PROCEDURES] step can insert records.
At line 37 changed one line
!Procedure Step Overflow
;[Retrieve Allowed|RETRIEVE_ALLOWED]:This field is a toggle that indicates whether the [procedure|PROCEDURES] step can display records.
At line 39 changed one line
;[Create Allowed|CREATE_ALLOWED]:This field is a toggle that indicates whether the procedure step can insert records.
;[Update Allowed|UPDATE_ALLOWED]:This field is a toggle that indicates whether the [procedure|PROCEDURES] step can update records.
At line 41 changed one line
;[Retrieve Allowed|RETRIEVE_ALLOWED]:This field is a toggle that indicates whether the procedure step can display records.
;[Delete Allowed|DELETE_ALLOWED]:This field is a toggle that indicates whether the [procedure|PROCEDURES] step can delete records.
At line 43 changed 40 lines
;[Update Allowed|UPDATE_ALLOWED]:This field is a toggle that indicates whether the procedure step can update records.
;[Delete Allowed|DELETE_ALLOWED]:This field is a toggle that indicates whether the procedure step can delete records.
;[Command|PROCEDURE_COMMAND]:This field contains special commands that get executed as part of the procedure.
!!Execution Rights tab
;[Role|ROLE_NAME]: This field identifies a role with specific execution rights to the procedure.
;[User|USER_NAME]: This field identifies a user with specific execution rights to the procedure.
;[Create Allowed|CREATE_ALLOWED]:This field is a toggle that indicates whether the role or user can create a procedure
;[Retrieve Allowed|RETRIEVE_ALLOWED]:This field is a toggle that indicates whether the role or user can view a procedure
;[Update Allowed|UPDATE_ALLOWED]:This field is a toggle that indicates whether the role or user can update a procedure
;[Delete Allowed|DELETE_ALLOWED]:This field is a toggle that indicates whether the role or user can delete a procedure
!!Header Setup tab
!Executions Table Detail
;[Seq #|STEP_SEQUENCE]: This field is used to order the table usages. The value does not matter; it is the order that counts. It is advisable to increment the step sequences by 10 to allow for insertion of new steps.
;[Table Usage|FORM_TABLE_USAGE]:This field identifies whether the form table is pre-loaded or user defined.
;[Data Source|DATA_SOURCE_NAME]: This field will hold the official name of the table.
;[Where Clause|WHERE_CLAUSE_CODE]:This field is used to filter information being queried.
;[Create Allowed|CREATE_ALLOWED]:This field is a toggle that indicates whether the role or user can create a procedure
;[Retrieve Allowed|RETRIEVE_ALLOWED]:This field is a toggle that indicates whether the role or user can view a procedure
;[Update Allowed|UPDATE_ALLOWED]:This field is a toggle that indicates whether the role or user can update a procedure
;[Delete Allowed|DELETE_ALLOWED]:This field is a toggle that indicates whether the role or user can delete a procedure
!Header Group Info
;[Seq #|STEP_SEQUENCE]: This field is used to order the form groups. The value does not matter; it is the order that counts. It is advisable to increment the step sequences by 10 to allow for insertion of new steps.
;[Form Group|FG_CODE]:This field provides the official name of the group. This should be coded as `Header`.
;[Layout |FG_LAYOUT]:This field indicates the how the group will be presented. This should be coded as `Text`.
;[Group Usage |FORM_GROUP_USAGE]:This field identifies whether the form group is pre-loaded or user defined. This should be coded as ‘User Defined’.
!Subject Info
;[Seq #|ITEM_SEQUENCE]: This field indicates the sequential order of the group item.
;[Item Name|ITEM_NAME]:This field holds the official name of the group item.
;[Prompt |ITEM_PROMPT]:This field shows the name that will appear on form for the item. This name will default in from Personality, however you may change it.
;[Type |FG_TYPE]:This field allows you to categorize the group.
;[Item Usage |FORM_GROUP_USAGE]:This field identifies whether the form group is pre-loaded or user defined. This should be coded as ‘User Defined’.
----
![Notes|Edit:Internal.IMPC]
[{InsertPage page='Internal.IMPC' default='Click to create a new notes page'}]
;[Command|PROCEDURE_COMMAND]:This field contains special commands that get executed as part of the [procedure|PROCEDURES] . Procedure_Command is an optional 2000 alphanumeric character field.
This page (revision-37) was last changed on 26-Nov-2021 10:22 by kparrottTop