Get started with Analytics β Amazon S3
This article walks you through the prerequisites, onboarding process, and first steps for connecting to your Analytics β Amazon S3 data.
Before you begin
Confirm the following before you begin:
- Analytics Plus license β your Zenoti organization must have an active Analytics Plus license.
- S3 Data Share add-on β this paid add-on must be enabled by Zenoti for your organization. Contact your Zenoti account representative to request it.
- AWS S3 bucket β Zenoti provisions and provides an S3 bucket for your organization as part of onboarding. You do not need to create one yourself.
- BI tool or data pipeline β have a plan for how you will connect to and consume the data (Tableau, Power BI, AWS Athena, Snowflake, Databricks, Python, etc.).
Onboarding process
Access to Analytics β Amazon S3 is set up by the Zenoti Implementation team. You do not configure S3 access yourself.
What happens during onboarding:
- Request access β contact your Zenoti Implementation team or account representative to request S3 Data Share.
- Zenoti configures access β the Implementation team sets up your S3 Data Share configuration, including your data scope (organization, zone, or center level) and S3 bucket.
- Initial full load runs β once configured, the system performs an initial full load that populates GroupID 1 with all your historical Zenoti data. This may take some time depending on the size of your organization.
- Credentials provided β Zenoti provides the S3 bucket credentials and connection details you need to access your data.
- Incremental updates begin β after the full load completes, incremental data refreshes run automatically every 1β2 hours.
You do not need to take any action to start or schedule data refreshes. They run automatically after onboarding.
What to expect after onboarding
Once onboarding is complete, your S3 bucket contains:
- GroupID 1 β the initial full load with all historical data. This is your starting baseline.
- SchemaFull folder β schema definition files for every available table.
- SchemaUpgrade folder β schema change files for future Zenoti releases (may be empty initially).
Within 1β2 hours of completing onboarding, you should also see a GroupID 2 folder containing the first incremental update.
First steps: connect and verify your data
Step 1 β Connect to your S3 bucket
Use the credentials provided by your Zenoti Implementation team to connect to your S3 bucket. You can use the AWS Console, AWS CLI, or your preferred S3-compatible tool.
Step 2 β Review the SchemaFull folder
Before building any pipelines, open the SchemaFull folder at the root of your bucket. This folder contains schema definition files β one per table β that describe the column names and data types for every table available to you.
Use these schema files to create matching table structures in your data warehouse or BI tool. Column order in the CSV files matches the column order defined in the schema files.
Step 3 β Navigate the folder structure
Your data is organized as follows:
Root/
SchemaFull/ <- schema definition files for all tables
SchemaUpgrade/ <- schema changes released after onboarding
PODName/
1/ <- initial full load (historical data)
Bi_DimCenter/
logid/
filename.csv
Bi_FactInvoiceItem/
logid/
filename.csv
...more tables...
2/ <- first incremental update
3/ <- second incremental update
...
Step 4 β Verify data in GroupID 1
Navigate to Root > PODName > 1 and confirm that table folders are present and contain CSV files. This confirms your initial full load completed successfully.
Tip: Avoid reading from any folder that ends in
_processing. This suffix means a data refresh is still in progress. Wait until the suffix disappears before querying that GroupID.
Step 5 β Check SchemaUpgrade before consuming new data
After any Zenoti product release, check the SchemaUpgrade folder for schema changes. If new files appear, update your downstream table definitions before processing the next GroupID to avoid ingestion errors.
Building your data pipeline
A typical pipeline consuming Analytics β Amazon S3 data follows this pattern:
- Detect new GroupIDs β scan the PODName folder for any new completed GroupID folders (folders without the
_processingsuffix) since your last run. - Load dimension tables β process dimension table CSV files first. Update existing rows and insert new ones.
- Load fact tables β process fact table CSV files. Delete records where
void = 1, then insert records wherevoid = 0. - Update your watermark β record the highest GroupID you have processed so you can resume from the correct point next time.
You can also use the etlcreateddate column present in every table to identify records added or updated in each refresh cycle.
What happens next
- To understand the star schema and data model, see Understand the star schema and data model.
- To learn how data refreshes work, see Data freshness and refresh cycles.
- To connect BI tools to your bucket, see Configure S3 data access.
- To navigate your S3 bucket structure, see S3 folder structure and file format.
- To apply schema changes after Zenoti releases, see Handle schema changes and upgrades.
- To write queries against your data, see Query S3 data with external BI tools.