Installing ENOVIA Live Collaboration Server

This topic describes how to install ENOVIA Live Collaboration Server software.

This task shows you how to:

Before you begin:

The ENOVIA Live Collaboration Server machine must have access to an ENOVIA Live Collaboration database. This means that the following are prerequisites:


  • Database client software—Refer to the Program Directory for the given release and Guidelines for Installing ENOVIA Supported Databases (PDF file).

    Note: For Oracle, some settings in the Oracle server configuration file (init<SID>.ora) may need to be adjusted when ENOVIA Live Collaboration Server is in use. Refer to "Oracle Parameter File: init<SID>.ora" in Guidelines for Installing ENOVIA Supported Databases for details.

  • A connection (bootstrap) file that points to an ENOVIA Live Collaboration Server database. You can use the included MQL executable to create a connection file after installation, if necessary.
  • Optionally, ENOVIA ENOVIA Studio Modeling Platform to assist with troubleshooting. However, it is not recommended to use the ENOVIA Live Collaboration Server frequently as a ENOVIA Studio Modeling Platform client. (MQL is included with the ENOVIA Live Collaboration Server on both Windows and UNIX).
  • As ENOVIA Studio Modeling Platform is no longer a required component, the MX_CLASSPATH environment variable in the enovia.ini file (in the SERVER_INSTALL\PLATFORM\code\bin\ directory) must be prefixed with the server install path, which is SERVER_INSTALL\managed\properties;SERVER_INSTALL\PLATFORM\docs\javacommon;SERVER_INSTALL\PLATFORM\docs\javaserver;SERVER_INSTALL\PLATFORM\docs\custom;

As the ENOVIA Live Collaboration Server can provide global access to an ENOVIA Live Collaboration database, potentially handling a much greater number of users, be sure to have the appropriate number and types of user licenses in your License Agreement. Users defined as "Full" can access the database through the ENOVIA Live Collaboration Server, as well as ENOVIA Studio Modeling Platform applications. On the other hand, "Application" users are allowed access only through MQL or applications that use the ENOVIA Live Collaboration Server. Refer to the Business Modeler Guide for information on the types of ENOVIA Live Collaboration Server users.

Related Topics
Installing a Live Collaboration Server Hot Fix
Preparing to Install the ENOVIA Live Collaboration Server
Configuring the ENOVIA Live Collaboration Server

Start the Live Collaboration Server Setup Program on UNIX/Linux

Before you begin:

Before installing the ENOVIA Live Collaboration Server software on UNIX/Linux you must:


  • Create an ENOVIA user and group. It is actually recommended to create two new user accounts, for example, enoinstall and enorun. The enoinstall account would "own" all of the Tomcat and ENOVIA Live Collaboration Server directories and files. It would grant execute permission to the enorun account so that it can start/stop Tomcat. It would also provide read/write permissions to the log/, work/, mxcache/, and temp/ directories.
  • Mount the CD so the operating system software can access the files contained on the disk. See "Mounting the CD," below, for examples of mount commands for each platform.
  • Make sure you know:
    • For Oracle, the path to where your tnsnames.ora file is located.
    • For DB2, the path to where DB2 is installed, and the DB2 instance name.
    • The path where the Application Server is installed, and the name of the startup script.
    • The path to the JDK.
  • Follow your OS instructions for automatic startup of mxrmirc services.

  1. Copy the MEDIA_NAME.tar.gz file, where MEDIA_NAME is the name of the media for your platform (for example, ENOVIALiveCollaborationServer-VERSION.RHEL64), from the CD or ENOVIA Download page to the distribution directory.

  2. Untar the MEDIA_NAME.tar.gz file to a temporary directory. Change to the MEDIA_NAME/1/ subdirectory. 

    % cd /MEDIA_NAME/1

  3. Run the setup script as follows:


    • GUI mode:
      ./StartGUI.sh
    • For details on using console mode or silent mode, see the ENOVIA Installer Guide.

Continue with Complete the Live Collaboration Server Installation.

Mounting the CD

If you are installing from CD on UNIX/Linux, you must mount the CD drive so that the operating system software can access the files contained on the disk.

  1. Insert the ENOVIA Live Collaboration CD for your platform into a local CD drive. If a local drive is not available, consult your operating system administrator's guide.

  2. Create a "mount point" directory for the CD drive with the command: mkdir /cdrom.

  3. Mount the CD. Below are some examples of the commands for various hardware and software platforms:

    Platform Example of Mount Command
    SPARCstation mount -F hsfs -r /dev/dsk/c0t6d4so /cdrom
    SUN (Solaris4/x86) mount -F hsfs -o ro /dev/lofi/1 /mnt
    IBM RS6000 mount -v cdrfs -r /dev/cd0 /cdrom
    Linux (RHEL and SUSE) mount -o loop file.iso /mnt

Start the Live Collaboration Server Setup Program on Windows

Before you begin:

Before installing ENOVIA Live Collaboration Server software on Windows you must:


  • Install a qualified Application Server (or other Web server, if you will not be using the servlets or will only be setting up Web Navigator) and ensure that it is operational.
  • Make sure you know:
    • The path where the Application server is installed and the name of the startup script.
    • The path to the HTTP server's document root directory.
    • The path to the JDK.

ENOVIA Live Collaboration Server installation on Windows may optionally be executed multiple times when more than one database will be accessed via one WebLogic server.

The MQL executable is installed together with the ENOVIA Live Collaboration Server software on Windows.

  1. Log into Windows as a user with Administrator privileges.

  2. Copy the MEDIA_NAME.zip file (for example, ENOVIALiveCollaborationServer-VERSION.Windows64, where VERSION is the software version to be installed), from the CD or ENOVIA Download page to a temporary directory.

    When transferring .zip files from the internet, executable files may be silently excluded when unzipping due to Windows security behaviour. To avoid this, before unzipping the file, right click in the file, select Properties, then click Unblock.

  3. Unzip the MEDIA_NAME.zip file to a temporary directory. Change to the ENOVIA_CSR.media\1\ subdirectory. 

    > cd \ENOVIA_CSR.media\1

  4. Run the setup script as follows:


    • GUI mode:
      setupV6.exe
    • For details on using console mode or silent mode, see the ENOVIA Installer Guide.

Continue with Complete the Live Collaboration Server Installation.

Complete the Live Collaboration Server Installation

  1. Specify the directory where the ENOVIA Live Collaboration Server software should be installed. The default path is displayed.

    UNIX/Linux:

    If you want to change the location, click Browse and select the desired path. This will become the SERVERHOME/ directory.
    Windows:

    If you want to change the location, click Browse and select the desired path. This will become the SERVER_INSTALL\ directory.

    Click Next to continue.

    Note: Setup does not check for the existence of a previous version. If a previous version exists, the software must be installed to a new location. The installation directory path may not include any spaces. The installation directory must also be different from the distribution directory.

  2. Select the components you want to install. The default option is "CSR - ENOVIA Live Collaboration Server".

    If you want to cancel the installation at this point, click Cancel.

    Otherwise, click Next to continue.

    Note: On UNIX, a white check box means that an item is selected.

  3. Specify the Java Home path. This is the location of your Java Development Kit (JDK). The default location is displayed.

    You can use the JDK installed by the Application Server or a higher version, if your custom Java programs require it. There cannot be any spaces in the path or the install will fail, as this will cause problems during deployment.

    The JDK you specify is used to configure Java for applications deployed by your Application Server (except WebSphere) and non-Application Server based applications. If you are using WebSphere, see "JDK Notes" in Installing a Web or Application Server before specifying your JDK.

    If using RIP mode, enter the path to Java that the Application Server uses.

    Note: Incorrect Java home path selection may abort the installation without a message indicating the reason for the failure. Failing to provide a 64-bit JDK for a 64-bit install will also cause the installation to abort.

    If you want to change the location, click Browse and select the desired path.

    Click Next to continue.

  4. Choose the database type. Only those database types that are supported on your particular platform are displayed.

    Note: If your platform supports multiple types of databases, Oracle is the default.

    Depending on the OS, the available database options could be any of the following:

    UNIX/Linux Options Description
    Oracle and DB2 Choose this option to be connected to either an Oracle or a DB2 database.
    Oracle only Choose this option to be connected to an Oracle database.
    Windows Options Description
    Oracle

    Choose this option to be connected to an Oracle database.
    Others

    Choose this option to be connected to any other type of database.


    • If you select Oracle, the Oracle Instant Client software is installed automatically. This software is distributed together with the Platform software, which means that you do not need to install the Oracle client software separately.
    • If you select DB2, you will be asked to enter the DB2 product directory and the DB2 Instance Name. The default instance name on UNIX is db2inst1, which you can change.

    Select the desired database type.

    Click Next to continue.

  5. If you selected Oracle, enter the location of the TNS_ADMIN directory. This is the directory where your tnsnames.ora file is located. The default path is displayed.

    Note: On UNIX/Linux, setup cannot detect the correct Oracle path. Incorrect Oracle path selection may abort the installation without any message indicating the reason for the failure.

    If you want to change the location, click Browse and select the desired path.

    Click Next to continue.

  6. Read and accept the terms in the Oracle Instant Client End User License Agreement.


    • Select I have read and accept the license terms to acknowledge that you accept the license terms.
    • Select I do not accept the license terms if you do not accept the license terms. This will cancel the installation.

    Click Next to continue.

  7. Enter the directory of your connection (MATRIX-R ) file. The default path is displayed.

    Note: If a connection file exists in the specified directory, you receive a confirmation message saying Matrix bootstrap exists. If a connection file does not exist in the specified directory, setup displays a warning message instructing you to copy a valid connection file to that location. Installation can continue without a valid connection file, but the ENOVIA Live Collaboration Server will not be able to run without one.

    If you want to change the location, click Browse and select the desired path.

    Click Next to continue.

  8. Select one of the following deployment options, based on the Application Server you are using:

    Option Description
    J2EE (build EAR and WAR archives) Select this option to use any of the supported Application Servers. If you intend to install advanced search on a dedicated machine, this option is required. Refer to "Running the WAR utility on Windows" in Installing and Configuring Live Collaboration Administration and Toolkits.
    None (Collaboration Kernel only) Select this option if you intend to use custom ENOVIA Studio Customization Toolkit applications that do not use the Servlets. In this case, an Application Server is not required but you must configure the ENOVIA Live Collaboration Server for RIP mode.

    Select the desired deployment option.

    Click Next to continue.

  9. Select a Java heap size. This setting affects the options for Java memory allocation. You should select a heap size based on what your system will support.

    Java Heap Size

    For 32-Bit Systems

    For 64-Bit Systems

    Small:

    256m

    256m

    Medium:

    640m

    960m

    Large:

    1024m

    2048m

    Note: Starting with version V6R2011x, the 64-bit version of ENOVIA Live Collaboration Server is supported on both Windows and UNIX. The 32-bit version of ENOVIA Live Collaboration Server is supported only for Windows and only for non-production use.

    Select the desired Java heap size.

    Click Next to continue.

  10. Select the server character encoding. Choose one of the following options:

    Option Description
    UTF8 Select this option if the server needs to support multiple non-English languages. If you choose this setting, ensure that your database character set is also UTF8. This option is the default, and is recommended for all implementations besides Japanese ShiftJIS, whether you support multiple non-English languages or only English.

    When this option is selected, UTF8 settings are added to your environment, as described in Automated UTF-8 Settings. To finish enabling UTF8, follow the instructions given in Manually Setting UTF-8 Options or Manually Setting UTF-8 Options for AIX, depending on your platform.
    Not UTF8 Select this option if your implementation must support Japanese ShiftJIS.

    Note: In order to support Japanese, the default setting of NLS_LANG=_UTF8 must also be changed to NLS_LANG=JAPANESE_JAPAN.JA16SJIS. On UNIX, you set this variable in the SERVERHOME/scripts/mxEnv.sh file. On Windows, you set it in the Windows registry by editing the HKEY_LOCAL_MACHINE/SOFTWARE/ORACLE/NLS_LANG key.

    For more information, see the Configuring a Japanese Web Environment chapter in the ENOVIA Live Collaboration Server Administration Guide.

    Select the desired character encoding.

    Click Next to continue.

  11. UNIX/Linux Only: Specify the location of the Application Server and the name of the startup script.

    1. Specify the location of the Application Server (location of the startup script). This must be a valid directory. The default location is displayed.

      The following are examples of typical startup script locations:

      Application Server Location of Startup Script
      WebLogic: app/weblogic/user_projects/domains/base_domain/
      WebSphere: The startServer.sh path for WebSphere should be from a profile. For example:

      /app/WebSphere/AppServer/profile01/bin
      Sun Java System Application Server: /app/SUNWappserver7/bin
      Tomcat: /app/tomcat/bin

      If you want to change the location, click Browse and select the desired path.

    2. Specify the name of the Application Server startup script. This must be a valid file name. Entering an empty string (the default) means not configuring the Application Server.

      The following are examples of typical startup script names:

      Application Server Location of Startup Script
      WebLogic: startWebLogic.sh/
      WebSphere: startServer.sh
      Sun Java System Application Server: asadmin
      Tomcat: startup.sh

      If you want to change the name of the startup script, type in the desired name.

    Click Next to continue.

    Setup invokes the startup script at the specified location to start the Application Server process and verify that the path and script name are valid.

  12. Choose whether or not you want to install the kernel in RIP mode.

    Option Description
    Yes (RIP mode) Choose this option to install the kernel in RIP mode. In this mode, the kernel runs in the same process space as the Application Server. This is the default and recommended configuration. See RIP: RMI In-Process for details.
    No (RMID mode) Choose this option if you want to set up the standard RMI mode. See RMI Gateway for details.

    Select the desired mode.

    Click Next to continue.

  13. If you chose No (RMID mode) in the previous step, setup then asks whether you want to install the Matrix RMI Gateway.

    The choices are:


    • Yes (multiple RMI servers):
      1. Check the Multiple RMI servers box to install the Matrix RMI Gateway. Click Next.
      2. Enter the number of additional server processes to use for the RMI Gateway. The default (and minimum allowed) is 2.
    • No (single RMI server):
      1. Leave the box unchecked to use a single RMI server (the default). Click Next.
      2. Specify the RMI port number for this server. The default is 1099.

    Click Next to continue.

    Note: If you are configuring the RMI Gateway, setup will assign sequential port numbers to each secondary server process used. For example, if you accepted the default of 2 for additional RMI processes, the RMI port number entered here (such as 1099) will be for the Gateway, and the other processes will use the next 2 ports (that is, 1100 and 1101).

    Setup now has enough information to start copying the program files.

  14. Review all of the settings you have made.

    If you want to make any changes, click Back and make the desired changes.

    When you are satisfied with the settings, click Next to begin the installation.

    Setup displays the status of the installation while it is in progress.

  15. Once the installation is complete, setup informs you with the message, CSR - ENOVIA Live Collaboration Server: installed.

    Click End to exit setup and close the setup dialog.

    Setup also creates program shortcuts under the "Dassault Systemes Software VERSION" program folder on the Start menu.

  16. Continue with the next step in General Installation for ENOVIA Live Collaboration Server.

Post-requisite: Be sure to place a working connection file in the location specified in step 7.