Specify per-node Variables and Values
$environment *|nodename|\\machinename varname "value" [start end days]
This command specifies variables which are to be applied to an individual CopiaFacts node. They are intended for use as replacements for values specified in the operating system program "environment", and to avoid the need to set such variables individually on each machine running the CopiaFacts engine.
The values defined with this command override 'real' operating system environment variables for any of the purposes defined in Appendix G. When the variable is named in the context of a system variable expansion, the variable defined on a $var_def configuration command takes precedence over a variables of the same name defined for the node on the $environment command. Variables defined on this command are NOT passed in the environment to programs spawned from the engine (e.g. INTERNAL pre-process commands), and are not expanded when environment variables are to be expanded using the special %varname% syntax supported in some places. In addition, the values from these commands are not available for use in EMDIRECT, which is designed to run when FAXFACTS.CFG is not accessible.
You can also define custom variables on this command and access them in the same way as $var_def variables, with the addition of the validity-time parameters described below.
The parameters on this command are used as follows:
| * | The variable is to be applied to all nodes and machines. |
| nodename | The name of the COPIAFACTS node (e.g. M1_1234) to which the variable is to be applied. |
| \\machinename | The name of the machine on which the variable is to be applied in CopiaFacts applications. These variables are ignored when a nodename has been matched for COPIAFACTS or FFEXTERN as described below. |
| varname | the name of the variable to be defined. |
| value | the value to be assigned to the variable, enclosed in double quotes if it contains embedded spaces. Note that system variables other than FFBASE are not expanded on this command. |
| start | the time at which the specified assignment is to be enabled, formatted as HH:MM. Applies to COPIAFACTS only. |
| end | the time at which the specified assignment is to be disabled, formatted as HH:MM. Applies to COPIAFACTS only. |
| days | a string of numbers indicating the days to be scheduled, with Sunday=1. Applies to COPIAFACTS only. |
The nodename parameter controls when the $environment variables are loaded for use in CopiaFacts applications:
| All programs | Variables with nodename parameter of * are loaded at initialization. |
| COPIAFACTS | Variables with a nodename matching the current node name are loaded at initialization, and variables are cleared and reloaded if the node name of the program is changed on the initial options screen (which can only be done before the main program starts). Variables with \\machinename are not loaded. |
| FFEXTERN | Variables with a nodename matching the Document Converter Node name specified on the command line are loaded at initialization. These variables are also loaded at initialization by CVSINGLE, but only if this has been called from an FFEXTERN instance which has a Document Converter Node name on its command line. Variables with \\machinename are not loaded. |
| Other Programs | Variables with \\machinename are loaded on the specified machine. Variables with a nodename are loaded only if it matches the node name used by the last COPIAFACTS instance run on the same machine. This action also applies to FFEXTERN when no document converter nodes have been defined, and to standalone instances of CVSINGLE. |
The optional start, end and days parameters cause the value of the variable to be used only during the specified schedule period(s). If more than one schedule period is active for a particular variable, the first specified takes precedence; however a variable specification without any schedule period is always overridden, even if it precedes scheduled entries for the same variable. Schedules are always enabled for periods of quarter of an hour, and any time specified within a quarter hour enables the schedule for the whole quarter of an hour. So for example a start time of 16:05 would actually start at 16:00 and an end time of 17:10 would actually end at 17:15. You will therefore find it simplest to specify all times as exact multiples of 15 minutes. You may use up to 64 variable definitions with time specifications.
Examples:
$environment M1 SVP "\\MASTER\COPIA\faxfacts\specialvox"
$environment * MyFaxSendLine "1-24" 09:00 17:00 23456
$environment * MyFaxSendLine "1-48"
