Function attributes

DID defined functions have the following attributes:

  • Name

    Sets the name of the function. This name is used in the Master Template development. It must begin with an uppercase character and can be followed by lowercase characters, uppercase characters, digits, or underscores.

    function-name ::=
    uppercase-itp-name

  • Execute function

    Determines the operation to perform when the Master Template calls a DID defined function. Depending on the connection type specified in the DID module, the name can be the full path to a program, an SQL query, or a special value. The string that you enter here is stored in the DID. The content of the string is only verified during the Master Template execution.

    execute-function
    [ local-connection-function-attributes ]
    [ function-codepage ]
    execute-function ::=
    EXECUTE_FUNCTION retrieval-name

  • List of formal parameters

    Optional. Specifies formal parameters for a function. The formal parameters are used in the execute function.

    formal-parameter-sequence ::=

  • Code page

    Sets the code page for the execute function used to translate the result and parameters. If not defined, the code page defined in the DID module is used. During the Master Template execution, KCM determines the code page of the system on which it runs. Parameters passed to the execute function are translated from the system code page to the code page defined in the entry. The result yielded by the execute function is translated from the code page defined in the entry to the code page used by the system.

    codepage 
    ::=EBCDIC
    |	        ASCII
    |	        natural-number

  • Function result

    Result of a function that was called.

    function-result ::=
    FUNCTION_RESULT field-def

In addition to this set of parameters, a DID defined function can have a calling connection attribute that depends on the connection type specified.