Professional Documents
Culture Documents
Preface
Conventions
What's New?
Installing Version 5
What You Need Before Installing Version 5
Hardware Requirements
Software Requirements
Distributing Code
Distributing Version 5 on Windows
About Distributing Version 5 on Windows
Distributing the Software To a Single Client Computer
Distributing the Software To a Client Using the RCMD Command
Accessing the Software From a Thin Client
Distributing the Software in Compressed Form
Distributing a Service Pack From an Archive File on Windows
Distributing Version 5 on UNIX
About Distributing Version 5 on UNIX
Setting Up the Server
Distributing the Software To A Client Workstation
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 2
Enabling User Access to the Software Over the Network
Distributing a Service Pack From an Archive File on UNIX
Administering Version 5
Licensing
Licensing Overview
Licensing Tools
Enrolling Nodelock Licenses After the Installation
Reserving Static Licenses Using the License Manager
Reserving Shareable Product Licenses Dynamically
Running in Demo Mode
Enabling Concurrent Offline Licensing
Overview
Welcome to the Version 5 Installation and Administration Guide!
This guide is intended for system administrators who need to install code and set up Version 5 products for use
by end users.
Conventions
Certain conventions are used in CATIA, ENOVIA & DELMIA documentation to help you recognize and understand
important concepts and specifications.
Graphic Conventions
The three categories of graphic conventions used are as follows:
a target of a task
the prerequisites
a tip
a warning
information
basic concepts
methodology
reference information
Site Map
What's New?
Overview
Getting Started
Basic Tasks
Workbench Description
Customizing
Reference
Methodology
Glossary
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 6
Index
Text Conventions
The following text conventions are used:
● The titles of CATIA, ENOVIA and DELMIA documents appear in this manner throughout the text.
● File -> New identifies the commands to be used.
● Enhancements are identified by a blue-colored background on the text.
Use this
mouse button... Whenever you read...
● Drag
● Move
What's New?
New and Enhanced Functionalities
Installation
Licensing
Ability to report the network adapter used for a Windows licensing target ID
Windows machines can have several network adapters. However, a network adapter is used by the
licensing software to generate a unique target ID. It's useful for the administrator to know which
network adapter is needed by the licensing software. The network adapter is identified by the
CATNodelockMgt and CATSoftwareMgt tools and the associated batch tools.
Allow document save if license server goes down
When a license server or the network goes down, a Version 5 session now enters a special mode giving
users the opportunity to save their work before exiting.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 8
Installing Version 5
What You Need Before Installing Version 5
Installing Version 5 Products on Windows
Installing Version 5 Products on UNIX
Distributing Code
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 9
Hardware Requirements
Common Hardware Requirements
The following requirements are common to all operating systems supported by Version 5. System unit and
graphic requirements are platform specific and are detailed in the topics that follow:
Disk drive: an internal or external disk drive (minimum recommended size : 4 GB) is required to store program
executables, program data, usage environment and paging space.
Installation of all CATIA Version 5 Products require 2.0 GB on Windows, 2.4 GB on AIX, 2.7 GB on HP-UX, 2.5
GB on IRIX and 2.3 GB on Solaris.
Memory: 256 MB of RAM is the minimum recommended amount of memory for all applications. 512 MB of RAM
is recommended for DMU applications on large assemblies and for the CATIA - Digitized Shape Editor 2 (DSE)
product. Requirements may be greater when large amounts of data are used.
Internal/external drives: a CD-ROM drive is required for program installation and access to the online
documentation, which can optionally be downloaded to disk.
Display: A graphic color display, compatible with the selected platform-specific graphic adapter. The minimum
recommended size for usability reasons is 17 inches. The minimum resolution required for Windows
workstations is 1024 x 768, and 1280 x 1024 on UNIX workstations. Changing the resolution during a session is
not supported. You first have to exit the current session, change the resolution then restart the session,
otherwise the result is unpredictable.
When selecting a graphic adapter, hardware texturing capability is strongly recommended when using Version 5
products that use texture mapping, in which case the amount of RAM has to be adequate for the number and
complexity of textures to be used.
Keyboard: a specific keyboard compatible with selected installation locale may be required for national
language support.
Pointing device: 3-button mouse. On Windows workstations, a 2-button mouse may alternatively be used (the
third button is emulated with a keyboard sequence). The 3-button mouse is recommended for usability reasons.
The IntelliMouse (two buttons plus wheel) is an alternative to the three-button mouse on Windows workstations,
the wheel acting as the middle button and allowing additional manipulations such as panning and scrolling.
SpaceBall and SpaceMouse can be used, in addition to the mouse, to perform graphic manipulations (zoom,
pan, rotate, etc.). The necessary drivers are delivered with the device.
These devices can be used with CATIA - DMU NAVIGATOR 1 (DN1), CATIA - DMU SPACE ANALYSIS (SP1) and
all CATIA P2 Products.
The robustness of the overall solution is dependant on the robustness of the operating system and the hardware
environment used. Windows and UNIX hardware configurations certified by Dassault Systemes for running
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 11
products are published at:
http://www.ibm.com/solutions/plm
Although products might run on other configurations or other graphic adapters, incidents specific to these
configurations or adapters would not be accepted for support.
System Unit
Intel Pentium III or Pentium 4-based workstations running Windows2000 Professional Edition, or Windows XP
Professional Edition.
Network Adapter
An active LAN adapter (Ethernet or Token Ring, installed and configured) is required for licensing purposes.
Graphic Adapter
An OpenGL-capable graphic adapter is required. Note that graphic performance on local transformations
(panning, zooming, rotating model) will depend on the selected graphic adapter. This graphic adapter should
have the following capabilities:
Pentium III or Pentium 4-based workstations running Microsoft Windows 2000, Windows XP Home Edition or
Windows XP Professional.
Graphic Adapter
A graphic adapter with a 3D OpenGL accelerator is required. Note that graphic performance on viewing functions
(panning, zooming, rotating) will depend on the selected graphic adapter. The graphic adapter should have the
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 12
following capabilities:
Network Adapter
An active LAN adapter (Ethernet or Token Ring, installed and configured) is required for licensing purposes.
An updated list of hardware configurations, certified at Dassault Systemes for running Version 5 products, is
published on the V5 Web site at URL:
http://www.ibm.com/solutions/plm
IBM AIX
System Unit
Any RS/6000, based on PowerPC 604 (166 MHz minimum clock speed), Power2 or Power3 or Power4 processor
families, supported on AIX Version 5.1, provided that requirements described below are met.
Graphic Adapter
● GXT500P
● GXT550P
● GXT800P
● GXT800M
● GXT2000P
● GXT3000P
● GXT4000P
● GXT4500P
● GXT6000P
● GXT6500P
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 13
HP-UX
System Unit
Any B-Class, C-Class or J-Class workstation based on a PA8000 processor family, supported on HP-UX Version
11.0 A.C.E. (November 1999), or HP-UX 11.11 (HP-UX 11i), provided that requirements described below are
met.
Graphic Adapter
● Visualize-FXE
● Visualize-FX2
● Visualize-FX4
● Visualize-FX5
● Visualize-FX6
● Visualize-FX10
● Fire GL-UX
SGI IRIX
System Unit
Any O2, Indigo2, Octane, Octane2, Onyx2, Fuel or Onyx3000 workstations based on R5000, R10000, R12000 or
R14000 processors, supported on IRIX 6.5, provided that requirements described below are met.
Graphic Adapter
● Infinite Reality
● Infinite Reality 3
● InfinitePerformance
setenv CAT_Phong 1
to enable phong (per-pixel) lighting for light sources in Version 5 without any impact on performance.
This feature allows only one light to be activated (which is the default lighting in Version 5).
export CAT_OdyOptim=1
SGI Onyx
Graphics Performance Tuning
export CAT_OdyOptim=1
If you want to use more Display List memory, export the variables as shown below. The values indicated
correspond to a 500Mo memory (500Mo = 1024 x 1024 x 500 = 524288000):
export GLKONA_RESERVE=524288000
export GLKONA_RESERVE_LIMIT=530000000
Note: this reserved memory is taken from the physical system memory, thus make sure that the size is
correctly balanced between the model and your system memory.
If you are fill-limited, you can export the following variable to use the DIGITAL VIDEO RESIZING:
where "number of frame" is the number of frames per second you would like to achieve.
The screen resolution will change automatically while moving the model to reach the number of frames per
second you specified.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 15
Sun Solaris
System Unit
Any Ultra1, Ultra2, Ultra10, Ultra30, Ultra60, SUN Blade 100, SUN Blade 150, SUN Blade 1000, SUN Blade
1500, SUN Blade 2000 or SUN Blade 2500 workstation based on UltraSPARC processor, supported on Solaris 8,
provided that requirements described below are met.
Graphic Adapter
● Creator3D
● Creator3D Series III
● Elite 3D (U10-440 Mhz only, for U10 workstations)
● Expert3D Lite
● Expert3D
● XVR-500
● XVR-1000
● XVR-1200
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 16
Software Requirements
Common Software Requirements
Version 5 runs on selected system levels of:
● Windows 2000
● Windows XP
● IBM AIX
● Hewlett Packard HP-UX
● SGI IRIX
● Sun Solaris.
Refer to the Program Directory or contact your IBM Support Center, for appropriate corrective service to apply
to the software described in the topics that follow.
Windows 2000 / XP
Minimum level required: Windows 2000 Professional Edition, with Service Pack 2 or higher, or Windows XP
Professional Edition, with the following components:
● A Microsoft implementation of OpenGL libraries, as delivered with Windows 2000 or Windows XP. These
libraries may have to be modified to accommodate the selected graphic adapter when installing the graphic
adapter and its associated drivers. For recommendations related to driver levels based on tested graphic
adapters, visit:
http://www.ibm.com/solutions/plm
● A localized version of the operating system may be required when selected installation differs from Latin 1.
Note: For remote access from networked clients, Terminal Server is supported by Windows 2000 Server,
Windows 2000 Advanced Server and Windows XP Professional. Access through standard browsers requires Citrix
MetaFrame 1.0 to also be installed on the server.
IBM AIX
Minimum level required: AIX 5.1 ML4 (includes OpenGL and GL3.2 for AIX runtime) with the following
components:
● ICSet++ runtime for AIX 5.0 version 6.0.0.5 (CSet++ runtime is delivered with the operating system)
● XL Fortran Runtime Environment (xlfrte), at level 7.1.1.5
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 17
● XL SMP Runtime Library at level 1.3.8
● Common Desktop Environment (CDE; delivered with the operating system)
HP-UX
HP-UX Version 11.0 ACE (Workstation Additional Core Enhancements for HP-UX 11.0 November, 1999), or HP-
UX 11.11 (HP-UX 11i), with the following components:
● ANSI C++ Runtime Environment (aC++, at a minimum level of 3.30, delivered with the operating system)
● HP Fortran 90 Runtime Environment (delivered with the operating system)
● HP-UX 700 OpenGL 3D API Runtime Environment
● CDE (delivered with the operating system)
A localized version of the operating system may be required when the selected installation differs from ISO code
pages.
SGI IRIX
Minimum level required: IRIX 6.5.15m, with the following components:
● C, C++ and Fortran77 standard execution environment at level 7.3.1 (delivered with the operating system)
● OpenGL (delivered with the IRIX execution environment)
● IRIX Interactive Desktop (delivered with the operating system)
● WorldView when the selected installation locale differs from ISO-1.
Sun Solaris
Minimum level required: Sun Solaris 8 H/W 02/02, with the following components:
● A localized version of the operating system may be required when the selected installation differs from ISO-
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 18
1.
CATIA - V4 Integration 2 (V4I) requires, on the CATIA Version 5 client, for interoperability with CATIA Version 4
CDM and ENOVIA VPM 1:
Note: Please contact your IBM or Oracle local representative for support and planning information on DB2
UDB or Oracle.
CATIA Version 4 CDM and ENOVIA VPM interoperability is available through CATIA - V4 Integration 2 (V4I) for
the following products:
Interoperability of CATIA Version 5 on the supported Windows platforms with ENOVIA VPM through ENOVIA 3d
com requires, on the client side, either (depending whether the database server is a DB2(R) or an Oracle
server):
Math Kernel Libraries: on Intel architecture in a Windows 2000 or Windows XP environment, the use of Intel
Math Kernel Libraries (MKL) 5.2 or 6.0 can improve the performance of the following products:
http://developer.intel.com/software/products/mkl/
This requirement is optional. For more information, refer to the section "Before You Begin" in your Generative
Structural Analysis documentation.
Only the latest version of Intel MKL can be found on the site, and this version may be at a higher level than
level 5.2 required for Version 5. In this case, you can download it from the Intel FTP site (see Generative
Structural Analysis Documentation, at section Before You Begin.
Product information is delivered on the product CDs in HTML format. An HTML browser is required to access this
documentation.
Supported Browsers
Windows
http://java.sun.com/j2se/1.4.2/download.html
● Mozilla 1.4 a Java plug-in is necessary for access to the Documentation search applet. The recommended
plug-in on Windows, at minimum level 1.4.2-03, is available on
http://java.sun.com/j2se/1.4.2/download.html
AIX
Mozilla 1.4 a Java plug-in is necessary for access to the Documentation search applet. The recommended plug-
in on AIX, at minimum level 1.4.1 is included in Java 1.4.1 (for AIX 5 only). Java 1.4.1 is provided as an update
to Java 1.4.0 ( IY43555).
HP-UX
Mozilla 1.4 : a Java plug-in is necessary for access to the Documentation search applet. The recommended plug-
in on HP-UX, at minimum level 1.4.2, is available on:
http://www.hp.com/products1/unix/java/java2/jpi/downloads/index.html
SGI
Mozilla 1.4 : a Java plug-in is necessary for access to the Documentation search applet. The recommended plug-
in on SGI, at minimum level 1.4.1, is available on:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 20
http://www.sgi.com/products/evaluation/6.5_java_plugin_1.4.1/
SUN
Mozilla 1.4 : a Java plugin is necessary for access to the Documentation search applet. The recommended plug-
in on Solaris, at minimum level 1.4.2-02, is available on:
http://java.sun.com/j2se/1.4.2/download.html
Although access to the online documentation might work on other HTML browsers, incidents specific to browsers
other than those specified are not eligible for support.
Product information is also supplied on the product CDs in Portable Document Format (PDF) form. Viewing and
printing of the PDF files requires the Adobe Acrobat Reader at a minimum level of 5.0. The reader can be
downloaded, at no charge, from:
http://www.adobe.com/
Licensing
Windows workstations must have an active LAN card (Ethernet or token ring) and TCP/IP installed and properly
configured, but there is no need to have the workstations connected to the network.
License Use Management (LUM) is required to serve concurrent licenses across a network. A LUM configuration
file (i4ls.ini) is required on clients to access concurrent licenses from these servers.
Server and nodelock licensing mechanisms are available for P1, P2 and P3, on all supported operating
environments (Windows 2000, Windows XP, AIX, HP-UX, IRIX and Solaris).
IBM License Use Management 4.6.7 is shipped with Version 5 Release 13. Other versions of LUM may be
obtained, at no charge, from:
http://www.software.ibm.com/is/lum/download.html
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 21
IBM License Use Management High-Availability Licensing (HAL) enables you to set up an environment in which
there is a very high degree of certainty that concurrent licenses will be available, even if a network license
server goes down.
When you use this option, you create a cluster of network license servers. A cluster is a group of from 3 to 12
network license servers that jointly serve vendor-managed concurrent licenses that are enrolled on the cluster
rather than on an individual server.
If you decide not to use HAL, when the server goes down, your Version 5 session remains active and another
license is requested from another license server. If the license is granted, the total number of licenses granted
is increased by one. With HAL, if the license is granted, the total numbers of licenses granted stays the same.
Consider that for HAL cluster members, it is strongly recommended to upgrade all the servers to LUM Version
4.5.8.
For more information about High-Availability Licensing, refer to the LUM documentation "Using License Use
Management Runtime" for your platform.
For UNIX, the interpreter is VB Script 3.0 from Mainsoft. Its components are included in Version 5 as shared
libraries.
● Visual Basic Script (VB Script) at minimum level 5.0. It is delivered with Microsoft Internet Explorer. VB
Script libraries at level 5.0.0.3715 are delivered with Microsoft Internet Explorer 5.0 or at later levels with
later versions of Microsoft Internet Explorer. Use of VB Script is recommended for developing Windows/UNIX
compatible macros.
● Microsoft Visual Basic for Applications (VBA) at minimum level 6.0. VBA is delivered and installed by default
with Version 5.
Windows
Printers and plotters are supported through the vendor's drivers for the targeted printer of plotter relative to the
targeted version of the operating system. Contact the printer or plotter vendor for requirements and support.
UNIX
ClearCoat technology is available for IRIX and Windows (SGI only) systems running Version 5 Release 4 or
higher. It is supported for more realistic shading effects. This technology reproduces the reflective nature of
glossy materials such as paint, plastic and glass. This life-like rendering technology improves greatly the fidelity
of styling reviews.
You can access this new technology on SGI UNIW/Windows workstations by downloading the runtime library
from the following site:
http://www.sgi.com/software/clearcoat
This library must be installed in the Version 5 filetree containing runtime code (...code/bin).
Once the ClearCoat software is installed, the environment mapping textures applied in Version 5 will be modified
in a way to produce the ClearCoat effects.
ClearCoat 360
ClearCoat 360 technology (SGI only) is supported for real-time lighting and reflection computation. It is
available for IRIX Systems running Version 5 Release 5 or higher.
You can apply ClearCoat 360 (.cc360 extension files) the same way you apply textures to your model:
● Version 5 Material Library product lets you create materials with ClearCoat 360 textures.
● Version 5 Photo Studio product lets you create a Box environment where you can apply environment
textures used by your ClearCoat 360 files.
You can download the ClearCoat 360 runtime environment from the following site:
http://www.sgi.com/software/clearcoat
To create ClearCoat files, use the Sphere Maps generator SMGen. SMGen ordering instructions are available
from the following site:
http://www.sgi.com/software/clearcoat
export CC360MipMap=1
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 23
to enable mipmapping on ClearCoat 360 rendering. This can improve quality on surface edges and has a low
impact on performance.
The MPK version 3.1 libraries are required to run multipiped sessions on SGI IRIX. If these libraries are not
installed, you will not be able to launch a multiscreen session. You can also put the libmpk.so.3 library directly
in your irix_a/code/bin directory. For detailed information, you can browse the following Web site:
http://www.sgi.com/software/multipipe/sdk/
Using WMQ communication tools, some batch operations can now be launched remotely. When implemented at
the batch level, this optional feature requires WMQ at minimum level 5.2. For availability of client and server
components on supported platforms, visit:
http://www.ibm.com/software/integration/wmq/
WMQ Client is required on systems where the transaction is initiated. WMQ Server is required on systems where
remote batches are executed.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 24
Installation and de-installation rely on Windows-compliant tools enabling anyone familiar with Windows procedures and concepts to install the
software without assistance.
Before starting the installation, refer to What You Need Before Installing Version 5 to check you have all the hardware and software
prerequisites.
Furthermore, to prevent the installation from hanging due to concurrently running programs such as screen savers or virus scanning
programs, we recommend that you first shut down any such programs.
You must also have your license enrollment certificate (in electronic format) provided by your vendor. If you have the certificate, you will be
able to register your license during the installation procedure.
Note also that, if an IBM License Use Management Runtime (LUM) license server is running on the computer on which you are installing
Version 5, you must stop the server before starting the installation.
Installation Log
An installation log will be created in the current temporary directory, located by default in:
%TMP%\cxinst.log
For example:
C:\TEMP\cxinst.log
How To Display the Target ID of Your Computer Before Ordering Your Products
Before ordering a nodelock license, you need to obtain the target ID of your computer. The target ID must accompany the license order. The
license certificate is generated using the target ID of your computer.
Before installing the software, the application has no way of determining the target ID. In this case, if you have installed IBM License Use
Management Runtime (LUM), you can use the tools provided by LUM to obtain the target id.
i4target -O
located in:
C:\ifor\win\bin
How To Display the Target ID of Your Computer Once You Have Received the CD-ROM
http://www.software.ibm.com/is/lum/lumdownl.html
If you double-click on i4tgtid.exe, a message box displaying the win32mac target ID of the machine will be presented. The target id is a
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 26
number represented in hexadecimal notation. Make sure that the string "win32mac" is also displayed alongside with the target id.
Depending on the network configuration of your machine, the win32mac target ID might not be available. This is when i4target.exe in
command-line mode is needed:
1. Open a Command Prompt window and set the directory to your CD-ROM drive.
2. Run "i4target -z".
This will list network adapters that can be used for the target ID.
3. Run "i4target -d xxx"
where "xxx" is one the network adapters listed in step 2.
4. Run i4target or i4tgtid.
You should obtain the same target ID as in step 2.
NOTE: Do not repeat step 2 once you have a valid win32mac target ID.
You must belong to the Administrators group, or have the privileges assigned to the Administrators group. Otherwise, you will not be
able to start the installation.
2. Insert the CD-ROM into the drive.
IBM License Use Management Runtime (LUM), needed to be able to manage nodelock licensing, is no longer installed automatically
with the files: it is now integrated in the software on the CD-ROM. The installation sets up the following folder:
C:\ifor\Ls\Conf
Note: the installation procedure now automatically installs the LUM driver which you previously had to install manually.
The Welcome dialog box is then displayed on a background window. Note that the screenshots illustrating the installation procedure
were taken without the background window:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 27
3. Click the Next button to move to the next step.
The CATIA V5R14 License dialog box appears, asking you if you want to enter a nodelock license key for the computer on which you
are installing the software.
Note that the target id of the computer on which you are performing the installation is displayed after the dialog box title.
4. If you want to enter a nodelock license, click the Import Certificate button to access the Import Certificate dialog box.
This dialog box lets you import the license certificate (that is, if you received your license certificate by electronic mail, and provided
you detached it and stored it on your disk).
5. Explore your environment containing the license certificate (ending with the suffix ".lic"), then click Open.
This creates a nodelock file on your computer, and stores your license by default in the nodelock file on all Windows platforms (except
Windows 2000) in:
C:\ifor\Ls\Conf\nodelock
If you already installed LUM elsewhere, the nodelock file will be updated in the correct LUM environment.
If you decide to skip the licensing step, or if you have a license enrollment certificate in paper format only (and not in electronic
format), you can enroll your licenses later, after the installation has been completed. For more information, refer to Enrolling Nodelock
Licenses After the Installation.
The Choose Destination Location dialog box appears. A default destination folder is already proposed:
7. If the default destination folder is suitable, click the Next button to move to the next step, or click the Browse... button and navigate
to select another folder and click OK.
The folder you choose must be empty. You can also specify a new folder: if the folder does not exist, you will be prompted to specify
that you want the folder to be created, in which case you must click the Yes button to create the folder.
Providing you have enough disk space, you can now install several identical releases in different locations on the same computer.
For example, you may want to install the same V5R14 GA release in two places. Your first installation could be, for example, the
production version. Then, once a V5R14 service pack becomes available, you could apply it to the second installation which would
then become the test version, enabling you to test it before it becomes the official production version.
Furthermore, the different releases you can install can belong either to the same product line, or to different product lines. For
example, you could install CATIA V5R14 and DELMIA V5R14 in different locations.
To install another identical release, when you reach the Choose Destination Location dialog box, this time click the Browse... button,
specify the new destination folder, then click OK. You will be prompted to create the folder if it does not already exist, so click Yes.
Click Next to display the dialog box entitled "Enter Ident for your new installation":
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 29
Enter an identifier which will enable you to identify all the components of your new installation. The string must contain uppercase
characters or numbers, and must not exceed 20 characters.
The identifier for your new installation is preceded by an underscore and is visible:
If identical releases belonging to the same product line are installed, the OLE behavior is the same for both. However, if the
installations involve different product lines, the OLE behavior registered for the last installation takes priority.
Note also that two identical product lines installed in different locations share the same nodelocked license: no new license is needed
for the second installation.
8. Click the Next button to move to the next step.
9. If the default folder is suitable, click the Next button to move to the next step, or click the Browse... button and navigate to select
another folder and click OK.
You can choose any folder, or specify a new folder: if the folder does not exist, you will be prompted to specify that you want the
folder to be created, in which case you must click the Yes button to create the folder.
For more about environment files, refer to About the Environment Created on Your Computer on Windows.
10. Click the Next button to move to the next step.
This dialog box lets you specify whether you want to install all of the software on the CD-ROM, or select the configurations and/or
products to be installed:
❍ Complete: specifies you want to install all the software, and moves on to the next installation step (installation of online
documentation files) when you click Next
❍ Custom: lets you choose the configurations and/or products to be installed.
11. If you want to choose which configurations and/or products to install, check the Custom option and click the Next button to move to
the next step.
Check the buttons to install the user interface files for the appropriate language(s) and/or to install language-indexed fonts. Uncheck
the buttons for the language files you do not want to install. This will let you skip the installation of unnecessary language files and
fonts and enable you to save disk space.
❍ Simplified Chinese
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 32
❍ Traditional Chinese
❍ Japanese
❍ Korean
❍ SSS4 (miscellaneous).
If you intend to access data containing language-indexed fonts for a specific language environment, for example, drawing documents,
if you have not installed the fonts beforehand, you will obtain a message when opening the document, saying that a font is missing
and that it will be replaced by another font.
To avoid this problem, we recommend that you check the option to install the language-indexed fonts.
Note that the choice you make at installation is definitive: you cannot add or remove languages or fonts later when installing
additional configurations and/or products.
13. Choose whether you want to install configurations and/or products by using the list box provided.
Depending on what you chose, the list will display the names of all the configurations or products on the CD-ROM.
14. Click on the configurations and/or products to select them.
In our example, we chose to install the DP2 - CATIA - Drawing Production 2 configuration and the MD2 - CATIA - Mechanical Design 2
configuration:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 33
The dialog box specifies the space available for the installation. Clicking on each configuration or product also specifies the amount of
space required for installing those configurations or products; the space required is updated progressively as you select from the list.
Depending on the configurations and/or products you chose, the Install Extra Products dialog box may appear:
An extra product is a standard product associated with certain configurations and products. You can choose to install or not to install
an extra product.
17. If your configuration requires you to configure Orbix, the Choose Orbix Configuration dialog box appears:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 34
For Port Number for Orbix daemon, the default is 1570. A check is performed to determine if the port is free. If it is not free, the
port number proposed is incremented by "1" until a free port is found.
For Starting port number for daemon-run servers, the default is 1590. No check is performed to determine if the port is free. If it
is not free, the port number proposed is incremented by "20".
The installation procedure checks that the administrator performing the installation has the correct privileges required for running
Orbix and the server manager. Note that the option "Add required privileges for current user" is grayed out, which means that the
privileges are correct. If the privileges are not correct, the option will be accessible. Check the option before proceeding with the
installation to add the required privileges to the administrator user performing the installation. If not, the installation will fail.
18. Click the Next button to move to the next step.
The Server Timeout Configuration dialog box is displayed if your configuration uses servers run by the server manager:
You can set the server timeout value at installation. This value corresponds to the duration (in minutes) after which the server exits if
it has not been contacted by the associated client. This behavior is valid for all servers run by the server manager: 3dcom, LCA for
example.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 35
The default value is 60 mn. The value can be increased up to 40.000 mn (1 month). The value can be decreased down to 2 mn. The
increment is 1 mn. The value is internally transformed into ms and stored in the CATIAServerManager.imp file. When launching a
server under its responsibility, the server manager passes the timeout value to it.
Only servers managed by the server manager take into account the timeout parameter. For example, the workbook server is not
impacted by the timeout value.
When installing a Version 5 product which contains a potential vault client, this dialog box prompts you to indicate if you want to
configure a vault client once the code has been installed. If you choose to configure a vault client, you will be prompted to do so in
another dialog box which will be displayed before the enoviadbsetup process is started.
After installation, you can run the VaultClientSetup command in order to catalog another vault server, modify the parameters of an
existing one, or remove an existing one. The VaultClientSetupB command provides the same functionalities in batch mode.
Note: you can only install a vault server by using a configuration belonging to the ENOVIA LCA brand.
20. Check the appropriate option if you want to set up the vault client at the end of the installation.
By default, the "Set up communication ports" option is checked because it is strongly recommended.
A backbone daemon is created as a service and started. You can monitor the daemon by selecting Start->Settings->Control Panel-
>Administrative Tools->Services. The name of the service is Backbone Service. The name of the executable program that
corresponds to the backbone service is CATSysDemon.exe, which you can track using the Task Manager.
This installation step adds three lines to a system file. For more information about the communications backbone and which file is
concerned, refer to Communications Backbone Files.
In previous releases, the Choose Communications Ports dialog box always appeared. Now, the installation setup analyses the file in
question. If the three lines are present (for example, due to a previous installation), the dialog box will not appear.
Furthermore, if the backbone service is already running, it is stopped then restarted. You can check which services are running by
selecting the Start->Settings->Control Panel->Administrative Tools command and selecting the Services control.
22. Click the Next button to move to the next step.
Not installing the desktop shortcuts allows you to minimize the number of registry entries during the installation.
23. Check the "I want to install Online Documentation" check box only if you want to install the online documentation during the code
installation procedure: this choice is optional.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 38
If you check this box, you will be prompted later on in the installation (after the software has been copied to your computer) to
remove the code CD-ROM and insert the first documentation CD-ROM.
24. Clicking the Next button displays the Start Copying Files dialog box.
The central area lists the current settings you set in the previous steps:
The result looks something like this (depending on which software you chose to install).
Note that the dialog box reflects our choice to install the
MD2 - CATIA - Mechanical Design 2 Configuration and the DP2 - CATIA - Drawing Production 2 configuration:
There is nothing to prevent you from installing all the configurations and products on the CD-ROM. However, you will be able to use
only the software for which you have enrolled licenses, except if you are using a demo mode license as explained in Running in Demo
Mode.
25. Click the Next button to start copying the files to your computer.
A progression indicator appears, and an animated sequence starts showing you some of the products that you will be able to create
with the software.
26. If you indicated earlier that you want to set up a vault client, the Vault Client Setup dialog box appears:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 39
27. Click the Add... button to display the following dialog box:
28. Specify the Vault alias name, server hostname and Orbix daemon port, then click OK.
The Vault Client Setup dialog box is now updated like this:
29. Use the Modify... and Delete... buttons to modify or delete the selected configuration.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 40
30. Click the Close button to continue.
If you have several online documentation CD-ROMs (one for each supported language), you can only install one of these CD-ROMs at
this stage of the installation.
If you do not want to install the online documentation immediately, press the Cancel button. You can always install it later. For more
information, refer to Installing the Online Documentation After Installing the Software on Windows.
For illustration purposes, this section describes the installation of online documentation for the CATIA product line.
Note, however, that the principle is the same for all product lines.
The documentation describing the interface between CATIA and SmarTeam is located on the SmarTeam documentation media CD-
ROM.
32. If you still want to install the online documentation, remove the product CD-ROM from the drive, insert the first online documentation
CD-ROM for your language (or browse to the documentation folder), and click OK to restart the Setup program, this time to install the
online documentation files.
Note that the dialog box also provides a path for specifying another drive or folder from which you can install the online
documentation. The default path is the drive name (usually D:) on the computer from which you are performing the installation.
❍ you already inserted the online documentation CD-ROM into another drive
❍ you copied the online documentation files from the online documentation CD-ROM to a folder. The advantage of installing from a
folder is that you will not be prompted to change CD-ROMs if the documentation you are installing is distributed on several CD-
ROMs.
If this is the case, click the Browse... button and specify the appropriate drive or folder, then click OK.
then the Choose Setup Language dialog box appears, prompting you to choose the user interface language for the Setup program:
The default folder in which the documentation in English will be installed is:
34. Click the Browse... button to select a new folder if the default folder is not suitable, or click the Next button to proceed.
The setup program detects which products are installed and preselects the corresponding manuals in the list. Move the scrollbar up or
down to see the preselected manuals:
Note that the BAS - Infrastructure and CFY - Common Functionalities documentation sets are prerequisites for all other online
documentation and are always installed, even if you do not select them explicitly in the list.
The list contains all the manuals related to the configurations you installed, along with any additional prerequisite documentation.
Note that the BAS - Infrastructure and CFY - Common Functionalities documentation sets are prerequisites for all other online
documentation and are always installed, even if you do not select them explicitly in the list.
This means that if you select the manual for a specific application (for example, PRT - Part Design), both this manual and the
associated prerequisite documentation will be installed.
The Start Copying Files dialog box appears listing the online documentation you are about to install:
Note that certain online manuals also require the installation of other prerequisite manuals, therefore the prerequisite manuals (which
you did not select) are also added to the list.
36. Click the Next button to install the documentation.
Depending on your product line, the online documentation may be provided on a suite of up to five CD-ROMs. Once the
documentation files on the first CD-ROM have been installed, and depending on which products you selected, you may be prompted to
insert the next CD-ROM. In this case, click OK to continue the installation until you have inserted the last CD-ROM.
Note that you must install all the documentation CD-ROMs: you cannot, for example, install only one out of two. If you click the
Cancel button before installing the final CD-ROM, the documentation files previously installed will be uninstalled.
If you interrupt the installation, the documentation files will be uninstalled automatically. If the uninstallation has already started, the
message "Uninstallation is running. Please wait..." appears. It will disappear once the uninstallation is completed. So you must wait
for the end of the uninstallation before trying to reinstall the documentation.
37. Once both the product and (optional) online documentation files have been copied, the Setup Complete dialog box informs you that
the installation has been completed:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 45
The Setup Complete dialog box specifies the name and location of the documentation homepage for your product line. On this page,
you will notice that the icons for documentation that you did not install are marked with a red symbol.
38. To exit the documentation installation phase, click the Finish button.
A dialog box informs you that the setup procedure has finished installing Version 5 on your computer, and prompts you to launch your
product now.
However, you may be prompted at this point to restart your computer. This is because certain Windows system libraries are also
shipped and installed with the software: these libraries will be installed if the existing libraries on your system are not present or at a
lower level.
Furthermore, installing CATIA also automatically installs Microsoft Visual Basic for Applications (VBA), Version 6.0.
The Setup Complete dialog box will then appear, informing you that you must restart your computer, otherwise you will not be able to
run Version 5.
39. To restart, leave the default setting "Yes, I want to restart my computer now" and click the Finish button to restart your computer
now.
If you do not want to restart your computer now, click the option "No, I will restart my computer later" then click the Finish button.
But you will not be able to run Version 5.
If Microsoft Visual Basic for Applications (VBA) Version 6.0 is already installed, a different dialog box will appear prompting you to
click the Finish button, this time to start a Version 5 session now.
40. After restarting, you must then relog onto the computer using the same administrator logon, then start Version 5.
1. Log on as administrator.
2. Select Start->Programs->Command Prompt to open a Command Prompt window.
3. Go to the following installation directory
Command Syntax
VaultClientSetupB
-list
-add VaultAliasName -host ServerHostname -port OrbixDaemonPort
-modify VaultAliasName [-host ServerHostname] [-port OrbixDaemonPort]
-delete VaultAliasName -h help
Example:
However, both levels point by default to the same settings environment. This can lead to a problem because downward compatibility of
settings is not guaranteed: only upward compatibility is guaranteed. For example, if you first work on the V5R13 level, then work on the
V5R14 level, V5R14 will be able to read and use your V5R13 settings. However, working first on V5R14 then on V5R13 with the same settings
will lead to problems.
To avoid such problems, we recommend, for example, when you install the latest level of Version 5, that you customize the values of the
CATUserSettingPath environment variable (and the CATReferenceSettingPath variable if necessary). We also recommend that you set
different settings for the CATTemp and CATErrorLog variables.
The objective is to have the runtime environment for each level pointing to its own settings.
Furthermore, you can only have one OLE link. This means that when you double-clicking on a Version 5 document using the Windows
Explorer, for example, you will not be able to choose the level to run: the last level that you installed is run (in other words, if you installed
V5R13 after V5R14, then V5R13 will be run).
This limitation is due to the operating system, not to Version 5. You can change which level you want to associate as follows:
1. Log on as administrator.
2. Open a command prompt window.
3. Go to the folder containing the level of Version 5 you want to run when double-clicking Version 5 documents, then to the \code\bin
folder.
4. Run the following command once only:
cnext /regserver
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 47
For detailed reference information about all the different methods for starting your product, refer to "Basic Tasks", "Starting a Session on
UNIX" in your Infrastructure Users Guide.
If you want to start your product in a language other than English, refer to the sections "Starting a Session in a Language Other than English
on Windows" in your Infrastructure Users Guide for CATIA.
The Version 5 window will look like this, for example, if you installed the configurations CATIA - Mechanical Design (MD2) and
CATIA - Drawing Production (DP2):
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 48
Because you imported a license certificate, the license is automatically reserved, allowing you to enter the session immediately without
having to reserve the license using the License Manager.
If you chose to run Version 5 now, but did not import a license certificate, a message window appears informing you that you have not yet
requested a configuration or product license:
The License Manager dialog box is then displayed in front of the application window:
The License Manager dialog box lists the configurations and products you installed.
At this stage, if you click the OK button, a session will still be started, but you will not be able to work with the product: menu commands will
be grayed out, and you will only be able to use the File->Exit command.
At this stage, you will not be able to go any further until you register your licenses.
To register nodelock licenses after the installation, as explained in Enrolling Nodelock Licenses After the Installation, you must import a
license certificate using the command:
Start->Programs->CATIA->Tools->Nodelock Key Management V5R14
Once you have imported a nodelock license certificate, start a session directly from the desktop by double-clicking the
You can now use the software you installed and for which you enrolled a license.
Your licensing settings are stored in a settings file. During a session, you can reserve and release licenses using the Licensing tab accessible
via the Tools->Options... command. For more information, refer to Reserving Static Licenses Using the License Manager.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 50
Installation Folder
The software is installed (if you used the default location) in the folder:
Desktop
The installation:
● creates the
Only one environment is created: a global environment (not a user environment). For more
information about global and user environments, refer to What are global and user
environments?.
CATIA.V5R14.B14.txt
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 51
● sets up the
Start->Programs->CATIA->Tools
menu containing the Environment Editor V5R14, Nodelock Key Management V5R14, Settings
Management V5R14 and Software Management V5R14 commands.
Registry
Whenever you perform an installation (or run a command using the /regserver command option), the
following registry keys are modified:
● HKEY_LOCAL_MACHINE
● HKEY_CLASSES_ROOT
HKEY_LOCAL_MACHINE
● HKEY_LOCAL_MACHINE\SOFTWARE\DassaultSystemes (the key "B14" is added containing the key "0"
which specifies the destination folder); additional entries are made each time you install the same
release in a different location, and the key number will be incremented for each installation as follows:
"0", "1", "2", etc.
● HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\Dassault Systemes
B14_0 specifies the application name for uninstallation purposes; additional entries are made each
time you install the same release in a different location, and the key number will be incremented for
each installation as follows: "B14_0", "B14_1", etc.)
● HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\AppPaths (sets up the Start-
>Run... command so you can enter the appropriate command to start a session for your product
line); this key is now integrated when using the /regserver and /unregserver command options
● HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Fonts (Windows XP and 2000)
(sets up fonts in True Type format, describing the full name and filename of the font)
HKEY_CLASSES_ROOT
This key registers the document types and extensions for the product line you installed.
In previous releases, document types for all V5 product lines were registered on your computer once and
for all when installing the first product line. Now, only the document types for the product line you
installed are registered.
Furthermore, the default OLE behavior of certain document types has changed. For example, what
happens when double-clicking a CATPart document in the Windows Explorer depends on which product
lines have been installed. For example, if only CATIA is installed, the CATPart will be opened. However, if
you installed ENOVIA DMU Navigator after installing CATIA, the default behavior associated with double-
clicking a CATPart in the ENOVIA DMU Navigator context will be used. In this case, the CATPart must be
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 52
inserted into a product, not opened.
Note also that the following registry keys are also set up for VBA:
HKEY_CLASSES_ROOT\TypeLib
HKEY_CLASSES_ROOT\Interface
The integration of the following key lets you import nodelock licenses by double-clicking the license
certificate file in the Explorer:
HKEY_CLASSES_ROOT\CATIA.Licensing
Please note that keys have been integrated into the registry for the CATIA Application, DELMIA Application
and ENOVIA DMU Application so that the the user can choose the appropriate security settings to use
these applications as Distributed COM clients.
Registry entries, folders and files are not protected. On both Windows XP and Windows 2000, you can
protect access to these entries using system tools, for example the regedt32 command. Please note that
this command is only recommended for advanced users because it is potentially dangerous.
When one application attempts to communicate with another, the backbone process is started
automatically. If the process is already running, it is not restarted. A timeout is triggered once there are
no more clients attempting to communicate with other applications.
A typical scenario involving the use of the inter-application communications backbone is implemented to
allow the ENOVIA Portal DMU Navigator and ENOVIA Portal WEB to communicate: ENOVIA Portal WEB can
load geometry and product structures into a viewer such as ENOVIA Portal DMU Navigator, 4D Navigator
or CATIA.
When installing from scratch, the installation procedure sets up the communications backbone by creating
the following lines:
catiav5bb 55555/tcp
catiav5run 55556/tcp
in the file:
%windir%\system32\drivers\etc\services
CATDeviceBroker 55557/tcp
If you do not want to set up communication ports during the installation, you can always edit the above-
mentioned files manually later.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 53
Tools for Setting Backbone and Peripheral Device Broker Port Numbers
The preferred method for setting port numbers, however, is to avoid manual edits by using one of the
following tools:
setV5Ports
● -backbonePorts p1 p2: Specifies communication ports for backbone. Default values are 55555 and
55556
● -VRPort p3: Specifies communication port for peripheral device broker - default value is 55557
● -h: displays help.
1. Log on as administrator.
2. Open a Command Prompt window and go to the installation directory, for example:
When used with the default values, it adds the following lines:
to the file:
BBDemonService
You can also use the BBDemonService command to set up the backbone.
● if the option -backbonePorts is not used, and if the services file already contains the lines catiav5bb
and catiav5run, it is not modified. If it does not contain these lines, it is updated using the default
ports 55555 and 55556 if they are free, if not, an error occurs and the command fails
● if the option -backbonePorts is used, a check is performed to see if the above-specified ports are free,
and the port numbers are added to the services file; if they are not, the file is updated using the port
number specified with the option.
A backbone daemon is created as a service and started. You can monitor the daemon by selecting Start-
>Settings->Control Panel->Administrative Tools->Services. The name of the service is Backbone Service.
The name of the executable program that corresponds to the backbone service is CATSysDemon.exe,
which you can track using the Task Manager.
Other Folders
An installation also affects the following:
● C:\Winnt\system32
Certain Windows system libraries will be installed if the existing libraries on your system are not up to
date.
All end users can now log onto the same computer and run a Version 5 session, because the
environment created at installation is global.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 55
The installation procedure is the same as for a first-time installation, with a few minor differences.
On Windows, to prevent the installation from hanging due to concurrently running programs such as screen savers or virus
scanning programs, we recommend that you first shut down any such programs.
This installation procedure shows you how to add products to a CATIA installation, for illustration purposes. The
installation steps are the same for the other product brands.
1. Log on as an administrator.
6. Click Next.
7. Click Complete to install all the software, or Custom to display a list containing the additional configurations and/or products
you can install.
8. Click Next.
This displays a list of the configurations and products you have not yet installed:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 57
9. Select the additional configurations and/or products you want to install, and click the Next button.
If the additional configurations and/or products you want to install, or already installed, include extra products, the Install
Extra Products dialog box appears:
An extra product is a standard product associated with certain configurations and products. You can choose to install or not to
install an extra product.
If you previously installed a service pack, you will be prompted to reinstall the service pack near the end of the installation.
When installing additional products on UNIX, you will be prompted to update your existing environment, or delete it and create a
new environment.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 58
Software fixes are distributed in the form of service packs. The service pack CD-ROM contains fixes for all configurations
and products available at the time it is built. Each service pack supersedes the previous ones and may be installed on top
of the released level or on top of a previous service pack. No individual corrections are delivered in between two service
packs. Service packs are made available on a regular basis. Delivery is synchronized for Windows and UNIX platforms.
Installing a service pack also involves committing or rolling back a service pack. For more information, refer to Committing
and Rolling Back Service Packs.
From start to finish, this task should take approximately 15 minutes.
You must belong to the Administrators group, or have the privileges assigned to the Administrators group. Otherwise, you
will not be able to start the installation.
2. Insert the CD-ROM into the drive.
The installation starts automatically, and the Welcome dialog box appears:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 59
3. Click the Next button to move to the next step.
If any Dassault Systemes processes are still running, preventing correct service pack setup, the setup program detects
them and prompts you to terminate them. If so, click the Yes button to terminate the processes and continue.
Note that if you installed the same GA release in more than one location, you will be prompted to select from a list the
destination folder to which you want to apply the service pack.
4. Check the "Commit the service pack automatically" option if you want to commit the service pack.
Installing a service pack also involves committing or rolling back a service pack. For more information, refer to Committing
and Rolling Back Service Packs.
During the installation, you can choose to commit the service pack automatically. This is useful when you want to save disk
space.
If you do not commit the service pack during the installation, and certain code components are redelivered with the service
pack (for example, shells, executable files), the new version of the component is installed and the previous version of the
component is saved using the following naming convention:
MyShell.BeforeSPK
%TEMP%\cxinst.log
For example:
C:\TEMP\cxinst.log
StartSPKB
-killprocess: detects running processes (for example, Orbix) in the installation folder (unload_dir\code\bin) and prompts
you to kill them before installing the service pack: if you do so, running processes will be killed, if not, the service pack will
not be installed. Do not forget to restart the process afterwards.
-h: help.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 62
Depending on your product brand, the online documentation may be provided on a suite of CD-ROMs.
Once the documentation files on the first CD-ROM have been installed, you will be prompted to insert the
next CD-ROM, and click OK to continue the installation until you have inserted the last CD-ROM.
Note that you must install all the documentation CD-ROMs: you cannot, for example, install only one out
of two. If you click the Cancel button before installing the final CD-ROM, the documentation files
previously installed will be uninstalled.
The last CD-ROM in each suite contains all the online documentation in PDF format.
Unlike when installing the software, the documentation installation procedure does not start
automatically.
3. Use the Windows Explorer to explore the documentation CD-ROM, and double-click the Setup.exe
program on the CD-ROM to start the installation.
Do not use "My Computer" to access the CD-ROM: this will not work.
From this point onwards, the installation procedure is the same as the online documentation installation
procedure within the code unloading phase. Refer to Installing the Online Documentation for full details.
To access the documentation using your browser, locate and open the documentation homepage for your
product brand.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 63
When installing additional documentation for the same version (or in another language), a dialog box like
this is displayed:
listing the documentation you already installed. Clicking the Next button will then display a list of
preselected documentation reflecting the software you installed, but the documentation already installed
obviously does not appear in the list. The additional documentation will be installed in the same folder.
Online documentation for all product brands is installed in the same location.
If you install documentation for several product brands, one line will appear for each product brand when
you select the Start->Settings->Control Panel, and double-click the Add/Remove Programs control
to access the Install/Uninstall dialog box:
If you interrupt the installation, the documentation files installed will be uninstalled automatically. If the
uninstallation has already started, the message "Uninstallation is running. Please wait..." appears. It will
disappear once the uninstallation is completed. So you must wait for the end of the uninstallation before
trying to reinstall the documentation.
2. In the Change or Remove Programs dialog box, you can choose to uninstall documentation for a
specific product brand by selecting the appropriate item:
(if the documentation is in English) from the list, then clicking the Change/Remove... button, and
confirming when prompted.
When uninstalling documentation for a specific product brand, all the documentation frameworks relating
to that brand are uninstalled, except certain manuals which are not related to any specific brand.
If you want to browse the documentation directly from the CD-ROM drive, and without running a Version
5 session, insert the documentation CD-ROM into the drive, access the device using the Windows
Explorer, and double-click the following file (depending on the language) to display the appropriate
Version 5 online documentation homepage:
● CATIAhomepage.htm (English)
● French CATIAhomepage.htm (French)
● German CATIAhomepage.htm (German)
● Japanese CATIAhomepage.htm (Japanese)
● Italian CATIAhomepage.htm (Italian).
For example, press F1 for contextual help. A dialog box will prompt you to specify the online
documentation path.
6. In the dialog box, specify the path where the documentation is located.
Wherever you install the documentation, if you attempt to activate the sample documents from within
the online documentation without first installing the code, the samples will not work.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 65
You can also access online documentation if it is installed on a http server (for example, Apache).
Documentation in PDF format for CATIA is delivered on a separate CD-ROM, therefore it is no longer
installed automatically. We recommend that you copy it to location on your hard disk or on a server to
which your end users have access.
UninstallProductLine-LanguageDocumentation.bat
For example:
Before uninstalling documentation, make sure that no documentation files are currently being accessed
by any program, and that no documentation file path is selected in the Explorer program.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 66
You can install all Version 5 software except online documentation in batch mode.
Note that, if your Version 5 software is delivered on more than one CD-ROM, you must copy all the
software to the same directory from which you run this command.
To perform a batch installation:
StartB
-ident IDENT: creates an identifier used for differentiating multiple versions of the same release
installed in different locations on the same computer
-D env_dir: specifies the environment directory; the default environment directory is:
-lic "pathname.lic": specifies the path and name of the nodelock license certificate to import
-orbixbase port2: specifies the starting port number for daemon-run servers
-AddUserPrivilegesForOrbix: adds required privileges for Orbix for current user if they are missing
-backbonePorts port3 port4: specifies the ports reserved for the communication backbone - default
values are 55555 and 55556
-VRPort port5: specifies the port reserved for processing events when using peripheral devices
(spaceball, spacemouse, joystick); the default port for the peripheral device broker is 6668
-CatiaV5Info/: used alone, setup takes default values for other parameters
-list: lists the configurations, products and extra products on the CD-ROM
-all: unloads all the configurations and the products on the CD-ROM
-l "list_to_unload": specifies the list of configurations and/or products to unload. You have to type the
list of configurations and/or products, which you can obtain by running the command using the "list"
argument. In the list, configuration names look like this: ME2.slt., and product names look like this:
KIN.prd. These are the names you must type. Separate the names using a blank.
The arguments -list, -all and -l "list_to_unload" are mutually exclusive.
-allextra_prd: unloads all the extra products included with the configurations and products that are
already installed or to be installed from the CD-ROM.
-lextra_prd "list_to_unload": specifies a list of extra products to unload. These extra products must
be included with the configurations and products that are already installed or to be installed.
-noLang "fr ge it jp ch"/-noLang all: specifies user doesn't want to install language user interface
files for French, German, Italian, Japanese, Simplified Chinese
-noStartMenuTools: does not create an entry in the Start menu for the administration tools
Example
The following example installs Version 5 software from scratch, creating the unload directory and
importing the appropriate licenses.
To install the DP2 and MD2 configurations for the CATIA product line, type the following command:
You have to install VBA6 manually after a batch installation. To do so, run the command:
msiexec /q /i pathcdrom\VBA\VBA6.msi
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 69
Note that you are not able to selectively uninstall a configuration or product.
Uninstalling relies on Windows-compliant tools enabling anyone familiar with Windows procedures and concepts
to uninstall the software without assistance.
Prior to removing the software, you must remove any user environments you may have created after the initial
installation using the tools described in Customizing Your Environment on Windows.
1. Log on as an administrator.
You must belong to the Administrators group, or have the privileges assigned to the Administrators group.
Otherwise, you will not be able to uninstall the software.
2. On the Windows desktop, select the Start->Settings->Control Panel, then double-click the Add/Remove
Programs control.
The dialog box looks something like this (depending on the software installed on your computer):
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 70
is going to be removed, and prompts you to confirm that you want to continue and remove all the software.
You can also use this command to remove the online documentation. The item name for the English
documentation will be, for example:
ALL the installed configurations and products will be removed. The program removes:
You may be prompted to kill any running processes which use the version you are uninstalling. If this is the
case, click the Yes button when prompted.
1. Log on as administrator.
2. Open a Command Prompt window.
3. Go to the installation directory:
C:\Program Files\Dassault Systemes\B14\intel_a\code\bin
4. Enter the command:
catstart -run KillV5Process
This command stops all Version 5 processes attached to the current concatenation of processes
(including Orbix), and stops all services (for example, the Backbone service). However, the processes
killed are not listed, but the services stopped, for example the Backbone service, are listed.
If you want to know the list of processes killed, run the command:
KillV5Process
KillV5Process
CATInstallPath = C:\Program Files\Dassault Systemes\B14\intel_a
The entries in the Start->Programs menu will not be removed if they still contain environments created using
the tools described in Customizing Your Environment on Windows.
If you delete the installation folder instead of uninstalling cleanly using the Add/Remove Programs control via
the Start->Settings command, your registry will be corrupted. Before, when you attempted to reinstall, you
were blocked. Now, a message will prompt you to click the OK button if you want to automatically clean up the
registry and continue the installation.
Unload_Dir\DSUninstall.bat
C:\Program Files\DassaultSystemes\B12
This command removes the software in the same way as the Add/Remove Programs control. However, note
that the procedure automatically kills any running processes which use the version you are uninstalling.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 73
This task explains how to unload the CATIA Version 5 code from scratch on a single workstation running UNIX.
The concepts, procedures and look and feel of the installation procedure for Windows have been carried over to the UNIX environment in order to provide a common
Version 5 installation interface for all supported operating systems.
This installation procedure steps you through a CATIA installation, for illustration purposes. The installation steps are the same for installing
ENOVIA DMU Navigator and DELMIA configurations.
Before starting the installation, refer to What You Need Before Installing Version 5 to check you have all the hardware and software prerequisites.
How To Display the Target ID of Your Computer Before Ordering Your Products
Before ordering a nodelock license, you need to obtain the target ID of your computer. The target id must accompany the license order. The Certificat.lic file is
generated using the target ID of your computer.
Before installing the software, the application has no way of determining the target ID. In this case, if you have installed IBM License Use Management Runtime
(LUM), you can use the tools provided by LUM to obtain the target ID.
For example, you can run the following command to obtain the "PREFERRED LUM Target ID":
i4target -O
located in:
/var/ifor/ (AIX)
How To Display the Target ID of Your Computer Once You Have Received the CD-ROM
http://www.software.ibm.com/is/lum/lumdownl.html
If you double-click on i4tgtid.exe, a message box displaying the win32mac target id of the machine will be presented. The target id is a number represented in
hexadecimal notation. Make sure that the string "win32mac" is also displayed alongside with the target ID.
Depending on the network configuration of your machine, the win32mac target id might not be available. This is when i4target.exe in command-line mode is needed:
1. Open Installation
CATIA Infrastructure a Command Guide
Prompt window and set the directory
Version to your14
5 Release CD-ROM drive. Page 75
2. Run "i4target -z".
This will list network adapters that can be used for the target ID.
3. Run "i4target -d xxx"
where "xxx" is one the network adapters listed in step 2.
4. Run i4target or i4tgtid.
You should obtain the same target ID as in step 2.
NOTE: Do not repeat step 2 once you have a valid win32mac target ID.
On AIX, the CATNodelockMgt tool displays a target ID different from what is displayed by the uname -m AIX command. This command is not the correct way for
getting the AIX target ID. Given that it has never been documented, it is not supported. The correct ways are listed above.
Note that, by chance, the results obtained by running both the uname -m and i4target -O command were identiical until V5R10 or LUM 4.6.5. This is no longer the
case on subsequent levels because IBM LUM changed the algorithm which is used to
compute the AIX target ID.
However, even if V5R11 displays an AIX target ID different from the one displayed by V5R10, for backward compatibility reasons V5R11 and above continue to
consider as valid the licenses generated with a target ID equal to that obtained by running the command uname -m. This compatibility will be removed in a future
release.
Additional information about obtaining target IDs can be found in the description of the i4target command in Chapter 6 of the manual Using License Use Management
Runtime - Version 4.6.7.
df -k
in order to verify that you have enough free disk space in the file system in which you intend to unload the code.
3. Insert the CD-ROM for your UNIX operating system into the drive.
If you are running IRIX or Solaris, inserting the CD-ROM declares and mounts the CD-ROM automatically (unless you disabled this feature).
If you are running AIX or HP-UX, check whether the CD-ROM drive is declared.
On AIX,
CATIA Infrastructure run the command:
Installation Guide Version 5 Release 14 Page 76
lsdev -C -c cdrom
you need to add the CD-ROM drive by using the smit AIX command, for example.
cat /etc/fstab
you need to add the CD-ROM drive, by using the sam HP-UX command, for example.
If you are running IRIX or Solaris, inserting the CD-ROM declares and mounts the CD-ROM automatically (unless you disabled this feature).
4. If you are running AIX and HP-UX, check whether the CD-ROM drive is mounted.
If the CD-ROM drive is not mounted, you will have to mount it before proceeding. You can determine if the drive has already been mounted by typing the
command:
mount
In the output lines, you should see a list of mounted file systems. The CD-ROM drive has already been mounted on your local system if a line similar to one of
the following lines appears in the list:
5. If you are running AIX and HP-UX, mount the CD-ROM drive, if necessary, by typing the commands:
If you are running HP-UX, mount the CD-ROM drive like this:
mount /cdrom
7. Check that the DISPLAY variable is exported appropriately before continuing, then enter the command:
./start
./start -s
if you want to start the installation procedure without the accompanying music.
The Version 5 setup program will be run. The setup program checks you have the correct prerequisites. Then, the Welcome dialog box greets you. The setup
program invokes a full self-explanatory graphical interface which walks you through the installation.
The Welcome dialog box is then displayed on a background window. Note that the screenshots illustrating the installation procedure were taken without the
background window:
Note that the target id of the computer on which you are performing the installation is displayed after the dialog box title.
If you want to enter a nodelock license, click the Import Certificate button to access the Import Certificate dialog box.
This dialog box lets you import the license certificate (that is, if you received your license certificate by electronic mail, and provided you detached it and
stored it on your disk).
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 79
Explore your environment containing the license certificate (ending with the suffix ".LIC"), then click OK.
This creates a nodelock file on your computer, and stores your license by default in the nodelock file on all UNIX platforms in:
/var/ifor/nodelock (AIX)
/opt/lum/ls/conf/nodelock (HP-UX, IRIX, Solaris)
If you already installed LUM elsewhere, the nodelock file will be updated in the correct LUM environment;
If you decide to skip the licensing step, or if you have a license enrollment certificate in paper format only (and not in electronic format), you can enroll your
licenses later, after the installation has been completed. For more information, refer to Enrolling Nodelock Licenses After the Installation.
The Choose Destination Location dialog box appears. A default destination folder is already proposed:
/usr/Dassault Systemes/B14
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 80
10. If the default destination directory is suitable, click the Next button to move to the next step.
Click Yes if prompted to create the directory if it does not exist. Or, click the Browse... button and navigate to select another folder and click OK.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 81
The folder you choose must be empty. You can also specify a new folder: the folder will be created after confirmation.
/CATEnv
12. If the default directory is suitable, click the Next button to move to the next step, or click the Browse... button and navigate to select another folder and click
OK.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 83
The directory you choose must be empty. You can also specify a new folder: the directory will be created after confirmation.
For more about environment files, refer to About the Environment Created on Your Workstation on UNIX.
13. Click the Next button to move to the next step.
This dialog box lets you specify whether you want to install all of the software on the CD-ROM, or select the configurations and/or products to be installed:
❍ Complete: specifies you want to install all the software, and moves on to the next installation step (installation of online documentation files) when you
click Next
❍ Custom: lets you choose the configurations and/or products to be installed.
14. If you want to choose which configurations and/or products to install, check the Custom option and click the Next button to move to the next step.
Check the buttons to install the user interface files for the appropriate language(s) and/or to install language-indexed fonts. Uncheck the buttons for the
language files you do not want to install. Uncheck the buttons for the language files you do not want to install. This will let you skip the installation of
unnecessary language files and fonts and enable you to save disk space.
❍ Simplified Chinese
❍ Traditional Chinese
❍ Japanese
❍ Korean
❍ SSS4 (miscellaneous).
If you intend to access data containing language-indexed fonts for a specific language environment, for example, drawing documents, if you have not
installed the fonts beforehand, you will obtain a message when opening the document, saying that a font is missing and that it will be replaced by another
font.
To avoid this problem, we recommend that you check the option to install the language-indexed fonts.
Note that
CATIA Infrastructure the choice
Installation you make at installation
Guide is definitive:
Version you cannot
5 Release 14 add or remove languages or fonts later
Pagewhen
86 installing additional configurations and/or
products.
15. Click the Next button to move to the next step.
Depending on what you chose, the list will display the names of all the configurations or products on the CD-ROM.
17. Click on
CATIA Infrastructure the configurations
Installation Guide and/or products Version
to select5them.
Release 14 Page 87
The selected configurations and/or products are listed in the "Selected Software" list.
In our example, we chose to install the DP2 - CATIA - Drawing Production 2 and MD2 - CATIA - Mechanical Design 2 configurations:
The dialog box specifies the space available for the installation. Clicking on each configuration or product also specifies the amount of space required for
installing those configurations or products; the space required is updated progressively as you select from the list.
At this stage, and depending on the space required for the configurations you are installing, you may be informed that there is not enough space in the
destination
CATIA Infrastructure directory.
Installation If so, go back and choose
Guide another
Version destination
5 Release 14 directory where this enough space. Page 88
There is nothing to prevent you from installing all the configurations and products on the CD-ROM. However, you will be able to use only the software for
which you have enrolled licenses, except if you are using a demo mode license as explained in Running in Demo Mode.
If your configuration requires you to configure Orbix, the Choose Orbix Configuration dialog box appears.
Orbix is used for server-client communications. You can accept the default values.
Note that the default values are set to 1570/1590/200. If CATIA or DMU have been installed previously, these values are already taken. If this is the case,
use different values than the CATIA and DMU port numbers.
For Port Number for Orbix daemon, the default is 1570. A check is performed to determine if the port if free. If it is not free, the port number proposed is
incremented by "1" until a free port is found.
For Starting port number for daemon-run servers, the default is 1590. No check is performed to determine if the port if free. If it is not free, the port
number proposed is incremented by "20".
19. Click the Next button to move to the next step.
The Server Timeout Configuration dialog box is displayed if your configuration uses servers run by the server manager:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 89
You can set the server timeout value at installation. This value corresponds to the duration (in minutes) after which the server exits if it has not been
contacted by the associated client. This behavior is valid for all servers run by the server manager.
The default value is 60 mn. The value can be increased up to 40.000 mn (1 month). The value can be decreased down to 2 mn. The increment is 1 mn. The
value is internally transformed into ms and stored in the CATIAServerManager.imp file. When launching a server under its responsibility, the server manager
passes the timeout value to it.
Only servers managed by the server manager take into account the timeout parameter. For example, the workbook server is not impacted by the timeout
value.
When installing a Version 5 product which contains a potential vault client, this dialog box prompts you to indicate if you want to configure a vault client once
the code has been installed. If you choose to configure a vault client, you will be prompted to do so in another dialog box which will be displayed before the
enoviadbsetup process is started.
After installation, you can run the VaultClientSetup command in order to catalog another vault server, modify the parameters of an existing one, or remove
an existing one. The VaultClientSetupB command provides the same functionalities in batch mode.
Note: you can only install a vault server by using a configuration belonging to the ENOVIA LCA brand.
If you are installing from scratch, the Choose Communications Ports dialog box is displayed:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 91
By default, the "Set up communication ports" option is checked because it is strongly recommended.
This installation step adds lines to various system files. For more information about the communications backbone and which files are concerned, refer to
Communications Backbone Files.
The installation setup analyses the file in question. If the three lines are present (for example, due to a previous installation), the dialog box will not appear.
Furthermore, if the installation path is different, the installation path referenced in the /etc/inetd.conf file is updated. This means that the most recent
installation takes priority.
The central area lists the current settings you set in the previous steps. The result looks something like this (depending on which software you chose to
install):
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 92
23. Click the Install button to start copying the files to your computer.
Depending on your UNIX platform, the software may be provided on a suite of CD-ROMs. Once the software on the first CD-ROM has been installed, you will
be prompted to insert the next CD-ROM, and click OK to continue the installation until you have inserted the last CD-ROM.
Note that you must install all the software CD-ROMs: you cannot, for example, install only one out of two. If you click the Cancel button before installing the
final CD-ROM, the software previously installed will be uninstalled.
24. If you indicated earlier that you want to set up a vault client, the Vault Client Setup dialog box appears:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 94
25. Click the Add... button to display the following dialog box:
26. Specify the Vault alias name, Server hostname and Orbix daemon port, then click OK.
The Vault Client Setup dialog box is now updated like this:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 95
27. Use the Modify... and Delete... buttons to modify or delete the selected configuration.
29. Once the product files have been copied, the Setup Complete dialog box informs you that the installation has been completed.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 96
The Version 5 window will look like this, for example, if you installed the DP2 - CATIA - Drawing Production 2 and MD2 - CATIA - Mechanical Design 2
configurations:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 97
An installation log is created (or the existing log is updated) in the current temporary directory, located by default in:
$HOME/CXINST.log
If you chose to run Version 5 now, but did not import a license certificate, a message window appears informing you that you have not yet requested a
configuration or product license:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 98
The application window now appears, along with the License Manager dialog box:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 99
The License Manager dialog box lists the configurations and products you installed.
In our example, we installed the DP2 - CATIA - Drawing Production 2 and MD2 - CATIA - Mechanical Design 2 configurations.
Note that the field below each license specifies: "Not Granted". This is because this is the first time you are starting Version 5, and you have not yet reserved
any licenses.
At this stage, if you click the OK button, a session will still be started, but you will not be able to work with the product: menu commands will be grayed out,
and you will only be able to use the File->Exit command.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 100
Setting Up the Vault Client in Batch Mode
To perform a batch installation:
1. Log on as root.
2. Enter the command:
● aix_a
● hpux_b
● irix_a
● solaris_a.
Command Syntax
VaultClientSetupB
-list
-add VaultAliasName -host ServerHostname -port OrbixDaemonPort
-modify VaultAliasName [-host ServerHostname] [-port OrbixDaemonPort]
-delete VaultAliasName -h help
Example:
front panel.
On IRIX, access the MYPRODUCT tab Application Manager in the desktop, then double-click
the MYPRODUCT.V5R14.B14 icon.
You can also double-click document icons in your file manager to start Version 5. Note,
however, that this starts a new Version 5 session each time: the document is not added to a
Version 5 session which is already running.
To do so:
● aix_a
● hpux_b
● irix_a
● solaris_a
/usr/DassaultSystemes/B14/OS_a/code/command/
Installation Path
The software is installed (if you used the default location) in the folder directory:
/usr/DassaultSystemes/B14/OS_a
● aix_a
● hpux_b
● irix_a
● solaris_a
Environment
The installation offers you the choice of where to create the /CATEnv directory. The default is the root
$HOME directory (typically "/"), but you can create the /CATEnv directory anywhere you like.
Note that, if an environment already exists, the installation procedure offers you the choice between
replacing it or creating a new environment with a different name.
If you choose the default location, the installation creates the global environment, required to set the
Version 5 runtime environment variables, in the /CATEnv directory.
The environment is created in a text file and the environment file name is:
CATIA.V5R14.B14.txt
Note: UNIX system administrators can also setup a /CATEnv environment directly in the home directory
of end users.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 104
The installation creates the following filetree required for integrating Version 5 into the CDE desktop:
The application is registered in the CDE application base via the "dtAppIntegrate" command which is
executed automatically during the installation. The result of registering the application is that the
/etc/dt/appconfig/ environment on your workstation is modified. This environment contains links to the
application desktop filetree located under /CATCDE (described above).
You do not see the icon immediately. To display the icon, you must click the Application manager icon on
the CDE front panel, go into the Desktop Tools cabinet, then double-click the Reload Applications icon.
You can also log off and log on to display the icon.
● the creation of the MyProductLine directory in the Application Manager cabinet, accessible via the
front panel
● the creation in this directory of the default global environment icon:
CATIA.V5R14
The installation creates the following directory required for integrating your product into the Magic SGI
desktop:
Installing on IRIX takes longer than on the other UNIX platforms because the Magic SGI desktop is
recompiled.
You do not see the icon immediately. To display the icon, you must log off and log on. The visible impact
on the SGI desktop in File->Applications is:
CATIA.V5R14
To do so, check the option "Set up communications ports (strongly recommended)" when prompted.
When one application attempts to communicate with another, the backbone process is started
automatically. If the process is already running, it is not restarted. A timeout is triggered once there are
no more clients attempting to communicate with other applications.
A typical scenario involving the use of the inter-application communications backbone is implemented to
allow the ENOVIA Portal DMU Navigator and ENOVIA Portal WEB to communicate: ENOVIA Portal WEB
can load geometry and product structures into a viewer such as ENOVIA Portal DMU Navigator, 4D
Navigator or CATIA.
If you are installing from scratch, the installation procedure sets up the communications backbone by
creating the following lines:
catiav5bb 55555/tcp
catiav5run 55556/tcp
in the file:
/etc/services
CATDeviceBroker 55557/tcp
/etc/inetd.conf
For example:
Tools for Setting Backbone and Peripheral Device Broker Port Numbers
The preferred method for setting port numbers, however, is to avoid manual edits by using the following
tool:
setV5Ports
● -backbonePorts p1 p2: Specifies communication ports for backbone. Default values are 55555 and
55556
● -VRPort p3: Specifies communication port for peripheral device broker - default value is 55557
● -h: displays help.
1. Log on as root.
2. Enter the command:
❍ aix_a
❍ hpux_b
❍ irix_a
❍ solaris_a.
When used with the default values, it adds the following lines:
to the file:
/etc/services
to the file:
/etc/initd.conf
/var/ifor/nodelock (AIX)
/opt/lum/ls/conf/nodelock (HP-UX, IRIX, Solaris)
All end users can now log onto the same workstation and run a Version 5 session, because the
environment created at installation is global.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 109
Software fixes are distributed in the form of service packs. The service pack CD-ROM contains fixes for all configurations and products
available at the time it is built. Each service pack supersedes the previous ones and may be installed on top of the released level or on top
of a previous service pack. No individual corrections are delivered in between two service packs. Service packs are made available on a
regular basis. Delivery is synchronized for Windows and UNIX platforms.
Installing a service pack also involves committing or rolling back a service pack. For more information, refer to Committing and Rolling Back
Service Packs.
From start to finish, this task should take approximately 15 minutes.
2. Insert the CD-ROM for your UNIX operating system into the drive.
3. Declare and mount the CD-ROM drive if necessary, depending on your UNIX system (as described in Installing Version 5 on UNIX).
4. Change directory to the CD-ROM mount point and enter the command:
./start -s
Follow the instructions, and note the following:
● the service pack will be installed automatically in the same directory as the current release: on UNIX, if you installed the current release
elsewhere than in the default location, you will be prompted to enter the path
● you are not allowed to choose configurations or products: the service pack CD-ROM contains fixes for all configurations and products
available at the time it is built. Fixes are installed for the configurations and products detected in your installation.
● unlike a normal installation, you are not allowed to start a session directly at the end of the installation procedure.
The service pack will be installed automatically in the same directory as the current release: on UNIX, if you installed the current release
elsewhere than in the default location, you will be prompted to enter the path.
By default, the service pack setup tool will install the service pack in the destination directory displayed, for example:
/usr/DassaultSystemes/B14
6. If the default destination directory is suitable, click the Next button to move to the next step, or click the Browse... button and navigate
to select another folder and click OK.
If the default destination directory is suitable, click the Next button to move to the next step, or specify another directory and click OK.
The directory you choose must be empty. You can also specify a new directory which will be created after confirmation.
7. Click the Next button to move to the next step.
8. If you want to commit the service pack automatically, check the "Commit automatically" option, or install the service pack without
committing by clicking the Next button.
For more information about committing service packs, refer to Committing and Rolling Back Service Packs.
9. Click the Install button to install the service pack, then click the Finish button once the setup phase is complete.
Note the following:
● you are not allowed to choose configurations or products: the service pack CD-ROM contains fixes for all configurations and products
available at the time it is built. Fixes are installed for the configurations and products detected in your installation
● unlike a normal installation, you are not allowed to start a session directly at the end of the installation procedure.
An installation log is created (or the existing log is updated) in the current temporary directory, located by default in:
$HOME/CXINST.log
● -h: help.
Examples:
● start or start -s: installs the service pack using the graphic user interface, and without music
● start -s -u /home/install/DassaultSystemes/B14 -bC: in batch mode, installs and automatically commits the service pack in
/home/install/DassaultSystemes/B14
● start -s -u install_dir: installs in the install directory without automatic commit
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 113
● start -u /mydirectory: in batch mode, installs in the directory "/mydirectory" without music and without automatic commit.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 114
On UNIX, you cannot install the online documentation directly from within the code installation procedure (unlike on
Windows).
Depending on your product line, the online documentation may be provided on a suite of CD-ROMs. Once the
documentation files on the first CD-ROM have been installed, you will be prompted to insert the next CD-ROM, and click
OK to continue the installation until you have inserted the last CD-ROM.
Note that you must install all the documentation CD-ROMs: you cannot, for example, install only one out of two. If you
click the Cancel button before installing the final CD-ROM, the documentation files previously installed will be
uninstalled.
There are five CD-ROMs for CATIA, and three CD-ROMs for all other product lines. The last CD-ROM in each suite
contains all the online documentation in PDF format.
1. Logon as root.
2. Insert the CD-ROM for your UNIX operating system into the drive.
If you are running IRIX or Solaris, inserting the CD-ROM declares and mounts the CD-ROM automatically (unless you
disabled this feature).
3. If you are running AIX or HP-UX, check whether the CD-ROM drive is declared.
On AIX, run the command:
lsdev -C -c cdrom
you need to add the CD-ROM drive by using the smit AIX command, for example.
Then, check whether the CD-ROM drive is mounted. If the CD-ROM drive is not mounted, you will have to mount it
before proceeding. You can determine if the drive has already been mounted by typing the command:
mount
In the output lines, you should see a list of mounted file systems. The CD-ROM drive has already been mounted on your
local system if a line similar to one of the following lines appears in the list:
cat /etc/fstab
you need to add the CD-ROM drive, by using the sam HP-UX command, for example.
Check if the pfs_mountd and pfsd daemons are running. If not, execute the commands:
Insert the CD-ROM into the drive. Mount the CDROM with the command /usr/sbin/pfs_mount, for
example:
/usr/sbin/pfs_mount /CDROM
/usr/sbin/pfs_umount /CDROM
./start
./start -s
if you want to start the installation procedure without the accompanying music.
The V5Doc Setup program starts, then the Welcome dialog box appears:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 116
7. If it is not already checked, check the option "CATIA is installed" to indicate that CATIA is already installed, if this is
the case:
If CATIA is already installed, the name of the installation folder will be detected and displayed.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 118
8. If not, click the Browse... button, navigate to the installation folder, then double-click the folder name and click OK.
The dialog box will now display the name of the installation folder.
/usr/DassaultSystemes/B14
9. Click the Next button to proceed.
/usr/DassaultSystemes/B14doc
10. Click the Browse... button to select a new folder if the default folder is not suitable, or click the Next button to
proceed.
The setup program detects which products are installed and preselects the corresponding manuals in the list, along with
any additional prerequisite manuals.
Note that the BAS - Infrastructure and CFY - Common Functionalities documentation sets are prerequisites for all other
online documentation and are always installed, even if you do not select them explicitly in the list.
This means that if you select the manual for a specific application (for example, PRT - Part Design), both this manual
and the associated prerequisite documentation will be installed.
The Start Copying Files dialog box appears listing the online documentation you are about to install:
Note that you must install all the documentation CD-ROMs: you cannot, for example, install only one out of two. If you
click the Cancel button before installing the final CD-ROM, the documentation files previously installed will be
uninstalled.
If you interrupt the installation, the documentation files will be uninstalled automatically. If the uninstallation has
already started, the message "Uninstallation is running. Please wait..." appears. It will disappear once the uninstallation
is completed. So you must wait for the end of the uninstallation before trying to reinstall the documentation.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 121
13. Once the documentation has been installed, click the Finish button in the Setup Complete dialog box:
We recommend that you install the documentation in the default location. If you decide to install the documentation
elsewhere than in the default location, you must update the value for the CATDocView variable in your default
environment to specify the location of the documentation files. Otherwise, you will not be able to access the
documentation.
To do so, use the setcatenv command to change the value of the CATDocView variable to point to the location where
the CD-ROM contents were copied. For more information, refer to Managing Environments.
Using your browser, locate and open the documentation homepage for your product line.
If you want to consult the documentation directly from the CD-ROM drive, and without running a Version 5 session,
insert the documentation CD-ROM into the drive, mount the CD-ROM where necessary, then use your HTML browser to
open the following file (depending on the language) to display the appropriate Version 5 online documentation
homepage:
● CATIAhomepage.htm (English)
● FrenchCATIAhomepage.htm (French)
● GermanCATIAhomepage.htm (German)
● JapaneseCATIAhomepage.htm (Japanese)
● ItalianCATIAhomepage.htm (Italian).
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 122
You set up a documentation server the same way as you set up a Version 5 code server. For more information, refer to
Enabling User Access to the Software Over the Network.
You can also access online documentation if it is installed on a http server (for example, Apache).
/usr/DassaultSystemes/B14doc
/usr/DassaultSystemes/xxx
/usr/DassaultSystemes/
and run:
Examples
cd /usr/DassaultSystemes
./B14doc/English/UninstallDoc -a -s
Note that, if your Version 5 software is delivered on more than one CD-ROM, you must copy all the
software to the same directory from which you run this command.
To perform a batch installation, log on as root, change directory to the CD-ROM mount point and enter
the command:
./start
-D: specifies the /CATEnv environment directory. The default environment directory is /CATENV.
-lic "pathname.lic": specifies the path and name of the nodelock license certificate to import
-env new|replace: if the environment file already exists, you can choose to replace it or create a new
one
● -env new: If you install the same level several times, the same environment is created
each time, and using the same name, except that the name is incremented like this each
time:
MYPRODUCT.V5R14_1.B14.txt, MYPRODUCT.V5R14_2.B14.txt
● -env replace: if you already installed Version 5, you may then have deleted the
installation directory, in which case the environment remains; in this case, use the "-env
replace" argument to overwrite the existing initial environment and create a new one
during the installation. Note that the "replace" option does not replace existing
environments that you may have created using the "new" option (or using the "Create New
Environment" option when installing using the GUI), and whose name is incremented, for
example:
MYPRODUCT.V5R14_1.B14.txt
-orbixbase port2: specifies the starting port number for daemon-run servers
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 125
-CatiaV5Info/: used alone, setup takes default values for other parameters
-backbonePorts port3 port4: specifies the ports reserved for the communication backbone - default
values are 55555 and 55556
-VRPort port5: specifies the port reserved for processing events when using peripheral devices
(spaceball, spacemouse, joystick); the default port for the peripheral device broker is 6668
-all: unloads all the configurations and the products on the CD-ROM
-l "list_to_unload": specifies the list of configurations and/or products to unload. You have to type the
list of configurations and/or products, which you can obtain by running the command using the "list"
argument. In the list, configuration names look like this: ME2.slt., and product names look like this:
KIN.prd. These are the names you must type. Separate the names using a blank.
The arguments -list, -all and -l "list_to_unload" are mutually exclusive.
-noLang "fr ge it jp ch"/-noLang all : specifies user doesn't want to install language user interface
files for French, German, Italian, Japanese, Simplified Chinese
-UpdateServices: if used without arguments, it updates the file /etc/services with the default
communication port numbers, even if the lines already exist in the file; if used with arguments, it can
also be used to specify other port numbers.
Reminder: if you run the command without arguments, the installation will be started using the graphical
user interface.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 127
Prior to removing the software, you must remove any user environments you may have created after the
initial installation using the tools described in Customizing Your Environment on UNIX.
End users who set up their own user environments using the setcatenv command can only remove them
using the delcatenv command.
1. Log on as root.
For example, the following command deletes the official global environment created at installation:
/usr/DassaultSystemes/B14/OS_a/code/command
● aix_a
● hpux_b
● irix_a
● solaris_a.
Note that environments cannot be deleted using simple operating system commands. The delcatenv
command is essential for removing all trace of environments in the desktop environment.
3. Kill all running Version 5 processes.
In certain cases, the orbixd& process is run. To delete the corresponding application correctly, run:
ps -ef&
kill -9
to kill the orbixd& process. You must also kill all the processes which are "sons" of orbix processes.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 128
1. Log on as root.
2. Go to the installation directory:
/usr/DassaultSystemes/B14/OS_a/code/command
3. Enter the command:
catstart -run KillV5Process
This command stops all Version 5 processes attached to the current concatenation of processes (including
Orbix).
Note, however, one important restriction: processes started using "./" will not be detected.
4. Only when all environments and running processes have been deleted, you can then delete the
installation directory using the command:
rm -rf /usr/DassaultSystemes/B14
/etc/inetd.conf
Distributing Code
Distributing Version 5 on Windows
Distributing Version 5 on UNIX
This section concerns only the CATIA, DELMIA and ENOVIA DMU Navigator product lines.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 130
Both solutions are ideal if you want the best level of performance, and involve installing and maintaining
the software on each computer.
● distribute the software from a source computer to a client computer using the StartB batch
installation command on the client computer
● distribute the software from a source computer to a client computer using the RCMD command (part
of the Windows Workstation Resource Kit)
● access the software installed on the server from a "light" client on which only a runtime environment
is installed, but no code
● distribute the software in compressed form
● distribute a service pack from an archive file.
Code distribution scenarios based on the use of the Install Shield silent installation file mechanism are no
longer supported, and are replaced by the use of the StartB batch installation command.
Your roaming profile is the same on every computer you use. Windows system administrators should
ensure that Version 5 end users use roaming profiles. This will enable end users to log onto different
computers to run Version 5 and recover their customizations. Refer to your Windows online
documentation for more information about roaming profiles.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 132
You can copy the software into a folder on the source computer, or simply insert the Version 5 CD-ROM into the
drive. Then, you can log onto another computer, the client, on which you want to install Version 5, map the drive
containing the folder (or the CD-ROM drive directly) and run the StartB batch command to install Version 5 over
the network, as illustrated below:
Note also that, if an IBM License Use Management Runtime (LUM) license server is running on the computer on
which you are installing Version 5, you must stop the server before starting the installation.
When you insert the CD-ROM into the source computer, the installation procedure starts automatically. The
Setup program displays a message telling you that it is preparing the installation procedure. In our example, you
do not need to install the software on the source computer before distributing it, so at this point, you must stop
the installation procedure from starting automatically.
One way of preventing the installation procedure from starting automatically after inserting the CD-ROM is to
press and hold down the Shift key immediately after inserting the CD-ROM.
1. Log on as Administrator onto the remote computer on which Version 5 is to be installed.
You must belong to the Administrators group, or have the privileges assigned to the Administrators group.
2. Run the Windows Explorer.
You need to use the Explorer to connect over the network to the computer containing the software, and access
the StartB batch program in the folder
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 133
3. Using the Explorer, select Tools->Map Network Drive...
4. Select a Drive, then enter either the name of the folder containing the software (in our example, this would be
something like \\Remote_Computer\My_CATIAV5_Folder) or directly the CD-ROM drive, or use the Browse...
button to navigate, then click the Finish button once you have made your selection.
Note that if you browsed to select the folder, its name will be displayed like this in the Folder field:
\\Remote_Computer\My_CATIAV5_Folder
Once mapped, the connection to the remote computer in the Explorer window will look like this:
5. Open a Command Prompt window and go to the folder on the source computer you mapped previously, and
then go to the INTEL folder.
6. Run the command:
StartB -h
to display help if you are not familiar with the StartB command.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 134
7. Install the Version 5 software.
will install the DP2 and MD2 configurations (and the corresponding nodelock licenses) for the CATIA product line
into the following location:
The Resource Kit must be installed on both the source computer ("ravel" in our example) and the client computer
("chopin" in our example).
Furthermore, for the RCMD command to operate, the RCMDSVC service must be started beforehand on the client
computer. This involves installing a Remote Command server on each client computer, then starting the Remote
Command server. For more information, refer to the following Windows online help topic: RCMD.EXE: Remote
Command Service.
Note also that, if an IBM License Use Management Runtime (LUM) license server is running on the computer on
which you are installing Version 5, you must stop the server before starting the installation.
The software supplied by Microsoft in the Windows Workstation Resource Kit is not officially supported. Microsoft
(and Dassault Systemes) do not guarantee the performance of the Windows Workstation Resource Kit tools,
response times for answering questions, or bug fixes to the tools. The software (including instructions for its use
and printed and online documentation) is provided "AS IS" without warranty of any kind.
1. Log onto the source computer using an account with Domain Administrator privileges.
2. Copy the Version 5 software into a folder on the source computer, and share the folder.
For example, the folder name could be My_CATIAV5_Folder ,and you could share the folder using the name
"CATIA".
3. Select Start->Programs->Windows 2000 (or XP) Professional Resource Kit->Tools.
4. Double-click the Network Management Tools control, then the Remote Command Service control.
A Command Prompt window is opened and you are now located in the directory:
rcmd \\remote_computer
rcmd \\chopin
6. Once you are connected to the remote computer, map a drive on the remote computer to the shared folder on
the source computer.
where:
This command maps the M: device (the device must be available) on the remote computer to the shared folder
"CATIA" on the source computer "ravel", using the domain administrator password "admin". Note that the domain
name is "MyDomain" and the domain administrator username is "root".
To check that the map has been successfully performed, enter the command:
net use
M:\INTEL\StartB -h
M:\INTEL\StartB -list
will install the DP2 and MD2 configurations (and the corresponding nodelock licenses) for the CATIA product line
into the following location on the remote computer:
This type of scenario is sometimes referred to as a "code server" scenario. The advantages of this type of
scenario are:
● you save time: the code is installed on the code server only, and not on the clients; and future
upgrades and installation of service packs are easier since you only have to upgrade the software on
the server, and not the clients
● you save disk space: code is installed on the server only, so you save disk space on the clients
● the code is sent over the network to the client, so you will experience problems if the network is not
efficient or goes down
● the code is executed on the client, so performance may vary depending on the power of the client
computer and the amount of memory on the client.
1. Log on as administrator onto the server computer, install the Version 5 software, for example, in the
following folder:
You need to use the Explorer to connect to the server over the network and access the C:\Program Files
folder on the server.
4. Select Tools->Map Network Drive...
The Map Network Drive dialog box is displayed, and looks something like this:
5. Select a drive.
6. Select the folder Program Files on the server, and click Finish.
This is the folder containing the Dassault Systemes\ folder in which you installed the Version 5 software.
Note that selecting the folder displays the server name and folder name in the Path field:
\\server\Program Files
In the All Folders list in the left window of the Explorer, you will now see the connection to the server, for
example:
where "server" is the server name, for example, and "F:" is the name of the drive you mapped.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 140
7. Still on the client computer, open a Command Prompt window and go to the following directory:
F:\Dassault Systemes\B14\intel_a\code\bin
where, for example, "F:" is the name of the mapped drive and represents F:\Program Files.
8. Check that the system DLLs on the client are up to date.
CATSoftwareMgtB -P
which checks whether the DLLs on the client are OK or not. The screen output will inform you if the DLLs
are OK. If so, proceed to the next step.
CATSoftwareMgtB -D
which provides detailed system information about prerequisite Microsoft DLLs installed and the DLL
versions installed on the client. If the DLLs on the client are not up to date, you must update them.
You can find the system DLLs on your product CD-ROM in the INTEL_SHARED folder.
To update the DLLs on Windows:
9. Restart your computer if your system DLLs were updated, and open a Command Prompt window to go
back to the directory where you were before,
Then, run the following command using exactly the syntax indicated, depending on whether you are
running CATIA, ENOVIA DMU Navigator or DELMIA:
where "MyEnvironment" is the name of the environment, and "MyEnvDirectory" the name of an existing
folder containing the environment on the client, if you intend to create an environment on the client as
described in step 11a.
If you intend to use the environment on the server (step 11b), run the command:
cnext /regserver
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 141
dmu /regserver
delmia /regserver
This activates OLE support which ensures that double-clicking Version 5 document icons on the client will
run a Version 5 session.
10. Run the following command:
● or access the server environment via the network, to avoid creating an environment on the client
(step 11b).
where "MyEnvironment" is the name of the environment, and "MyEnvDirectory" the name of
the folder containing the environment.
In both cases, a global environment is created on the client computer which can be used by all
users who log onto the client.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 142
11b. You can also access the server environment via the network. To be able to do so, the code and the
runtime environment on the server must be installed in a shared location so you can map it from the
client.
For illustration purposes, let's suppose you installed the code in:
To facilitate access to the runtime environment over the network, the environment must be located in a
shared easily accessible location, and NOT in the default location in the All Users profile on the server
which is:
For illustration purposes, let's suppose you created the runtime environment on the server in the
following shared location:
E:\CATEnv
where "MyEnvironment" is an example for the name of the runtime environment on the server.
Note that this scenario will only work if the drive letter on the client and the drive letter on the server are
identical. In certain cases, you may not be able to use the same drive letter on the client and the server.
For example, the code is installed on "E:" on the server, but the drive "E:" on the client is not free, so
you map the drive "K:". If you then try to start a session, the runtime environment will not be found
because the paths referenced in the runtime environment point, for example, to "E:..." like this:
...
CATInstallPath=E:\Program Files\Dassault Systemes\B14\intel_a
CATDLLPath=E:\Program Files\Dassault Systemes\B14\intel_a\code\bin
...
To bypass this problem, create a new global environment on the server using the following command:
where "\\servername\home" is the UNC name of the server and shared folder, and "NewEnvironment" is
the new environment name. Creating a new environment this way will create the correct UNC paths as
follows:
...
CATInstallPath=\\servername\home\Program Files\Dassault Systemes\B14\intel_a
CATDLLPath=\\servername\home\Program Files\Dassault Systemes\B14\intel_a\code\bin
...
This time, your attempt to start a session will be successful if you use the following command:
Note also that if you disconnect the drive you mapped, you will have to remap it as before for the
scenario to continue to work.
12. If you require extended font support, run the following command:
For more information, refer to "Using and Customizing Fonts" in your Infrastructure Users Guide.
13. If you want to record and replay macros, and Microsoft Visual Basic for Applications (VBA), Version
6.0 is not already installed on your client, you have to install VBA manually from the product CD-ROM.
msiexec /q /i pathcdrom\VBA\VBA6.msi
14. If you need access to the communications backbone and peripheral device broker, the associated
port numbers must be set up on the client.
Used to support process interoperability (for example, between CATIA and DMU), the backbone needs to
be set up on each computer running applications which need to communicate.
1. Log on as administrator.
2. Open a Command Prompt window and go to the installation directory, for example:
For more information about the communications backbone, refer to Communications Backbone Files.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 144
15. If you created a runtime environment on the client, start a session by double-clicking the
environment icon on the desktop or by selecting the command to start the product from the Start-
>Programs menu.
Make sure that you have set up your licenses (either network or nodelocked) before starting a session.
16. If you want to delete the environment created on the client, run the following commands:
Note that you cannot first install a GA level in compressed form, then install a service pack in normal
installation mode. In this particular case, you have two solutions:
● reinstall everything in compressed form
● or use the CATDeltaInstall utility.
1. Log on as administrator onto the server computer, install the Version 5 software, for example, in the
following folder:
CATSoftwareMgtB -P
which checks whether the DLLs on the client are OK or not. The screen output will inform you if the DLLs
are OK. If so, proceed to the next step.
CATSoftwareMgtB -D
which provides detailed system information about prerequisite Microsoft DLLs installed and the DLL
versions installed on the client. If the DLLs on the client are not up to date, you must update them.
You can find the system DLLs on your product CD-ROM in the INTEL_SHARED folder.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 146
7. Restart your computer if your system DLLs were updated, and open a Command Prompt window to go
back to the directory where you were before, then run the following command using exactly the syntax
indicated, depending on whether you are running CATIA, ENOVIA DMU Navigator or DELMIA:
where "MyEnvironment" is the name of the environment, and "MyEnvDirectory" the name of the folder
containing the environment, if you intend to create an environment on the client as described in step 9.
This activates OLE support which ensures that double-clicking Version 5 document icons on the client will
run a Version 5 session.
8. Run the following command:
where "MyEnvironment" is the name of the environment, and "MyEnvDirectory" the name of
the folder containing the environment.
In both cases, a global environment is created on the client computer which can be used by all
users who log onto the client.
Instead of creating an environment on the client computer, you can use access the environment on
another computer via the network. For more details, refer to step 11b in Accessing the Software From a
Thin Client.
10. If you require extended font support, run the following command:
For more information, refer to "Using and Customizing Fonts" in your Infrastructure Users Guide.
11. If you want to record and replay macros, and Microsoft Visual Basic for Applications (VBA), Version
6.0 is not already installed on your client, you have to install VBA manually from the product CD-ROM.
msiexec /q /i pathcdrom\VBA\VBA6.msi
12. If you need access to the communications backbone and peripheral device broker, the associated
port numbers must be set up on the client.
Used to support process interoperability (for example, between CATIA and DMU), the backbone needs to
be set up on each computer running applications which need to communicate.
1. Log on as administrator.
2. Open a Command Prompt window and go to the installation directory, for example:
For more information about the communications backbone, refer to Communications Backbone Files.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 148
13. If you intend to extract offline licenses for use on the client, and the client happens to be a laptop (as
described in Enabling Concurrent Offline Licensing), you must install the LUM driver as follows:
14. If you created a runtime environment on the client, start a session by double-clicking the
environment icon on the desktop or by selecting the command to start the product from the Start-
>Programs menu.
Make sure that you have set up your licenses (either network or nodelocked) before starting a session.
15. If you want to delete the environment created on the client, run the following commands:
For example, you can build an archive file containing the differences between level V5Rn GA and V5Rn SP2 (even
if you installed V5Rn SP1 in between).
You use the CATDeltaInstall command with the appropriate arguments to build the archive. The resulting archive
file can then be copied to the target computer and decompressed using platform-specific tools. For example, you
need the Microsoft CabArc.exe utility which can be downloaded from:
http://support.microsoft.com/default.aspx?scid=kb%3ben-us%3b310618
The installation files from the archive file then overwrite the installation files on the target computer.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 150
Note that installing a service pack from an archive file always commits the service pack automatically. Make sure
that the previously installed service packs on the target computer have been committed before installing the
archive. Furthermore, you can only use this method if the configurations/products on both the source and target
computers are identical.
The traditional methods of service pack installation and the use of the CATDeltaInstall command are
interchangeable: you can install a service pack from a CD-ROM, then install another service pack from an archive
file.
Installation Procedure
1. Log on as an administrator onto the source computer.
You must belong to the Administrators group, or have the privileges assigned to the Administrators group.
Otherwise, you will not be able to install the different levels on the source computer.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 151
2. Perform, for example, the following installations:
● install V5Rn GA
● install V5Rn SP1 then commit the service pack
● install V5Rn SP2 then commit the service pack.
● -s: previous level number: the level can be either a service pack or the GA level for the same release;
0 = GA, 1 = service pack 1, 2 = service pack 2, etc.; the default is 0.
A service pack must have been correctly installed if you intend to build an archive based on the differences
between this service pack and another level. For example, if you installed only the V5Rn GA and V5Rn SP2
levels, you cannot specify "-s 1" as an argument (because you did not install the V5Rn SP1 level).
● -d: Installation directory; when the command is run from the installation directory, this argument is not
required
● -l: only lists the files which are different between the two installation levels; this list can be used to build a
different type of archive (for example, WinZip)
● -a: builds an archive file with the specified name (requires the CabArc utility)
● -h: help.
On Windows, the archive file compression is handled automatically thanks to the cabarc format.
The service pack installed your computer, and used as the basis for comparison with a previous level, must be
committed beforehand. If not, the CATDeltaInstall command will not operate.
5. Copy the archive file to a target computer on which you want to install the same service pack level.
Keep in mind that the target computer must be running the same Version 5 configuration/products as the source
computer on which the archive file was built.
6. Stop all running Version 5 processes on the target computer before proceeding.
7. Install the archive using the following command:
You can:
● install the software on each computer, either directly from the CD-ROM or from a server.
This is the ideal solution if you want the best level of performance, but involves installing and
maintaining the software on each computer.
● or, set up the software on a server, and simply set up a minimum environment on each user's
computer so end users can access the software over the network.
This is the ideal solution if you want to save space on each computer, and facilitates future upgrades
since means that you only have to upgrade the software on one computer: the server.
The distribution scenarios described in this section are based on mounting NFS file systems. Note that
you can also use DFS (Distributed File System). DFS is an open, cross-platform distributed file system for
managing network security and administration, and is compatible with Version 5.
You can run Version 5 using CATIA Version 4 userids. Using Version 5 with a CATIA Version 4 userid is
transparent as is the case for other userids.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 155
We have chosen the AIX platform for the purposes of this scenario.
For the purpose of our example, the name of the directory is:
/usr/My_CATIA_V5_Directory
6. Go to the directory as follows:
cd /usr/My_CATIA_V5_Directory
You are now ready to perform an installation of Version 5 from this directory.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 156
./start
For the purposes of this scenario, when you are prompted to choose a destination directory in the Choose
Destination Location dialog box, choose the default installation directory:
/usr/DassaultSystemes/B14/aix_a
For detailed information about the start command, refer to Start Command Syntax.
You could also export the CD-ROM directory itself in read only mode.
You are now ready to distribute Version 5 to other workstations on your network.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 157
We have chosen the AIX platform for the purposes of this scenario.
You already copied the contents of the CD-ROM into the following directory on the server:
/usr/My_CATIA_V5_Directory
using the scenario described in Setting Up the Server. You are going to perform the installation by
allowing the client to access this directory on the server.
To do so, you must export the directory /usr/My_CATIA_V5_Directory to the client: the directory must be
accessible from the client.
2. Log on as root onto the client.
3. Mount the exported directory via NFS.
4. Go to the mounted directory.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 158
./start
/usr/DassaultSystemes/B14/aix_a
For detailed information about the start command, refer to Start Command Syntax.
You have another alternative if you have not already copied the CD-ROM contents into a directory: insert
the CD-ROM, export the /cdrom directory to the client, then mount the /cdrom directory from the client.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 159
We have chosen the AIX platform for the purposes of this scenario.
/usr/DassaultSystemes/B14/aix_a
2. From the server, export the installation directory (/usr/DassaultSystemes/B14) to the client.
/usr/DassaultSystemes/B14/aix_a/code/bin
6. Set the path of the installation directory on the server using the command:
export
PATH=/usr/DassaultSystemes/B14/aix_a/code/bin:/usr/DassaultSystemes/B14/aix_a/code/command:$PATH
The following list contains the variables to modify on each UNIX system:
/usr/DassaultSystemes/B14/aix_a/code/command
For a description of the setcatenv and delcatenv command syntax for UNIX, refer to Customizing Your
Environment on UNIX.
9. If you need access to the communications backbone and peripheral device broker, the associated port
numbers must be set up on the client.
Used to support process interoperability (for example, between CATIA and DMU), the backbone needs to be
set up on each computer running applications which need to communicate.
/usr/DassaultSystemes/B14/OS_a/code/command
2. Enter the command:
❍ aix_a
❍ hpux_b
❍ irix_a
❍ solaris_a.
/usr/DassaultSystemes/B14/aix_a/code/command
12. To delete this environment, run the command from the same directory.
For CATIA:
./catstart -run "delcatenv -e CATIA.V5R14.B14 -d /CATEnv -desktop yes -a global" -env CATIA.V5R14.B14 -
direnv /CATEnv
For DELMIA:
For a description of the setcatenv and delcatenv command syntax for UNIX, refer to Customizing Your
Environment on UNIX.
/usr/DassaultSystemes/B14/aix_a
2. From the server, export the following directories to the client:
● /usr/DassaultSystemes/B14/aix_a (installation directory)
● /CATEnv (runtime environment directory)
Both the installation and runtime environment directories must be accessible from the client.
3. Log onto the client as root.
4. From the client, mount both exported directories via NFS.
5. Go to the following mounted directory:
/usr/DassaultSystemes/B14/aix_a/code/command
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 163
/usr/DassaultSystemes/B14/aix_a/code/command
./catstart
For example, you can build an archive file containing the differences between level V5Rn GA and V5Rn SP2 (even
if you installed V5Rn SP1 in between).
You use the CATDeltaInstall command with the appropriate arguments to build the archive. The resulting archive
file can then be copied to the target computer and decompressed using platform-specific tools (for example, you
use the tar command). The installation files from the archive file then overwrite the installation files on the target
computer.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 165
Note that installing a service pack from an archive file always commits the service pack automatically. Make sure
that the previously installed service packs on the target computer have been committed before installing the
archive. Furthermore, you can only use this method if the configurations/products on both the source and target
computers are identical.
The traditional methods of service pack installation and the use of the CATDeltaInstall command are
interchangeable: you can install a service pack from a CD-ROM, then install another service pack from an archive
file.
Installation Procedure
1. Log on as an root onto the source computer.
/usr/DassaultSystemes/BOn/OS_a/code/command
● aix_a
● hpux_b
● irix_a
● solaris_a.
4. To build an archive file based on the differences between the V5Rn GA and V5Rn SP2 levels, for example, run
the CATDeltaInstall command as follows:
● -s: previous level number: the level can be either a service pack or the GA level for the same release;
0 = GA, 1 = service pack 1, 2 = service pack 2, etc.; the default is 0.
A service pack must have been correctly installed if you intend to build an archive based on the differences
between this service pack and another level. For example, if you installed only the V5Rn GA and V5Rn SP2
levels, you cannot specify "-s 1" as an argument (because you did not install the V5Rn SP1 level).
● -d: Installation directory; when the command is run from the installation directory, this argument is not
required
● -l: only lists the files which are different between the two installation levels; this list can be used to build a
different type of archive
● -a: builds an archive file with the specified name
● -t: temporary file for storing archive file; the default is /tmp
● -h: help.
5. You may want to compress the archive file. To do so, run the command:
compress MyArchiveFile
6. Copy the archive file to a target computer on which you want to install the same service pack level.
Keep in mind that the target computer must be running the same Version 5 configuration/products as the source
computer on which the archive file was built.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 167
7. Stop all running Version 5 processes on the target computer before proceeding.
8. If you compressed the archive file earlier, uncompress it by running the command:
compress -d MyArchiveFile.Z
9. Install the archive using the following commands.
/usr/Dassault Systemes/B0n
Note: The tar command is not enabled for files greater than 2 GB an AIX.
10. Start a session to check the service pack has been correctly installed.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 168
Administering Version 5
Licensing
Managing Environments
Managing Software
Managing Settings
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 169
Licensing
Licensing Overview
Licensing Tools
Enabling Concurrent Offline Licensing
Setting Up Network Licensing
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 170
Licensing Overview
Configurations
Configurations are a convenient and attractive way for you to order and install the adequate combination
of products for each type of user, while offering a single solution from a licensing point of view.
● standard configurations contain a pre-defined list of products, corresponding to most frequent user
profiles across industries and processes. These configurations are offered at an attractive price
compared to the sum of the individual product prices.
● the content of custom configurations is dynamically defined at ordering time, thus allowing you to
adapt the configuration content to the most specific user needs. The content of a custom
configuration is defined by adding individual products (see product delivered as "add-on" below) to an
existing standard configuration. The result is a competitively priced solution, and remains a single
solution from a licensing point of view.
After initial installation, the configuration mechanism lets you manage the evolution and growth of your
user profile content by allowing you to add new products. The resulting new seat definition is still a single
solution from a licensing point of view.
To be able to use Version 5, you need to purchase and acquire at least one configuration license.
If you already have a custom configuration, you can extend it by adding products. But before you do so,
you must use LUM to migrate your server license database to support custom configuration growth.
To do so:
i4ccmig
Products
Products are the elementary software building blocks for Version 5 installations. Version 5 software may
be ordered as:
● a standard configuration
● an add-on product on top of a standard configuration to build a custom configuration
● a shareable product:
In this case the product is delivered with its own license key, allowing the user to obtain the license at
the beginning of the session, or to leave it for another user. Prices of products ordered in this mode
are different, versus "add-on" price, to take into account multiple users potential. Shareable product
licenses do not have serial numbers.
Shareable products concern the CATIA, DELMIA and ENOVIA Portal DMU Navigator product
lines only.
● an Extra Product:
An extra product is a standard product associated with certain configurations or a products. At install
time, if you select a configuration or a product which contains an extra product, a new dialog box is
displayed allowing you to install (or not install) the extra product. An extra product cannot be
licensed: it is free of charge. In additional install mode, the extra products already installed are listed
along with the already installed standard products. Installation in batch mode also takes extra
products into account. The CATSoftwareMgt[B] commands list the installed extra products along
with the installed standard products.
After installation, there is no possibility to differentiate the products installed as standard products or
as extra products. Documentation installation does not manage extra products.
Licensing Types
In workstation environments, Version 5 controls the number of concurrent users of a Version 5
configuration or product, according to the number of licenses acquired for the configuration or product.
Version 5 delivers identical licensing mechanisms on UNIX and Windows environments, based on IBM
License Use Management (LUM). The following licensing principles apply:
● A Version 5 configuration (standard or custom) will require a license. Licenses for Version 5
configurations are acquired and released for the total configuration. The products within a
configuration cannot be shared.
● Version 5 shareable products will require a license, in addition to one for the prerequisite
configuration and any prerequisite product, if applicable.
● In all cases, licenses are acquired at the beginning of the process and are released at its termination.
● Shareable product licenses may be acquired at the beginning of the process and released at its
termination, or upon user request, acquired and released during the process (ability to acquire and
release licenses is not available for configuration licenses). Shareable licenses acquired at the
beginning of the session cannot be released before the end of the session; only licenses dynamically
granted upon user request during the session can be released during the session.
Version 5 can be used in two licensing modes: nodelock or with concurrent usage of licenses on a
network.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 172
Nodelock Licensing
The use of local display of the hardware configuration is mandatory for Version 5 usage in nodelock
mode. There is no limit to the number of Version 5 processes launched for a given license (configuration
or product). For instance, a user can launch the following simultaneous processes:
In nodelock mode of operation, only one license per configuration and product can be registered by
machine, and only one user can run a license at a time. If you want multiple licenses per configuration or
product, or multiple users, refer to Concurrent Licensing.
Nodelock licensing is available only for the CATIA, DELMIA and ENOVIA Portal DMU Navigator
product lines.
ENOVIA LCA and ENOVIA Portal 3d com use concurrent licensing only.
Concurrent Licensing
For CATIA/DELMIA/DMU/RADE, a user on one machine on one display uses one license per configuration
or product used, regardless of the number of processes. For LCA/3d com, an individual license is
requested by each running process.
If the display changes, an additional license is reserved for the corresponding process.
Add-on and shareable products require a license for a configuration which includes at least the
prerequisite products.
Licenses for Version 5 configurations are acquired and released for the total configuration. The functions
within a configuration cannot be shared.
This feature is designed to add additional flexibility to a user's work environment. It is offered to
accommodate short-term travel needs and collaboration while away from a fixed office environment or
server connection. All ICA terms and conditions, including Cross-Border licensing terms are unchanged,
and users will checkout and check-in licenses at their home server, where rules and procedures are
controlled by LUM.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 173
Demo Usage
In addition to its normal mode of operation where all licensed functions are accessed, Version 5 is
capable of running in demo mode, on UNIX and Windows, with some disabled functions (such as File-
>Save - see list below):
● Existing Version 5 customers, who have a minimum of one regular license, can switch from standard
mode to demo mode (Tools->Options->Licensing tab). As the user restarts a session, the demo
mode will be automatically used.
● Qualified prospects, who may be given the Version 5 code for evaluation purposes, are required to
enter a special demo license key. This will ensure that the code starts automatically in demo mode.
With this mechanism, customers can explore add-on products for which they do not yet have a license.
The qualified prospect can get first hands-on experience, verify the ease of use of Version 5, and create
the first parts. In both cases, a favorable business environment is created for accelerating sales cycles.
When using Version 5 in demo mode, the following functions are disabled:
Note that only shareable products in the CATIA product line can be acquired without exiting a session.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 174
Licensing Tools
Enrolling Nodelock Licenses After the Installation
Reserving Static Licenses Using the License Manager
Reserving Shareable Product Licenses Dynamically
Running in Demo Mode
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 175
On Windows
1. Log onto the computer.
2. Select the Start->Programs->CATIA V5R14->Tools->Nodelock Key Management V5R14 command, or run the program:
install_root\code\bin\CATNodeLockMgt
where "install_root" is the name of your installation folder which is, by default:
A check is performed automatically to verify whether your license is still valid, and display the number of days before your license
expires.
Note that:
● a green light opposite the license serial number means that the license will still be valid for at least 30 days
● an orange light opposite the license serial number means that the license will still be valid for less than 30 days
● a red light opposite the license serial number means that the license has expired.
If the license is still valid, the number of days left before the license expires is indicated.
Note that the target id of the computer on which you are performing the installation is displayed inside the dialog box.
Pointing to the target id on Windows
displays a tooltip containing the name of
the network adapter used by the
licensing software to generate the target
id:
On UNIX and Windows, in both interactive and batch modes, the nodelock key management tool now displays the three-letter code
for nodelock custom configuration licenses. If this license contains add-on products, their three-letter code will be also displayed.
Identifying the configuration from which the custom configuration license has been generated is now easier, because the three-
letter code provides additional information, along with the serial number.
If the configuration cannot be identified,
the trigram displayed will be "???" like
this:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 176
This can happen for example if you have a license for a configuration which has not been installed, or has been uninstalled.
The File menu contains the following commands:
● Import
● Add
● Read
● Extract
● Restitute
● Clear
● Exit
3. To import your electronic license certificate (if you have one), select the File->Import command.
To be able to import the certificate using this command, you do not need administrator privileges, however you need write access
to the folder in the LUM environment containing the nodelock file.
This displays a file selection box which opens with the C:\Temp folder contents displayed:
Explore your filetree and select the license certificate file which uses the prefix ".lic", then click the Open button to import the
certificate.
This imports the license and creates the file named "nodelock" (or updates the existing "nodelock" file) in the default LUM
environment:
C:\ifor\ls\conf\nodelock
If you already installed LUM elsewhere, the nodelock file will still be updated in:
C:\ifor\ls\conf\nodelock
This procedure can be used both after installing for the first time and after installing additional products.
To be able to add a license using this command, you do not need administrator privileges, however you need write access to the
folder containing the nodelock file.
This is useful when you do not have a license certificate file to import, and your license is sent to you on paper.
Type the following information (contained in your license on paper) in the appropriate fields:
● Version
● Password
● Serial Number
There may or may not be a serial number, depending on the case:
❍ a serial number exists for all configurations: all configurations are custom configurations
❍ if you already have a custom configuration, you can extend it by adding products: in this case, a new license is provided,
and the new license contains the same serial number as the original configuration
❍ a serial number does not exist for standalone (shareable) products.
● Annotation
● Comment.
The "Nodelock" file is created or updated just as if you had imported a license certificate.
5. To read a license, select the File->Read command.
This displays the license in the "Nodelock Key File Content" box:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 178
Offline Licensing
The File->Extract and File->Restitute commands are used for extracting offline licenses from and returning offline licenses to a
LUM 4.6.7 server for the purpose of running Version 5 on a laptop disconnected from the network. For more information, refer to
Enabling Concurrent Offline Licensing. To be able to extract and restitute offline licenses, you do not need administrator privileges,
however you need write access to the folder containing the nodelock file and to the nodelock file itself.
The File->Clear command allows you to clear obsolete nodelock licenses from the nodelock file. Each time you import a nodelock
license, it is added to the nodelock file. After a period of time, the nodelock file may contain a large number of licenses, some of
which are obsolete. We recommend that you clear obsolete licenses from the nodelock file using this command, not by editing the
nodelock file manually. To be able to clear the nodelock file using this command, you do not need administrator privileges,
however you need write access to the folder containing the nodelock file and to the nodelock file itself.
On UNIX
1. Log on as root.
2. Go the directory:
/usr/DassaultSystemes/B14/OS_a/code/command
● aix_a
● hpux_b
● irix_a
● solaris_a
and enter the following command to display the "Nodelock License Manager" dialog box:
The user interface on UNIX is the same as the user interface on Windows described above.
While not recommended, you can also enroll licenses after the installation by editing the nodelock file created by default in:
/var/ifor/nodelock (AIX)
/opt/lum/ls/conf/nodelock (HP-UX, IRIX, Solaris)
Batch Mode
On all platforms, you can also run the command in batch.
On Windows:
install_root\code\bin\CATNodelockMgtB (Windows)
On UNIX:
● aix_a
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 179
● hpux_b
● irix_a
● solaris_a
2. Select the General category, then the Licensing tab to display the License Manager.
The role of the License Manager is to allow you to reserve licenses before using these products. You will not be able to work with
any Version 5 products until you have first reserved the corresponding licenses.
If you are using network licensing, selecting this tab contacts any license servers to update the list of available configurations and
products.
In our example, it will look like this if you installed the configurations CATIA - Mechanical Design (MD2) and CATIA - Drawing
Production (DP2), and imported a nodelock license for the CATIA - Mechanical Design (MD2) configuration:
Licensing Information
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 181
The "Licensing Information" section contains the following information:
● Target id: specifies the target id of your computer
● Display Type: informs you whether you are running on a local or remote display;
❍ Local: you are running on a local display and you can work with either nodelock or server licenses
❍ Remote: you are running on a remote display and you can work with server licenses only.
● Active servers: if you are using network licensing, the list of all active and the number of available license servers is now
displayed like this:
The name of the server you are using is displayed in the field opposite. Click the the up and down arrows to display the
list of servers available.
If you are using nodelocked licensing only (in other words, if you are not using network licensing), Active Servers is set to
"None".
Licensing Setup
The "Licensing Setup" section contains the following information:
● Server Timeout: When a client requests a license from a license server list, the client is prepared to wait a certain amount of
time for a response from the first license server (the server replies that the license is available or not available) before
contacting another server. A slider lets you specify approximately the amount of time the client is prepared to wait for a
response from the license server, from a few seconds to a few minutes.
If you have a high-performance network, and servers that are not heavily loaded, we recommend that you reduce the value: this
will allow the client to contact other servers more quickly, instead of waiting too long for a response from the first server.
If you have a low-performance network, or servers that are heavily loaded, we recommend that you increase the value: this will
allow the client to wait long enough for a response over a slow network or from heavily loaded servers.
In principle, a license granted by a LUM license server to a V5 session is released when the V5 session stops. The license is also
automatically released when a V5 session crashes.
However, it may occur in the event of certain severe crashes or network problems, that the V5 session cannot instruct the
license server to release the license, so the license is not released. To prevent the license from being retained endlessly by the
license server, there is a specified period of time (referred to as the "heartbeat") after which the license server considers the V5
session to be dead, and releases the license. This heartbeat is communicated to the license server by the V5 session when the
license is first requested.
Originally, the value of the heartbeat was set by default to approximately 17 mn, which meant that a license could be incorrectly
retained by the license server up to 17 mn, and could not be customized. During this period of time, this license cannot be
granted to another user. However, it can still be granted to the same user on the same machine on which the severe crash
occurred.
Now, you can set the heartbeat using the Frequency option. The default value is the same as before: approximately 17 mins.
This is the maximum value (represented by the value MAX in the list) and cannot be increased. Decreasing the heartbeat value
will decrease the maximum period of time during which a license can be inadvertently retained by the license server.
You can set the appropriate value by increments of 1 min. Consequently, the heartbeat can be set to any of the following range
of values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 and MAX.
Note: because the V5 session must contact the license server more frequently, decreasing the heartbeat may lead to increased
network load.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 182
When a license server or the network goes down, a Version 5 session now enters a special mode giving users the
opportunity to save their work before exiting.
To understand the new behavior when a license server goes down, let`s look at what happened in previous releases.
Let`s take the example of a concurrent license granted to a V5 session when started. Every heartbeat period (about
17mn), the V5 session checks that the license is still granted to it. It may occur that, for example, the license server or
the network are down. In that case, the license check fails.
The session then enters a "countdown" mode. A popup is displayed informing the user that the license check has failed.
The user must then save any work in progress. Five checks are performed at one minute intervals. If all checks fail, the
session exits.
● users may not necessarily have understood that any work in progress had to be saved.
● even when a save was launched, the session could be exited while the save was still running.
From now on, the popup message clearly indicates to users that saving open documents is strongly recommended. After
the five failed checks, instead of exiting, a new license request is attempted. If it succeeds, the session continues. If this
session fails also, the session is set to a special mode in which only saving and exiting commands are available. All menu
items and toolbars are grayed out, except the command s Exit, Save, Save As, Save All and Save Management from the
File menu. Only the save and exit commands can be launched by using power input.
Notes:
● processes such as batches and macros do not support this mechanism: automatic exit is still performed.
● even if the problem which led to the license check failure is solved, it is impossible to return to the normal mode after
the session has been set to the special mode in which only saving and exiting are allowed: no other license request is
performed after entering in this mode.
● Show License Info: check this option if you want feedback when attempting to reserve a license which is not available
(reserved by another user). The next time you start a session, the software will inform you who is using the license you are
trying to use.
Note that this mechanism, even though managed by the Licensing tab, also applies to shareable product licenses managed by
the Shareable Products tab.
● Demo mode: You will be able to work in demo mode if you registered and reserved at least one configuration license, and
checked the Demo Mode option. For more information about the demo mode, refer to Running in Demo Mode.
Note that, if you have not previously reserved any licenses, none of the check buttons is checked.
If you are working with a nodelocked license, the license will be reserved by default when you start a session, even if you unchecked
the corresponding button.
If you entered a nodelock license during the installation, the corresponding configuration is preselected in the list.
In our example, the MD2 option is checked because we imported a nodelock license for this configuration (CATIA - Mechanical
Design (MD2) (DS4D8E940000 - MD2)) during the installation.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 183
The "+" button is displayed next to the license in the list. Clicking this button lets you switch between compact mode (the default)
and expanded mode. In compact mode, the license imported is already reserved.
Click the "+" button to switch to expanded mode. In this mode, a sublist is displayed containing the list of all the installed licenses,
preceded by the "Any License" option.
All configurations are considered as custom configurations. When you install a configuration, the list of configurations/products is
organized as follows, in the order of appearance from top to bottom:
● selected configuration licenses forced by the administrator, in alphabetical order
● selected product licenses forced by the administrator, in alphabetical order
● selected configuration licenses not forced by the administrator, in alphabetical order
● selected product licenses not forced by the administrator, in alphabetical order
● non-selected configuration licenses with the "Granted" status, in alphabetical order
● non-selected product licenses with the "Granted" status, in alphabetical order
● non-selected configuration licenses available for selection, with the "Not Granted" status, in alphabetical order
● non-selected product licenses available for selection, with the "Not Granted" status, in alphabetical order
● non-selected configuration licenses, not available for selection, with the "No License" status, in alphabetical order
● non-selected product licenses, not available for selection, with the "No License" status, in alphabetical order
● non-selected configuration licenses, not available for selection, locked and prohibited by the administrator, in alphabetical order
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 184
● non-selected product licenses, not available for selection, locked and prohibited by the administrator, in alphabetical order.
Your administrator instruct you specifically to reserve a specific license with a specific serial number in the list. In this case, check
the button for the corresponding license.
However, for a variety of reasons, (network performance, license availability) you may decide to install several identical
configuration licenses on different license servers. Furthermore, these licenses may have identical serial numbers, but they may also
have different serial numbers.
If you are interested in using a specific configuration, irrespective of the serial number, and you do not care which server serves the
license, check the Any License option. This means that you want to reserve any one of the licenses for that configuration in the
list.
In this case, the software reserves by itself one of the available licenses. If the software finds a valid nodelock license on your
computer, the nodelock license will be used first. If there is no nodelock license, or the nodelock license is not valid, the software will
reserve a network license from the list of license servers.
Below each configuration or product license, you will see Local or Server which informs you whether the license is a nodelock
(local) license or a server license. If you are using a server license, the name of the server will be displayed like this:
Server (ip:servername)
The name of the license that granted access to the product is indicated in parentheses.
The status Not Granted means that you have not requested a configuration or product license, or that you attempted to reserve a
license that is not available (nodelock license expired, server license expired, network server down, etc.).
The status No License appears next to configurations and products which have been installed, but for which you do not have a
license. The configuration and product names are grayed out in the list, and the check buttons cannot be checked.
Click the "-" button to return to compact mode.
3. After checking the appropriate license buttons, click OK.
4. Exit and restart your session.
You need to restart your session after reserving configuration and/or product licenses.
Licensing settings are stored in a settings file. The settings active in the License tab depend on what you set the last time you used
it.
If you run a Version 5 session in administrator mode, you can lock individual configuration and/or product licenses to control their
usage.
Troubleshooting Messages
You may encounter one of the following messages (the list is not exhaustive) when using the Licensing Manager:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 185
"Environment xxx not set or incorrect. Please set an environment using the setcatenv command"
Set a valid environment using the setcatenv command. For more information about customizing environments, refer to Customizing
Your Environment on Windows.
"No Configuration/Product Available"
The path containing the information required to display the list of configurations/products, referenced by the CATICPath
environment variable, is incorrect, or the information is incomplete.
"There is no suitable license to fulfill the xxx request"
You tried to reserve a license when all available licenses are used. Contact your administrator. See Show License Info.
"You have requested one or more product licenses, but no configuration license. Click OK and select at least one configuration
license using the License Manager dialog box."
You tried to reserve only a product license. Click OK and select at least one configuration license using the License Manager.
"No License Available for Requested Configuration(s)"
Click OK and select at least one valid configuration license using the Licensing tab.
"Not All Licenses Available"
The added value of shareable products is that they can be reserved and released "dynamically". You can simply reserve the
shareable product license using the Shareable Products tab described below, and start using it immediately without exiting your
session.
Scenario
In the following scenario, we previously installed the DP2 - CATIA - Drawing Production 2 configuration and the MD2 - CATIA -
Mechanical Design 2 configuration. The DP2 license has already been reserved.
2. Select the General category, then the Licensing tab to display the License Manager.
You can see that the DP2 license has already been reserved:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 187
3. Select the Shareable Products tab:
The lower part of the tab lists the products belonging to the DP2 configuration. When you reserved the DP2 configuration license
using the License Manager in the Licensing tab, the authorization to use this list of products was granted.
You can also use shareable products along with the licenses you reserved using the Licensing tab.
The list of shareable products is displayed in the upper part of the tab. The software detects all potentially shareable products
installed on your hard disk and displays them in the list. Accessible shareable products have an option button which you can check
to reserve them.
The list of shareable products is organized as follows, in the order of appearance from top to bottom:
Unlike the Licensing tab, selecting the Shareable Products tab does NOT contact the license servers to display the licensing status of
the products. This is intended for performance reasons. For example, if you installed a shareable product for which there is no
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 188
license, the status of the product as displayed in the Licensing tab is:
No License
However, when you select the Shareable Products tab, the status of the product displayed is:
Not Granted
This illustrates that that you cannot determine immediately the true status of the license in the Shareable Products tab. To do so,
select the license: the license servers are then contacted, and return the message, in our example, that no license is available for
this product.
Consequently, in all cases, you first have to select the license to display its true licensing status.
4. Check the button for the shareable product you want to use.
If you select a product which requires another shareable product as a prerequisite, this prerequisite is also reserved. Once reserved,
the list will indicate that the product is required by another product.
5. Click OK to save your changes and exit the tab.
You can now start using the workbench associated with the shareable product without exiting your session.
Note that:
● if you are using a workbench for a shareable product, then attempt to release the shareable product, you must first close the
corresponding workbench before being able to release the product
● shareable product licensing is disabled when accessing the Shareable Products tab using the Start->Programs->CATIA Tools
menu, and running the Settings Management command.
If you reserve a shareable product, use the Tools->Options... command to make changes to a tab introduced by this product, then
release the shareable product, any changes made to these tabs will be saved.
An administrator can lock access to shareable products in administration mode. End users will not be able to access the shareable
product license, but an administrator running in administration mode will be able to do so.
Reset Button
You must have already registered either one demonstration license, or at least one configuration license
(which automatically provides access to the demo mode).
Running in demo mode lets you use all the features of all the configurations and/or products installed,
apart from the few exceptions listed below.
In demo mode:
Note that when running a normal (non-demo) session, you can read specially marked Version 4 or
Version 5 demo documents, and save them as non-demo documents.
The License Manager is displayed automatically after starting Version 5 (either for the first time, or each
time you start a session until you reserve a license). You can also display it by selecting the Tools-
>Options... command, then the Licensing tab in the General category.
2. Check the Demo Mode option, and click OK.
When the concurrent offline license is reserved for use, a license is installed on a laptop connected to the network. For the duration of the
reservation, the extracted license is considered as a nodelock license tied to the laptop. This license is called an offline nodelocked license.
Once the offline nodelocked license has been installed on the laptop, the laptop can be disconnected from the network.
Once extracted, the license is no longer available from the license server. The license only becomes available once more to other users when
one of the following occurs:
The maximum extraction duration is 30 days. License Use Management Runtime administrators can reduce this duration.
If a free standard concurrent license and a free concurrent offline license exist for the same product, and an end-user requests a license for this
product, the server will provide the standard concurrent license, so that the concurrent offline license remains available for extraction.
Note that if you extract a license, you will not be able to run a release prior to V5R12 with that license.
Offline licensing is not supported if you use the LUM HAL (High-Availability Licensing) feature.
Software Prerequisites
Here are the software prerequisites for the laptop and the license server.
License Server
● Concurrent offline licenses can be enrolled and administered only on a server running IBM License Use Management Runtime (LUM) Version
4.6.7 on either Windows or UNIX.
● The machine running the license server does not require Version 5 software.
Laptop
● Version 5 Release 13 General Availability level of CATIA, ENOVIA DMU or DELMIA (or RADE) software
● supported Windows platforms: Windows 2000 SP2 or Windows XP
● the laptop does not require any IBM License Use Management Runtime software,
but must be configured as a LUM client
● and a LUM driver has to be installed on the client.
Procedure
Implementing concurrent offline licensing involves the following steps which should be performed in the following order:
The following steps referring to starting and stopping existing LUM servers and migration tasks do not apply if you are installing LUM for
the first time or on a different machine.
2. If you have already installed a previous version of LUM, go to the LUM installation directory.
3. Stop the license server using the command:
i4cfg -stop
To do so, refer to the section "Using the Built-In Backup and Recovery Procedure" in "Chapter 7. Hints and Tips" in the following
manual: IBM License Use Management - Using License Use Management Runtime.
5. Install IBM License Use Management Runtime (LUM) Version 4.6.7.
6. On Windows, perform the necessary license database migration steps.
To do so, you need to copy the i4_offline_mig tool from the LUM CD-ROM. This purpose-built command migrates all concurrent
licenses into concurrent offline licenses on the network license server.
It is similar to a normal concurrent license because, even after migration, it can continue to be used as a normal concurrent license.
Each time a new license is enrolled, and you want to use it as an offline license, you must use the same command again to migrate the
license.
The tool is located in a folder named after the operating system you are using. Copy the tool into the same LUM installation directory
from which you run your LUM commands (i4cfg, i4blt, ...). Change the execution rights on the executable file to make sure that you
will be able to run the tool.
i4_offline_mig
After migration, the licenses will remain available, once the server has been restarted.
8. Restart the license server using the command:
i4cfg -start
The LUM administrator must set up rules to determine which users, groups of users and machines are authorized to extract an offline
concurrent license, and under which conditions.
For example, a password can be associated to each rule. By default, nobody is authorized to extract offline licenses.
To do so, you use the Basic License Tool. Run the following command to start the Basic License Tool GUI:
i4blt
At this point, refer to the following manual: IBM License Use Management - Using License Use Management Runtime Version 4.6.7.
In this manual the section: Scenario 15: Managing Concurrent-Offline Licenses, located in the chapter Administering License Use
Management Runtime, explains how to manage the use of concurrent-offline licenses. This scenario shows you the different aspects
involved in concurrent offline license management, for example:
Once this phase has been completed, you are now ready to extract the offline licenses to the laptop.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 192
Warning: if you are using ENOVIA LCA or ENOVIA 3d com, these product brands use concurrent licenses only: nodelock licenses are not
supported. This means that, although nothing stops you physically from extracting licenses for these brands, the extracted licenses will be
useless. Consequently, do not extract concurrent-offline licenses for ENOVIA LCA or ENOVIA 3d com.
On the Laptop
The following dialog box appears, listing the concurrent offline licenses located on the license server:
Before you extract the license, you can reset the license duration to extract the license for a lower duration than the one authorized. To
do so, click the appropriate field, then click it again and enter a new value (30 days maximum).
In certain cases, you may attempt to set a value greater than the value registered for that license on the LUM server. You will be
informed if this is the case, and must reset an appropriate value accordingly.
If the LUM administrator set a password, you must enter the password. Even if you select several licenses for extraction, there will still
be only one password. After validation, the license(s) is(are) extracted.
You cannot extract a license if the same license already exists as a nodelock license (either standard nodelock or offline nodelock) and
with the same serial number, if applicable.
Let's assume that you want to extract a license for the MD2 configuration which you have installed on your laptop. Note that you can
extract several licenses if required.
6. Select the license MD2, then click the Extract button.
A message popup will confirm that the license was successfully extracted. You can then click the OK button in the message box. Once
the license has been extracted, it is no longer available on the license server for network users. The new status of the license can be
tracked on the license server using the Basic License Tool.
Extracting an offline license creates the nodelock file on your laptop, or updates it if it already exists. If you select the File->Read
command, you will see the offline license for MD2:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 193
Offline nodelock licenses are identified in blue when listed using the Nodelock Key Management tool.
7. To test that you can use the license offline, disconnect the laptop from the network.
8. Start a Version 5 session.
Check that you are using a nodelock license by selecting the Tools->Options... command, then the Licensing tab.
If you were using a network license beforehand, the request for this license is still stored in your licensing settings. Consequently, at
this point, the License Manager will inform you that the requested license is not available (you are now disconnected from the network)
and prompt you to select the offline license and restart.
Once you have finally displayed the Licensing tab, you will then see the following (note that the tab does not specifically identify the
license as an offline nodelock license, but as a Local license):
You can now use your license for the duration specified when it was extracted. Once that duration has expired, the license will no longer
be available.
You may also return the license before the expiry date.
9. To do so, reconnect the laptop to the network, then make sure that the LUM client is correctly configured and points to the machine
running the LUM 4.6.7 license server to which you are going to return the license.
10. Select the Start->Programs->CATIA V5R14 (or ENOVIA_DMU_Navigator V5R14, or DELMIA V5R14)->Tools->Nodelock Key
Management V5R14 command.
11. Using the Nodelock Key Management tool, select the File->Restitute command.
Note that you can return more than one offline license.
12. Select the license, then click the Restitute button.
A message popup will confirm that the license was successfully returned. You can then click the OK button in the message box. Once
the license has been returned, it becomes available once more on the license server for network users.
The status of the license can be tracked on the license server using the LUM Basic License Tool.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 195
If you need to install the complete LUM package, and if you want to set up a network license server, you
can install the rest of the product from the LUM CD-ROM accompanying the software to avoid having to
download the software over the Internet.
Additional information about LUM may be found at:
http://www.software.ibm.com/is/lum
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 197
Designing the network licensing environment requires careful thought and planning. Consequently, we
strongly recommend that you read the following sections in the manual Using License Use Management
Runtime for your platform:
● Chapter 2 "Planning Your Network Licensing Environment": note that before starting, you must
determine whether you want to use direct binding or namespace binding. For more information about
what this means, read the section "Selecting a Type of Network Binding". For reliability reasons, we
strongly recommend that you use direct binding.
● the section "Setting Up Your Servers and Clients", in particular "Scenario 3: Configuring a Network
License Server" in the chapter "Getting Started with License Use Management Runtime".
A cluster is a set of active servers configured to communicate with each other through direct binding
mode. In this mode, several workstations serve licenses and others are in reserve ready to take over
from an unavailable server.
For more information about clusters, refer to the manual Using License Use Management Runtime for
your platform: section "Planning Clusters" in Chapter 2 "Planning Your Network Licensing Environment"
For more information about configuring clusters, refer to the manual Using License Use Management
Runtime for your platform: section "Administering High-Availability Licensing", "Scenario 11: Creating
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 198
and Administering a Cluster" in Chapter 4 "Getting Started with License Use Runtime".
Note that if you wanted to set up a mixed Windows and UNIX cluster, LUM 4.5.9 or higher is required.
1. Log on as root onto the workstation on which the network license server is to be configured.
i4cfg
On all UNIX platforms, the license server can be configured using a script. To do so, type the command:
i4cfg -script
and in response to the first question, select 3, then answer the questions when prompted.
9. Run the command:
i4cfg -start
i4cfg -list
You are now ready to enroll your licensed products and register the licenses using the Basic License Tool.
For detailed information and a scenario explaining how to enroll licensed products and register the
licenses, refer to the sections "Performing Basic Administration", "Scenario 6: Managing a Licensed
Product", in the chapter "Getting Started with License Use Runtime" in the manual: Using License Use
Management Runtime for your platform.
If you suspect that the license server database has been corrupted, we recommend that you run the
following LUM command
i4blt -C
You need to install License Use Management Runtime on at least one client.
Refer to the section "Setting Up Your Servers and Clients", in particular "Scenario 4: Configuring a
Network License Client" in the chapter "Getting Started with License Use Management Runtime".
1. Log on as root onto a workstation to be configured as client, and on which you installed License Use
Management Runtime.
i4cfg
On all UNIX platforms, the license server can be configured using a script. To do so, type the command:
i4cfg -script
and in response to the first question, select 1, then answer the questions when prompted.
7. Run the command:
i4tv
to check that the server is up and running, and that the client can communicate with the server.
The configuration creates the i4ls.ini configuration file in:
● C:\Documents and Settings\All Users\Application Data\IBM\LUM (on Windows 2000/XP)
● /var/ifor/ (AIX)
● /opt/lum/ls/conf/ (HP-UX, IRIX, Solaris).
To configure the other clients, simply copy this file to a directory on each client and reference the
variable IFOR_CONFIG with this directory: you do not need to install License Use Management Runtime
on each client. The same file can be used on Windows and UNIX.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 201
For compatibility reasons, if the i4ls.ini configuration file is not located in:
C:\Documents and Settings\All Users\Application Data\IBM\LUM
after migrating to Windows 2000, it may also be located and accessed in the following folders and in the
following order:
C:\ifor\ls\conf, then C:\Winnt.
If you migrated your machine from Windows NT to Windows 2000, and the target ID of your computer is no longer
recognized, use the regedt32 command and delete the following registry entry:
However, you should be aware of the following situation which might occur when using HAL clusters.
In this example, let's suppose you have one license on a 3-server HAL cluster. A CATIA client requests the
license, and the license is granted by the first server.
The next time that CATIA connects to the license server to check that it is still up and running, CATIA
displays several warning messages because it is not certain that the license can be acquired or not on
another server in the cluster.
The license is then granted by the second server and CATIA goes on.
After the first server shuts down, another CATIA client on another machine may request the same license
from the server which has shut down. The same license is then granted to this client by the second
server. The next time that CATIA connects to the license server to check that it is still up and running,
CATIA displays several warning messages then exits, because the license is already granted to the second
CATIA.
This problem is due to the fact that the second server knows that the first server is down, but doesn't
take into account the licenses granted by the first server. If this was the case, the second CATIA process
wouldn't start, the same license wouldn't be granted to two CATIA processes, and the first CATIA process
wouldn't exit.
In both cases, the messages which appear are insignificant, and should be ignored.
These problems are due to the way in which HAL was originally designed.
Servers that are members of a HAL cluster share license availability information, but not license usage
information. Consequently, the other servers do not know that a certain license was in use on the server
that went down, consider this license as available, and grant it to the first client that requests it.
HAL was not designed to share this type of license usage information among all the servers in a cluster.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 203
Managing Environments
What Is An Environment?
Customizing Your Environment on Windows
Customizing Your Environment on UNIX
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 204
What Is An Environment?
What is an Environment?
An environment is a set of runtime environment variables. Each variable points to a path searched by the
software when you start a session.
All Version 5 product lines share the same environment management mechanism.
For example, on Windows, the CATDocView environment variable is set by default to:
meaning that the online documentation files are installed in the folder C:\Program Files\Dassault
Systemes\B14doc. When you want to access the online documentation, the software will look for the files
in this location.
The term environment also includes its graphical representation, in other words how it is represented to
the user on the user's desktop.
On Windows, for example, the environment is created in a text file located by default in:
You can also specify during the installation procedure the location of environment files on both Windows
and UNIX.
Global environments can only be created, edited or deleted by a Windows administrator, or the root
userid on UNIX.
A user environment is visible to and can be used and manipulated (customized or deleted) only by the
user who created it.
● using the catiaenv command (Windows) or CATIAENV command (UNIX) to run the Environment
Editor, a GUI-based tool which creates, edits and deletes environments
● using the setcatenv command: this command creates and edits user and global environments (if you
are administrator or root, you can edit the default global environment)
● using the delcatenv command: this command deletes environments
● using the lscatenv command (to list the names of environments)
● 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.
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 (UNIX only)
● delete environments
CATIA
The environment editor belongs to the common suite of Version 5 administration tools. All the different examples in this
section procedure step you through the customization of a CATIA environment, for illustration purposes. The steps are
the same for customizing DELMIA, ENOVIA DMU Navigator, ENOVIA LCA and ENOVIA 3d com environments.
You can also start the environment editor by running the command:
\install_folder\intel_a\code\bin\catiaenv
When an environment in the list is selected, click the right mouse to display a contextual menu of environment manipulation commands.
The Mode field indicates one of two possible values:
● User: indicates that the environment was set up using your userid, is visible to you and can only be accessed by you (you cannot see
anybody else's user environments)
● Global: indicates that the environment was set up by somebody belonging to the Administrators group, or who has the privileges
assigned to the Administrators group (you can see all the global environments on your computer): this is what you will see after an
initial installation on your computer.
This means that you will only see in the Environment name list the names of environments you created, or which are common to all
users. You can only edit environments which belong to you. Furthermore, if you select a global environment as end user, you will be
able to display an environment, but not edit it.
The Last Modified field specifies the date and time the environment was last modified.
The Environment storage directories area displays the current storage location for both global and user environments. This setting is the
location you specified during installation.
2. To reset environment storage directories, select the
Options->Set User Storage Directory or the Options-
>Set Global Storage Directory command to display a file
explorer, then explore your filetree to select the directory,
and click OK.
You can use the storage directory settings to filter the list of
environment names and types displayed. For example, if you
created both global and user environments in the same user
storage directory, selecting the user storage directory will
now only display the user environments, and not the global
environments.
3. To display the variables for any environment, click the environment name.
For example, click the CATIA.V5R14.B14 environment which is the name of the default global environment set up at installation.
This will be the only environment name in the list after a default installation. However, once you create new environments, these will
also be displayed in the list.
For example, the default path for the CATDocView variable is:
However, you may have installed the online documentation in a different folder.
5. If you are authorized to edit the variable, click the variable value to be able to edit it, then type in the new value.
For example, you would type in the new path for the variable CATDocView. The value of the variable is reset in the Environment
Variables field.
6. Click OK.
CSIDL Values in Environment Variable Paths
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 211
There are a number of folders that are used frequently by applications, but may not have the same name or location on any given
system. For example, the system folder may be "C:\Windows" on one system and "C:\Winnt" on another. CSIDL values provide a
unique system-independent way to identify these special folders.
Consequently, CSIDL values are now part of paths pointed to by environment variables. The variables concerned are:
● CATUserSettingPath
● CATTemp
● CATReport
● CATErrorLog
● CATMetasearchPath
● CATW3PublishPath
The TMP and TEMP variables pointing to the current temporary file path on your computer are not necessarily activated.
The DSKEY_TMPDIR key points to the current temporary file path on your computer which is obtained as follows:
The software does not verify that the directory specified by the TMP or TEMP environment variables exists. The temporary file path is
obtained as follows:
CATIA
The type can be user or global (global is available only for administrators only). If you are logged on as a normal end user, the type is
set automatically to "user".
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 212
6. Set the product line by choosing your product line from the list:
CATIA
7. Check the "Server" option if the environment is to be a server-type environment. This concerns ENOVIA_LCA and ENOVIA_3d com
only.
8. Check the "Add Desktop Icon" option if you want to create a desktop shortcut and an entry in the appropriate Version 5 location of
the Start->Programs menu.
9. Check the "Overwrite existing environment" option to overwrite an existing environment.
10. Click OK to create the environment.
where "user" is "All Users" for a global environment, or "myuserid" for a user environment.
CATIA
2. Select an environment and click Yes to confirm you want to modify it.
3. Select the Environment->New from... command to display the following dialog box:
The type can be user or global (global is available only for administrators only). If you are logged on as a normal end user, the type is
set automatically to "user".
8. Set the product line by choosing your product line from the list:
CATIA
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 213
9. Check the "Add Desktop Icon" option if you want to create a desktop shortcut and an entry in the appropriate Version 5 location of
the Start->Programs menu.
10. Check the "Overwrite existing environment" option to overwrite an existing environment.
11. Click OK to create the environment.
where "user" is "All Users" for a global environment, or "myuserid" for a user environment.
CATIA
2. To display the variables for any environment, click the environment name and confirm that you want to modify it.
3. Without selecting a variable, right-click on the variable list to see the contextual commands:
● New Variable
● Delete Variable
● Edit Variable
4. To create a user-defined variable, select the New Variable command to display the Variable Editor dialog box:
and enter the variable name, its value, and a comment if required, then click OK.
5. To delete a user-defined variable, select the variable, then select the Delete Variable command, then click Yes to delete the variable.
Note that you can delete only user-defined variables created using the New Variable command, and not official variables.
6. To edit any variable, select the variable, select the Edit Variable command to display the Variable Editor dialog box:
then enter its new value and click OK. Note that the variable name and comment field are not available if you are modifying an official
variable. However, the name, value and comment are editable if you are editing a user-defined variable only.
7. Do not forget to save your changes by selecting the Save command, also in the contextual menu.
\install_folder\intel_a\code\bin
setcatenv
is as follows:
● -e: environment file name; if the "-e" option is not specified, the name of the environment created will be "DefaultEnvironment"
● -d: specifies an existing directory in which the environment file will be created (it does not create the directory if it does not exist);
if you do not specify "-d", the environment will be created in:
where "user" is "All Users" for a global environment, or "myuserid" for a user environment
● -p: specifies the installation folder, and is mandatory if the "-u" or "-k" options are not specified (by default, it is set to the default
installation folder: C:\Program Files\Dassault Systemes\B14)
● -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.
Furthermore, a server type environment is always a global type environment, without a desktop representation, and always
overwrites an existing environment with the same name. 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.V5R14.B14
creates the new environment MyNewEnv from a copy of CATIA.V5R14.B14.
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).
Behavior Options
These options determine a type of behavior:
● -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").
● -tools: sets up the Tools menu containing the Environment Editor V5R14, Nodelock Key Management V5R14, Settings
Management V5R14, Software Management V5R14 and Settings Management commands.
This is an exclusive option: run this command once like this, without other options:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 215
setcatenv -tools -cs MyProductLine
● -desktop yes/no: sets up the desktop representation of the environment, if it does not already exist. The default is "yes".
Equivalent to "-icone yes" "-menu yes".
● -icone yes/no: creates a startup icon on the desktop; default is "yes"
● -menu yes/no: creates a startup icon in the Start menu; default is "yes"
Action Options
These options specify a particular creation or modification action:
● -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.
● -u: updates a variable by adding a new value for the variable (the previous value is kept, but is concatenated with the new value:
the new value is read first)
● -k: updates a variable by providing a new value for the variable (there is no concatenation: the previous value is overwritten). If
both the "-p" and "-u" options are specified at the same time, an environment is created then modified by "-u" and "-k".
Note that the "-u" and "-k" options will no longer be supported as such in future releases: the functions performed by these options
will continue to exist, but will be integrated in a different way in future administration tools. Keep this point in mind if you write your
own administration scripts which encapsulate current administration tools using these options.
● -h: displays help.
The catenv.log log file logs environment creation and modification operations. The log file is created in the temporary folder in one of
the following locations:
Creating an environment using the setcatenv command sets up the following environment:
● sets up Start->Programs menu by adding the shortcut for your environment
● and creates the shortcut for your environment on the desktop.
If you create a new environment, you can start a session using the new environment with the command:
delcatenv
● -e: environment file name; if the "-e" option is not specified, the name of the environment deleted will be "DefaultEnvironment"
● -d: specifies the directory containing the environment; the default is CSIDL_APPDATA\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: if it exists, deletes its graphical representation, in other words, how it is represented to the user on the user's desktop
(desktop shortcut, shortcut in Start menu, etc.). The default is "yes".
● -tools: deletes the Tools menu containing the Environment Editor V5R14, Nodelock Key Management V5R14, Settings
Management V5R14, Software Management V5R14 and Settings Management commands.
This is an exclusive option: run this command once like this, without other options:
delcatenv -tools
● -cs [CATIA|ENOVIA_DMU_Navigator|ENOVIA_LCA|DELMIA|ENOVIA_3d_com]: specifies the product line whose desktop
tools you want to delete; the default is CATIA.
● -v yes/no:
❍ -v yes (default): verbose mode
❍ -v no: non-verbose mode
● -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.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 216
● -h: displays help.
Keep in mind that deleting an environment using the delcatenv command deletes all the registry entries.
lscatenv
● -a user/global: lists user or global environments. You must specify one or the other.
● -d: specifies the directory containing the environment; the default is CSIDL_APPDATA\CATEnv.
● -h: displays help.
readcatenv
chcatenv
If the path includes blanks, include the whole string in " ".
● -new: creates a new user-defined variable (specified by the "-var" option) with its corresponding value
● -del: deletes a user-defined variable
● -comment "text": adds a comment only to variables you created; the text must be added between " "
● -h: displays help.
Examples
Running this command... Displays this:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 217
readcatenv -e CATIA.V5R14.B14 -a global CATInstallPath=C:\Program Files\Dassault Systemes\B14\intel_a
CATDLLPath=C:\Program Files\Dassault
Systemes\B14\intel_a\code\bin
CATICPath=C:\Program Files\Dassault
Systemes\B14\intel_a\code\productIC
CATCommandPath=C:\Program Files\Dassault
Systemes\B14\intel_a\code\command
CATDictionaryPath=C:\Program Files\Dassault
Systemes\B14\intel_a\code\dictionary
CATDocView=C:\Program Files\Dassault
Systemes\B14\intel_a\doc
CATReffilesPath=C:\Program Files\Dassault
Systemes\B14\intel_a\reffiles
etc....
The feedback obtained when using all the administration commands from the command line is now output to the current command
prompt window.
Each time you use one of the configurations, your licensing settings are stored in the same place. This means that when you start
"Configuration 1", acquire the corresponding license, then exit your session, your licensing settings are saved. When you start
"Configuration 2", your previous licensing settings are retrieved, so you must acquire the new license. Each time you exit, the previous
licensing settings are overwritten by the new licensing settings.
This means that, when you use different configurations alternately, you have to continually reacquire the corresponding license each
time you start.
You can avoid this problem by editing each environment. Let's assume that the two configurations are installed on an Intel computer
running Windows, and that you are authorized to edit each environment. The two variables of interest are:
● CATReferenceSettingPath
● CATUserSettingPath
In the default environments created, let's assume each variable has the following values:
Environment 1
Environment 2
Note that, for the moment, the path pointed to by CATUserSettingPath is the same in both cases. Your licensing settings are saved here
each time you use a configuration.
1. Select the Start->Programs->MyProductLine->Tools->Environment Editor V5R14 command,
CATIA
2. Edit "Environment 1" and reset the value for the CATUserSettingPath variable as follows:
● aix_a
● hpux_b
● irix_a
● solaris_a.
The Environment Editor appears. The user interface and functions are the same as on Windows. For more
information, refer to the Windows description of the Environment Editor.
● aix_a
● hpux_b
● irix_a
● solaris_a.
setcatenv
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 220
is as follows:
● -e: environment file name ; if the "-e" option is not specified, the name of the environment created
will be "DefaultEnvironment"
● -d: specifies an existing directory in which the environment file will be created ($HOME/CATEnv by
default); the directory is not created
● -p: specifies the installation directory, and is mandatory (by default, set to the default installation
directory: /usr/DassaultSystemes/B14)
● -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. Furthermore, a server type environment is always a
global type environment, without a desktop representation, and always overwrites an existing
environment with the same name. 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.V5R14.B14
creates the new environment MyNewEnv from a copy of CATIA.V5R14.B14.
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).
Behavior Options
These options determine a type of behavior when creating or updating environments:
● -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.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 221
The default is "yes", except on IRIX where the default is "no".
Action Options
These options specify a particular creation or modification action:
● -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.
● -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 Version 5 documents.
This option creates the following files for the CDE Desktop:
❍ $HOME/CATEnv/CATCDE/CATIA/dt/appconfig/types/C/CATIAFiles.dt (action description file for
CATIA document types)
❍ $HOME/CATEnv/CATCDE/CATIA/dt/appconfig/icons/C (contains icons for document types)
❍ $HOME/CATEnv/CATCDE/CATIA/dt/appconfig/types/C/CATIA.dt (CDE desktop)
and the following files for the Magic SGI Desktop on IRIX:
CATIA.V5R14.B14.txt
Global environment:
GLOBAL1.txt
The name of this environment is specified by using the "-e" option
User environment:
USER1.txt
The name of this environment is specified by using the "-e" option.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 222
The setcatenv command creates in your $HOME directory the following filetree:
$HOME/CATEnv/CATCDE/MyProductLine/dt/appconfig/appmanager/C/MyProductLine
Contains files required for graphic representation of the default global environment and global
environment in the CDE desktop:
CATIA.V5R14.B14
GLOBAL1
$HOME/CATEnv/CATCDE/MyProductLine/dt/appconfig/types/C
Action description file for default global environment and global environment icon:
CATIA.V5R14.B14.dt
GLOBAL1.dt
CATIA.dt
CATIAFiles.dt
(file created by the option -regserver)
$HOME/CATEnv/CATCDE/MyProductLine/dt/appconfig/icons/C
CATIA
$HOME/.dt/appmanager/My_MyProductLine
USER1
$HOME/.dt/types
USER1.dt
Note: the files "MyProductLine.dt" are not present in this directory because they are already present in
$HOME/CATEnv/CATCDE/MyProductLine/dt/appconfig/types/C.
$HOME/.dt/icons
The MyProductLine icons are not present in this directory because they are already present in:
$HOME/CATEnv/CATCDE/MyProductLine/dt/appconfig/icons/C
CATIA.V5R14.B14
My_MyProductLine : USER1
Note
You do not see the icon immediately. To display the icon, you must click the Application manager icon on
the CDE front panel, go into the Desktop Tools cabinet, then double-click the Reload Applications icon.
You can also log off and log on to display the icon.
The visible impact on the CDE desktop in the Application manager cabinet is:
● the creation of the MyProductLine directory and the creation in these directories of the default global
environment icon and global environment icon:
MyProductLine.V5R14 - GLOBAL1
● the creation of the My_MyProductLine directory and the creation in this directory of the user
environment icon: USER1
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 224
The setcatenv command creates in your $HOME directory the following filetree:
$HOME/CATEnv/CATSGI/MyProductLine
Files required for graphic representation of default environment, global and user environment in the SGI
desktop:
CATIA.V5R14.B14
GLOBAL1
USER1
$HOME/CATEnv/CATSGI/MyProductLine/.ftr
$HOME/CATEnv/CATSGI/MyProductLine/.fti
The MyProductLine icon files are not present in this directory because they are already present in:
/usr/lib/filetype/install/iconlib
The files in the /.ftr and /.fti directories are only created if the desktop integration was not successful:
these directories allow the administrator to perform the integration manually.
/usr/lib/filetype/install
Dassault_Systemes.CATIAFiles.ftr
(created by the option "-regserver").
Dassault_Systemes.CATIAEnvironments.ftr
(created by the option "-regserver")
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 225
/usr/lib/filetype/install/iconlib
CATIA
You do not see the icon immediately. To display the icon, you must log off and log on. The visible impact
on the SGI desktop in File->Applications is:
● the creation of the MyProductLine directory and the creation in these directories of the default global
environment icon and global environment icon:
CATIA V5R14
- GLOBAL1
● creation of the My_MyProductLine directory and the creation in this directory of the user environment
icon
● aix_a
● hpux_b
● irix_a
● solaris_a.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 226
The full list of options for the command:
delcatenv
is as follows:
● -e: environment file name; if the "-e" option is not specified, the name of the environment deleted will
be "DefaultEnvironment"
● -d: specifies the directory containing the environment file to be deleted ($HOME/CATEnv by default)
● -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: 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".
● -cs [CATIA|ENOVIA_DMU_Navigator|ENOVIA_LCA|DELMIA|ENOVIA_3d_com]: specifies the
product line whose desktop tools you want to delete; the default is CATIA.
● -v yes/no:
❍ -v yes (default): verbose mode
❍ -v no: non-verbose mode.
● -unregserver: unregisters Version 5 in the CDE Desktop and the Magic SGI Desktop on IRIX, and
deletes the appropriate desktop files set up by the "-regserver" option. The effect is that dragging and
dropping of Version 5 documents inside the desktop environment, and the behavior associated when
double-clicking Version 5 documents, are deactivated.
This option must be used on its own like this:
delcatenv -unregserver
and once only on a given workstation because it unregisters all Version 5 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 Version 5 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 Version 5 documents, etc.)
will work: this behavior is common to all Version 5 applications, and was deactivated when
unregistering.
If you have only one Version 5 installation, first unregister Version 5, then delete the runtime
environment and finally remove the code.
The "- unregserver" option can be used only by an administrator (root).
For more information, refer to Enabling User Access to the Software Over the Network.
● -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.
● aix_a
● hpux_b
● irix_a
● solaris_a.
The full list of options for the command:
lscatenv
is as follows:
● -a user/global: lists user or global environments. You must specify one or the other.
● -d: specifies the directory containing the environment
● -h: displays help.
● aix_a
● hpux_b
● irix_a
● solaris_a.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 228
The full list of options for the command:
readcatenv
is as follows:
● aix_a
● hpux_b
● irix_a
● solaris_a.
The full list of options for the command:
chcatenv
is as follows:
CATVariable = new_path
CATVariable = $CATVariable: new_path
CATVariable = new_path:$CATVariable
If the path includes blanks, include the whole string in " ".
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 229
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
● -del: deletes a user-defined variable
● -h: displays help.
Examples
Running this command... Displays this:
(where "OS_a" varies for the UNIX platform)
./catstart -run "readcatenv -e CATInstallPath=/usr/Dassault
CATIA.V5R14.B14 -a global" Systemes/B14/OS_a
CATDLLPath=/usr/Dassault
Systemes/B14/OS_a/code/bin
CATICPath=/usr/Dassault
Systemes/B14/OS_a/code/productIC
CATCommandPath=/usr/Dassault
Systemes/B14/OS_a/code/command
CATDictionaryPath=/usr/Dassault
Systemes/B14/OS_a/code/dictionary
CATDocView=/usr/Dassault
Systemes/B14/OS_a/doc
CATReffilesPath=/usr/Dassault
Systemes/B14/OS_a/reffiles
etc....
The feedback obtained when using all the administration commands from the command line is now output
to the current command prompt window.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 230
All of these products can install, by default, a runtime environment in the same location. If you run a tool
using the catstart command without specifying which environment you want to use, the last environment
installed will be executed.
Consequently, make sure you use the "-env" option to specify which runtime environment you want to
run.
where "myenv" is the environment for your product, and "mytool" is the tool you are running.
For example, if you want to run the VPMPeopleEdit tool, which is an ENOVIA LCA tool, use a command like
this:
Managing Software
Committing and Rolling Back Service Packs
Getting Information About Installed Software
Checking Integrity and Prerequisites
Getting System Information
Using Software Management Tools in Batch Mode
Setting Up Batch Monitoring Using the Communications Backbone and MQSeries
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 232
After installing a service pack, you may want to spend some time using the service pack for validation
purposes, before making it officially available to your end users. "Committing" a service pack means
applying the service pack to your installation, so that it becomes the official working level. This deletes
the previous level, thereby saving disk space.
After spending some time using the service pack for validation purposes, you may find that the service
pack is not suitable. If this is the case, you can "roll back" the service pack: rolling back a service pack
uninstalls the service pack, and restores the software level to the level prior to installing the service
pack.
As explained in Getting Information About Installed Software, you can identify at any time the level of
software on your computer.
On Windows
1. Log on as an administrator.
You must belong to the Administrators group, or have the privileges assigned to the Administrators
group.
2. Select the Start->Programs->MyProductLine->Tools->Software Management V5R14
command, where "MyProductLine" is:
CATIA
install_root\code\bin\CATSoftwareMgt.exe
where "install_root" is the name of your installation folder which is, by default:
If no service packs are installed, the tab will inform you that no service packs are installed.
However, if a service pack is detected, the tab will inform you exactly what you can do.
For example, the following tab informs you that "Service Pack 1" has been installed after a GA
installation.
Depending on the results of your validation, you may decide to commit the service pack, or roll back to
the previous level.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 233
4. Click the Commit button to commit the service pack, or the Rollback button to uninstall the service
pack and restore the previous level.
Keep the following rules in mind when committing and rolling back service packs:
● if you install a GA level, then "Service Pack 1", and then intend to install "Service Pack 2", you must
commit "Service Pack 1" before installing "Service Pack 2"
● let's assume you install a GA level, then "Service Pack 1", and commit the service pack; if you then
add configurations or products to your installation, you will be prompted at the end of the
installation to reinstall "Service Pack 1"; when you reinstall "Service Pack 1", the service pack is
committed automatically.
You can also choose to commit a service pack automatically during service pack installation. The
consequences of choosing to automatically commit a service pack at installation are:
● the service pack overwrites any previous level (GA or service pack): if you have already decided to
commit the new service pack, and you do not want to keep the previous version, this allows you to
save disk space
● once you have automatically committed the service pack, you cannot roll back to the previous level
(GA or service pack)
● when you add products after automatically committing a service pack, the new software is also
automatically committed.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 234
If running processes are detected in the installation directory when you choose the Rollback option, you
will be prompted to kill running processes.
On UNIX
1. Logon as root.
● aix_a
● hpux_b
● irix_a
● solaris_a.
The Dassault Systemes Software Management dialog box is displayed, and the General tab is open.
3. Click the Service Pack Management tab, and proceed as explained for Windows (see above).
You do not need to be an administrator to obtain information about installed software: this capability is available to all
users.
On Windows
1. Select the Start->Programs->MyProductLine->Tools->Software Management V5R14 command, where
"MyProductLine" is:
CATIA
install_root\code\bin\CATSoftwareMgt.exe
where "install_root" is the name of your installation folder which is, by default:
Service Pack Level: identifies which service packs (SPK) have been installed (under certain conditions, more than one
service pack may be installed). If no service packs have been installed, the "Service Pack Level" field specifies:
No Service Pack
Installation Path: specifies the installation folder for the specified build level.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 236
If a service pack has been installed, the Service Pack Level field will specify the service pack level, and the last service
pack level that was committed. Note that you can have several service packs installed on your computer.
For information about what committing and rolling back a service pack means, refer to Committing and Rolling Back
Service Packs.
2. Click the Installed Software tab.
The installed configurations and/or products are listed.
On UNIX
1. Log on as root or end user.
● aix_a
● hpux_b
● irix_a
● solaris_a.
The Dassault Systemes Software Management dialog box is displayed, along with the General tab containing the same
options as on Windows (see above).
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 238
You do not need to be an administrator to obtain information about installed software: this capability is available to all
users, and at any time.
On Windows
1. Select the Start->Programs->MyProductLine->Tools->Software Management V5R14 command, where
"MyProductLine" is:
CATIA
install_root\code\bin\CATSoftwareMgt.exe
where "install_root" is the name of your installation folder which is, by default:
The message:
Integrity is OK
Integrity is KO
appears, your installation has been corrupted (for example, some files are missing), it will be followed by troubleshooting
information helping you to identify the problem.
When running a level 3 integrity check on a remote computer from a Windows client, a read error may occur on several
files due to a saturation problem.
The problem may be resolved by deactivating the cache of the network redirector on the client computer, by modifying the
following registry key as follows:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Lanmanworkstation\parameters
Data: 0
Please exercise extreme caution when editing the registry. It is only recommended for advanced users with the proper
authorization: deactivating the network cache may cause the computer's performance on the local network to deteriorate.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 240
3. Click the Check Prerequisites tab.
This simply checks if you still have the prerequisite environment required for your product line to operate:
Clicking the "Certified Configurations" button opens the Hardware Certification section of the www.catia.com website
containing a list of certified hardware configurations.
On UNIX
1. Log on as root.
● aix_a
● hpux_b
● irix_a
● solaris_a.
The Dassault Systemes Software Management dialog box is displayed, and the General tab is open.
3. Click the Check Integrity or Check Prerequisites tab.
CATIA
install_root\code\bin\CATSoftwareMgt.exe
where "install_root" is the name of your installation folder which is, by default:
The Dassault Systemes Software Management dialog box is displayed, and the General tab is open.
2. Click the System Information tab.
● machine target id
● locale
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 242
● hostname, processor, physical memory, paging space
● display and video settings
● operating system level
Windows
UNIX
● aix_a
● hpux_b
● irix_a
● solaris_a.
-I1: Checks integrity - Level 1 (only control files are checked): quickest
-I2: Checks integrity - Level 2 (checks existence of all installed files)
-I3: Checks integrity - Level 3 (checks existence and validity of all installed files ): this may
take several minutes.
● -C/-R: performs service pack commit or rollback; you must be administrator to use these options
(see Committing and Rolling Back Service Packs)
%TEMP%\CATSoftwareMgt.log (Windows)
C:\TEMP\CATSoftwareMgt.log
$HOME\CATSoftwareMgt.log
If you do not specify the " -o" option, the output will be displayed on the screen on both
Windows and UNIX.
● -D: dumps system information to the output log file (see Getting System Information). This option is
only available on Windows.
● -killprocess: detects running processes (for example, Orbix) in the installation folder
(unload_dir/code/bin) and prompts you to kill them if you decide to rollback the service pack using
the "-R" option: if you do so, running processes will be killed, if not, the service pack will not be rolled
back. Do not forget to restart the processes afterwards.
● -h: provides help on arguments.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 245
For information about how to run the batch monitor and submit batches in both local and remote modes,
refer to Using the Batch Monitor in your Infrastructure Users Guide.
The CATIA, DELMIA and DMU Navigator core software features the CATUTIL batch monitor for running
and monitoring Version 5 batches. Certain batches are provided as part of the Version 5 core package,
others are part of specific configurations/products. Note that certain batches can only be run if you have
the corresponding license.
You can run the batch monitor using a variety of methods to launch the batches installed with your
software. The batches can be:
● run locally on the machine on which you are using the batch monitor
● or submitted to a remote machine to be run on the remote machine.
● with the first implementation, the batch monitor requires no external software as a prerequisite since
it can work using the communications backbone packaged with the core Version 5 software described
in Communications Backbone Files; the backbone is used for both local and remote batch execution
● if you install and configure the IBM MQSeries Version 5.2 product, you will be able to run and monitor
batches on both your local computer and remote computers:
❍ using the batch monitor in Version 5
❍ or using the MQSeries command line syntax
The batches can be either those provided with the Version 5 core software, or your own customized
batches.
So that each batch can be listed and recognized, a descriptor file is delivered for each batch on Windows
in:
/usr/DassaultSystemes/B14/OS_a/resources/batchdesc
● aix_a
● hpux_b
● irix_a
● solaris_a.
The descriptor file must NOT be modified by the batch monitor administrator.
The syntax of the parameter file for each batch is provided in an empty file.
The person who runs the batch must fill in this XML file to specify the inputs to be passed to the batch.
If the batch is submitted using the CATUTIL interactive batch tool, the file is generated from the user
input specified by using the batch user interface.
A list of Version 5 batches along with their description is displayed in the Type column. This list may vary
according to the licenses you set up during installation:
● Batch-DXF-IGES-STEP: lets you exchange data between Version 5 and DXF, IGES/STEP
● ExtractModelFromSequential: lextracts CATIA Version 4 models from CATIA Version 4 sequential
files
● MigrateV4ToV5: converts CATIA Version 4 models into Version 5 documents
● CATDUAV5: uses the CATIA Version Data Upward Assistant allowing support for Version 5 level
changes, diagnostics and, if required, repairing of Version 5 data
● Data Life Cycle: provides a user interface and capabilities common to all batches dealing with data
life cycle, i.e. CATDUAV5, Downward Compatibility and Extract Model From Sequential
● DownwardCompatibility: lets you reuse Version 5 data, created in the most recent release, in an
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 247
earlier release
● UpdateBatch: lets you update a list of CATDrawing documents
● PrintBatch: lets you print your documents without running Version 5.
Note that not all batches can be run on a remote machine! Furthermore, documents containing links to
other documents (for example, CATProducts) cannot be processed in remote batch mode.
In Local Mode
To submit batches for execution on your local machine using the communications backbone, no
administration tasks are necessary: the backbone is the default communication driver. The batch will be
run as long as the required license is available.
In Remote Mode
● the Version 5 core software containing the communications backbone must be installed
● the configuration installed on the remote machine must allow end users to run the desired batch
● a license for the appropriate configuration must be either installed on the remote machine, or be
accessible from the remote machine
● you must start the backbone server monitor, as explained in Configuring the Communications
Backbone on the Remote Machine.
In Local Mode
If you want to run batches on your local computer, you have to install the IBM MQSeries Server software
on the local computer and then configure the MQSeries server on the local computer.
In Remote Mode
If you want to run batches on a remote computer, you have to install the IBM MQSeries Client software
on your local computer and configure the client, then install the IBM MQSeries Server software on the
remote computer and then configure the server.
To allow end users to run a batch on a remote machine, you first have to start the server monitor on the
remote machine.
On Windows
On UNIX
On Windows
1. Log onto the server computer as administrator.
C:\Program Files\MQSeries\bin
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 249
set MQSNOAUT=yes
For more detailed information about the role of the MQSNOAUT variable, refer to the manual IBM
MQSeries System Administration, Chapter 10 : "Protecting MQSeries objects".
5. Create a queue manager for the hostname of your server computer by entering the command:
crtmqm HostNameMachine
strmqm HostNameMachine
7. Configure the queue manager by entering the command:
where "ConfigFile" is the path of the following file located in the Version 5 installation directory and
installed with the Version 5 software:
The presence of messages in the queues will prevent a batch from being run.
On UNIX
1. Log onto the UNIX workstation as root.
Refer to the IBM MQSeries documentation for more details. For example, you will find the Quick
Beginnings manual very useful if you are using IBM MQSeries for the first time.
For the purposes of our scenario, we installed the IBM MQSeries Server software on a workstation
running AIX.
Refer to the manual MQSeries V5.2 Quick Beginnings for your UNIX platform for more information.
In particular, pay attention to the kernel configuration. MQSeries makes use of semaphores, shared
memory, and file descriptors, and it is probable that the default kernel configuration is not adequate.
Refer to the section Kernel configuration in the manual MQSeries V5.2 Quick Beginnings for your UNIX
platform for more information.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 250
After installation, the mqm user ID owns the directories and files that contain the resources associated
with the product.
If you want to run any administration commands, for example crtmqm (create queue manager) or
strmqm (start queue manager), your user ID must be a member of group mqm.
4. To configure the server, open a shell window and enter the command:
su mqm
and provide the password mqm when prompted. Using this user ID will now let you perform MQSeries
administration tasks.
5. Before creating the queue manager, export the following variable:
export MQSNOAUT=yes
For more detailed information about the role of the MQSNOAUT variable, refer to the manual IBM
MQSeries System Administration, Chapter 10 : "Protecting MQSeries objects".
6. Create a queue manager on your workstation by entering the command:
crtmqm HostNameMachine
strmqm HostNameMachine
8. Configure the queue manager by entering the command:
where "ConfigFile" is the path of the following file located in the Version 5 installation directory and
installed with the Version 5 software:
/usr/Dassault Systemes/B14/aix_a/resources/batchdesc/CATBatchMQ.conf
If you encounter an error (execution code other than 0) when running the runmqsc command, you will
not be able to run any batches. If this is the case, please contact your IBM MQSeries Administrator.
9. Run the channel listener:
10. Before running a batch, check that the queue manager you created earlier is running, and that there
are no messages present in existing queues.
The presence of messages in the queues will prevent a batch from being run.
On Windows
Set the MQServer variable as follows:
set MQSERVER=CATBATCHANNEL/TCP/Hostname_server
where "Hostname_server" if the name of the client computer on which you installed the IBM MQSeries
Server software.
On UNIX
Export the MQServer variable as follows:
export MQSERVER=CATBATCHANNEL/TCP/Hostname_server
where "Hostname_server" if the name of the client computer on which you installed the IBM MQSeries
Server software.
Furthermore, on UNIX, make sure that you read the information in this section about certain UNIX
system files which need to be modified:
● /etc/services
● /etc/inetd.conf
On Windows
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 252
where MyParameterFile is the path of an existing XML parameter file saved, for example, by running the
batch monitor in interactive mode in a Version 5 session.
C:\Temp
You can monitor the batch queues by selecting the command Start->Programs->IBM MQSeries-
>MQSeries Explorer.
On UNIX
To run a batch, go to the following Version 5 installation folder, for example:
/usr/DassaultSystemes/B14/aix_a/code/bin
where MyParameterFile is the path of an existing XML parameter file saved, for example, by running the
batch monitor in interactive mode in a Version 5 session.
/tmp
However, note that before starting Version 5 on the local computer configured as an MQSeries client, you
must export the following variable to specify that you are using IBM MQSeries:
export CATBATCHMQ=1
You can also run batches on a remote computer: the IBM MQSeries Client is on your local computer, and
the IBM MQSeries Server is on a remote computer.
The client machine and the server machine on which the batch is to be run must both have Dassault
Systemes Version 5 software installed.
On the server machine, the batch server monitor is started. This monitor starts the batches installed on
the server submitted from any client. The monitor waits for batch launch requests and must be stopped
manually.
The batch server monitor is started once and for all, whereas the client monitor is started once for each
batch submitted.
Windows
and enter the following command to run the batch monitor server:
CATBatSvrMonitorExe MQ
UNIX
/usr/DassaultSystemes/B14/aix_a/code/command
and enter the following command to run the batch monitor server:
/usr/DassaultSystemes/B14/aix_a/code/command
Managing Settings
About Settings
Locking Settings
Resetting Default Settings
Detailed Scenario Illustrating Concatenation and Inheritance Mechanisms
Administrating Data Using the DLName Mechanism
Importing and Exporting Settings Files to/from XML Format
This section concerns only the CATIA, DELMIA and ENOVIA DMU Navigator product lines.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 256
About Settings
Version 5 creates two types of data:
● application data contained in the documents you create
● setting files which are non-editable.
● temporary settings
● permanent settings.
Permanent setting files store customization you perform mainly using the various tabs provided by the Tools->Options...
command. For example, application window customization, background colors, part and print settings, etc.
Permanent setting files are identified by the suffix: *.CATSettings, and are created in a location referenced by the
CATUserSettingPath variable.
Deleting either types of files deletes your customization.
You specify settings using the Tools->Options... command which displays the Options dialog box:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 257
The left-hand column contains a list of categories used for organizing the different groups of settings. There are general settings for
all configurations and products, and settings for each type of configuration installed. The category names are the same as those
listed on the Start menu.
To access the settings for a specific configuration, click the "+" to display the subcategories. Clicking on the subcategory displays
the settings tabs for that subcategory.
CATOptionsMgt
If you have several runtime environments on your computer, you can select the environment by entering the following command:
This function is useful for administrators because it allows you to set up user settings without having to start an interactive session
first.
On UNIX
If you have several runtime environments on your computer, you can select the environment by entering the following command:
The mechanism used is the CSIDL value mechanism. This implementation allows:
● your permanent settings (CATSettings) to roam as part of your user profile (CSIDL_APPDATA)
● your temporary settings (CATTemp, etc.) to be still stored in the user profile, but prevents them from roaming
(CSIDL_LOCAL_APPDATA).
The following table will help you determine where your settings are located:
Windows 2000/Windows XP
Variable Location
CATUserSettingPath C:\Documents and Settings\user\Application Data\DassaultSystemes\CATSettings
CATTemp C:\Documents and Settings\user\Local Settings\Application
Data\DassaultSystemes\CATTemp
CATCache Obsolete
CATReport C:\Documents and Settings\user\Local Settings\Application
Data\DassaultSystemes\CATReport
CATErrorLog C:\Documents and Settings\user\Local Settings\Application
Data\DassaultSystemes\CATTemp\error.log
CATMetasearchPath C:\Documents and Settings\user\Local Settings\Application
Data\DassaultSystemes\CATTemp
CATW3PublishPath C:\Documents and Settings\user\Local Settings\Application
Data\DassaultSystemes\CATTemp
The value:
Concatenation Mechanism
Settings are based on a hierarchical concatenation mechanism.
The Version 5 software provides default values for all settings. This enables you to start a session without any settings files (for
example, if settings have been deleted accidentally). End users can run a session and use the defaults.
Order of Priority
Setting files are stored in directories referenced in the Version 5 runtime environment by the CATReferenceSettingPath and
CATUserSettingPath environment variables:
● CATReferenceSettingPath: points to the directory (or directories) where administrator settings are stored
● CATUserSettingPath: points to the directory where user settings are stored.
When a session is started, the directories pointed to by these variables are searched in the following hierarchical order: all files
found first in the CATReferenceSettingPath, and then in the CATUserSettingPath will be read in this order of priority.
When a session is started, if no setting file is found either in the CATReferenceSettingPath or in the CATUserSettingPath, the setting
value is the default provided by the software.
If settings files have been deleted, an end user will inherit the setting values set by the administrator or the default values provided
by the software.
If there are administrator directories pointed to by CATReferenceSettingPath, and the settings have not been locked, the value is the
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 260
value written in the last administrator's file found in CATReferenceSettingPath, or in the user file found in the CATUserSettingPath.
In this case, the tend user will be able to modify the settings.
If there are administrator directories pointed to by CATReferenceSettingPath, and settings have been locked, the setting value is the
value written in the first administrator directory where this attribute has been locked. End users will not be able to modify the
settings.
For full details about how to start a session in administrator mode for the purpose of locking settings, refer to Locking Settings.
For a fully detailed scenario illustrating how settings are concatenated and inherited, and involving multiple administration levels,
refer to Detailed Scenario Illustrating Concatenation and Inheritance Mechanisms.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 261
Locking Settings
This task explains how to run a session in administrator mode for the purpose of locking settings so that other users running a
session with the same environment inherit those settings and cannot change them.
An administrator can also take advantage of this mechanism to set default settings which, although not locked, are proposed to
users as a starting point.
By default, there is "zero administration" of settings: user settings are stored in the CATSettings environment as explained in About
Settings.
The scenario walks you through a procedure useful for locking settings for users of the default environment created at installation.
This is a useful procedure if you interested in locking settings, but do not want to multiply environments on the same computer.
The scenario described reflects the Windows platform only, but the feature is also supported on UNIX.
Do not confuse running a session in administrator mode (a Version 5 concept) with logging on as administrator (a system concept).
You must belong to the Administrators group, or have the privileges assigned to the Administrators group.
For the purposes of this particular scenario only, you need to log on as administrator because you are going to modify the default
global environment (V5R14).
2. Select the Start->Programs->CATIA->Tools->Environment Editor V5R14 command to display the Environment Editor.
CATIA
3. Click the CATIA.V5R14.B14 environment to display the corresponding environment variables.
4. Locate the following environment variable: CATReferenceSettingPath
CATReferenceSettingPath E:\users\administrator\LockSettings
then click Set, then OK to save and exit the environment editor. This folder will contain the setting locks you will create later. The
folder access rights must be set up for read access only for end users, and read/write for the person creating the setting locks.
6. Run a session in administrator mode using the following command:
or:
cnext -admin
The session is started using the default global environment, and a message informs you that you are running in administration
mode. Click OK in the message box to proceed. If prompted by the License Manager, reserve at least one configuration license then
restart a session.
7. Select the Tools->Options... command.
The "Options" dialog box is displayed. Note that a lock symbol like this appears opposite each option in the General tab:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 262
Pointing the cursor to a lock symbol displays a message indicating the name of the folder/directory containing the lock settings. This
is particularly useful for administrators who need to identify which lock settings are active when the are multiple levels of
concatenated locks.
8. To set the locks, click on one of the appropriate lock symbols.
For example, click the lock symbol for the User Interface Style option:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 263
Because the user interface style was set to CATIA - P2, end users running this environment will not be able to change this setting.
9. Click OK to confirm.
The lock settings are stored in the folder referenced by the CATReferenceSettingPath environment variable you reset earlier.
10. Exit the session.
An end user who starts a session with the normal startup commands (but not the cnext -env CATIA.V5R14.B14 -admin command)
and using the same environment, will see this after selecting the Tools->Options... command:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 264
Because the user interface style was set to "CATIA - P2", end users running this environment will not be able to change this setting
to "CATIA - P1".
End users can customize their own user environments to store their own settings in a location referenced by the
CATReferenceSettingPath environment variable, start a session using the command:
where "myenv" is the name of the user environment, then lock settings in the same way as described in their first scenario. Then,
other end users starting a session on the same computer, with the normal startup commands and using the same environment, will
inherit the locked settings.
If several users set locks in different folders using the same environment, end users of the same environment will inherit all the
locks set by those administrators.
To implement this solution, you must concatenate several CATReferenceSettingPath values as illustrated below:
In this example:
● one administrator (starting in administration mode) locks settings in "Environment 1" at the site level
● on the same site, two administrators (also starting in administration mode) in two different workshops lock settings in
"Environment 2" and "Environment 3" respectively
● users 1 and 2 run a Version 5 session with "Environment 2" and inherit the setting locks in "Environment 1" and "Environment 2"
respectively
● users 3 and 4 run a Version 5 session with "Environment 3" and inherit the setting locks in "Environment 1" and "Environment 3"
respectively.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 266
After changing settings, you may decide to restore the default settings. The Tools->Options... command provides a Reset... button
for this purpose:
6. Use the default option which restores the default settings for the current tab, which in our example is the Visualization tab, then
click the Yes button.
No matter how many times you change settings, you can always restore the default settings using the Reset... button.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 270
The Cancel button is a handy tool for undoing your changes. Access the Visualization tab again to confirm that your changes have
been cancelled:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 272
8. Access the Visualization tab again, click the Reset... button, then the Yes button:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 274
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 275
The locks on C and D are kept, but all the initial setting values for A, B C and D are restored.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 276
1. Using the environment editor, create the environment Admin1 and reset the variable CATReferenceSettingPath so that it points
to an existing folder, for example:
CATReferenceSettingPath E:\users\administrator\LockSettings
then click Set, then OK to save and exit the environment editor.
Environment Admin1 is the top level administration environment containing the reference settings for all other environments that
reference it.
2. Using the environment editor, create the environment Admin2 and reset the variable CATReferenceSettingPath to concatenate
the value for Admin1 and the name of another folder, for example:
CATReferenceSettingPath E:\users\administrator\LockSettings;E:\users\administrator\LockSettings2
then click Set, then OK to save and exit the environment editor.
Note that the separator on Windows is ";", but on UNIX it is ":". Furthermore, there should be no blanks between the separator and
the path string.
3. Start a session using environment Admin1 in administrator mode as explained in Locking Settings.
4. Select the Tools->Options... command, the Display category, then the Visualization tab.
You inherit the settings and locks from environment Admin1. Note that the locked settings are displayed like this: .
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 279
What Happened?
For locks C and D, the settings were already locked - the values are obviously kept.
Consequently, unlike in the case of the scenario in which no locks are used, using the Reset... button in a scenario involving multiple
administrator levels restores (for non-locked settings) the default values set by the higher level administrator environment, and not
the default settings in the software.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 283
The scenario involves one end user and two administration levels, explains what happens when both
administrators successively set, explicitly modify, lock and unlock settings, and describes the impact on
the end user inheriting these settings and who in turn explicitly modifies and resets settings.
We assume before reading this scenario that you are already familiar with the following concepts:
● basic settings concatenation and inheritance mechanisms
● resetting settings
● locking and unlocking settings.
The scenario presents a list of tables containing settings visible to or specified by Administrators 1 and 2,
and visible to or specified by the User.
Legend
Black: unlocked values inherited from the higher administration level, or from software defaults
The settings visible to Admin 1, Admin 2 and User are identical: they are the default values provided by
the software.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 284
When the User starts a session, because the User has not yet explicitly modified Setting 3, the User
inherits directly the new value b3. However, as the user has already explicitly modified Setting 2, the
modification of Setting 2 made earlier by Admin 2 is not visible.
5. The User then resets the settings
Setting
Setting 1 Setting 2 Setting 3 Setting 4
/Level
Default a1 a2 a3 a4
Admin 1 b1 a2 a3 a4
Admin 2 b1 c2 b3 a4
User b1 c2 b3 a4
After the reset, the User immediately sees that the value of Setting 1 is imposed by Admin 1, whereas
the values of Settings 2 and 3 are imposed by administrator 2. The main difference is that, for Setting 2,
the User now inherits the value c2.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 285
6. The User explicitly changes Setting 2 to value d2 and Setting 4 to value b4:
Setting
Setting 1 Setting 2 Setting 3 Setting 4
/Level
Default a1 a2 a3 a4
Admin 1 b1 a2 a3 a4
Admin 2 b1 c2 b3 a4
User b1 d2 b3 b4
7. Admin 2 explicitly changes Setting 1 to value c1, and then locks Settings 1 and 2:
Setting
Setting 1 Setting 2 Setting 3 Setting 4
/Level
Default a1 a2 a3 a4
Admin 1 b1 a2 a3 a4
Admin 2 c1 c2 b3 a4
User c1 c2 b3 b4
The User now inherits the values of Settings 1 and 2 directly: the values are locked so they cannot be
modified.
8. The User resets the settings:
Setting
Setting 1 Setting 2 Setting 3 Setting 4
/Level
Default a1 a2 a3 a4
Admin 1 b1 a2 a3 a4
Admin 2 c1 c2 b3 a4
User c1 c2 b3 a4
The only difference here is that the reset forces the value of Setting 4 to a4, imposed by Admin 2 which
is the administration level directly above.
9. The User again explicitly changes the settings. This time, the User changes Setting 4 back to the value
b4:
Setting
Setting 1 Setting 2 Setting 3 Setting 4
/Level
Default a1 a2 a3 a4
Admin 1 b1 a2 a3 a4
Admin 2 c1 c2 b3 a4
User c1 c2 b3 b4
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 286
10. Admin 2 unlocks Setting 1 and explicitly changes the value to d1:
Setting
Setting 1 Setting 2 Setting 3 Setting 4
/Level
Default a1 a2 a3 a4
Admin 1 b1 a2 a3 a4
Admin 2 d1 c2 b3 a4
User d1 c2 b3 b4
Because the User has not yet explicitly changed (and therefore has not saved) Setting 1 before Admin 2
locked it earlier, the User now inherits the new value d1 from Admin 2 when the setting is unlocked.
11. Admin 2 unlocks Setting 2 and explicitly changes the value to e2:
Setting
Setting 1 Setting 2 Setting 3 Setting 4
/Level
Default a1 a2 a3 a4
Admin 1 b1 a2 a3 a4
Admin 2 d1 e2 b3 a4
User d1 d2 b3 b4
Earlier in the scenario (step 6), the User had already explicitly changed the value of Setting 2 to d2
before Admin 2 locked it. This value was saved. Consequently, because the lock is no longer present, the
User does not inherit the new value e2 from Admin 2 (as in step 10).
In this case, once the setting has been unlocked, the User retrieves the value set in step 6, i.e. d2.
12. The User then resets the settings again:
Setting
Setting 1 Setting 2 Setting 3 Setting 4
/Level
Default a1 a2 a3 a4
Admin 1 b1 a2 a3 a4
Admin 2 d1 e2 b3 a4
User d1 e2 b3 a4
The value of Setting 2 is now reset to e2, and the value of Setting 4 back to a4.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 287
13. The User now explicitly changes the values of all four settings like this:
● Setting 1 is changed to e1
● Setting 2 is changed to f2
● Setting 3 is changed to c3
● Setting 4 is changed to b4
Setting
Setting 1 Setting 2 Setting 3 Setting 4
/Level
Default a1 a2 a3 a4
Admin 1 b1 a2 a3 a4
Admin 2 d1 e2 b3 a4
User e1 f2 c3 b4
14. Admin 1 explicitly changes Setting 1 to the value d1, then locks Settings 1 and 3:
Setting
Setting 1 Setting 2 Setting 3 Setting 4
/Level
Default a1 a2 a3 a4
Admin 1 d1 a2 a3 a4
Admin 2 d1 e2 a3 a4
User d1 f2 a3 b4
Both Admin 2 and the User now inherit the locks and values of Settings 1 and 3, which can no longer be
modified.
15. The User finally resets the settings:
Setting
Setting 1 Setting 2 Setting 3 Setting 4
/Level
Default a1 a2 a3 a4
Admin 1 d1 a2 a3 a4
Admin 2 d1 e2 a3 a4
User d1 e2 a3 a4
The value of Setting 2 is now e2, and the value of Setting 4 is now back to a4.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 288
This allows you to implement a tightly controlled data storage strategy whereby end users will be able to
store data in only those directories referenced by DLNames.
For a full description of how DLNames are created from an end user point of view during an interactive
session, refer to the description of how document environments are set in the section "Customizing
Settings - General - Document" in your Infrastructure Users Guide.
You must belong to the Administrators group, or have the privileges assigned to the Administrators group.
For the purposes of this particular scenario only, you need to log on as administrator because you are
going to modify the default global environment (V5R14).
2. Select the Start->Programs->CATIA ->Tools->Environment Editor V5R14 command to display the
Environment Editor.
CATIA.V5R14.B14
3. Double-click the CATIA.V5R14.B14 environment to display the corresponding environment variables.
4. Locate the following environment variable: CATReferenceSettingPath
CATReferenceSettingPath E:\users\administrator\LockSettings
then save your modification, and exit the environment editor. This folder will contain the setting locks you
will create later. The folder access rights must be set up for read access only for end users, and read/write
for the person creating the setting locks.
6. Run a session using the following command:
or:
cnext -admin
A session is started using the default global environment, and a message informs you that you are
running in administration mode.
7. Click OK in the message box, then select the Tools->Options... command.
Note that a lock symbol like this appears opposite each option:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 291
DLName is now defined as your current document environment as indicated by the "Current" value in the
State column:
Creating DLNames
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 292
Now that you have set the DLName environment as your current environment, you have to create the
DLNames you will use.
10. Click the Configure... button to open the Configure dialog box which lets you add or remove
DLNames:
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 293
11. Click the button or right-click then select the New command once for each new DLName you
want to create.
A default name and a default folder are assigned to each new DLName as shown below:
12. To customize the DLName, click "DLName1", then click again to activate the editor field, type the new
name and press the ENTER key.
When creating DLNames, you can also organize them into a logical tree using Root DLNames. For
more details, refer to the section "Customizing Settings - General - Document" in your Infrastructure
Users Guide.
13. To customize the folders, click C: (Windows) or /tmp (UNIX) in the appropriate column, then click
again to activate the editor field, type the path of the folder and press the ENTER key.
Instead of typing in the editor field, you can also choose a folder by clicking in the field, and selecting the
New contextual command and selecting the folder using the explorer which is displayed.
Note that you can include system or user-defined variables in DLNames using the syntax $ {VARIABLE}:
Example 1
Example 2
Locking a DLName changes its state from "Green" to "Orange" (and inversely when you unlock the
DLName):
The reason why you would want to lock DLNames is to restrict end user access to only those folders
referenced by DLNames. End users running Version 5 using the same environment will inherit the locks
you set on DLNames, and will not be able to either modify or remove them.
15. Add another DLName and name it "CATProducts", lock it using the same procedure as above, then
rename the folders:
End users will not be able to modify or remove DLNames, but will still be allowed to add DLNames. If you
do not want this to happen, lock the list by clicking the green lock symbol to change it to the orange
lock symbol . End users will then see the red lock symbol and will not be able to add DLNames to
the list.
16. When finished adding DLNames to your list, you can then click the Export... button to save your
list of DLNames as an ASCII .txt file.
This is particularly useful when you have a large number of machines. You can then import the .txt file
containing the DLNames onto all the machines so that end users also inherit the same DLNames, as
described in Importing DLName Settings in Batch Mode.
You can make as many lists as you like. Whenever you want to use one of them, just click the Import...
button before selecting a list from the Import dialog box.
17. Click OK to close the Configure dialog box
18. To force end users to use the DLName strategy only, make sure that "DLName" is still "Current", set
Folder to "Not Allowed", click the lock for the Document Environments, then click OK to exit the Document
tab.
DLNames settings are stored in the settings file: DLNames.CATSettings.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 295
1. Log on as an end user, and start a Version 5 session using the normal startup commands, that is,
without using the "- admin" option.
Because your administrator earlier locked the access to document environment selection, and forced the
DLName document environment, instead of the usual File Selection dialog box, the following panel
opens:
The "Look in" pulldown list only contains the DLNames you defined in the previous steps:
● CATParts
● CATProducts.
3. Select the desired File name and type from the list.
4. Click OK to open the document.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 296
5. Select the Tools->Options... command, then the Document tab in the General category.
6. Select the DLName option in the Document Environment list, then click the Configure... button to
display the Configure dialog box:
Note that you cannot delete, modify or rename any of the DLNames in the list.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 297
To do so, you start Version 5 in administration mode, set up the DLNames, then lock them as described
in Setting Up DLNames in Administrator Mode. This also means that you have to export the DLNames to
a .txt file.
● if you have a small number of end users, import the .txt file containing the DLNames (but the
DLNames will not be locked)
● or, use the CATSysDLExport batch: you can write a script using this batch syntax to automate the
process and distribute the DLNames over a large number of machines; the batch provides an option
ensuring that the imported DLNames are locked.
Once the file containing the DLNames has been imported in batch mode, end users must first activate
DLName mode by selecting the Tools->Options... command, then the Document tab in the General
category, then the DLName option in the Document Environment list, and finally by clicking the
Configure... button to display the Configure dialog box.
On Windows
Run the program:
On UNIX
1. Log on as root.
to import file filename with the current DLNames, only in admin mode, and lock all the DLNames in the
file (the option -il is available only in admin mode); a report file is generated to log the encountered
problems
to import the file filename with the current DLNames, either in user mode or in admin mode; a report
file is generated to log the encountered problems
to add the DLName with the values NTPath and UPath for the current real UNIX and Windows path.
Note that the CATSysDLExport command behaves like a standard UNIX or Windows command: names
including blanks should be surrounded by single (' ') or double (" ") quotation marks. Backslashes (\)
should be doubled (\\).
CATSysDLExport -d DLName
to export the current DLNames to the file filename, either in user mode or in admin mode.
The -nocheck option avoids checking the existence of the physical paths and their possible creation.
Notes
● The text file must be suitable for the platform on which the import is to be performed, consequently
with carriage returns followed by a line feed (CRLF) on Windows, and just line feeds (LF) on UNIX.
Therefore, if you use Notepad to create it, use either Windows directly or transfer it in FTP ASCII
mode to UNIX before using it.
● If you import a first file containing, for example, DLName1 and DLName2, then import another file
containing DLName3, the additional DLName3 will be added to the settings, so you will now have
three DLNames to choose from.
● The format of the file to be imported (exported when configuring the DLNames interactively) is like
this:
...
DLName1;C:\MyDLnames;/tmp;
DLName2;E:\AdditionalDLNames;/tmp;
...
where the first part contains the DLName, the second part contains the path on Windows, and the
third part contains the path on UNIX.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 299
● No previously existing DLName will be updated during the import in user mode. These DLNames in
the import file will be skipped, and can be updated only in administrator mode. This means that, for
example, if the first file you import contains DLName2, and the second file also contains DLName2,
but the path for DLName2 is different in the second file from the value in the first file, the path for
DLName2 will be updated in the settings if imported in administrator mode.
● If a previously existing DLName did not have a lock, but is then updated with a lock by using the -il
option, , the settings will be locked.
● For the changes to take effect after importing a file, you have to stop then restart Version 5.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 300
E:\users\ses\CATProducts\Product1.CATProduct
E:\users\ses\CATParts\Part1.CATPart
If you open the document Product1.CATProduct and select the Edit->Links... command, you will see in the "Links" and "Pointed documents"
tabs that the CATProduct document points to the correct CATPart document. For example, this is what you see in the "Pointed documents"
tab:
The path:
E:\users\ses\CATParts\Part1.CATPart
E:\users\ses\CATProducts\Product1.CATProduct
After creating a large number of documents in this way, you may then decide to implement a data storage strategy based on the DLName
mechanism,
However, it is not sufficient to simply create DLNames for all the directories where your documents are stored. Because the path of pointed
documents is stored in the pointing document, you need some way of converting the pathname in the document to the corresponding
DLName.
The CATDLNameMigr batch tool can be used to solve this problem. The batch tool can be used in two modes:
● repair mode: the pointing documents are "repaired", in other words modified to replace the pathname by the correct DLName
● check mode: provides information and generates a text file containing a list of DLNames; the pointing documents are not modified.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 301
install_root\code\bin\CATDLNameMigr.exe
where "install_root" is the name of your installation folder which is, by default:
On UNIX
1. Log on as root.
2. Enter the command:
E:\users\ses\CATProducts\Product1.CATProduct
E:\users\ses\CATParts\Part1.CATPart
To do so, select the Tools->Options... command, then the Document tab in the General category. To make the DLName environment the
current document environment, select "DLName" in the Document Environments column, then select successively the Allowed and Current
buttons.
Then, click the Configure... button and add the two DLNames. You can name them "DLName1" and "DLName2."
E:\users\ses\CATParts
2. Exit the session, then open a Command Prompt window and go to the installation directory, which is by default:
CATDLNameMigr -r E:\users\ses\CATProducts\Product1.CATProduct
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 302
The output displayed in the command prompt window informs you that:
● you chose to run the tool with the "-r" option, so it will attempt to save the file
● it analyzed the file:
E:\users\ses\CATProducts\Product1.CATProduct
and succeeded in modifying it.
E:\users\ses\CATProducts\Product1.CATProduct.CATDLNameMigr_report
4. Restart a Version 5 session, then open the document Product1.CATProduct.
5. Select the Edit->Links... command, then click the "Pointed documents" tab:
The batch tool uses the first DLName it finds in the list, and replaces the path by "DLName1" so the pointed document path is now:
DLName1\Part1.CATPart
Our scenario shows how to repair a single document. To repair all the documents contained in a specific directory, run the command with
the "-d" option followed by the name of a directory. For example, the command:
CATDLNameMigr -r -d E:\users\ses\CATProducts
modifies all the files found in the directory E:\users\ses\CATProducts. The "-d" option can be run in check mode without the "-r" option.
Furthermore, if you do not want to modify the original document, specify the "-p" option followed by the name of a directory. For example,
the command:
runs the tool in repair mode, does NOT modify the original file, but copies it to the directory E:\users and modifies the file in this directory
only. This is useful if you do not want to modify the original file.
For the purposes of this scenario, we are going to use the same documents. But this time, make sure that NO DLNames have yet been
created.
1. Start a Version 5 session, and make sure that no DLNames have been created.
2. Exit the session, then open a Command Prompt window and go to the installation directory, which is by default:
CATDLNameMigr E:\users\ses\CATProducts\Product1.CATProduct
Note that this time, you do not use the "-r" option.
Because you have not yet created a DLName for the path:
E:\users\ses\CATParts
the batch tool cannot replace the path by the appropriate DLName. Displaying the document using the Edit->Links... command will show
that the path has not been modified.
The output displayed in the command prompt window informs you that:
● you have chosen to run the tool in check mode (because you did not specify the "-r" option")
● it could not change the link in E:\users\ses\CATProducts\Product1.CATProduct
● the following file has been created in:
C:\Documents and Settings\user\Local Settings\Temp\CATDLNameMigr_missing-DLNames_report.txt
in which a DLName has been created. The file contains the following line:
DLName1;E:\users\ses\CATParts;/tmp;
The ".txt" file can now be imported, which will allow you to run the tool again later to repair the document.
E:\users\ses\CATProducts\Product1.CATProduct.CATDLNameMigr_report
informing you that the link could not be changed because there was no corresponding DLName.
4. Restart a Version 5 session and import the text file.
To do so, select the Tools->Options... command, then the Document tab in the General category. To make the DLName environment the
current document environment, select "DLName" in the Document Environments column, then select the Allowed button.
Click the Configure... button, then the Import... button, browse to select the file:
DLName1 E:\users\ses\CATParts
Now that you have a DLName, you can run the batch tool using the "-r" option to repair the file.
Command Outputs
Running the command in any of the above modes outputs information to the command prompt window about the tasks processed. This
information can also be obtained using the "-h" option.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 304
CATBatGenXMLSet
CATBatImpXMLSet
Certain attributes in certain settings files, when exported to XML format, cannot be converted to text. The
setting files concerned are:
● FrameConfig.CATSettings
● FrameGeneral.CATSettings
● DLNames.CATSettings (which can only be exported in any case using the CATSysDLExport tool).
This renders these settings files unusable after exporting them to XML format.
On Windows
1. Change to the default folder in which you installed the product.
CATBatGenXMLSet
or:
CATBatImpXMLSet
On UNIX
1. Log on as root or end user.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 305
2. Enter the command:
/usr/DassaultSystemes/B14/OS_a/code/bin/CATBatGenXMLSet
or:
/usr/DassaultSystemes/B14/OS_a/code/bin/CATBatImpXMLSet
● Output_directory: name of the directory where the XML file will be created. Example: /tmp.
● SettingName: name of the CATSettings file (without the .CATSettings extension) that you want to
export to XML format. Example: CATStatistics.
● mode: optional argument, specify -admin in order to run the command in administrator mode, which
has the effect of creating the resulting file in the administrator settings environment. The default
mode is user mode. No extension.
If you want to understand what administrator mode is and what it is used for, refer to How Settings
are Concatenated and Inherited and Locking Settings.
General information about settings is provided in About Settings.
Batch Output
Example
Example of output
Let's say we have a settings file named Example.CATSettings comprising the following attributes:
Note that a size of 0 means that the attribute has not been explicitly modified anywhere in the
concatenation. Its value is also the default value of the code.
● XML_File: path of the XML file to import into the current V5 environment. Example:
/tmp/CATStatistics.xml.
● mode: optional argument, specify -admin in order to run the command in administrator mode, which
has the effect of creating the resulting file in the administrator settings environment. The default
mode is user mode.
If you want to understand what administrator mode is and what it is used for, refer to How Settings
are Concatenated and Inherited and Locking Settings.
General information about settings is provided in About Settings.
Batch Output
The output is a settings file in the user settings repository of the current V5 environment, for example
Statistics.CATSettings.
Example
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 307
CATBatImpXMLSet /tmp/Statistics.CATSettings
General Remarks
After either exporting or importing settings files, a message like this appears confirming the operation has
succeeded:
depending on the case, where "xxx" is the settings file name and "yyy" is the number of attributes.
If the exported file is already present, the previous file will be overwritten.
Certain settings files may be empty. If you attempt to export an empty settings file, the following
message is displayed:
where "xxx" is the settings file name, but the resulting XML file is still generated.
We recommend that you do not edit the XML files manually, since the syntactical coherence of setting files
is guaranteed by the interactive Tools->Options... command.
We advise that you use this export/import facility simply as a means of capturing the state of your
configuration settings at a specific point in time, for the purpose of restoring the same settings for another
configuration.
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 308
Index
Symbols
$CATRealUser environment variable
Numerics
3d com alternative settings server
on Windows
3d com single sign-on
on Windows
A
administrator mode
administrator settings
permanent
temporary
Any License
archive file
B
backbone service
batch monitor
BBDemonService command
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 309
C
CATBatGenXML command
CATBatImpXML command
CATCollectionStandard variable
CATCommandPath variable
CATDefaultCollectionStandard variable
CATDeltaInstall command
CATDictionaryPath variable
CATDLLPath variable
CATDLNameMigr command
CATDocView variable
CATErrorLog variable
CATFeatureCatalogPath variable
CATFontPath variable
CATGalaxyPath variable
CATGraphicPath variable
CATICPath variable
CATInstallPath variable
CATMetasearchPath variable
CATMsgCatalogPath variable
CATNodeLockMgt command
CATNodeLockMgtB command
CATOptionsMgt command
CATReferenceSettingPath variable
CATReffilesPath variable
CATReport variable
CATSharedWorkbookPath variable
CATSoftwareMgt command
CATSoftwareMgtB command
CATStartupPath variable
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 310
CATSysDLExport command
CATTemp variable
CATUserSettingPath variable
CATW3PublishPath variable
CATW3ResourcesPath variable
Certificat.lic file
chcatenv command
installing manually
ClearCoat technology
cnext command
commands
BBDemonService
CATBatGenXML
CATBatImpXML
CATDeltaInstall
CATDLNameMigr
CATNodeLockMgt
CATNodeLockMgtB
CATOptionsMgt
CATSoftwareMgt
CATSoftwareMgtB
CATSysDLExport
chcatenv
cnext
cnext -admin
db2start
delcatenv
ENOCheckVaultLink
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 311
Environment Editor
i4_offline_mig
i4blt
i4blt -C
i4ccmig
i4cfg
i4target (UNIX)
i4target -O
i4tv
KillV5Process
lscatenv
net use
readcatenv
regedt32
rm -rf
runOrbix
setcatenv
Settings Management
setV5Ports
Software Management
start
StartSPKB
VaultClientSetupB
VaultServerSetupB
VaultSetup
communications backbone
CSIDL values
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 312
D
database
setting up DB2
setting up Oracle
DB2INSTANCE variable
db2start command
delcatenv command
Demo mode
distributing code on UNIX
overview
overview
CATDLNameMigr command
CATSysDLExport command
creating
migrating to DLNames
overview
DSKEY_TMPDIR Key
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 313
E
ENOCheckVaultLink command
enoviadbsetup step
global
user
on UNIX
on Windows
environment variables
$CATRealUser
CATCommandPath
CATDictionaryPath
CATDLLPath
CATDocView
CATErrorLog
CATFeatureCatalogPath
CATFontPath
CATGalaxyPath
CATGraphicPath
CATICPath
CATInstallPath
CATMetasearchPath
CATMsgCatalogPath
CATReferenceSettingPath
CATReffilesPath
CATReport
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 314
CATSharedWorkbookPath
CATStartupPath
CATTemp
CATUserSettingPath
CATW3PublishPath
CATW3ResourcesPath
DB2INSTANCE
LD_LIBRARY_PATH
LD_LIBRARYN32_PATH
LIBPATH
list
ORA_NLS33
ORACLE_HOME
PATH
SHLIB_PATH
TNS_ADMIN
USER_HOME
extra products
F
full text server
G
getting information about installed software
global environment
Granted licenses
graph
definition
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 315
importing
H
hardware prerequisites
common
HP-UX
IBM AIX
SGI IRIX
SGI Onyx
Sun Solaris
I
i4_offline_mig command
i4blt -C command
i4blt command
i4ccmig command
i4cfg command
i4tv command
on UNIX
on Windows
additional configurations/products
distributing on UNIX
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 316
distributing on Windows
on UNIX
on Windows
service pack
on UNIX
on Windows
installing online documentation
K
KillV5Process command
L
LD_LIBRARY_PATH variable
LD_LIBRARYN32_PATH variable
LIBPATH variable
License Manager
Any License
Demo mode
Granted
No License
Not Granted
troubleshooting
model
offline licensing
overview
prerequisites
shareable licenses
static licenses
locking settings
concatenating locks
lscatenv command
M
Microsoft Visual Basic for Applications installation
MQSeries
N
net use command
No License
on UNIX
on Windows
O
offline licensing
ORA_NLS33 variable
ORACLE_HOME variable
P
packaging
products
PATH variable
permanent settings
post installation
hardware
software
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 319
R
readcatenv command
regedt32 command
resetting
rm -rf command
runOrbix command
S
service pack
committing
installing
installing on UNIX
installing on Windows
rolling back
setcatenv command
settings
how to specify
location
location on UNIX
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 320
locking
overview
permanent
temporary
setV5Ports command
shareable licenses
shareable products
SHLIB_PATH variable
software management
additional
ClearCoat
client
HP-UX
IBM AIX
licensing
macro capabilities
MQSeries
server
SGI IRIX
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 321
Sun Solaris
start command
StartB command
StartSPKB command
T
temporary settings
TNS_ADMIN variable
U
uninstalling code
on UNIX
on Windows
uninstalling online documentation
on UNIX
on Windows
unregserver
user environment
V
Vault Server
setting up cache
VaultClientSetupB command
CATIA Infrastructure Installation Guide Version 5 Release 14 Page 322
VaultServerSetupB command
VaultSetup command
VPMGRAPHADM tool
VPMPeopleUpdate tool