#===========================================================================================
#
# Filename: UserVariables.var
#
#===========================================================================================
#
# This file provides documentation and syntax for user-variables.
# This file declares no variables when shipped.
#
# User-variables may be declared in the main configuration file, in separate 'varfile'(s) (such as this one) or embedded into 'module' files.
#    - The advantage of using a common 'varfile' such as this one is that all declared variables are in one file and not inter-mixed with other configuration settings.
#    - Use of 'module files' makes moving (or enabling/disabling) database or file output sections easier.
#    - Use of the main configuraiton provides single-file convenience for small configurations.
#
# All variables declared for test and demonstration purposes are contained in the relevant '*.module' files.
#
#===========================================================================================
# Each user-variable in DBD2 provides a mapping of a (globally-unique) sql-index value (a positive integer) to a list of names that may be provided
#    in the 'name=value' pairs of incoming 'dbcl' data-strings or in syslog parameter lists.
#
# Each user-variable may include (in its name-list) a single system-variable name which is identified by a '$' preceding the name. The system-variable
#    defines any processing that DBD2 needs to perform on the provided data for proper conversion formatting to meet the database expectations.
#
# The keyword to define a user-variable is 'var':
#     Sql-indeices are positive integer values.
#     Sql-indices need not be sequential and need not appear in any particular order.
#     There is no upper limit to the sql-index (numeric value) (other than the operating-system-imposed max value) for positive integers.
#
#===========================================================================================
#
#  U s e r - V a r i a b l e   F o r m a t
#
#===========================================================================================
# 'var' [=] <numeric sql-index> [=] <comma-separated list of variable names>
#
# To access and use a system-variable (dynamic) definition, prepend a '$' to the system-variable's name when specifying the name-list in the 'var' declaration.
#     Only the first system-variable-name for any given user-variable will be used.
#     If system-variables and non-system-variable values are mixed in a 'var' name-list, the system-variable processing will still occur and will take precedence.
#     If the system-variable 'source' is other than 'parms', this could produce unexpected results.
#
# Each user-variable definition must be on a line by itself.
#
#     var = 181 = username,user,userid              # Any of these names will match a data-base template request for '$181' if found in the dbcl parameter-list
#     var = 182 username, user, userid, $PUserStr   # Any of these names will match a data-base template request for '$182' if found in the parameter-list - Plus:
#                                                   # The system variable specifies that any numeric values (user-ids) will be converted to user names by DBD2.
#     var = 183 = $syslogmsg                        # A system-variable name that returns the value of the message-string from a syslog input-string.
#===========================================================================================
# For more examples of user variables, please review any of the '*.module' files included in this package.
#===========================================================================================