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

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

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
20 26-Nov-2021 10:22 2 KB kparrott to previous
19 26-Nov-2021 10:22 2 KB ihowie to previous | to last
18 26-Nov-2021 10:22 2 KB ihowie to previous | to last
17 26-Nov-2021 10:22 2 KB jmyers to previous | to last
16 26-Nov-2021 10:22 2 KB jmyers to previous | to last
15 26-Nov-2021 10:22 2 KB jmyers to previous | to last
14 26-Nov-2021 10:22 2 KB jmyers to previous | to last
13 26-Nov-2021 10:22 2 KB jmyers to previous | to last
12 26-Nov-2021 10:22 2 KB jmyers to previous | to last
11 26-Nov-2021 10:22 2 KB jmyers to previous | to last
10 26-Nov-2021 10:22 2 KB rforbes to previous | to last
9 26-Nov-2021 10:22 2 KB rforbes to previous | to last
8 26-Nov-2021 10:22 2 KB rforbes to previous | to last
7 26-Nov-2021 10:22 1 KB RForbes to previous | to last
6 26-Nov-2021 10:22 1 KB RForbes to previous | to last
5 26-Nov-2021 10:22 1 KB RForbes to previous | to last
4 26-Nov-2021 10:22 1 KB RForbes to previous | to last
3 26-Nov-2021 10:22 969 bytes RForbes to previous | to last
2 26-Nov-2021 10:22 865 bytes RForbes to previous | to last
1 26-Nov-2021 10:22 770 bytes RForbes to last

Page References

Incoming links Outgoing links
CREATE A USERCALC CUSTOM FUNCTION
CREATE A USERCALC CUSTOM FUNCTION

Version management

Difference between version and

At line 3 removed one line
\\
At line 7 changed 5 lines
#Go to [IMLN] and identify the custom function in the [X_UC_FUNCTIONS] lexicon.
#*__Saved Value__\\This field holds the unique ten character code that is stored in the data base.\\%%information Best practice: Use your customer code and a sequential number (e.g. GT02).\\Please note the __Saved Value__ may not be longer than four characters.%%
#*__Displayed Value__\\This field holds the function name as declared in the data base.
#*__Meaning__\\This field holds the product that the function is intended to be used with.\\ \\
#Invoke the custom function in your UserCalc using an operand type of 'CF'.
!1. Go to [IMLN] and identify the custom function in the [X_UC_FUNCTIONS] lexicon
;Saved Value: This field holds the unique ten character code that is stored in the data base.\\%%information Best practice: Use your customer code and a sequential number (e.g. GT02).\\Please note the Saved Value may not be longer than four characters.%%
* Displayed Value is the Function Name as declared in the data base
* Meaning is the product that the Function is intended to be used with
At line 11 added 2 lines
2. Invoke the custom function in your usercalc using an Operand Type of CF (Custom Function)
At line 14 changed 9 lines
!!Defining the Custom Function in the Data Base
#The custom function must be named P2K_xxx (must start with P2K).\\ \\As a best practice, it is recommended that you include your customer code in the name of the function, which will ensure it is not overlaid at some future point by any new development.\\ \\For workflow oriented custom functions, a recommended best practice is to also include the table/product name in the function name. For example, a custom function created for the WF_EASD table might be named P2K_CF_EASD_xxx_yyyy where xxx is your customer code and yyyy is some kind of descriptive value to aid in remembering what the function does.\\ \\
#Create the function in the data base as a [data base function] returning VARCHAR or NUMBER or BOOLEAN (true/false)
#*No parameters may be defined in this function.
#*Variables, however, can be passed by setting their value prior to calling the custom function and then referring to them within the function.
#**Variables defined on the [IMUC Variables|IMUC#VariablesTab] tab are created in the UserCalc as V_<''variable name''>.\\For example, a variable identified as __Current Month FTE__ will be identified as __V_CURRENT_MONTH_FTE__ in the SQL code.
#*If defining a PR UserCalc, you also have access to all the package variables that are used as part of the P2K_PMCALC package (see P2K_PMCALC_SPEC.sql, which is server code and is a package that exists in the database)
#*You also have access to the P2K_PMUCUTIL package variables (see P2K_PMUCUTIL_SPEC.sql, which is server code and is a package that exists in the database)
!! [Existing Custom Usercalc Functions]
!!Defining the Custom Function in the data base
1. The custom function must be named P2K_xxx (must start with P2K).
At line 17 added 12 lines
As a best practice, it is recommended that you include your customer code in the name of the function, which will ensure it is not overlaid at some future point by any new development. For workflow oriented custom functions, a recommended best practice is to also include the table/product name in the function name. For example, a custom function created for the WF_EASD table might be named P2K_CF_EASD_xxx_yyyy where xxx is your customer code and yyyy is some kind of descriptive value to aid in remembering what the function does.
2. Create the function in the data base as a [data base function] returning VARCHAR or NUMBER or BOOLEAN (true/false)
* No parameters may be defined in this function
* Variables can be passed, however, by setting their value prior to calling the custom function and then referring to them within the function.
** Variables defined on the IMUC Variables tab are created in the usercalc as V_<''variable name''>
** example: a Variable identified as __Current Month FTE__ will be identified as __V_CURRENT_MONTH_FTE__ in the SQL code
* If defining a PR usercalc you also have access to all the package variables that are used as part of the P2K_PMCALC package (see P2K_PMCALC_SPEC.SQL)
* You also have access to the P2K_PMUCUTIL package variables (see P2K_PMUCUTIL_SPEC.SQL)
This page (revision-20) was last changed on 26-Nov-2021 10:22 by kparrottTop