• Created by user-2c621, last updated by user-eb51a on Mar 28, 2023 1 minute read

RDML Naming Conventions

With RDML User-Defined Built-In Functions, you are not required to enter the definitions manually.  The definitions are registered automatically when you compile your RDML Built-In Function.

Built-In Function Definition (BIF Name)

Unless overridden by the definition of field BIF_NAME within the function it defaults to the Function name.   It is recommended that the following naming convention be adopted when overriding within the function.

  • BIF names can be up to 18 characters in length.

  • The BIF name is simple. It is composed of letters of the English alphabet (A through to Z), 0 through to 9 and underscore only.

  • The BIF name should be in the format XX_YYYYYYYYYYYYYYY

         where

         XX must be either UD for User-Defined or OV for Other Vendor.

         YYYYYYYYYYYYYYY is the name that will describe, even to the non-programmer, what functions the BIF performs

Function name

  • Function names can be up to 7 characters in length

While there aren't any mandatory naming conventions for RDML User-Defined Built-In functions, it is recommended that you follow these naming conventions, especially if you want it to be distributed:

  • The name should be in the format XX@Y999

         where

         XX identifies this as Built-In Function code; i.e. OV for Other Vendor or UD for User-Defined.

         y is the type of object, either P for Program or D for Display file

         999 is the unique identifier in the range:
                 -400 to -600 for User-Defined (UD) BIFs.
                 -600 to -999 for Other Vendor (OV) BIFs as per allocated range.

  • No labels