Installing Help for Web Apps

This topic describes how to install the help for Web Apps and XCAD integration apps.

This task shows you how to:

Before you begin:

You can copy the contents of each CD-ROM into a separate folder for each CD-ROM, making sure that the name of each folder corresponds to the CD-ROM number ( 1, 2 ...).

Install the Help on Windows

This task explains how to install the help on a Windows server.

Before you begin:

You must have access privileges to install software on the target machine. On UNIX/Linux, you must log in as root. On Windows, 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.

  1. Log onto the server that has your apps installed.

    You need to have administrator privileges to install the online documentation.

  2. Insert the media.
  3. Use Windows Explorer to explore the documentation media, and double-click the setup.exe program on the media to start the installation.
    The Choose Destination Location Window appears. The default folder in which the documentation in English will be installed is: 
    c:\Program Files\Dassault Systemes\BXXXdoc\English
    Where XXX is the internal release number.
  4. Use Browse to chose a different location.
    The War Utility asks for the location used here to copy the documentation for Web apps to the STAGING area to include in the .war file.
  5. Click Next.

    The Documentation Select Software dialog box appears containing the list of all documentation. All documentation is preselected.

  6. Select only the required apps in the list.
    It is recommended to install help only for the apps you have installed on this server to minimize the size of the .war file. You can rerun the installation to any location to get additional documentation that is not context sensitive.
  7. Once your selection is final, click Next.
    The Documentation Start Installation dialog box appears listing the online documentation you are about to install. You also see a list of the selected apps.
  8. Click Install.

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

    Click Close.

Install the Help on Linux

This task explains how to install the help on UNIX or Linux.

The help is provided on a suite of CD-ROMs. Depending on how many apps you install, you may be prompted to insert the next CD-ROM. Click OK to continue the installation until you insert the last CD-ROM.

If you click Cancel before you install the final CD-ROM, the documentation files previously installed are uninstalled.

  1. Logon as root.
  2. Verify that you have enough free disk space in the file system in which you intend to unload the help.
  3. Insert the CD-ROM into the drive, mount the CD-ROM drive and change directory to the CD-ROM mount point.
  4. Enter the command:

    ./startGUI.sh or ./startTUI.sh to start the installation procedure.

    The Welcome dialog box appears. The steps are the same as for Windows.

Install Internationalized Help

You can download and install the localized help for Web apps in a manner similar to the English version. Once installed you must make some changes to properties as described below.

  1. Download the required language help tarkits, unzip them, and run the installation.
  2. Create an emxFrameworkStringResource_xx.properties page object for each language you are installing, as described in Installation and Setup | Administrate | 3DEXPERIENCE Platform | 3DSpace Administration | Collaboration and Approvals | Configuring Properties.
    For example, if you are installing the French documentation create a page object named emxFrameworkStringResource_fr.properties.
  3. Add the following properties to the page object you just created: 
    emxFramework.OnlineXML.HelpDirectory=french
emxFramework.HelpDirectory=fr
    Other languages are: 
    emxFramework.OnlineXML.HelpDirectory=german
emxFramework.HelpDirectory=de
emxFramework.OnlineXML.HelpDirectory=japanese
emxFramework.HelpDirectory=ja
emxFramework.OnlineXML.HelpDirectory=simplified_chinese
emxFramework.HelpDirectory=zh_CN
emxFramework.OnlineXML.HelpDirectory=italian
emxFramework.HelpDirectory=it
emxFramework.OnlineXML.HelpDirectory=spanish
emxFramework.HelpDirectory=es
  4. In the emxSystem.properties page object:
    1. Add the OnlineHelp.Language property for each language you are installing. The available languages are:
      emxFramework.OnlineHelp.Language.fr=french
emxFramework.OnlineHelp.Language.de=german
emxFramework.OnlineHelp.Language.ja=japanese
emxFramework.OnlineHelp.Language.zh_CN=simplified_chinese
emxFramework.OnlineHelp.Language.it=italian
emxFramework.OnlineHelp.Language.es=spanish
emxFramework.OnlineHelp.Language.en=english
      Note: The system.property has a slightly different name than the framework.property.
    2. Add this setting and set it to the folder where you installed the help:
      emxFramework.Help.URL=../docv6
  5. Run warutil and deploy the archive file.
  6. Restart the application server.