Unloading Your Product Code on Windows

This task explains how to unload the CATIA Version 5 code from scratch on a single computer running a supported Windows operating system and set up your nodelocked licenses.

If you want information about subjects such as:
  • installing Version 5 on several computers
  • setting up network licensing

refer to Distributing Code and Licensing.

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, 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.

Installation Log

An installation log will be created in the current temporary directory, in one of the following locations:

  • The path specified by the TMP environment variable
  • The path specified by the TEMP environment variable, if TMP is not defined
  • The path specified by the USERPROFILE environment variable, if TEMP is not defined

in a file named:

cxinst.log

If not created in any of these locations, it will be created here:

C:\cxinst.log

The following line is added at the beginning of the installation log:

64-bit installation of PRODUCT_LINE on Windows

where PRODUCT_LINE is the name of the product line you are installing.

 

How To Display the DSLS Computer ID of Your Computer

You must run DSLicTarget tool first. This tool is located either in the root of your media or in the code\bin folder of your installation path.

For example, you can run the command:

DSLicTarget -t

To know more about the syntax, please see the  DSLicTarget Command Syntax of the Dassault Systemes License Server User's Guide.

The Computer ID of your computer is also displayed:

  • at the top of the License Manager dialog box, access via the Tools > Options... command when running the application
  • by the Nodelock key Management tool, from the 
    Start > Programs > CATIA > Tools menu.

 

Installing the Version 5 Files

  1. Mount the physical media or download it.
  2. Start the setup.exe.

    If you have downloaded the media, the setup.exe will be located in the folder 1.

    If required, setup will install “Microsoft Visual C++ 2017 Redistributable (x86)” and “Microsoft Visual C++ 2017 Redistributable (x64)”.

  3. Click Next to move to the next step.

    The Choose Destination Location dialog box appears. The default destination folder:

    WindowsInstallPath

    is the same if you are installing:

    • 32-bit code on Windows
    • 64-bit code on Windows.

    However, if you are installing 32-bit code on Windows, the default destination folder is:

    WindowsInstallPathx86

    Note that the next level folder for 32-bit code on Windows is still:

    WindowsInstallPath\intel_a

    but if you are installing 64-bit code on Windows, the default destination folder is:

    WindowsInstallPath\win_b64

    However, if you are installing 32-bit code on Windows, the default destination folder is:

    WindowsInstallPathx86\intel_a

    Note: Throughout this guide, the installation path will be described as:
    WindowsInstallPath\win_b64 (64-bit code, x64 Edition)
    WindowsInstallPathx86\intel_a (32-bit code, x64 Edition)

  4. If the default destination folder is suitable, click Next to move to the next step, or click Browse... 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.

    Installing Several Identical Releases in Different Locations on the Same Computer

    Providing you have enough disk space, you can install several identical releases in different locations on the same computer. 

    For example, you may want to install the same VersionNumber GA release in two places. Your first installation could be, for example, the production version. Then, once a VersionNumber 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 VersionNumber and DELMIA VersionNumber 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:

    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:

    • in the environment name
    • in the appropriate registry entries
    • in the Start > (All) Programs > MyProductLine menu, and new entries for the corresponding tools are created in the Start > (All) Programs > MyProductLine > Tools menu
    • in the Add/Remove Programs control.

    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.

  5. Click Next.

    The Choose Environment Location dialog box appears.

    A default destination folder is already proposed:

    C:\ProgramData\DassaultSystemes\CATEnv
     

  6. If the default folder is suitable, click Next to move to the next step, or click Browse... and navigate to select another folder and click OK.

    The Select Directory  dialog box appears.

    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.

  7. Click Next.

    The Setup Type dialog box appears.

    This dialog box lets you specify whether you want to install all of the software on the media, 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.
       
  8. 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.

    The Install Language-Specific File and Fonts dialog box appears.

    Check the options to install the user interface files for the appropriate language(s) and/or to install language-indexed fonts. Uncheck the options 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 the disk space.

    The following language-indexed fonts are all installed by default:

    • 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 get a message when opening the document, saying that the font is missing and that it will be replaced by another font.

    To avoid this problem, we recommend that you check Language-indexed fonts option.

    If you uncheck Language-indexed fonts, only SICH.font, TRCH.font , KANJ.font, KOHG.font and SSS4.font are installed. The Russian font is not removed.

    Note: The options you select during installation is definitive. You cannot add or remove languages or fonts later when installing additional configurations and/or products.
     

  9. Click Next to move to the next step.

    The Select Software dialog box appears.

  10. 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 media.

  11. 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:

    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.

  12. Click Next.

    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.

    For more information, refer to Extra Products.

  13. Click Next.

  14. If your configuration requires you to configure Orbix, the Choose Orbix Configuration dialog box appears.

    Keep the default values as is it for Orbix.

    Note: 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 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.

  15. Click the Next button to move to the next step.

    Server Timeout

    The Server Timeout Configuration dialog box is displayed if your configuration uses servers run by the server manager.

    This value corresponds to the duration in ms after which the server exits if it has not been contacted by the associated client.

    You enter a value in minutes, then 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. The default value is 60 mn. The value can be increased up to 35.700 mn (1 month). The value can be decreased down to 2 mn. The increment is 1 mn.

    This behavior is valid for all servers run by the server manager: ENOVIAV5VPM, 3dcom, and the settings server for example.  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.

    You can customize this value by editing the SERVER_TIMEOUT parameter in the appropriate file after the installation and setting it to a value different from the default one (1 hour).

    Modifying Server Timeouts

    This task explains how to modify the timeout of the ENOVIAV5VPM, 3d com and Settings servers. Note that the Settings server is common to both ENOVIAV5VPM and 3d com.

    To control the timeout of all servers globally, add the following line:

    set SERVER_TIMEOUT=<value in milliseconds>

    to the beginning of the file:

    $install_path\code\command\runServerManager

    Note: The default value is 3600000 milliseconds. The maximum value is 2142000000 milliseconds.

    All processes started by the server manager then inherit the same environment.
     

  16. Click Next.

    The Vault Client Configuration dialog box is displayed.

    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 PLMDBSetup 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 ENOVIAV5VPM brand.

    For more detailed information about the vault, refer to Installing Vault Servers and Clients.

  17. Check the appropriate option if you want to set up the vault client at the end of the installation.
     
  18. Click Next.

    The Choose Communications Ports dialog box is displayed.

    This allows you to set up on your computer:

    • a port reserved for the communications backbone process
    • a port reserved for starting the communications backbone process automatically
    • a port reserved for processing events when using peripheral devices (spaceball, spacemouse, joystick).

    By default, the Set up communication ports option is selected because it is strongly recommended.

    A backbone daemon is created as a service and started. You can monitor the daemon by selecting Start > 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. The installation setup then 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 > Control Panel > Administrative Tools command and selecting the Services control.

  19. Click Next to move to the next step.

    The Shortcut Creation dialog box appears.

    This dialog box gives you the choice whether to create:

    • a startup icon on the desktop
    • a startup shortcut in the Start menu
    • entries in the Start menu for the administration tools.

    Not installing the desktop shortcuts allows you to minimize the number of registry entries during the installation.

    Check the appropriate options.

    The Select CATIA VersionNumber Documentation dialog box appears.

  20. Select 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.

    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 media and insert the first documentation media.

  21. Clicking Next displays the Start Copying Files dialog box.

    The central area lists the current settings you set in the previous steps:

    • configuration and product names and documentation
    • destination folder.

    Note: 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 media. 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.

  22. Click Install 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.

    Warning: During the installation, and depending on the configuration, an Orbix daemon may be installed and a Server Manager is registered on the daemon. On Windows systems, and specifically machines running Windows, this call can trigger a Windows Security alert, giving a registered domain name on the machine, because it is occurring on a non-HTTP port with an unknown application. The connection is harmless for client systems. However, the installation may not terminate successfully.

    What typically happens is that the Windows Security Alert  dialog box appears. Select the checkbox Domain networks, such as a workplace network and click Allow access.

    If this is the case, click the Unblock button to continue the installation.

    Furthermore, when you start the application, if the Windows Security Alert dialog boxes appear for CATIA or ENOVMetaSearch (if you enabled the metasearch proxy), click Unblock again to continue.

    To prevent this problem from occurring, you can deactivate the Windows Firewall. For instructions about how to deactivate the firewall, refer to the Microsoft documentation.

    The Setup will install automatically Microsoft Visual Basic for Applications (VBA).

  23. If you indicated earlier that you want to set up a vault client, the Vault Client Setup dialog box appears.
  24. Click Add... to display the Vault Client Setup - Add dialog box.
  25. Specify the Vault alias name, server hostname and Orbix daemon port, then click OK.

    This information is added to the VaultClient.properties file.

    The Vault Client Setup dialog box is now updated showing the vault alias name (entered in the Vault Client Setup - Add dialog box) under Vault servers catalogued, and the characteristics showing the given Server hostname and Orbix daemon port.

  26. Use the Modify... and Delete... to modify or delete the selected configuration.

    For more detailed information about the vault, refer to Setting Up Vault Servers and Clients.

  27. Click the Close button to continue.

    Installing the Online Documentation

    Once the files have been copied, and only if you decided to install the online documentation, the Enter Documentation media dialog box appears.
     

  28. Click Next to install the documentation.

    If you have several online documentation medias (one for each supported language), you can only install one of these medias 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.

    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 media.
     

  29. If you still want to install the online documentation, remove the product media from the drive, insert the first online documentation media 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 C:) on the computer from which you are performing the installation.

    Modifying this path is useful if:

    • you already inserted the online documentation media into another drive
    • you copied the online documentation files from the online documentation media to a folder. The advantage of installing from a folder is that you will not be prompted to change medias if the documentation you are installing is distributed on several medias.

    If this is the case, click the Browse... button and specify the appropriate drive or folder. Select the folder named "disk1" and click OK.

    The Welcome dialog box appears.

     

  30. Click Next to proceed.

    The Code Installation Folder dialog box appears.

    If CATIAProductLine is not installed, make sure that the CATIA P3 is not installed is checked before proceeding.

    If CATIAProductLine is installed, check the CATIA P3 is installed and enter the installation path, or click Browse... and navigate to select the path:

    The Existing installation folders field lists the code installations detected on your machine.
     

  31. In both cases, click Next to proceed.

    The Choose Destination Location dialog box appears.

    The default folder in which the documentation in English will be installed is:

    WindowsInstallPathdoc\English
     

  32. Click Browse... to select a new folder if the default folder is not suitable, or click Next to proceed.
  33. The default folder in which the documentation in English will be installed is:

    WindowsInstallPathdoc\English

    Click Browse... to select a new folder if the default folder is not suitable.
     

  34. Click Next to proceed.

    The Select Documentations dialog box appears.

    If CATIA has been installed, the setup program detects which products are installed. Move the scrollbar up or down to see the manuals.

    If CATIA P3 has not been installed, all the manuals in the list will be preselected:

    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.

    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.

    At this stage, you can:

    • deselect manuals in the list
    • select additional manuals in the list
    • toggle the All / Nothing button to select either all documentation or no documentation respectively
    • press Reset to return to the original list of preselected manuals.
  35. Once your selection is final, to install the documentation click Install.

    The Start Copying Files dialog box appears listing the online documentation you are about to install.

    A progress bar is displayed.

    Depending on your product line, the online documentation may be provided on a suite of up to six medias. Once the documentation files on the first media have been installed, and depending on which products you selected, you may be prompted to insert the next media. In this case, click OK to continue the installation until you have inserted the last media.

    Note: You must install all the documentation medias. For example, you cannot install only one out of two. If you click Cancel before installing the final media, the documentation files previously installed will be uninstalled.

    If you interrupt the installation, the documentation files will be uninstalled automatically. If the un-installation has already started, the message:

    Uninstallation is running. Please wait...

    appears. It will disappear once the un-installation is completed. So you must wait for the end of the un-installation before trying to reinstall the documentation.

  36. Once the online documentation files have been copied, the Setup Complete dialog box informs you that the installation has been completed:

    If you have already installed documentation for several 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, for example:

    Dassault Systemes Doc English CATIAProductLine P3 B28

    Note: Installing the online documentation updates the path of the CATDocView environment variable using the online documentation installation path.

  37. To exit the documentation installation phase, click Finish.

    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. To do so, click Finish.

  38. To restart, leave the default setting "Yes, I want to restart my computer now" and click Finish 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 Finish. 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 Finish, this time to start a Version 5 session now.

  39. After restarting, you must then relog onto the computer using the same administrator logon, then start Version 5.

 

Importance of Setting IT_LOCAL_DOMAIN Variable for ENOVIAV5VPM

The IT_LOCAL_DOMAIN variable located (in a default installation) in the files:

install_path\startup\orbix\orbix3.cfg
install_path\startup\orbix\config\common.cfg

references the network domain in which the machine is operating. For any networked machine, this variable should have a value. This value is determined by system calls at during the automatic post-installation phase, reading the value from the registry on Windows, for example.

The local domain value which is queried during installation is written in both file locations orbix3.cfg and config\common.cfg. When manually submitted, this value must be included in both files.

As specified in the Orbix documentation, both the CATIA client and the ENOVIA server in the context of an ENOVIA V5 VPM installation must reference the same IT_LOCAL_DOMAIN value in order to be able to communicate correctly. If not, the CORBA communication cannot be guaranteed to occur without error. Moreover, when the post-installation process is running, an error occurs when the network domain can not be determined. This information concerns Orbix 3.0.1 and Orbix 3.3.

 

Installing Multiple Versions of Version 5 on the Same Computer

You can install several levels of Version 5 on the same computer, for example V5R16 and VersionNumber.

However, all 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 V5R17 level, then work on the VersionNumber level, VersionNumber will be able to read and use your V5R17 settings. However, working first on VersionNumber then on V5R17 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 V5R17 after VersionNumber, then V5R17 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