Connecting the Operational Insights Front-End to the API
This topic describes how to import configuration and runtime details into Operational Insights Front-End from an Elastic Path Commerce environment.
Procedure
The Operational Insights Front-End supports two modes for retrieving configuration and runtime details from an Elastic Path Commerce environment:
- In online mode, the Operational Insights Front-End connects directly to the Integration Server REST APIs.
- In offline mode, the Operational Insights Front-End can read the Integration Server REST API response from a file. This mode is useful when a direct connection to the Integration Server REST APIs is not possible. Realtime updates are disabled in this mode.
Online mode
The fields on this form are described below:
| Field | Description |
|---|---|
| Integration Server URL | The Integration Server URL for the Elastic Path Commerce environment to review. |
| 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. |
| Integration Server Password | The password to use for authenticating with the REST API. |
| Environment Type | The type of environment being reviewed. This setting affects some of the recommendations for the environment. |
| Expected Peak Concurrent API Requests | The expected number of concurrent Cortex API requests at peak usage. This setting affects some of the recommendations for the environment. |
note
We recommend that you disable the default admin user and create a custom user for accessing Integration Server APIs in production environments.
Click GO when all fields are completed.
Offline mode
The fields on this form are described below:
| Field | Description |
|---|---|
| Insights JSON | The file containing the JSON output from the Integration Server REST endpoint. |
| Environment Type | The type of environment being reviewed. This setting affects some of the recommendations for the environment. |
| Expected Peak Concurrent API Requests | The expected number of concurrent Cortex API requests at peak usage. This setting affects some of the recommendations for the environment. |
Click GO when all fields are completed.