Naming Convention Environment Variables

Attribute(s)

  • Environment Variable

    Description

    Environment Variables must have a standard naming convention. See Details field for more information.

    Motivation

    In order to quickly identify environment variables in the Notes.ini file, they must have a distinct, standard naming convention.

    Example / Details

    Use Environment variables only in the Notes client, not on the server.

    Environment variables are automatically placed in the Notes.ini file. It is
    very important that they be identifiable, not only for notes developers who may
    need to be able to examine them from time to time, but also for Notes
    administrators who regularly check the Notes.ini file.

    Environment variables must have the following form:

    ENV-<DBFileNameStem>-<8LetterVariableName>

    Where:

    ENV
    - Indicates that this is an environment variable
    <DBFileNameStem>
    - The file name stem. Needed to indicate from which application the environment
    variable is created.
    <8LetterVariableName>
    - A description used to indicate the function of the environment variable.


    Example:
    For the database Standards.nsf, the following environment variable name would
    be acceptable:

    ENV-Standards-UserName


    NOTE:
    When you no longer need an environment variable in the database design, make
    sure you delete it from the Notes.ini file. To do this, you must include the
    following code in your programming:

    Formula Language:
    @SetEnvironment('EnvironmentVariableName'; '')

    Script:
    Dim Session as New NotesSession
    Call Session.SetEnvironment('EnvironmentVariableName'; '')