Api parameter value

Script ADP_TOOL

GET_PARAM

This Funprog is used to get the parameter value defined at Folder/Legislation/Company/Site level. The value of the parameter is returned in string format.

Funprog GET_PARAM(FOLDER, TYPCOD, TYPVAL, PARAM)
Value Char FOLDER Folder
Value Integer TYPCOD 1=Folder, 2=Company, 3=Site, 5=Legislation, 0=not specified
Value Char TYPVAL Value that corresponds to the TYPCOD
Value Char PARAM Parameter code

Note:

  • The "Definition Level" of the parameter to search can be at any level.
  • The search level 'TYPCOD' can only be Folder/Legislation/Company/Site.
  • For the search of the value at the User level, use Funprog 'GET_PARAM_USER'.
  • A heritage logic is implemented in this Funprog, which means:
    • If no value is found for the given site, then search continues in an attempt to find the value defined for this site company.
    • If no value is found for the given company, then search continues in an attempt to find the value defined for this company Legislation.
    • If no value is found for the given legislation, then search continues in an attempt to find the value defined at the Folder level.

GET_PARAM_USER

This Funprog is used to get the parameter value defined at the user level. The value of the parameter is returned in string format.

Funprog GET_PARAM_USER(FOLDER, USER, PARAM)
Value Char FOLDER Folder
Value Char USER User
Value Char PARAM Parameter code