1. Reference Guide
  2. Getting Started

1 Getting Started

Telemetry monitors an enterprise’s cloud and on-premises components to capture performance metrics, providing insight into:

  • How long it takes for a transaction to post to cloud service.

  • Whether a workstation is online or offline.

Note:

Telemetry is available only for Oracle Simphony Cloud Service single-tenant subscribers. Telemetry does not monitor financial results such as revenue, tables, or checks.

Prerequisites

Telemetry requires the following software:

  • Simphony Point of Sale Cloud - 19.2.1 or later

  • Simphony Point of Sale Location - 18.2.4 or later

  • Simphony Reporting and Analytics - 20.1 or later

Enabling Telemetry

The following table explains the tasks required to enable Telemetry for your enterprise:
Task Procedure

Create Account

Navigate to Profile.Oracle.com and create an account. This account allows you to access the Telemetry portal via the welcome e-mail link described in the next task.

Download Telemetry Agent CAL Package

Locate your CAL package ID and Telemetry Proxy URL in the Telemetry welcome e-mail.

Download the CAL package from MOS.

Review the patch ReadMe file for important information. Download and extract the accompanying custom CAL package. Open the package contents and find the TelemetryAgent.exe.config file and set the value for TelemetryProxyURL to the Telemetry Proxy URL for your environment.

Deploy Telemetry Agent CAL Package
Add the Telemetry Agent CAL package to EMC CAL Package Deployment. It is then distributed to all workstations in the enterprise via CAL Package Deployment.

Note:

Following deployment, metric flow will begin at random intervals during the first hour to optimize performance across the enterprise.

For those using CAPS on IIS/CAPS as Windows Service:

  1. Ensure that your CAPS on IIS/CAPS as Windows Service Database Administrative account credentials are available. Install the Telemetry Agent CAL package, and then complete the standard deployment process.

  2. Following a successful deployment, proceed to the C:\Micros\Simphony\TelemetryAgent directory on your device. Run the ProvisionHeadlessCAPSDBAccess batch file as an Administrator.

  3. Enter your Database Administrator credentials and then click Enter.

    • If successful, a Headless CAPS database access provisioned successfully message appears.

    • In the event of a database credential loss due to database recovery or troubleshooting, the ProvisionHeadlessCAPSDBAccess batch file needs to be run again to update the credentials in the Telemetry agent.

This process can also be completed by opening the command line on your CAPS device, changing to the Telemetry Agent directory, and running the following: TelemetryAgent.exe -provisionheadlesscapsdbaccess <DB admin user_name> <password>

See the Oracle Simphony Client Deployment Guide for more information on how to use EMC CAL Package Deployment. For specific information on CAL Package installation status, see the Viewing the CAL Package Download Status topic.

Allowlist Telemetry Proxy URL

If your network has a firewall setting or another security tool, allowlist the Telemetry Proxy URL from your welcome e-mail.