Graphical Mode Installation
This procedure documents installation for Analytics Server, release 9.3. If you need installation information for one of the following earlier releases, use the links below to open earlier PDF installation guides maintained on the PTC eSupport Portal:
This procedure represents the graphical installation mode, typically used in a Windows environment. For launch information using the Silent installation mode, see Silent Mode Installation
Before Installation
• Make sure all of the prerequisites have been met.
• Download the appropriate installer files for your operating system.
• Extract the downloaded files to a location on your host system.
• If you plan to use TLS support for connections to any Analytics Server components, review and complete the relevant tasks in the following sections before you begin the installation:
Installation Steps
1. Navigate to the extracted Windows installer file, ThingWorxAnalytics-<n.n.n>-windows-installer.exe, right click the file, and select the Run as Administrator option.
 |
An advanced option is available if you want to override the default user account during the installation. For more information about launching the installer with this option, see Change the User Account.
|
2. Accept the license agreement and click Next.
3. Select the ThingWorx Analytics components you want to install. For a description of the available components, see Installation Components
4. Specify an installation directory. You can accept the default or provide a different location.
If the installer detected a previous version of the ThingWorx Analytics Server, and you want to upgrade, the old installation directory is preselected and you will not be able to change it. For more information, see Upgrade from an Earlier Version.
5. Enter TLS connection information for the ThingWorx Analytics microservices. For a description of the available parameters, see ThingWorx Analytics TLS Information.
|
|
For Analytics Server 9.2 and earlier, the TLS installation parameters are still labeled SSL instead of TLS.
|
6. If you selected the Async Microservice as one of the components to install, enter TLS connection information for ZooKeeper. TLS protection is optional for ZooKeeper connections but is enabled by default. For a description of the required parameters, see ZooKeeper TLS Connection Information.
7. Enter ThingWorx connection information. For a description of the required parameters, see ThingWorx Connection Information.
|
|
If you opted not to select the ThingWorx Adapter for installation, ThingWorx connection information will not be requested.
|
8. When you complete the previous step, the installation begins. Depending on your operating system, several windows may open and then close while the process unpacks and installs the necessary libraries and settings.
When the installation process is complete, an API Key is displayed on screen. You will need this key for any scenario that requires access to the internal ThingWorx Analytics API layer. The API key is automatically encrypted and, for security, is not stored in plain text anywhere. Make a note of the key for later reference. If you forget or need to upgrade the key, you must generate a new key. For more information, see Update a ThingWorx Analytics API Key.
9. When the final page is displayed, click Finish. An Installation Summary page is displayed with a list of the components that were installed.
10. Review the Installation Summary page and then click OK to close it.
11. To test the product installations, see:
◦ Verify the ThingWorx Analytics Server Installation
◦ Verify the Analytics Extension Installation
 | The Analytics Extension installation is not complete until you perform the necessary post-installation configuration steps. For information about these steps, see Perform Post Installation Configuration for Analytics Builder or for Analytics Manager. |
Installation Components
In Step 3 above, the components available for installation include the following:
Analytics Server | Click the + icon to expand the option and select either one or both of the following: | |
Async Microservice | Installs the Asynchronous Microservice along with other necessary components, including ZooKeeper and Analytics Common Workers. During the installation, three Workers are installed but the number of Workers can be scaled up when the installation is complete. For information, see Scale the Number of Workers. | |
Sync Microservice | Installs only the Synchronous Microservice. | |
Integration with ThingWorx | The following components involve integration with ThingWorx: | |
ThingWorx Adapter for Analytics Server | This adapter generates the Analytics Things that can be accessed in ThingWorx Composer. It is selected by default if you have selected the Integration with ThingWorx parameter. If you plan to interact with ThingWorx Analytics via ThingWorx, this parameter is required. | |
Analytics Extension | Must be selected if you plan to use Analytics Builder or Analytics Manager. Analytics Extension can only be used if both the Async and the Sync Microservices are installed. | |
ThingWorx Analytics TLS Information
For Step 5 above, the following TLS parameters are required.
Parameter | Description | ||
|---|---|---|---|
Use TLS for Analytics Microservices | By default, this check box is selected. You can accept the default or clear it. When TLS authentication support is enabled for the microservices, communication is protected between the ThingWorx Adapter and the Analytics APIs. Communication between the APIs is also secured.
| ||
TLS Keystore file | Click the icon to the right of the field and navigate to the location where the TLS Keystore file is stored. This file contains the signed TLS certificate. | ||
TLS Keystore Password | Enter the password for the TLS Keystore. | ||
Certificate Alias Name | Enter the alias name that is assigned to the signed TLS certificate. Alias names are converted automatically to all lower case. | ||
Host IP Address or Fully Qualified Domain Name to access Analytics microservices | Enter either an IP address or a fully qualified domain name for the primary network adapter on your ThingWorx Analytics Server. The value must match the SAN value provided on the TLS certificate. | ||
Analytics Server Truststore Password |
Enter a password that will be assigned to the Analytics Server truststore. This truststore is created automatically during the Analytics Server installation. | ||
Java Truststore Password |
Enter the password for the Java truststore, a file where trusted TLS certificates are stored. The truststore is created automatically, with a default password, when Java is installed. For more information about Java truststore passwords, see Working with Certificates and SSL on the Oracle website. |
ZooKeeper TLS Connection Information
For Step 6 above, the following connection parameters are required to enable TLS support.
Parameter | Description | ||
|---|---|---|---|
Use TLS for ZooKeeper | Select this check box to enable TLS authentication support for Zookeeper. When TLS is enabled, the ZooKeeper connections with the Async Microservice and the Analytics Common Workers are protected. TLS is enabled by default.
| ||
TLS Keystore file | Enter the path to the TLS Keystore file where the signed ZooKeeper TLS certificate is stored.
| ||
TLS Keystore Password | Enter the password for the TLS Keystore. | ||
TLS Truststore file | Enter the path to a JKS Truststore file that contains the authority that signed the ZooKeeper certificate.
| ||
TLS Truststore Password | Enter the password for the TLS Truststore.. For more information about Java Truststore passwords, see Working with Certificates and SSL on the Oracle website. |
ThingWorx Connection Information
In Step 7 above, the following ThingWorx connection parameters are required.
Parameter | Description | ||||
|---|---|---|---|---|---|
ThingWorx IP Address or Host Name | Enter the IP address or host name of your ThingWorx server, which must already be installed and running. If you are using TLS for your connection to ThingWorx, this IP Address or Host Name must match the SAN address or host used to create the ThingWorx TLS certificate.
| ||||
ThingWorx Port | Enter the port for communicating with your ThingWorx server. If you are using TLS for your connection to ThingWorx, enter that port number. | ||||
ThingWorx AppKey | Enter the value from the Key ID field of the application key you created in ThingWorx. | ||||
Analytics Server Thing Name | Enter a name for the AnalyticsServer Thing that is created in ThingWorx during the Analytics Server installation. This full name is attached as a prefix to each microservice name. This Thing name must be unique within the server deployment. | ||||
Configure Anomaly Detection to use this instance of Analytics Server | Select this check box if you plan to use Anomaly Detection functionality with this installation of Analytics Server. When this option is selected, the installer automatically configures the Alert Processing Subsystem in ThingWorx. | ||||
Use TLS?
| Select this check box in order to require the use of TLS when connecting to ThingWorx. By default, this check box is not selected.
If you do not opt to use TLS for the connection to ThingWorx, continue with Step 6. If you enable TLS for the ThingWorx connection, complete the remaining parameters in this step. | ||||
TLS parameters for 9.2 and later | • Upload ThingWorx Certificate File? – Select this check box if you want the installer to upload your ThingWorx TLS certificate automatically. By default, this check box is not selected. For a new installation using TLS, this option must be enabled. For an upgrade, modify, or repair installation, this option is necessary only if you want to upload a new certificate. To continue using an existing certificate, leave this check box unselected. For more information, see TLS Support for ThingWorx. • ThingWorx Certificate File – Click the icon to the right of the field and navigate to the path where the ThingWorx TLS certificate file is stored. This file is either a PEM or CER file. This file is required when Upload ThingWorx Certificate File? is selected. • ThingWorx Truststore Password – Enter a password that will be assigned to the ThingWorx truststore. This truststore is created automatically during the Analytics Server installation. | ||||
TLS parameters for 9.0 and 9.1
| • Upload a Self-signed ThingWorx SSL Certificate – Select this check box if you are using a self-signed ThingWorx TLS certificate and you want to allow the installer to upload it automatically. By default, this check box is not selected, but you will need to import the certificate manually if it is not selected. For more information, see Import a Self-signed TLS Certificate Manually. • SSL Certificate File – Click the icon to the right of the field and navigate to the path where the ThingWorx TLS certificate file is stored. This file is either a PEM or CER file. • ThingWorx Certificate Alias Name – Enter an alias name that is assigned to the TLS certificate. Alias names are converted automatically to all lower case. • Java Truststore Password – Enter the password for the Java truststore, a file where trusted TLS certificates are stored. The truststore is created automatically, with a default password, when Java is installed. For more information about Java truststore passwords, see Working with Certificates and SSL on the Oracle website. |