Starting the Operational Insights Front-End

This topic explains how to download and launch the Operational Insights Front-End. This tool is distributed as a standalone JAR file that starts a small webapp on port 8080. The webapp can be used to connect to the Operational Insights REST API that is part of the Integration Server in Elastic Path Commerce. The Operational Insights Front-End is compatible with all supported versions of Elastic Path Commerce.

note

The Operational Insights API is available in Elastic Path Commerce 8.3.0 and later, but may also be available in earlier versions by consuming a patch. Check the changelog for your version of Elastic Path Commerce to determine if a patch is available.

Prerequisites

• Ensure that you use Java 8 or later.

Procedure

1. Download the latest Operational Insights JAR.

   note

   You will be prompted for credentials to download the JAR. Use the Nexus credentials for your organization. If you do not have the credentials, send an email to access@elasticpath.com.

   Once you have successfully logged in, you will need to click the download link again to begin the download.

2. In a terminal, go to the folder where you downloaded the JAR and run the following command:

   java -jar operational-insights-[VERSION].jar
   

   Replace [VERSION] with the version of the tool that you downloaded.

   The JAR also supports the following optional JVM parameters. If the integration.server.url parameter is set, then the configuration page will not be shown and the user will be redirected to the scan results right away.

   JVM Parameter	Description	Supported Values	Default
   integration.server.url	The Integration Server URL for the Elastic Path Commerce environment to review.	HTTP/HTTPS URL
   integration.server.username	The username to use for authenticating with the REST API. This should be the username of a Commerce Manager user with the Web Service Access role.	String	admin
   integration.server.password	The password to use for authenticating with the REST API.	String	111111
   environment.type	The type of environment being reviewed. This setting affects some of the recommendations for the environment.	LOCAL_DEVELOPMENT, SHARED_DEVELOPMENT, STAGING_AUTHOR, STAGING_LIVE, PROD_AUTHOR, PROD_LIVE	PROD_LIVE
   expected.peak.concurrent.requests	The expected number of concurrent Cortex API requests at peak usage. This setting affects some of the recommendations for the environment.	10000, 5000, 1000, 100	1000

3. Connect to http://localhost:8080/ in your browser.

4. Follow the steps in Connecting the Operational Insights Front-End to the API.