)
at fulfilled (/home/ubuntu/bartrack-pos/integrations/cli/cli.js:1419:58)
at process._tickCallback (internal/process/next_tick.js:68:7)
```
# Restaurant Manager Dev Guide
This is a three step process that calls ahead to an end-point with a POST along with site specific cert. It returns a list of signed, time-sensitive urls S3 for each file to upload by the BT Client. Once completed it calls GET on the batch for final processing after the uploads have been confirmed. Note that the file name of the export must match this name, it’s expectations based on the point-of-sale type.
# SmartTab Dev Guide
##### **Integration Type: - Undocumented API**
## Parameters Used
- venueId=1&\_=1638468699524
- **TODO:** - Need to discover what the second param \_ is for.
- timeZone
- timeStart
- timeEnd
- date
## Local Storage Keys
```
token: U2FsdGVkX183RZIJk5oO/AuYZbG6KES7q+E/2DoSSAAcX9l+6pduyb6uhJuTV46l
```
## Request Headers
```
Request-Method: GET
Authorization: Basic bWZsb3JlczpGbG9yZXMxNjA=
```
## Tabs Endpoint
I’m not sure yet if the mflores is a private sandbox api, or if that URL will be establishment specific.
##### Example URL:
`https://api-mflores.smarttab.com/api/report/tabReport/?timeStart=05%3A00%3A00&timeEnd=05%3A00%3A00&timeZone=America%2FNew_York&date=2020-10-05&venueId=1&_=1638468699524`
### Response JSON Example:
```JSON
[
{
"id": "30cc598f-58f9-4a3f-a4b0-381360d521a0",
"paymentId": null,
"ticketId": "3846f386-36e5-4281-8948-fe47566824d9",
"tableId": null,
"customerId": null,
"dayOrdinalNumber": 1,
"subNumber": null,
"tabStatus": "OPENED", //FILTER CLOSED ONLY
"paymentStatus": null,
"amount": null,
"tips": null,
"balanceDue": 39.18,
"total": 39.18,
"lastFourSymbols": null,
"smartTabFee": null,
"tableName": null,
"closeTime": null,
"dayTimestamp": "2020-10-05 00:00:00",
"tabName": "Test",
"paymentTender": null,
"customTender": null,
"creditTender": null,
"refundAmount": null,
"cardDataInputMethod": null,
"paymentSource": null,
"kioskMode": false,
"ownerId": 173,
"tabType": "BAR_TYPE",
"ownerName": "Michael Flores",
"customerName": "Test",
"tender": null,
"status": "OPENED",
"hasVoids": false,
"hasDiscounts": false,
"hasComps": false,
"voidsNum": null
}
]
```
## Ticket Endpoint
I’m not sure yet if the mflores is a private sandbox api, or if that URL will be establishment specific.
##### Example URL:
`https://api-mflores.smarttab.com/api/tab/ticketView?id=30cc598f-58f9-4a3f-a4b0-381360d521a0&venueId=1&_=1638468699525`
### Response JSON Example
*only showing pieces of data we’re looking for, this response has a huge tree for a single row*
```JSON
{
"productId": 894,
"itemizedDiscountAmount": 0
"isVoided": false,
"creationTime": "2020-10-05 21:27:15.459+00"
"deleted": false,
"created": "2020-10-05 21:27:26+00"
"modifiers": [],
"name": "EAGLE SHOT",
"price": 10,
"classId": 2,
"multiplier": 1,
"adjustedGrossPrice": 9.09,
"netPrice": 9.09, 72
"quantity": 1,
"subClassId": null,
"priceWithModsAndMultiplier": 10,
"includedTax": 1.07,
"excludedTax": 0
}
```
## Categories/Products Sold Endpoint
`https://api-mflores.smarttab.com/api/report/product/?dateStart=2021-01-01&dateEnd=2021-10-31&timeStart=05%3A00%3A00&timeEnd=05%3A00%3A00&timeZone=America%2FNew_York&classId%5B%5D=1&classId%5B%5D=2&classId%5B%5D=3&showSold=1&showNotSelling=0&venueId=1&_=1638566076252`
### Response JSON Example:
```JSON
[
{
"type": "BEER",
"classId": 1,
"cost": "3.30",
"quantity": "1",
"productId": 761,
"name": "SUDWERK PILSNER ",
"roleIds": [1],
"employeeIds": [173]
},
{
"type": "BEER",
"classId": 1,
"cost": "4.13",
"quantity": "1",
"productId": 209,
"name": "BUD LIGHT",
"roleIds": [1],
"employeeIds": [173]
}
]
```
## References:
[SmartTab Integration Notes (JIRA)](https://bartrack.atlassian.net/browse/BAR-950)
# Square Dev Guide
##### **Integration Type: - [Documented API](https://developer.squareup.com/reference/square)**
## Parameters Used
### Caveats
- Voids are not available on this integration.
- Due to the way voids are handled in the API data (not the visual report data), they no longer exist as an item line in the data set. Instead you have to listen to their webhook for monitoring order modifications as the Square API does not support it.
- `Authorization: Bearer {token}`
- Authorization: Bearer {token}
#### Parameters
- `cursor`
- Initial request is without `cursor`. If response includes `cursor` then paginate using response `cursor`.
- If no `cursor` is returned then it is the last page.
- Authorization: Bearer {token}
#### Body Parameters
- `location_id` as per response from get location
- `sales_start` format `YYYY-MM-DDTHH:MM:ssZ`
- `sales_end` format `YYYY-MM-DDTHH:MM:ssZ`
#### Body Example
```
{
"location_ids": [
{location_id}
],
"query": {
"filter": {
"date_time_filter": {
"closed_at": {
"start_at": {sales_start},
"end_at": {sales_end}
}
},
"state_filter": {
"states": [
"COMPLETED"
]
}
},
"sort": {
"sort_field": "CLOSED_AT",
"sort_order": "DESC"
}
}
}
```
#### Response JSON Example:
```
[
{
"id": "kTmqQ6TTaKVY8KlcbAJEQSyeV",
"location_id": "GXFWQJMA4XGBA",
"line_items": [
{
"catalog_object_id": "NPOXBH3AEIFOQUMJGDLELNZC",
"quantity": "1",
"name": "8- Gingers Revenge fig and vanilla",
"variation_name": "Regular",
"modifiers": [
{
"name": "12oz"
}
],
"gross_sales_money": {
"amount": 600
},
"total_tax_money": {
"amount": 45,
},
"total_discount_money": {
"amount": 60,
}
}
]
}
]
```
### References:
[Square Integration Notes (JIRA)](https://bartrack.atlassian.net/browse/BAR-1174)
# Touch Bistro Dev Guide
##### **Integration Type: - Undeveloped**
## References:
[Touch Bistro Integration Notes (JIRA)](https://bartrack.atlassian.net/browse/BAR-687)
# GoTab Dev Guide
GoTab API explorer:
[https://gotab.io/api/graph](https://gotab.io/api/graph)
[https://studio.apollographql.com/sandbox/schema/reference/objects/Item?query=returnType%3ADatetime](https://studio.apollographql.com/sandbox/schema/reference/objects/Item?query=returnType%3ADatetime)
[https://docs.gotab.io/reference/objects#item](https://docs.gotab.io/reference/objects#item)
List of order statuses:
- PENDING
- SCHEDULED
- SENT
- IN\_TRANSIT
- DELIVERED
- OFFLINE\_DELIVERED
- RECALLED
- VOIDED
- RESET
All items ordered on a tab for that fiscal day:
```
curl -L -X POST 'https://gotab.io/api//graph' \
-H 'Authorization: BearerToken' \
-H 'Content-Type: application/json' \
--data-raw '{"query":"query($locationUuid: String!) {\n location(locationUuid: $locationUuid) {\n tabsList(\n filter: {\n fiscalDay: { equalTo: \"2022-08-26\" }\n status: { equalTo: \"CLOSED\" }\n ordersPlaced: {greaterThan: 0}\n }\n ) {\n tabUuid\n href\n name\n status\n numGuests\n tabMode \n tax\n subtotal\n autograt\n total\n opened\n closed\n orderType\n server {\n userId\n name\n }s\n itemsList(\n filter: {\n ordered: {equalTo: true}\n }\n ) {\n fee\n discount\n comped\n voided\n status\n name\n itemId\n taxRate\n taxRateDetail\n sku\n subtotal\n subtotalInitial\n options {\n name\n shortName\n isProduct\n price\n quantity\n }\n adjustments {\n itemAdjustmentId\n quantity\n unitPrice\n adjustmentReason\n adjustmentType\n }\n accountingStream {\n accountingStreamUuid\n name\n reportingGroup\n }\n }\n }\n }\n}","variables":{"locationUuid":"NA2RpxKdptZYnHOA3Z~eIo4E"}}'
```
# SpotOn
Please see "Requesting API Access" here:
[SpotOn Establishment Setup Documentation](https://developers.spoton.com/enterprise/docs/enabling-api-access "https://developers.spoton.com/enterprise/docs/enabling-api-access")
# SpotOn
See official documentation:
[https://wiki.bartrack.beer/books/pos-integrations/page/spoton](https://wiki.bartrack.beer/books/pos-integrations/page/spoton "See Official Documentation")
# New Establishment or Integration
1. New integrations and establishment config will be added to staging first.
2. Integration would be tested in three parts:
1. individual establishment.
2. all establishments of integration type.
3. finally, all integrations/establishments (full daily automation)
3. These types of failure must be tested:
1. establishment has no data.
2. connection failure.
3. any type of breakage in one integration, does not cause break in another.
# Configuring New Locations
This outlines the processes necessary to configure a location in the database and begin pulling data
# Toast
## Gather POS Information
1\. In order to configure customers who utilize **Toast** as their POS provider the Customer Success team needs to have the customer create an account for us with the appropriate reporting privileges. Visit the [Toast Homepage](https://pos.toasttab.com/) in a web browser and proceed to **Login** - input the BarTrack `technology@bartrack.beer` credentials
2\. Locate `Switch Restaurant` on the top left side of the webpage and then click it and find the location you're trying to configure - you can either manually search the list or enter the establishment name into the filter
[](https://wiki.bartrack.beer/uploads/images/gallery/2022-04/image-1651060456221-54-09-am.png)
3\. Once the location has been found, make note of the establishment name and copy it exactly as displayed in the Toast dashboard. It is extremely important that this is accurately captured - if there are two lines, separate the content of the bottom and top line with a dash.
- In the screenshot above, we would want to record their location name as, `QBar Darien - 8109 cass avenue` in the database.
4\. The next step is to determine how the customer utilizes their Point of Sale system - particularly as it relates to Categories, and Sub-Categories. Navigate to the [Menus > Item Details](https://www.toasttab.com/restaurants/admin/reports/home#selection-details) page to pull up a breakdown of all the sales data at the establishment - you should select the date range for a busy day of the week such as Friday or Saturday.
[](https://wiki.bartrack.beer/uploads/images/gallery/2022-04/image-1651061810879-16-48-am.png)
- Once you've generated data for your specified date, try sorting by **Sales Category** or **Menu** to identify where the draft beer sales are.
- Toast has 3 layers of organizational hierarchy whereas we are only capturing 2 - *Category* and *Sub-Category*. You will need to use your judgment to determine which ones that we want to utilize, in the example above I assign `Menu Group` as the **Category** and `Sales Category` as the **Sub-Category**
The **Category** and **Sub-Category** will be different for every location - you will need to manually investigate this to ensure the data comes in clean for SKU mapping, otherwise we'll have to re-pull the data
5\. The last step in the Toast dashboard is to determine if a customer utilizes modifiers for their Draft Beer products. Once you're done identifying the **Category** and **Sub-Category** usage, click on one the Draft Beer items and it will pull up the *Order Details* - if you scroll down you'll see a list of items on the order and there will be a column labeled `Modifiers`.
[](https://wiki.bartrack.beer/uploads/images/gallery/2022-04/image-1651062498384-28-15-am.png)
- If there are things related to the glassware size, we will want to ensure that modifiers are marked as TRUE - otherwise, if modifiers do not appear to be a determining factor in identifying what a SKU represents mark this as FALSE
The Onboarding Team should have already identified if the customer utilizes modifiers so you can ask them for that information, otherwise, you can verify this yourself by looking at the data in Toast.
- - - - - -
## Database Configuration
1\. The next step in the configuration process is updating the **establishments** table of the database to reflect the necessary information for the integration. The primary things that you'll need to know are as follows:
- Establishment ID
- Timezone
- Location Name from Toast Dashboard
- Modifier Usage
- Category / Sub-Category
Once you have collected all of the necessary information you can proceed with executing the SQL query below, this will prompt you to enter several variables which encompass the information you captured above -
```SQL
UPDATE
establishments
SET
integration_id = 4,
default_pour_cost_pct = 20,
pos_hour_integration_done = 5,
pos_cloud_based = true,
pos_modifiers = ${pos_modifier_flag}$,
time_zone = '${timezone}$',
pos_properties = '{"header_titles": {"category": "${category}$", "subcategory": "${subcategory}$"}, "location_pos_name": "${establishment_toast_name}$"}'
WHERE
id = ${establishment_id}$;
```
**Example Data for Variables -**
```
Name Value
------------------------ --------------
pos_modifier_flag true
timezone US/Eastern
category Menu
subcategory Sales Category
establishment_toast_name Test Name
establishment_id 1
```
- - - - - -
## Server Configuration
1\. The final step of the configuration process is to SSH onto the POS server to modify the `settings.json` file and insert a new record for the location you are configuring - this can be found in the `/home/ubuntu/bartrack-pos/integrations/cli` directory on the server.
2\. In the configuration file you will need to locate the section for `toast` and then scroll to the bottom of that list of entries, see the screenshot below for reference -
[](https://wiki.bartrack.beer/uploads/images/gallery/2022-04/image-1651063505662.png)
3\. Once you have found the section, you will need to insert a record in the chronological position based on the `establishment_id`. In order to minimize error, it is recommended to copy the existing structure and paste it into the necessary position and then modifying the `establishment_id`. Once the changes have been finalized be sure to save your changes.
Make sure you are careful when editing the configuration file - incorrect formatting will result in the inability to pull POS data for any locations on the server. In order to minimize error, it is recommended to copy the existing structure and paste it into the necessary position - modifying the establishment
4\. Now that the establishment has been correctly configured you will be able to pull the POS data for the location, you will need to pull the data from the **Activation Date** onwards - it is recommended to pull at least one day of data to ensure that things are operational and there were no configuration-related issues.
# Omnivore
## Gather POS Information
1\. In order to configure customers who utilize **Omnivore** for their POS Integration the Customer Success team needs to have the customer install the Omnivore agent on their back-office machine. Visit the [Omnivore Control Panel Login](https://panel.omnivore.io/login) in a web browser and proceed to **Login** - input the BarTrack `technology@bartrack.beer` credentials
2\. Navigate to the `Locations` tab on the top center of the webpage menu - this will provide you a list of all of the customers that are currently integrated with BarTrack through Omnivore. You may utilize the search box on the top right side of the screen to quickly filter locations. See the attached image below for reference -
[](https://wiki.bartrack.beer/uploads/images/gallery/2022-04/image-1651065136740.png)
3\. Once you have found the location you're looking to configure, you will want to click on that customer and cross-reference the address displayed here with what we have captured in the database to ensure that we are referencing the correct location. Once you have confirmed that the location is valid, you will need to copy the `Location ID`
[](https://wiki.bartrack.beer/uploads/images/gallery/2022-04/image-1651065215673.png)
While here, it is useful to also reference the **Status** and **Ping Latency** in order to determine if there are any issues. As long as the status indicates they are Online and the ping latency does not have any significant yellow or red periods you are good to proceed.
If you do not see a location in the Omnivore Control Panel or their **Status** is offline - please contact the Customer Success team to coordinate a meeting with the customer
- - - - - -
## Database Configuration
1\. The next step in the configuration process is updating the **establishments** table of the database to reflect the necessary information for the integration. The primary things that you'll need to know are as follows:
- Establishment ID
- Timezone
- Modifier Usage
- Location Identifier
The Onboarding Team should have already identified if the customer utilizes modifiers so you will need to ask them for that information - if they are unsure, set this to FALSE and then reference the POS data that is captured
Once you have collected all of the necessary information you can proceed with executing the SQL query below, this will prompt you to enter several variables which encompass the information you captured above -
```SQL
UPDATE
establishments
SET
integration_id = 1,
default_pour_cost_pct = 20,
pos_hour_integration_done = 5,
pos_cloud_based = true,
pos_modifiers = ${pos_modifier_flag}$,
time_zone = '${timezone}$',
pos_properties = '{"processed_locations_ids": ["${location_id}$"]}'
WHERE
id = ${establishment_id}$;
```
**Example Data for Variables -**
```
Name Value
------------------------ --------------
pos_modifier_flag true
timezone US/Eastern
location_id i6EzBB4T
establishment_id 1
```
- - - - - -
## Server Configuration
1\. The final step of the configuration process is to SSH onto the POS server to modify the `settings.json` file and insert a new record for the location you are configuring - this can be found in the `/home/ubuntu/bartrack-pos/integrations/cli` directory on the server.
2\. In the configuration file you will need to locate the section for `omnivore` and then scroll to the bottom of that list of entries, see the screenshot below for reference -
[](https://wiki.bartrack.beer/uploads/images/gallery/2022-04/image-1651065864710-24-20-am.png)
3\. Once you have found the section, you will need to insert a record in the chronological position based on the `establishment_id`. In order to minimize error, it is recommended to copy the existing structure and paste it into the necessary position and then modifying the `establishment_id`. Once the changes have been finalized be sure to save your changes.
Make sure you are careful when editing the configuration file - incorrect formatting will result in the inability to pull POS data for any locations on the server. In order to minimize error, it is recommended to copy the existing structure and paste it into the necessary position - modifying the establishment
4\. Now that the establishment has been correctly configured you will be able to pull the POS data for the location, you will need to pull the data from the **Activation Date** onwards - it is recommended to pull at least one day of data to ensure that things are operational and there were no configuration-related issues.
# Square
## Gather POS Information
1\. In order to configure customers who utilize **Square** as their POS provider, the Customer Success team needs to gather an `Access Token` from the customer.
- The Customer Success team typically shares this in the [\#customer-pos-integrations](https://bartrack.slack.com/archives/C01V90HPYAJ) Slack channel or [Customer Onboarding Tracker](https://docs.google.com/spreadsheets/d/1IBeZlgJ_QjTNu7DRPAYuL-pgQR3NyUhv88KPFtXC2es/edit#gid=0) spreadsheet
2\. Once you have obtained an `Access Token` for a customers location, you will need to execute the following command on your Terminal -
```shell
curl https://connect.squareup.com/v2/locations \
-H 'Square-Version: 2022-02-16' \
-H 'Authorization: Bearer EAAAEP2HXAiYWQuoUlL0igb9C2-3HCaahVOdrfSPS7LnB4dwiyRUCBgyXo-IeMKs' \
-H 'Content-Type: application/json'
```
Make sure to replace the bearer token in the provided example with the Access Token that the customer provided
3\. After executing the command the server will return a large JSON object of location(s). You should utilize a [JSON Formatter](https://jsonformatter.org/json-pretty-print) to make this more legible, the output should look similar to the example below -
```JSON
{
"locations": [
{
"id": "4D09GFZF388XW",
"name": "Palate Bottle Shop",
"address": {
"address_line_1": "1007 N. 4th Street",
"locality": "Wilmington",
"administrative_district_level_1": "NC",
"postal_code": "28401",
"country": "US"
},
"timezone": "America/New_York",
"capabilities": [
"CREDIT_CARD_PROCESSING",
"AUTOMATIC_TRANSFERS"
],
"status": "ACTIVE",
...
]
}
```
4\. Once you have formatted the JSON object, you will need to find the location that represents the one you are currently trying to configure - be sure to validate the address as there might be multiple different locations under one account. Once you have identified the location you will need to copy the `id` value.
If there are no locations in the JSON object that match the location in the database, reach out to the Onboarding team and have them verify the address and which location that we are supposed to use for our integration
- - - - - -
## Database Configuration
1\. The next step in the configuration process is updating the **establishments** table of the database to reflect the necessary information for the integration. The primary things that you'll need to know are as follows:
- Establishment ID
- Timezone
- Location ID (Square)
- Modifier Usage
The Onboarding Team should have already identified if the customer utilizes modifiers so you will need to ask them for that information - if they are unsure, set this to FALSE and then reference the POS data that is captured
Once you have collected all of the necessary information you can proceed with executing the SQL query below, this will prompt you to enter several variables which encompass the information you captured above -
```SQL
UPDATE
establishments
SET
integration_id = 3,
default_pour_cost_pct = 20,
pos_hour_integration_done = 5,
pos_cloud_based = true,
pos_modifiers = ${pos_modifier_flag}$,
time_zone = '${timezone}$',
pos_properties = '{"locations_id": "${location_id}$"}'
WHERE
id = ${establishment_id}$;
```
**Example Data for Variables -**
```
Name Value
------------------------ --------------
pos_modifier_flag true
timezone US/Eastern
location_id 4D09GFZF388XW
establishment_id 1
```
- - - - - -
## Server Configuration
1\. The final step of the configuration process is to SSH onto the POS server to modify the `settings.json` file and insert a new record for the location you are configuring - this can be found in the `/home/ubuntu/bartrack-pos/integrations/cli` directory on the server.
2\. In the configuration file you will need to locate the section for `square` and then scroll to the bottom of that list of entries, see the screenshot below for reference -
[](https://wiki.bartrack.beer/uploads/images/gallery/2022-04/image-1651068845454-13-59-am.png)
3\. Once you have found the section, you will need to insert a record in the chronological position based on the `establishment_id`. In order to minimize error, it is recommended to copy the existing structure and paste it into the necessary position and then modifying the `establishment_id` and `access token` to reflect the location you're configuring. Once the changes have been finalized be sure to save your changes.
Make sure you are careful when editing the configuration file - incorrect formatting will result in the inability to pull POS data for any locations on the server. In order to minimize error, it is recommended to copy the existing structure and paste it into the necessary position - modifying the establishment
4\. Now that the establishment has been correctly configured you will be able to pull the POS data for the location, you will need to pull the data from the **Activation Date** onwards - it is recommended to pull at least one day of data to ensure that things are operational and there were no configuration-related issues.
# UpServe
## Gather POS Information
1\. In order to configure customers who utilize **UpServe** as their POS provider the Customer Success team needs to have the customer create a guest account for us using the integration email address. Visit the [UpServe Dashboard](https://reports.breadcrumb.com/login) in a web browser and proceed to login - input the BarTrack `technology@bartrack.beer` credentials
2\. Upon authentication, utilize the search box to identify the location you're attempting to configure. Once you've found the location, make a note of the establishment name.
[](https://wiki.bartrack.beer/uploads/images/gallery/2022-04/image-1651073590206-33-07-am.png)
- - - - - -
## Database Configuration
1\. The next step in the configuration process is updating the **establishments** table of the database to reflect the necessary information for the integration. The primary things that you'll need to know are as follows:
- Establishment ID
- Timezone
- Location Name (UpServe)
- Modifier Usage
The Onboarding Team should have already identified if the customer utilizes modifiers so you will need to ask them for that information - if they are unsure, set this to FALSE and then reference the POS data that is captured
Once you have collected all of the necessary information you can proceed with executing the SQL query below, this will prompt you to enter several variables which encompass the information you captured above -
```SQL
UPDATE
establishments
SET
integration_id = 5,
default_pour_cost_pct = 20,
pos_hour_integration_done = 5,
pos_cloud_based = true,
pos_modifiers = ${pos_modifier_flag}$,
time_zone = '${timezone}$',
pos_properties = '{"location_pos_name": "${location_name}$"}'
WHERE
id = ${establishment_id}$;
```
**Example Data for Variables -**
```
Name Value
------------------------ --------------
pos_modifier_flag true
timezone US/Eastern
location_name Outer Range Brewing Company
establishment_id 1
```
- - - - - -
## Server Configuration
1\. The final step of the configuration process is to SSH onto the POS server to modify the `settings.json` file and insert a new record for the location you are configuring - this can be found in the `/home/ubuntu/bartrack-pos/integrations/cli` directory on the server.
2\. In the configuration file you will need to locate the section for `upserve` and then scroll to the bottom of that list of entries, see the screenshot below for reference -
[](https://wiki.bartrack.beer/uploads/images/gallery/2022-04/image-1651073967644-39-24-am.png)
3\. Once you have found the section, you will need to insert a record in the chronological position based on the `establishment_id`. In order to minimize error, it is recommended to copy the existing structure and paste it into the necessary position and then modifying the `establishment_id` to reflect the location you're configuring. Once the changes have been finalized be sure to save your changes.
Make sure you are careful when editing the configuration file - incorrect formatting will result in the inability to pull POS data for any locations on the server. In order to minimize error, it is recommended to copy the existing structure and paste it into the necessary position - modifying the establishment
4\. Now that the establishment has been correctly configured you will be able to pull the POS data for the location, you will need to pull the data from the **Activation Date** onwards - it is recommended to pull at least one day of data to ensure that things are operational and there were no configuration-related issues.
# Revel
## Gather POS Information
1\. In order to configure customers who utilize **Revel** as their POS provider, the Customer Success team needs to gather the custom Revel `Login URL` from the customer and inform us which email address that the customer used to create a guest access account for us
- The Customer Success team typically shares this in the [\#customer-pos-integrations](https://bartrack.slack.com/archives/C01V90HPYAJ) Slack channel or [Customer Onboarding Tracker](https://docs.google.com/spreadsheets/d/1IBeZlgJ_QjTNu7DRPAYuL-pgQR3NyUhv88KPFtXC2es/edit#gid=0) spreadsheet
- - - - - -
## Database Configuration
1\. The next step in the configuration process is updating the **establishments** table of the database to reflect the necessary information for the integration. The primary things that you'll need to know are as follows:
- Establishment ID
- Timezone
- Login URL (Revel)
- Modifier Usage
The Onboarding Team should have already identified if the customer utilizes modifiers so you will need to ask them for that information - if they are unsure, set this to FALSE and then reference the POS data that is captured
Once you have collected all of the necessary information you can proceed with executing the SQL query below, this will prompt you to enter several variables which encompass the information you captured above -
```SQL
UPDATE
establishments
SET
integration_id = 2,
default_pour_cost_pct = 20,
pos_hour_integration_done = 5,
pos_cloud_based = true,
pos_modifiers = ${pos_modifier_flag}$,
time_zone = '${timezone}$',
pos_properties = '{"url": "${login_url}$"}'
WHERE
id = ${establishment_id}$;
```
**Example Data for Variables -**
```
Name Value
------------------------ --------------
pos_modifier_flag true
timezone US/Eastern
login_url https://solacebrewing.revelup.com
establishment_id 1
```
- - - - - -
## Server Configuration
1\. The final step of the configuration process is to SSH onto the POS server to modify the `settings.json` file and insert a new record for the location you are configuring - this can be found in the `/home/ubuntu/bartrack-pos/integrations/cli` directory on the server.
2\. In the configuration file you will need to locate the section for `revel` and then scroll to the bottom of that list of entries, see the screenshot below for reference -
[](https://wiki.bartrack.beer/uploads/images/gallery/2022-04/image-1651069630108-27-05-am.png)
3\. Once you have found the section, you will need to insert a record in the chronological position based on the `establishment_id`. In order to minimize error, it is recommended to copy the existing structure and paste it into the necessary position and then modifying the `establishment_id` and `username/password` to reflect the location you're configuring. Once the changes have been finalized be sure to save your changes.
Make sure you are careful when editing the configuration file - incorrect formatting will result in the inability to pull POS data for any locations on the server. In order to minimize error, it is recommended to copy the existing structure and paste it into the necessary position - modifying the establishment
4\. Now that the establishment has been correctly configured you will be able to pull the POS data for the location, you will need to pull the data from the **Activation Date** onwards - it is recommended to pull at least one day of data to ensure that things are operational and there were no configuration-related issues.