<< Click to Display Table of Contents >> RayPack > 7.3 u6 > User Guide > PackDesigner > MSI / MST / RPP Based Projects > Visual Designer Mode > System Configuration > Environment Variables Edit an Environment Variable |
Once an environment variable data object has been created, its properties can be adjusted. To do so by using the Visual Designer mode interface of PackDesigner, users select the environment variable item from the list at the left-hand side of the Environment Variables view.
As soon as an item is selected, RayPack loads its properties into the edit form at the right-hand side of the view.
At any time, users can go to the corresponding Installer database table row to compare the actual column content to the settings made in the Visual Designer interface.
The following settings are visible and modifiable within the edit environment variable data object form:
The localizable name of the environment variable as it is visible for the end user on the target machine. Any non-empty alphanumerical string is a valid name value.
When RayPack saves the properties of an environment variable data object to the Environment table of the Installer database, prefixes will be added to the user defined value of the name property. It is recommended not to use those prefix symbols (e. g. equals (=), exclamation mark (!), plus (+), minus (-), or asterisk (*)) within the Name input field at all, but let RayPack apply them due to the settings made for the Action and Behavior properties (see below).
At any time, users can go to the corresponding Installer database table row to compare the actual column content to the settings made in the Visual Designer interface.
This column contains the localizable value that is to be set as a formatted string.
When RayPack saves the properties of an environment variable data object to the Environment table of the Installer database, standardized symbols will be added to the user defined value. It is recommended not to use those prefix symbols (e. g. NULL ([~]), separator (;), plus (+), or minus (-)) within the Value input field at all, but let RayPack apply them due to the settings made for the Action and Behavior properties (see below).
•Append
The value entered above is added as a suffix to the value of the environment variable as it exists on the target machine during run time.
RayPack automatically prepends the following symbols to the Value column of the Environment table to trigger this behavior: [~];
•Prepend
The value entered above is added as a prefix to the value of the environment variable as it exists on the target machine during run time.
RayPack automatically appends the following symbols to the Value column of the Environment table to trigger this behavior: ;[~]
•Replace
The value entered above fully replaces the value of the environment variable as it exists on the target machine during run time.
Please note that the Placement property is only available for manipulation if the behavior of the environment variable during installation is set to "Create or set" (see section on Actions above)
Every environment variable data object needs to be assigned to a specific component. At run time, environment variable data objects are only handled when the component they are associated to is installed or uninstalled. If the parent feature of a component is not installed or uninstalled during run time, the environment variable data objects are not considered at all.
Select from the list of existing components. If the current packaging project does not contain the right component yet, please use the NEW button at the right-hand side of the component selection control to add a component to the project. Make sure to assign the new component to a feature, since unassigned components may lead to invalid target packages later. To assign a component to a feature, switch to the COMPONENTS view of the Advanced mode.
The behavior of an environment variable data object can be manipulated from three separated angles:
•Create the variable if it does not exist
If the environment variable already exists on the target machine, no action is applied during installation.
If it does not exist, a new environment variable is created on the target machine.
•Create or set the value of the variable
If the environment variable already exists on the target machine, the action defined above (append, prepend, replace) is executed.
If it does not exist, a new environment variable is created on the target machine.
•Remove the variable from the target system
If the environment variable exists on the target machine, it is removed during installation.
If it does not exist, no action is applied during installation.
•Leave the variable
No action is applied during uninstallation.
•Remove the variable
If the environment variable exists on the target machine, it is removed during uninstallation.
System variables are related to resources and settings of any logged user on the target system.
Location in the target device registry: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Environment
User variables are related to resources and settings owned by various user profiles within the system. These variables usually do not refer to critical system resources or locations, which are necessary for the operating system to run.
Location in the target device registry: HKEY_CURRENT_USER\Environment