PTC Navigate for Manufacturing Installation and Configuration Guide 1.0
Copyright 2016 PTC Inc. and/or Its Subsidiary Companies. All Rights Reserved. User and training guides and related documentation from PTC Inc. and its subsidiary companies (collectively "PTC") are subject to the copyright laws of the United States and other countries and are provided under a license agreement that restricts copying, disclosure, and use of such documentation. PTC hereby grants to the licensed software user the right to make copies in printed form of this documentation if provided on software media, but only for internal/personal use and in accordance with the license agreement under which the applicable software is licensed. Any copy made shall include the PTC copyright notice and any other proprietary notice provided by PTC. Training materials may not be copied without the express written consent of PTC. This documentation may not be disclosed, transferred, modified, or reduced to any form, including electronic media, or transmitted or made publicly available by any means without the prior written consent of PTC and no authorization is granted to make copies for such purposes. Information described herein is furnished for general information only, is subject to change without notice, and should not be construed as a warranty or commitment by PTC. PTC assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. The software described in this document is provided under written license agreement, contains valuable trade secrets and proprietary information, and is protected by the copyright laws of the United States and other countries. It may not be copied or distributed in any form or medium, disclosed to third parties, or used in any manner not provided for in the software licenses agreement except with written prior approval from PTC. UNAUTHORIZED USE OF SOFTWARE OR ITS DOCUMENTATION CAN RESULT IN CIVIL DAMAGES AND CRIMINAL PROSECUTION. PTC regards software piracy as the crime it is, and we view offenders accordingly. We do not tolerate the piracy of PTC software products, and we pursue (both civilly and criminally) those who do so using all legal means available, including public and private surveillance resources. As part of these efforts, PTC uses data monitoring and scouring technologies to obtain and transmit data on users of illegal copies of our software. This data collection is not performed on users of legally licensed software from PTC and its authorized distributors. If you are using an illegal copy of our software and do not consent to the collection and transmission of such data (including to the United States), cease using the illegal version, and contact PTC to obtain a legally licensed copy. Important Copyright, Trademark, Patent, and Licensing Information: See the About Box, or copyright notice, of your PTC software. UNITED STATES GOVERNMENT RIGHTS PTC software products and software documentation are commercial items as that term is defined at 48 C.F. R. 2.101. Pursuant to Federal Acquisition Regulation (FAR) 12.212 (a)-(b) (Computer Software) (MAY 2014) for civilian agencies or the Defense Federal Acquisition Regulation Supplement (DFARS) at 227.7202-1(a) (Policy) and 227.7202-3 (a) (Rights in commercial computer software or commercial computer software documentation) (FEB 2014) for the Department of Defense, PTC software products and software documentation are provided to the U.S. Government under the PTC commercial license agreement. Use, duplication or disclosure by the U.S. Government is subject solely to the terms and conditions set forth in the applicable PTC software license agreement. PTC Inc., 140 Kendrick Street, Needham, MA 02494 USA
Contents Introducing PTC Navigate for Manufacturing...5 Product Requirements...7 Installing PTC Navigate for Manufacturing...9 Connecting ThingWorx to Kepware... 11 Getting Started with the PTC Navigate for Manufacturing Apps...17 Known Issues...19 3
1 Introducing PTC Navigate for Manufacturing PTC Navigate for Manufacturing delivers role-based apps to the factory, allowing modern factories to understand their environment, advance, and outperform their competition. PTC Navigate for Manufacturing includes the following role-based app. Industrial connectivity Industrial connectivity enables controls engineers to quickly unlock machine data in their factory. Key features include: Real-time connectivity to factory machines through KEPServerEX Remote monitoring of all KEPServerEX installations on a single web page See server status, number of tags, number of clients, devices in error and more Be alerted when a device or server stops communicating Remotely troubleshoot problem devices Trend any tag in minutes Access trends through any browser on your phone, tablet, and desktop Zoom in, out, and set markers to help troubleshoot Support for high resolution (sub 100ms) data Define an alarm for any tag in minutes This guide covers how to: Install PTC Navigate for Manufacturing as an extension to ThingWorx Perform the initial configuration steps to get started with PTC Navigate for Manufacturing 5
2 Product Requirements PTC Navigate for Manufacturing works in connection with ThingWorx servers and Kepware servers. To use PTC Navigate for Manufacturing you must have the following installed: Platform Support Windows Server 2008 R2 and Windows 2012 are recommended and fully tested for production. Server Support Note Kepware and ThingWorx can be on the same machine, but for production, they should be on separate machines. ThingWorx server support: ThingWorx 7.2.1 with PostgresSQL database For information, see Installing ThingWorx. Kepware server support: KEPServerEX V5 5.21, which includes ThingWorx Native Interface For information on installing and using KEPServerEX V5 see KEPServerEx V5. 7
Note This release of PTC Navigate for Manufacturing supports up to 10 KEPServerEX V5 installations. Client Browser Support Chrome 51 Firefox 45 8 PTC Navigate for Manufacturing Installation and Configuration Guide
3 Installing PTC Navigate for Manufacturing Installing as an Extension to the ThingWorx Platform If you are an experienced ThingWorx user or already have ThingWorx installed, the easiest way to get started with PTC Navigate for Manufacturing is to download and import the extensions. 1. Download and unzip the content of the following files: ptc-navigate-mfg-{version}-extensiondependency.zip ptc-navigate-mfg-{version}-extension.zip 2. From ThingWorx Composer, navigate to Import/Export Import. 3. In the Import Extensions window, navigate to ptc-navigate-mfg- {version}-extension-dependency.zip. 4. Click Import and refresh the window if prompted. 5. Again select Import/Export Import. 6. In the Import Extensions window, navigate to ptc-navigate-mfg- {version}-extension.zip. 7. Click Import and refresh the window if prompted. To view the extensions after the import is complete, select Import/Export Manage. 9
Verify the Installation Now that PTC Navigate for Manufacturing is installed, verify that you can access the apps. Go to the following URL on the ThingWorx server: http:// localhost/thingworx/runtime/index.html#master= PTC.FactoryConsole.Master&mashup=PTC.FactoryConsole The default login and password are Administrator and admin respectively. 10 PTC Navigate for Manufacturing Installation and Configuration Guide
4 Connecting ThingWorx to Kepware Once everything is installed, connect Kepware to ThingWorx. This connection provides the data needed by the PTC Navigate for Manufacturing apps. Kepware can be on the same server or a different server than ThingWorx. One or more KEPServerEX servers can be connected. Following the steps in the sections below to connect ThingWorx to Kepware: Configure Java Options for Tomcat Create an Entity Create an Application Key Kepware and Thingworx Integration Verify Kepware Connection to ThingWorx Configure Java Option for Tomcat In addition to the recommended ThingWorx settings, the following Tomcat setting must be added in the Java options of the Tomcat properties to display the KEPServerEX local time in the app: -Duser.timezone=GMT To change the Tomcat configuration, follow these steps: 1. Launch the Configure Tomcat program from the Start menu. 2. Under the Java tab, add the following line in the Java Options: -Duser.timezone=GMT Note: The recommended ThingWorx Java options are: -Dserver -Dd64 -XX:+UseNUMA 11
-XX:+UseConcMarkSweepGC -Dfile.encoding=UTF-8 Define values in the Initial memory pool and Maximum memory pool fields. The recommended values for a production system are:: Initial memory pool: 2048 Maximum memory pool: 4096 Increase the default cache settings that affect static file caching by adding the following line within the tags in the $TOMCAT_HOME/conf/context.xml file: <Resources cachemaxsize="501200" cacheobjectmaxsize="2048" cachettl="60000"/> Verify that the following are set: Go to the location of the Tomcat installation and open the server.xml file in the conf folder. For example, C:\Program Files\Apache Software Foundation\Tomcat 8.0\conf\server.xml. Replace HTTP/1.1 with protocol="org.apache.coyote.http1 1.Http11NioProtocol". Save and close the file. Create an Entity First, create a remote thing in ThingWorx that represents the Kepware connection. A remote thing is needed for each KEPserverEX server connecting to ThingWorx. To create a new remote thing, follow these steps: 1. Go to the following URL on the ThingWorx server: http://localhost/ Thingworx/ 2. In the left pane, select MODELING Things, and click the new icon. 12 PTC Navigate for Manufacturing Installation and Configuration Guide
3. Enter information in the following fields: Name: A name related to the server you re connecting to, for example, kepware_line_6. Thing Template: PTC.Factory.KepServerThingTemplate Implemented Shapes: PTC.Factory.KepServerResourceThingShape 4. Click Save. Create an Application Key An application key is required to allow KEPServerEX to connect to ThingWorx. The application key is used to restrict what applications can connect to ThingWorx, providing an element of security. To create an application key, follow these steps: 1. Go to the following URL: http://localhost/thingworx/ 2. In the left pane, select Security Application Keys, and click the new icon. Connecting ThingWorx to Kepware 13
3. Enter information in the following fields: Name: A name relevant to the connection. User Name Reference: Administrator 4. Click Save. 5. Copy the new application key. You will use it when configuring Kepware in the following section. Example app key: 12345678-1234-1234-1234-12345678901 Kepware and Thingworx Integration Now that the remote thing and application key are defined, launch the KEPServerEX configuration and configure KEPServerEX to connect to ThingWorx. 1. Open the KEPServerEX configuration tool. 2. Go to File Project Properties. 3. Select the ThingWorx tab. 4. Under Server Interface, set Enable to Yes. 5. Under Connection Settings, complete the following steps. a. Set the Host. A ThingWorx host ID that can be an IP address or host name. b. Set the Port. A ThingWorx port ID. The default is 443. c. Set the AppKey Use the key created in the previous section. d. If you are developing an application, you may have self-signed certificates to use for testing. Alternatively, you could disable security temporarily 14 PTC Navigate for Manufacturing Installation and Configuration Guide
while testing. To prevent errors generated if you use a self-signed certificate, set the following parameter: "Trust self-signed certificates":yes e. Alternatively, to disable certificate validation, set the following parameter: "Trust all certificates":yes f. Additionally, to disable all secure connection while testing, set the following parameter: "Disable encryption":yes Verify Kepware Connection to ThingWorx 1. To access the PTC Navigate for Manufacturing console, enter the following url where the default port is 80. http://localhost/thingworx/runtime/ index.html#master=ptc.factoryconsole.master&mashup= PTC.FactoryConsole 2. Login as a ThingWorx administrator. 3. Go to the KEPServerEX Monitoring and your KEPServerEX server should display in the table. 4. Select your server. You can also change the description and update the publish rate of your connection. Connecting ThingWorx to Kepware 15
5 Getting Started with the PTC Navigate for Manufacturing Apps User and Access Control To allow others to login and access the app without administrator rights, create a user. Go to User and Access Control, create a new user, and assign the role as a Controls Engineer. This user will have access to all the apps and can create additional users in the app. KEPServerEx Monitoring KEPServerEX Monitoring provides a single web page for monitoring the status of all KEPServerEX connections and devices. If a device stops communicating, this app instantly notifies the Controls Engineer and helps troubleshoot the problem. To add devices from KEPServerEX to the app, select the KEPServerEX server and click discover devices. It scans the server and creates the devices in PTC Navigate for Manufacturing. Repeat this action as devices are added and removed from KEPServerEX. Trending and Troubleshooting Trending and Troubleshooting provides an easy tool to trend tags from KEPServerEX. Trend up to 5 tags on a single trend, and store up to one week of data per trend. Alert Manager Alert Manager creates alerts from any tag in KEPServerEX. For example, create an alert of the pressure exceeds 100 psi. 17
Go to Alert Manager to: View alerts Modify predefined alerts Define new alerts 18 PTC Navigate for Manufacturing Installation and Configuration Guide
6 Known Issues The following known issues exist in this release of PTC Navigate for Manufacturing. Performance and scalability PTC Navigate for Manufacturing supports a maximum of 250 devices per server. Discovering devices for a specific server may take several minutes for a large number of devices. Update of KEPServerEX system tags only occurs when non-system tags associated to the server are monitored. To monitor a non-system tag, create a trend in Trending and Troubleshooting and add any tag from any devices. 19