What Is An Environment?

What is an Environment?

An environment is a set of runtime environment variables in a text file. Each variable points to a path searched by the software when you start a session.

Note that the default installation path (on Windows) can be:

C:\Program Files\Dassault
          Systemes\B424\win_b64

All product lines share the same environment management mechanism.

For example, on Windows, the CATDocView environment variable is set by default, for 64-bit Windows, to:

C:\Program Files\Dassault
          Systemes\B424\win_b64doc

meaning that the online documentation files are installed in the folder:

C:\Program Files\Dassault
          Systemes\B424\win_b64\doc

When you want to access the online documentation, the software will look for the files in this location.

On Windows, for example, the environment named Env.txt is created in:

C:\Program Files\Dassault
          Systemes\B424\CATEnv

The Platform Administrator can now specify the path of the native app CATEnv runtime configuration file:

• via a setting in an individual platform member's profile in the Members Control Center app
• or by using a TCL script on Windows or a shell script on Linux for one or more users at the same time (active or pending users can be used, the e-mail address is needed for pending users).

This runtime configuration file will be used by the 3DEXPERIENCE Launcher when launching native apps via the compass.

From the Members Control Center app:

1. From the north quadrant of the Compass, open the Members Control Center app.
2. In the member's profile, click Details.
3. Select the More Options tab.
4. In the Native Apps Environment Configuration File field, set the path to the folder where the CATEnv file will be stored.
   Note: The user must have read access to the selected folder.
5. Click Save.

   To set the path back to the default one, clear the one you entered and click Save.

Using the TCL script (Windows):

To update several users (the users must already exist on the platform):

1. In the 3DSpace server filetree, go the folder containing the TCL scripts.

   For example:

   C:\DassaultSystemes\R2022x\3DSpace\Apps\3DExperienceMyApps\V6R2022x\tcl

2. Run the modify_catEnv.tcl script via MQL.

   The variables to set are:

   - CATENV: CATEnv file path
   - USERS: list of users with the following syntax:
   {user1,user2,user3}, where each user is separated by a comma
   - TENANT: OnPremise

   Run the command, for example:

   mql -t -c "set context user creator; set env CATENV {C:\Program Files\Dassault Systemes\B424\CATEnv\Env.txt}; set env
   USERS {user1,user2,user3}; set env TENANT {OnPremise}; run E:\3DSpace\Apps\3DExperienceMyApps\R2022x\tcl\modify_catEnv.tcl;"

3. Check the details of the users via the Members Control Center app, click Details in the member's profile, then the More Options tab and check that the configuration file path has been set correctly.
4. Connect with one of the users in the list and open the compass (if it is already open, change the quadrant to take the changes into account), and launch a native app.

Using the shell script (Linux):

To update several users (the users must already exist on the platform):

1. In the 3DSpace server filetree, go the folder containing the shell scripts.

   For example:/

   usr/DassaultSystemes/R2022x/3DSpace/server/scripts

2. Run the following shell script:

   ./modify_catEnv.sh -h

   The parameters are:

   -l database login
   -t database tenant id
   -p database password
   -c CATEnv file path
   -u users list
   -e platform (OnPremise)
   -h displays this help message

   Run the command, for example:

   ./modify_catEnv.sh -l login -t tenant -p password -e OnPremise -c 'C:\Program Files\Dassault Systemes\B424\CATEnv\Env.txt' -u 'user1,user2,user3'

   On Premises: platform = OnPremise.

   The tenant and password parameters are not mandatory.

3. Check the details of the users via the Members Control Center app, click Details in the member's profile, then the More Options tab and check that the configuration file path has been set correctly.
4. Connect with one of the users in the list and open the compass (if it is already open, change the quadrant to take the changes into account), and launch a native application.

How are Environments Managed?

Environments are managed:

• using the CATIAENV command to run the Environment Editor, a GUI-based tool which creates, edits, copies and deletes environments
• using the DSYEnvMgt command to create and delete environments
• using the DSYShortcutsMgt to create and delete all application shortcuts on the desktop, and in the menu or tools
• using the lscatenv command to list environment names
• using the chcatenv command to edit one or more environment variables
• using the readcatenv command to read the variables of an environment.

Please use the official tools provided to manage environments. Do not attempt to edit the environment file using a text editor.

What Does Customizing an Environment Mean?

Customizing your runtime environment means creating a new environment and providing different values for the runtime variables in the new environment.

For example, you may install the online documentation at a location different from the default location. If this is the case, you need to specify where the documentation files are located by modifying the value for the CATDocView variable. This is an example of what we mean by customizing your runtime environment.

When customizing runtime environments, you can:

• create new environments
• edit existing environments
• copy existing environments
• delete environments

but you cannot rename existing variables.

List of Official Runtime Variables

The runtime environment variables for all product lines are listed in the table below:

CATErrorLog=%CATTemp%\error.log      

%CATTemp%\error.log

CATErrorLog=OFF