Salesforce Docs Portal

POS App Register & Hardware Vitals

Monitor the status of individual registers, store connections, and offline readiness using the Point of Sale (POS) Vitals feature.

Prerequisites:

  • Modern POS App Build: 5.10.3 and later
  • Platform Support: iPhone & iPad
  • Offline Support: yes

The POS Vitals feature offers a comprehensive overview of registers and store operations. It lists all registers configured for each store, offering real-time overview and detailed vital statistics. The POS app sends vital information to the system every five minutes.

After the POS app is rolled out to the stores, log in to Point of Sale CMS.

  1. Go to Store Management > Registers.
  2. Select the ‌store from the dropdown.The Registers screen of the Store Management section in Point of Sale CMS.

View POS App Vitals Information

Show the status of each register per store along with the current dollar value of transactions going through the register for the day in Point of Sale CMS.

High-Level Vitals Information

Register vitals data is retained for one year. You can't see Register Vitals because the register never sent a message to Salesforce’s Backend. You can also see Register Vitals because the last message from the register was more than one year old.

Register Vitals information shwoing in Point of Sale CMS.

Detailed Level Vitals Information

At the detailed level, we provide extensive information on each register's vital, peripheral connectivity, and offline data.

  1. Under POS Vitals (to the right of the store), select View.
  2. Configure the date filter.
  3. Select Search.
  4. Under Log Details (to the right of the register event), select View Details.The log details screen of the Reports section in Point of Sale CMS.

General Information

Genreal Register Information showing in Retail Clould CMS.

Register Connectivity

This reports if the register communicated with Point of Sale.

See Register Connectivity reports in Point of Sale CMS.

Peripheral Connectivity

The Perripheral Connectivity report in Point of Sale CMS.

Vitals also provides detailed information related to connectivity issues, if any, with each peripheral.

Connectivity issue reports about payment terminals shwoing in Point of Sale CMS.Information about scanner connectivity issues in Point of Sale CMS.Cash Drawer Connectivity Issues report in Point of Sale CMS.

Offline Data

We also provide details on offline activity and any orders that are pending sync with Point of Sale.

Offline orders pending and a list of offline tax feeds showing in Point of Sale CMS.An Offline Store Credentials Feed report in Point of Sale CMS.The Offline Product Delta Feed in Point of Sale CMS.The Offline Promotion Feed in Point of Sale CMS.

Export Point of Sale App Vitals

Export vitals data to Point of Sale using webhooks.

After being received by Point of Sale's backend, events are posted to the merchant-specified API endpoint. The JSON payload includes a snapshot of vitals (all captured metrics) and register metadata, such as the capture date and time, for the specific register on the current schedule for publishing vitals to Point of Sale.

  1. Go to Store Management > Integrations > Custom Connectors.
  2. Select Create in the upper right.
  3. Under Connector Type, select "Webhook".
  4. Under Endpoint Name, select "POS_Vitals".
  5. Configure the rest of the fields.
  6. Save your changes. Configure CMS for the POS Vitals Webhook endpoint.