Appointment Automated Reports

This document is provided to help merchants have a better understanding of what appointment automated reports are, how they can be configured and what data is available with each report type.

---

What You Will Find in this Document

• Transfer and hosting configurations
• Report configuration and options
• List of all reports and metrics
• Data exported for each report type

---

Requirements

Transfer Configuration

The below table lists the information required to configure where automated reports will be transferred and how they will be stored. Take note that Booxi doesn’t provide hosting service.

Report Configuration

The content of the reports will be configured per the information below.

---

Report Types

Preconfigured Reports

Booxi provides a list of reports to choose from, each report comes with a predetermined list of fields. Take note that the preconfigured report will only export data marked as default. However, it is possible for a merchant to create a custom report by selecting any combination of fields. Please consult with your Booxi representative to make a selection.

---

Customizations

Field Selection

Reports can be customized by selecting any combination of fields and so for each report type. If you wish to customize the content of any report, please consult with your Booxi representative.

Field Names

Reports are generated in CSV format with each field as an individual column. If you wish to rename any or all columns appearing in a report, please consult your Booxi representative.

Field Order

When providing a custom list of fields, the order in which the fields are listed will dictate the order in which they will appear in the report. If you wish to change the order in which fields will appear in a report, please consult with your Booxi representative.

---

Appointment

Generate a report of all daily appointments for a merchant location. The report includes date, duration, service, staff, client and revenue associated with each appointment.

Filters

The following filters are provided to further customize the report’s content. Once set, all appointment reports will be generated with the selected filters.

The below table lists all available fields for an “Appointment” type report. For multi-service appointments, service fields will be repeated up to 5 times, once for each service assigned to the appointment.

Time Slot

Identify peak and downtimes by generating a report of all calendar time slots associated with a merchant. The report includes dates, duration, status, associated staff and store information.

Filters

The following filters are provided to further customize the report’s content. Once set,  all timeslot reports will be generated in accordance with the selected filters.

Fields

The below table lists all available fields for a “Time Slots” type report.

Consent Status

The below table lists all available fields for a “Consent Status” type report.

Name	Description	Default
client_id	Unique Booxi generated client ID	☐
client_name	Client's first and last name	☐
client_first_name	Client's first name  Note: the client's name at the time the consent was granted or revoked.	☐
client_last_name	Client's last name  Note: the client's name at the time the consent was granted or revoked.	☐
external_client_id	Client's external ID (ex: Salesforce)	☐
client_email	Client's email address	☐
client_phone	Client's phone number	☐
client_mobile	Client's mobile number	☐
client_postal_code	Client's postal code	☐
client_address	Client's address	☐
client_city	Client's city	☐
client_state	Client's state/province/territory, etc.	☐
client_country	Client's country	☐
client_ip_address	Client IP address  Note: May be captured in IPv4 or IPv6	☐
client_user_agent	OS, browser, IP, etc.	☐
booking_id	Unique Booxi generated booking ID	☐
service_id	Unique Booxi generated service ID	☐
service_name	Name of the queue service given by the brand	☐
merchant_id	Merchant ID associated with the booking where the consent was captured.	☐
merchant_name	Name of the store/merchant	☐
merchant_address	Store/merchant’s address	☐
merchant_city	Store/merchant’s city	☐
merchant_postal_code	Store/merchant’s postal code	☐
merchant_country	Store/merchant’s country	☐
staff_id	Unique Booxi generated staff ID	☐
external_staff_id	Staff’s external ID (ex: CEGID)	☐
consent_status	Granted Revoked	☐
consent_id	Unique Booxi generated consent ID	☐
consent_name	The consent name	☐
consent_version	The version of the consent that was displayed to the client	☐
consent_mandatory	Whether the consent is mandatory	☐
consent_language	The language of the consent text presented to the client. Ex: EN, FR, etc.	☐
consent_text	The text presented to the client when they granted or revoked their consent	☐
date_and_timestamp	The date and time that the consent was granted or revoked by or on behalf of the client (based on merchant timezone).	☐

Limitations

• The import of consent information is not supported.
• You are responsible for storing and maintaining your client consent data. For more information, contact your Booxi representative.
• We (Booxi) do not keep a copy of the generated reports.

Metric Reports

Metric reports provide a concise and comprehensive set of metrics to analyze how your business is performing from resource occupancy, popularity of services to trends. Several report types are offered to focus on specific data. See below for a list of all metric reports.

Metric Filters

The following filters are provided to further customize the report’s content. Take note that all metric report types will be generated with the selected filters.

Merchant Occupancy 

Fields

The below table lists all available fields for a “Merchant Occupancy” type report.

Merchant Appointment

Fields

The below table lists all available fields for a “Merchant Appointment” type report.

Service Occupancy

Fields

The below table lists all available fields for a “Service Occupancy” type report.

Staff Occupancy

Fields

The below table lists all available fields for a “Staff Occupancy” type report.

Resource Occupancy

Fields

The below table lists all available fields for a “Resource Occupancy” type report.

---

Protocol Options

Here is a list of protocols supported with the automated FTP report. When it comes to selecting a transfer method between FTP, FTPS or SFTP we highly recommend avoiding the basic FTP protocol and choosing a more secure option. As an alternative, reports can be uploaded to Google Cloud Storage by specifying GCS as a protocol.

Booxi is using dedicated outbound IPs for all reports except GCS. They should be whitelisted by customers.

FTP

FTP exchanges data using two separate channels known as the command channel and data channel. With FTP, both channels are unencrypted, leaving any data sent over these channels vulnerable to being intercepted and read. It should only be used in limited cases or on networks you trust.

FTPS

Like FTP, FTPS uses two connections: a command channel and a data channel. It authenticates your connection using a user ID and password, a certificate, or both. When connecting to a trading partner's FTPS server, your FTPS client will validate if the server's certificate is trusted. 

SFTP

SSH File Transfer Protocol is a separate protocol packaged with SSH that works in a similar way but over a secure connection. The advantage is the ability to leverage a secure connection to transfer files and traverse the filesystem on both the local and remote system. SFTP is preferable to FTP because of its underlying security features and ability to piggy-back on an SSH connection. Furthermore, SFTP needs only a single port number for all SFTP communications, making it easy to secure.

Public Key Fingerprint 

SFTP supports server fingerprint as an optional security feature. Our implementation requires the key to be in MD5 format.

Your server’s fingerprint can be obtained with the following console command:

A remote server’s fingerprint can be obtained like so:

Google Cloud Storage (GCS)

Google Cloud Storage is the object storage service offered by Google Cloud. In Cloud Storage, different objects are grouped in unique “namespaces” called buckets. A bucket can hold multiple objects yet, a single object will belong to only one bucket.

Client Configuration

The client must configure its destination storage bucket, using a Service Account. A destination folder must be created as files can’t be saved on the root. Contact your Account Manager or CS to request an account. 

We recommend configuring the storage bucket with the following settings.

• Region: Can either be Multi-Region or Region specific
• Storage Class: Standard
• Public Access: NOT Public
• Access Control: Uniform
• Protection: Activate one or more of the following protection options: Object Versioning Retention Policy or Default Event-Based Hold Option.
• Life Cycle rules: Weekly data deletion
• Requesters Pay: OFF
• Permissions: storage.buckets.get and storage.objects.create

The permissions above are included into the below roles:

• Storage Legacy Bucket Reader
  • Needed to read the metadata and the permissions on the bucket.
• Storage Object Creator
  • Needed to write the file blob.

Storage Directory

The client can specify in what “destination folder” reports will be exported. Folders and sub-folders must be formatted as : 'level1/level2/'. Leading '/' is unnecessary unless a root '/' folder is needed.

Furthermore, the storage directory must follow the below naming guidelines as provided by Google:

• Object names can contain any sequence of valid Unicode characters, of length 1-1024 bytes when UTF-8 encoded.
• Object names cannot contain Carriage Return or Line Feed characters.
• Object names cannot start with .well-known/acme-challenge/.
• Objects cannot be named . or ...

For further information about the naming guidelines, please consult this article.

---