Who is this article for?

Administrators / BI engineers integrating the system with analytics tools such as Power BI.

Account manager, SQL read-only, API, or web service access is required.

This article outlines two supported integration paths for hosted customers and provides guidance on how to request access and validate connectivity.

1. Hosted tenants (v7.4–v7.7) – SQL read‑only access

If your hosted tenant is running a version between 7.4 and 7.7, you can request SQL read‑only connectivity for reporting and analytics. The request process is outlined below.

1.1. Step A – Contact your account manager

• Reach out to your account manager to initiate the request and complete any required approvals or documentation.
• Confirm the database you need to access.

1.2. Step B – Raise a support request (include your account manager)

Once your account manager confirms that approvals are complete, raise a support request and include them on the thread. Provide the following information:

1. Your tenant URL and exact version (for example, 7.7.0.0).
2. Your intended use, such as Power BI DirectQuery or scheduled refresh, and the modules or tables you plan to target.
3. Source IPs or DNS names that need to be allow‑listed.

Note: SQL read‑only access is typically chosen when reporting governance requires curated, model‑driven datasets served directly from the database. If you prefer a service‑based approach, use the web services API path instead.

2. API (web services) – using the documentation

The system provides web services suitable for BI extraction. Use your environment’s API base URL and the authentication method configured for your tenant.

1. Download the API guides from the attachments section.
2. Validate authentication and test a small endpoint before scaling queries.
3. Map fields to your BI model using your internal data dictionary or field map.

3. Verification

1. SQL path: establish a read‑only connection from Power BI Desktop or your gateway and return a small dataset.
2. API path: authenticate to the base URL and parse JSON from a low‑volume endpoint into Power BI.

4. Troubleshooting

• Cannot connect over SQL (hosted): ensure your version is within 7.4–7.7, IPs are allow‑listed, and the account is read‑only.
• API calls fail or time out: check the base URL format and authentication, and begin with a small endpoint before scaling.
• Field mapping issues: confirm table and field names against your internal field map or data dictionary used for previous BI models.

5. Further reading

• Data dictionary (field map)
• How to install the web service APIs