Configuring Your Environment in Command Line Mode

This task explains how to configure an environment in command line mode.

Create or Customize Environments Using the setcatenv Command

The setcatenvcommand is available creating and customizing both user and global environments.

Running the Command

The command is located on Windows in:

C:\Program Files\Dassault Systemes\B211\intel_a\code\bin\setcatenv
C:\Program Files\Dassault Systemes\B211\win_b64\code\bin\setcatenv

Run the command as follows on AIX:

/usr/DassaultSystemes/B211/aix_a64/code/command/catstart -run setcatenv

Syntax

The full list of options for the command:

setcatenv
is as follows:

These options specify the general operating environment:

Parameter Description
-cs specifies the name of the product line for which the environment is being created. The value is, for example:
CATIA
-e environment file name ; the "-e" option is mandatory; an existing environment with the same name is always overwritten
-d specifies an existing directory in which the environment file will be created ($HOME/CATEnv by default); the directory is not created if it does not exist; on Windows, if you do not specify "-d", the environment will be created in:
C:\Documents and Settings\user\Application Data\DassaultSystemes\CATEnv
-p specifies the installation directory, and is mandatory; by default, set to the default installation directory:
C:\Program Files\Dassault Systemes\B211(Windows)
/usr/DassaultSystemes/B211/aix_a64AIX)
-server: creates an environment suited for server type environments. The CATUserSettingPath variable value differs between a server environment and an interactive environment. The "-e" option is mandatory when specifying server environments. Consequently, system administrator rights are required for using this option.
-cf specifies the name or path of an existing environment from which you create a new environment. For example, the command:
setcatenv -e MyNewEnv -cf CATIA.V6R2012.B211
creates the new environment MyNewEnv from a copy of
CATIA.V6R2012.B211
This allows you to inherit previous customizations without having to recreate them in the new environment. For example, the CATReferenceSettingPath variable is frequently used to store settings locked by the administrator, and may concatenate several different levels of settings. Copying an existing environment saves you time because you do not having to customize the new environment. Note that if you do not use the "-cf" option, all the variables are set with their default values in the new environment. If only the name is specified in the "-cf " option, the template environment is searched in the default storage directories (user or global).

These options determine a type of behavior when creating or updating environments:

Parameter Description
-v yes/no
  • -v yes (default): verbose mode
  • -v no: non-verbose mode.
-new yes/no
  • yes (default): an environment with the same name (if it exists) is overwritten
  • no: if an environment has the same name, this time it is not overwritten (nothing happens)
  • : However, note that if no environment using the same name is detected, a new environment is created in both cases (whether you use "yes" or "no").
-desktop yes/no sets up the desktop representation of the environment, if it does not already exist. The default is "yes".
-tools Windows only; sets up the Tools menu containing the Environment Editor, Local Key Management, Settings Management and Software Management commands. This is an exclusive option: run this command once like this:

setcatenv -tools -cs CATIA

-icon yes/no Windows only; creates a startup icon on the desktop; default is "yes"
-menu yes/no Windows only; creates a startup icon in the Start menu; default is "yes"

These options specify a particular creation or modification action:

Parameter Description
-a user/global specifies whether you are creating a user or global environment. The default value is "user". Note that you need administrator rights to create a global environment.
-refresh: resets the desktop shortcut and tools; this is useful if you installed a server and client in the same installation path: use the refresh option to initialize the desktop tools and shortcuts
-regserver registers the application on the workstation by adding or modifying a certain number of files required to support dragging and dropping of documents inside the desktop environment, and associates the behavior when double-clicking documents. If a base configuration is already installed, this option serves no useful purpose since the desktop environment is already present. Only use the "-regserver" option if no base configuration is already installed. It should be used after creating a reference environment, and can be used only by an administrator. Note that the execution of the -regserver option takes time, so please be patient.
-h displays help.

Any environment created by either an administrator or an end user using the setcatenv command is a user (not global) environment.

Delete Environments Using the delcatenv Command

Run the delcatenv command to delete environments on your computer.

Running the Command

The command is located on Windows in:

C:\Program Files\Dassault Systemes\B211\intel_a\code\bin\delcatenv
C:\Program Files\Dassault Systemes\B211\win_b64\code\bin\delcatenv

Run the command as follows on AIX:

/usr/DassaultSystemes/B211/aix_a64/code/command/catstart -run delcatenv

Syntax

The full list of options for the command:

delcatenv

is as follows:

Parameter Description
-e environment file name ; the "-e" option is mandatory
-d specifies the directory containing the environment file to be deleted

On Windows, the default is CSIDL_APPDATA\CATEnv.

On AIX, the default is $HOME/CATEnv.

-a user/global specifies whether you are deleting a user or global environment. The default value is "user". Note that you need administrator rights to delete a global environment.
-desktop yes/no if it exists, deletes its graphical representation, in other words, how it is represented to the user on the user's desktop. The default is "yes".
-tools Windows only; deletes the Tools menu containing the Environment Editor, Local Key Management, Settings Management and Software Management commands. This is an exclusive option. Run this command once like this:
delcatenv -tools -cs CATIA
-cs ProductBrand yes/no specifies you want to delete the desktop tools for the brand specified, for example:

delcatenv -cs CATIA

-v yes/no
  • -v yes (default): verbose mode
  • -v no: non-verbose mode.
-unregserver unregisters the software in the CDE Desktop and deletes the appropriate desktop files set up by the "-regserver" option. The effect is that dragging and dropping of documents inside the desktop environment, and the behavior associated when double-clicking documents, are deactivated. This option must be used on its own like this:
delcatenv -unregserver -cs ENOVIA
and once only on a given workstation because it unregisters all installations on the same workstation. This option is an integral part of the installation process, but must be used with caution if you have more than one installation on the same workstation. For example, you may have two installations, A and B (you first installed A, then B). Then, you decide to uninstall B. If you run the commands like this and in this order:
delcatenv -unregserver
delcatenv -e EnvB
then remove the code directory for installation B, installation A will continue to work, but none of the features available via the desktop (dragging and dropping, double-clicking documents, etc.) will work: this behavior is common to all applications, and was deactivated when unregistering. If you have only one installation, first unregister, then delete the runtime environment and finally remove the code. The "- unregserver" option can be used only by an administrator (root). Note that the execution of the -unregserver option takes time, so please be patient.
-server deletes an environment suited for server type environments. The CATUserSettingPath variable value differs between a server environment and an interactive environment. The "-e" option is mandatory when specifying server environments. System administrator rights are required for using this option.
-h displays help

List Environments Using the lscatenv Command

Run the lscatenv command to list the names of all environments on your computer.

Running the Command

The command is located on Windows in:

C:\Program Files\Dassault Systemes\B211\intel_a\code\bin\lscatenv
C:\Program Files\Dassault Systemes\B211\win_b64\code\bin\lscatenv

Run the lscatenv command on AIX as follows:

/usr/DassaultSystemes/B211/aix_a64/code/command/catstart -run lscatenv

Syntax

The full list of options for the command:

lscatenv

is as follows:

Parameter Description
-a user/global lists user or global environments. You must specify one or the other
-d specifies the directory containing the environment; on Windows, the default is CSIDL_APPDATA\CATEnv.
-h displays help

Read Environments Using the readcatenv Command

Run the readcatenv command to read the environment variables in a specified environment.

Running the Command

The command is located on Windows in:

C:\Program Files\Dassault Systemes\B211\intel_a\code\bin\readcatenv
C:\Program Files\Dassault Systemes\B211\win_b64\code\bin\readcatenv

Run the command on AIX as follows:

/usr/DassaultSystemes/B211/aix_a64/code/command/catstart -run readcatenv

Syntax

The full list of options for the command:

readcatenv

is as follows:

Parameter Description
-e environment file name
-d specifies the directory containing the environment; on Windows, the default is CSIDL_APPDATA\CATEnv.
-a user/global specifies user or global environment. You must specify one or the other.
-var specifies a variable whose value is to be read; if you omit "-var", all variables will be displayed
-h displays help

Modify Environments Using the chcatenv Command

Run the chcatenv command to edit one or more environment variables.

Running the Command

The command is located on Windows in:

C:\Program Files\Dassault Systemes\B211\intel_a\code\bin\chcatenv
C:\Program Files\Dassault Systemes\B211\win_b64\code\bin\chcatenv

Run the command on AIX as follows:

/usr/DassaultSystemes/B211/aix_a64/code/command/catstart -run chcatenv

Syntax

The full list of options for the command:

chcatenv

is as follows:

Parameter Description
-e environment file name
-d specifies the directory containing the environment
-a user/global specifies user or global environment. You must specify one or the other.
-var specifies a variable whose value is to be modified. The following syntax is allowed:

CATVariable = new_path 
CATVariable = $CATVariable: new_path 
CATVariable = new_path:$CATVariable

If the path includes blanks, include the whole string in " ".

Note: if you are running this command inside a shell, we recommend that you add a "\" (backslash) before each variable preceded by the "$" character to avoid the values of referenced variables from being replaced by their real values. For example:

CATVariable = \$CATVariable: new_path

-new: creates a new user-defined variable (specified by the "-var" option) with its corresponding value

Example:

chcatenv -e CATIA.V6R2012.B211 -a global -var TOTO=\$TEMP -new

-del: deletes a user-defined variable
-comment "text" adds a comment only to the newly created variables Note: whether you add comments using this command or using the Environment Editor, do not use blank spaces in the comment.
-h displays help

Examples

This section contains examples.

Environment creation and manipulation commands are logged in the installation directory in the file:

SetupEnv.log

The feedback obtained when using all the administration commands from the command line is now output to the current command prompt window.

Running this command on AIX...
./catstart -run "readcatenv -e CATIA.V6R2012.B211-a global"
...displays this...
CATInstallPath=/usr/DassaultSystemes/B211/aix_a64 
CATDLLPath=/usr/DassaultSystemes/B211/aix_a64/code/bin 
CATICPath=/usr/DassaultSystemes/B211/aix_a64/code/productIC 
CATCommandPath=/usr/DassaultSystemes/B211/aix_a64/code/command 
CATDictionaryPath=/usr/DassaultSystemes/B211/aix_a64/code/dictionary 
CATDocView=/usr/DassaultSystemes/B211/aix_a64/doc 
CATReffilesPath=/usr/DassaultSystemes/B211/aix_a64/reffiles 
etc....
Running this command...
./catstart -run "readcatenv -e CATIA.V6R2012.B211 -a global -var CATInstallPath"
...displays this...
CATInstallPath=/usr/DassaultSystemes/B211/aix_a64
Running this command...
./catstart -run "readcatenv -e CATIA.V6R2012.B211 -d /CATEnv -var CATInstallPath"
...displays this...
CATInstallPath=/usr/DassaultSystemes/B211/aix_a64
Running this command...
./catstart -run "chcatenv -e CATIA.V6R2012.B211 -a user -var CATInstallPath=\\\$CATInstallPath:/tmp"
...displays this...
CATInstallPath=/usr/DassaultSystemes/B211/aix_a64:/tmp
Running this command...
./catstart -run "chcatenv -e CATIA.V6R2012.B211 -a user -var CATInstallPath=/tmp"
...displays this...
CATInstallPath=/tmp
Running this command...
./catstart -run "chcatenv -e CATIA.V6R2012.B211 -a user -var NewVar=/tmp -new"
...displays this...
NewVar=/tmp
Running this command...
./catstart -run "lscatenv -d /CATEnv"
...displays this...
CATIA.V6R2012.B211.txt