Siemens PLM Documentation Server 1.0 Installation Instructions for Windows

Siemens PLM Documentation Server 1.0 Installation Instructions for Windows

Proprietary & Restricted Rights Notice This software and related documentation are proprietary to Siemens Product Lifecycle Management Software Inc. 2014 Siemens Product Lifecycle Management Software Inc. All Rights Reserved. Siemens and the Siemens logo are registered trademarks of Siemens AG. NX is a trademark or registered trademark of Siemens Product Lifecycle Management Software Inc. or its subsidiaries in the United States and in other countries. All other trademarks, registered trademarks or service marks belong to their respective holders.

Table of Contents PROPRIETARY & RESTRICTED RIGHTS NOTICE... 3 TABLE OF CONTENTS... III CONVENTIONS... III PRE-INSTALLATION CONSIDERATIONS... 3 WEB SERVED DOCUMENTATION... 3 COMPANY-WIDE INSTALLATION... 3 LOCAL INSTALLATION... 4 INSTALLING SIEMENS PLM DOCUMENTATION SERVER... 4 AUTOMATIC INSTALLATION OF SPLMDOCSERVER... 5 SPLMDOCSERVER SILENT INSTALLATION... 6 LOCAL SERVER PARAMETERS... 7 LOG FILES... 9

Version 1.0 Conventions All references to "Windows" in this manual refer to 64-bit versions of Windows 7 or Windows 8. Our company name is Siemens PLM Software, however, some program names, folder names and some product kit names may still retain the UGS company name. Windows menu items and commands appear in italic letters or courier font. An arrow ( ) is used to represent submenus on Windows machines, for example, Start All Programs Accessories Windows Explorer. If you do not have the Symbol font installed, or if you browse this document on a non-windows computer, you may see the registered trademark symbol ( ) in place of the arrows. Version 1.0 Installation Instructions for Windows iii

Version 1.0 Pre-installation Considerations The Siemens PLM Documentation Server product installation requires the following: Java (64-bit) Java 1.7.0_67 or later Web Served Documentation Siemens PLM documentation has been redesigned to use a web application to serve the Help. This redesign has the following benefits: Sites can serve one copy of the documentation to many users. Search capabilities are better and searches are faster. Java updates are not required. Although Java is still used, the new web application is not dependent on Java applets which frequently break due to Java security updates. Customers must decide on either a Company-wide Installation or a Local Installation approach. Company-wide Installation Customers with an existing web server can deploy the documentation webapps to that server. In this case you should not install SPLMDOCSERVER, as it is not required. You must install the Documentation content and then manually deploy it to your webserver following the documentation provided with the content. Version 1.0 Installation Instructions for Windows 3

Version 1.0 Local Installation Customers without a company-wide web server or customers who do not want to make use of a company-wide web server, can do a local installation on their machines. 1. First install SPLMDOCSERVER. This sets up a small, self-contained web server on your local system that can be used to serve documentation locally from your machine. This will run as a service, Siemens PLM Documentation Server, which starts automatically when you reboot the system. 2. Next install documentation content to this local web server. You can use this web server to serve any number of Siemens PLM products that make use of the new web served documentation design. Installing Siemens PLM Documentation Server 1. Log in as Administrator. 2. Navigate to the folder containing the installation files and double click on setup.exe. 3. At the Welcome dialog, select Next to continue. The installation prompts you for the installation directory. This directory is also used for the documentation content installs for all Siemens PLM products, so choose a disk drive with plenty of space. 4. The Ready to Install dialog displays the default port that will be used for the installation, if you want to use a different port, select Change Port. The installation will copy the necessary files to your system, configure and start the Siemens PLM Documentation Server. 4 Installation Instructions for Windows Version 1.0

Version 1.0 Automatic Installation of SPLMDOCSERVER Customers can install SPLMDOCSERVER using an automatic, unattended installation. This method is helpful for System Administrators with a large number of site installations. It is also typically much faster than the standard GUI based install. Siemens PLM Software does not recommend that you install the Documentation content on every user s workstation, unless you have a very small number of users. It is highly recommended that you use a single central server to serve the documentation to your users. Caution: This type of installation is intended for experienced installers only. The unattended automatic installation is controlled by the Windows system component, msiexec.exe. In order to install silently, you must pass switches with specific configurable properties to msiexec.exe on the command line. The msiexec.exe program has several command line switches. For full documentation on these switches, see the Microsoft help documentation (Help and Support) for msiexec. The following are a few commonly used command line switches. /h Lists available switches. /i Specifies the input.msi file to be used, for example: msiexec /i "Siemens NX 10.0 Documentation.msi" /q Specifies the UI level. /qn+ specifies no dialogs except for the ending install done message box {recommended}. /qn specifies a silent installation with no dialogs. If you use this option, there is no indication when the installation is complete; you must use Task Manager to monitor the msiexec.exe. /L Specifies a log file to be created, and the level of the messages to be written to the log file, for example: msiexec /L*v log file This example gives the most verbose log file. See msiexec switches for various log file switch options. /x Specifies the input.msi file to be used for de-installation, for example: msiexec /x Siemens NX 10.0 Documentation.msi Version 1.0 Installation Instructions for Windows 5

Version 1.0 SPLMDOCSERVER Silent Installation The SPLMDOCSERVER installation has the following configurable properties. INSTALLDIR STARTPORT This property sets the directory where the SPLM Documentation Server will be installed. If you do not specify a directory, the installation uses the default directory: C:\Program Files\Siemens\PLM Documentation Server. This directory will also be used by the NXDOCS installation, so choose a disk with plenty of space. This property sets the TCP port for the SPLM Documentation Server. It must be an unused port. The installation checks to make sure that the port is not currently in use. Caution: The msiexec.exe examples below may appear on multiple lines because of document formatting but you must enter them on one line. Arguments with embedded spaces must be quoted. Example: Installing silently msiexec.exe /qn+ /i "Siemens PLM Documentation Server.msi" By default, the default installation directory C:\Program Files\Siemens\PLM Documentation Server and the default STARTPORT of 8181 are used. The /qn+ switch displays an ending message box. No other dialogs will appear. Example: Installing in a user-specified directory with a specific port msiexec.exe /qn+ /i "Siemens PLM Documentation Server.msi" INSTALLDIR="E:\Program Files\MyInstalls" STARTPORT=8282 The /qn+ switch displays an ending message box. No other dialogs will appear. 6 Installation Instructions for Windows Version 1.0

Version 1.0 Example: Generating a verbose log file msiexec.exe /qn /L*v c:\temp\install.log /i "Siemens PLM Documentation Server.msi The log file is generated to c:\temp\install.log. The /qn switch does not display any dialogs. If you use the /qn switch without the +, you must use Task Manager to monitor msiexec.exe as there will be no indication when the installation is complete. Example: Uninstalling msiexec.exe /qn+ /x "Siemens PLM Documentation Server.msi" Only an ending message box appears. Local Server Parameters The SPLMDOCSERVER is configured to be a local server, for one user only. While the server can be opened up for multiple users, Siemens has done no work to determine loading and memory usage when this is done. For this reason the installation uses LOCALHOST as the node name for the server. To open the server up to allow other workstations to use it, you must provide a username and password for the service. 1. Choose Start Control Panel Administrative Tools and double-click Services. 2. In the Services panel, right-click Siemens PLM Documentation Server, and choose Properties. 3. In the Properties dialog box, click the Log On tab and select This Account. 4. Enter a login account and password for the service. 5. Stop and restart the service. You should then be able to access the documentation from other workstations using the node name of your workstation and the port configured. The trailing slash is required in your path; for example: http://my_hostname:8181/tdoc/nx/10/nx_help/ Version 1.0 Installation Instructions for Windows 7

Version 1.0 The configurable parameters of the Siemens PLM Documentation Server are contained in the registry at: HKLM\Software\Wow6432Node\Apache Software Foundation\Procrun 2.0\Siemens PLM Documentation Server\Parameters The Options multistring entry in the Registry Editor contains the following definitions. jetty_home plm_helpserver.properties jetty.port jetty.host solr.solr.home XX:PermSize=128m XX:MaxPermSize=256m The top level directory for the Jetty Server. The location of the configuration file for the documentation. The port used by the jetty process. This is also duplicated in the plm_helpserver.properties file above. The hostname that you can use to restrict access to the server. By default, this is set to 0.0.0.0 for wide open access. The top level directory for the Solr process and where it looks for search cores. Sets the java perm size minimum. Sets the java perm size maximum. 8 Installation Instructions for Windows Version 1.0

Log Files Version 1.0 The SPLM Documentation server has log files that can help you diagnose problems if the server does not run correctly. C:\Windows\System32\LogFiles\Apache This directory will contain log files from the Siemens PLM Documentation Service. These typically do not contain much information, and are only mentioned for completeness. C:\Program Files\Siemens\PLM Documentation Server The first time you start the server after installing it, a log file is placed in this location. This log file will have information about the server startup and shutdown, as well as messages on activity on the web server. C:\Program Files\Siemens\PLM Documentation Server\logs This directory will contain PLM specific log files, tdoc_client.txt and data_service.txt. The server log files will also be placed in this directory after the first run. We recommend that you clean up this directory periodically. Version 1.0 Installation Instructions for Windows 9