Pull from SevenRooms

SevenRooms is a guest experience and data platform for the hospitality industry. Restaurants, hotels, and other operators use it to manage guest profiles, reservations, and transactions.

SevenRooms can send guest profiles, reservations, venues, and charges to Amperity. Choose which data streams to pull: clients (guest profiles) and venues are pulled as full exports, while reservations and charges are pulled incrementally based on the courier’s date range. Amperity creates a feed and domain table for each data stream you select.

Beta

The SevenRooms source connector is currently in beta. Contact your Amperity representative to learn more.

The steps that are required to pull guest profiles, reservations, venues, and charges to Amperity from SevenRooms:

  1. Get details

  2. Add courier

  3. Run courier

  4. Review feed and domain table

  5. Add to courier group

Get details

SevenRooms requires the following configuration details:

  1. The Client ID and Client Secret for your SevenRooms API credentials.

    Request API credentials (a client ID and client secret) from SevenRooms. API access must be provisioned for your account before Amperity can connect to SevenRooms.

  2. The Base URL for the SevenRooms API, including the version path. For example: https://demo.sevenrooms.com/api-ext/2_2. Your production base URL differs from the demo URL.

  3. The Venue Group ID for your SevenRooms account. This scopes the data that Amperity pulls.

  4. The Data types to pull. Select any combination of clients, reservations, venues, and charges.

Tip

Use SnapPass to securely share configuration details for SevenRooms between your company and your Amperity representative.

Add courier

A courier brings data from an external system to Amperity.

To add a courier

  1. From the Sources page, click Add Courier. The Add Courier page opens.

  2. Find, and then click the icon for SevenRooms. The Add Courier page opens.

  3. Enter the name of the courier. For example: “SevenRooms”.

    From the Credential field, select an existing credential or select Create a new credential.

    To add a credential, enter the name of the credential, a description, and the SevenRooms Client ID and Client Secret. Click Save.

    When finished click Continue.

  4. Enter the Base URL and Venue Group ID for your SevenRooms account.

  5. Under Data types, select the data streams to pull: clients, reservations, venues, and charges.

  6. Click Create.

    Amperity creates a feed and domain table for each selected data type.

Run courier manually

Run the courier again. This time, because the load operations are present and the feeds are configured, the courier will pull data from SevenRooms.

To run the courier manually

  1. From the Sources tab, open the menu for the courier with updated load operations that is configured for SevenRooms, and then select Run. The Run Courier dialog box opens.

  2. Select the load option, either for a specific time period or all available data. Actual data will be loaded to a domain table because the feed is configured.

  3. Click Run.

    This time the notification will return a message similar to:

    Completed in 5 minutes 12 seconds

Review feed and domain table

After running the SevenRooms courier, Amperity creates a feed and domain table for each data type you selected: clients, reservations, venues, and charges. You may apply semantic tags to the fields in these tables and you may make each domain table available to Stitch, depending on your use case.

Add to courier group

  1. From the Sources tab, click Add Courier Group. This opens the Create Courier Group dialog box.

  2. Enter the name of the courier. For example: “SevenRooms”.

  3. Add a cron string to the Schedule field to define a schedule for the orchestration group.

    A schedule defines the frequency at which a courier group runs. All couriers in the same courier group run as a unit and all tasks must complete before a downstream process starts. Define a schedule using cron.

    Cron syntax specifies the fixed time, date, or interval at which cron runs. Each line represents a job. 30 8 * * * represents “run at 8:30 AM every day” and 30 8 * * 0 represents “run at 8:30 AM every Sunday”.

    For example:

    ┌───────── minute (0 - 59)
│ ┌─────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌────────────── month (1 - 12)
│ │ │ │ ┌─────────────── day of the week (0 - 6) (Sunday to Saturday)
│ │ │ │ │
│ │ │ │ │
│ │ │ │ │
* * * * * command to execute

    Amperity validates the cron syntax and shows you the results. You may also use crontab guru to validate cron syntax.

  4. Set Status to Enabled.

  5. Specify a time zone.

    A courier group schedule is associated with a time zone. The time zone determines the point at which a courier group’s scheduled start time begins. A time zone should be aligned with the time zone of system from which the data is being pulled.

    Use the Use this time zone for file date ranges checkbox to use the selected time zone to look for files. If unchecked, the courier group uses the current time in UTC to look for files to pick up.

    Note

    The time zone that is chosen for an courier group schedule should consider every downstream business processes that requires the data and also the time zones in which the consumers of that data will operate.

  6. Add at least one courier to the courier group. Select the name of the courier from the Courier dropdown. Click + Add Courier to add more couriers.

  7. Click Add a courier group constraint, and then select a courier group from the dropdown list.

    A wait time is a constraint placed on a courier group that defines an extended time window for data to be made available at the source location.

    Important

    A wait time is not required for a bridge.

    A courier group typically runs on an automated schedule that expects customer data to be available at the source location within a defined time window. However, in some cases, the customer data may be delayed and is not made available within that time window.

  8. For each courier group constraint, apply any offsets.

    A courier can be configured to look for files within range of time that is older than the scheduled time. The scheduled time is in Coordinated Universal Time (UTC), unless the “Use this time zone for file date ranges” checkbox is enabled for the courier group.

    This range is typically 24 hours, but may be configured for longer ranges. For example, it is possible for a data file to be generated with a correct file name and datestamp appended to it, but for that datestamp to represent the previous day because of how an upstream workflow is configured. A wait time helps ensure that the data at the source location is recognized correctly by the courier.

    Warning

    This range of time may affect couriers in a courier group whether or not they run on a schedule. A manually run courier group may not take its schedule into consideration when determining the date range. Only the provided input days to load data from are used as inputs.

  9. Click Save.