Skip to main content

Data Stream Endpoints

From the Xenial Portal, define endpoints where external data is published. For example, define endpoints for accounting and labor scheduling data for consumption by external partners.

Create Data Stream Endpoint

Xenial Portal Settings and Tools Data Stream Endpoints

To create a data stream endpoint:

Define General Settings for an Endpoint

Xenial Portal Settings and Tools Data Stream Endpoints

There are two types of endpoints:

  • HTTP

  • SQS

To define settings for an HTTP endpoint:

  1. From the menu pane on the left of the data stream endpoint record, select General.

  2. In the Name field, type the name of the endpoint.

  3. In the Description field, type a description of the endpoint.

  4. From the Type dropdown, select HTTP.

  5. In the Target endpoint field, type/paste the URL where endpoint data is sent.

  6. In the Access Token field, type the value used for authorization for the target HTTP endpoint (if required).

  7. To validate the endpoint connection values, select Validate Connection.

To define settings for an SQS queue endpoint:

  1. From the menu pane on the left of the data stream endpoint record, select General.

  2. In the Name field, type the name of the endpoint.

  3. In the Description field, type a description of the endpoint.

  4. From the Type dropdown, select SQS.

  5. In the Target endpoint field, type/paste the URL where endpoint data is sent.

Define Availability Settings for an Endpoint

Xenial Portal Settings and Tools Data Stream Endpoints

To define the availability of a data stream endpoint:

  1. From the menu pane on the left, select Availability.

  2. Toggle Active to Yes if the data stream endpoint is currently active and available.

    • Multi-site users: To the right of the field, select the globe icon to define values for each site.

Enable Orders for an Endpoint

Xenial Portal Settings and Tools Data Stream Endpoints

To send POS orders to a data stream endpoint:

  1. From the menu pane on the left, select Orders.

  2. Toggle Enable to Yes.

  3. Toggle Send Net/Gross Sales to Yes to send Net and Gross Sales data to the endpoint.

    • This setting is intended to accommodate external consumers who prefer receiving precalculated Net and Gross Sales data within the order payload.

  4. Toggle Filter Data to Yes to define order state and order type filters.

    When this toggle is enabled, the following sections are displayed:

Add Order State Filters

To add order state filters:

  1. Locate the Order States section.

  2. Select Add Filters.

  3. From the Add Order States window, select the order states to send to the endpoint.

  4. Select Add Item(s).

To remove an order state from the list, select the X on the row of the order state.

Add Order Type Filters

To add order type filters:

  1. Locate the Order Types section.

  2. Select Add Filters.

  3. From the Add Order Types window, select the order types to send to the endpoint.

  4. Select Add Item(s).

To remove an order type from the list, select the X on the row of the order type.

Enable Drawer Events for an Endpoint

Xenial Portal Settings and Tools Data Stream Endpoints

To send POS drawer events to the endpoint:

  1. From the menu pane on the left, select Drawers.

  2. Toggle Enable to Yes.

  3. Toggle Filter Data to Yes to define drawer event type filters. When toggled on, the Drawer Event Types section is displayed.

Add Drawer Event Type Filters

To add drawer event type filters:

  1. Locate the Drawer Event Types section.

  2. Select Add Filters.

  3. From the Add Drawer Event Types window, select the drawer event types to send to the endpoint.

  4. Select Add Item(s).

To remove an event type from the list, select the X on the row of the event type.

Enable Deposits for an Endpoint

Xenial Portal Settings and Tools Data Stream Endpoints

To send deposit data to the endpoint:

  1. From the menu pane on the left, select Deposits.

  2. Toggle Enable to Yes.

  3. Toggle Filter Data to Yes to define deposit status filters.

    • When this toggle is enabled, the Deposit Statuses section is displayed. Add deposit status filters in this section.

Add Deposit Status Filters

To add deposit status filters:

  1. Locate the Deposit Statuses section.

  2. Select Add Filters.

  3. From the Add Drawer Event Types window, select the drawer event types to send to the endpoint.

  4. Select Add Item(s).

To remove a deposit status from the list, select the X on the row of the deposit status.

Enable Employee Time Punches for an Endpoint

Xenial Portal Settings and Tools Data Stream Endpoints

To send employee time punches to the endpoint:

  1. From the menu pane on the left, select Punches.

  2. Toggle Enable to Yes.

Enable EOD Notifications for an Endpoint

Xenial Portal Settings and Tools Data Stream Endpoints

To send End of Day (EOD) notifications to the endpoint:

  1. From the menu pane on the left, select EOD.

  2. Toggle Send Site EOD to Yes to enable site-level EOD notifications.

  3. Toggle Send Terminals EOD to Yes to enable terminal-specific EOD notifications.

Resend Data to Data Stream Endpoint

Xenial Portal Settings and Tools Data Stream Endpoints

To resend transactional data to a data stream endpoint:

  1. From the Data Stream Endpoints page, locate the endpoint.

  2. From the right of the endpoint, select the 3-dots menu.

  3. From the 3-dots menu, select Resend Data.

  4. From the Resend Data window, specify the data to resend:

  5. From the lower-right of the Resend Data window, select Send.

Resend Deposit Data

From the Resend Data window, define the following:

Field

Description

Entity

From the dropdown, select Deposits.

Site

From the dropdown, select the site.

Business Date

Select the calendar icon to specify the business date to resend.

Deposit Statuses

Select the deposit statuses to resend.

To use the filters defined for the endpoint, leave this field blank.

Deposit IDs

Specify the deposit IDs to resend.

  • Put quotation marks around each ID.

  • Separate the IDs with a comma.

Example: "23c2cb1d-e01a-46e8-8bf7-2ca374daa665", "257dafeb-ec2d-4869-8da9-11b132c53364"

Resend Drawer Data

From the Resend Data window, define the following:

Field

Description

Entity

From the dropdown, select Orders.

Site

From the dropdown, select the site.

Business Date

Select the calendar icon to specify the business date to resend.

Drawer Event Types

Select the drawer event types to resend.

To use the filters defined for the endpoint, leave this field blank.

Drawer IDs

Specify the Drawer IDs to resend.

  • Put quotation marks around each ID.

  • Separate the IDs with a comma.

Example: "10025", "10026"

Drawer Event IDs

Specify the Drawer Event IDs to resend.

  • Put quotation marks around each ID.

  • Separate the IDs with a comma.

Example: "11002", "21056"

Resend Order Data

From the Resend Data window, define the following:

Field

Description

Entity

From the dropdown, select Orders.

Site

From the dropdown, select the site.

Business Date

Select the calendar icon to specify the business date to resend.

Order Numbers

Specify the order numbers to resend.

  • Put quotation marks around each order number.

  • Separate the order numbers with a comma.

Example: "10025", "10026"

Order IDs

Specify the order IDs to resend.

  • Put quotation marks around each ID.

  • Separate the IDs with a comma.

Example: "1-1002", "2-1056"

Order States

Select the order states to resend.

To use the filters defined for the endpoint, leave this field blank.

Order Types

Select the order types to resend.

To use the filters defined for the endpoint, leave this field blank.