CREATE A USERCALC CUSTOM FUNCTION#

Defining the Custom Function in the Application#

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.
     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.
     
     
2. Invoke the custom function in your UserCalc using an operand type of 'CF'.

Defining the Custom Function in the Data Base#

1. 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.
   
   
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, 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 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#

Notes #