Connections are used to automatically extract, load, and transform data from a client’s external system. Standard connectors and Custom connectors are two types of integration options that are available to users.

Standard Connection - User Guide

Managing your Connections

Adding a new connection

Select ‘Connections’ from the ‘CONNECTIONS’ dropdown menu.

Click ‘ADD CONNECTION’ on the homepage.

Select your system from the list.

Scroll down and click CONTINUE.

To setup integration in Briq, you have to connect your database.
You can set up your connection using WHITELISTING/VPN/ON-PREMISE SERVER
Connection Method 1 - Whitelisting
Connection Method 2 - SSL VPN (Point to Site)
Connection Method 3 - On-Premise Server
Fill out the required information and click ‘ADD CONNECTION’.

STANDARD CONNECTIONS vs NON-STANDARD CONNECTIONS

Standard Connections offer one-click connection functionality that will automatically bring in the required tables for planning and Forecasting.
On the Add Connection page, if a Standard Connection is selected, the mappings to the Briq Graph tables will be displayed.
If a Non Standard Connection is selected, the tables have to be added after establishing the connection.

Verifying a successful connection

STANDARD CONNECTION

Upon entering your credentials, the automation will then verify the credentials input against the system.
Once the automation is able to verify the connection, a successful authentication will be indicated with the blue tick next to the green Connected chip.
The Standard Workflow will automatically be created.
If the automation was unable to verify the credentials, the blue tick would not be displayed and the connection would return unhealthy.

NON-STANDARD CONNECTION

Upon entering your credentials, the automation will verify the credentials input against the system.
Once the automation is able to verify the connection, a successful authentication will be indicated with the blue tick next to the grey Deactivated chip.
The status will reflect Deactivated until a workflow is attached to the connection.
If the automation was unable to verify the credentials, the blue tick would not be displayed and the connection would be outlined with a red box, with a Fix icon.

Adding a Workflow

Workflows consists of the list of tables, schedule and import type specifications for bringing the data into Briq. The steps are as follows:

Click “Add Workflow” on the Connections homepage.

Name & Tables - Enter a Workflow Name, and select the tables from the dropdown and click continue.

Review Tables - Review the tables and click continue.

Data Frequency - Set frequency for data extraction and click Add Workflow.

Status Workflow

Statuses are used to represent the position of the connection in its workflow. The workflow represents a set of stages that a connection goes through to reach a final stage.

STATUS	DEFINITION	USER RECOMMENDED ACTION
Healthy	The connection extraction was successful, and indicated with a Healthy status.	If the table contains data, you can access the table in Briq by selecting the option “View Committed Results”. If the table has no data, the message "No new records" is displayed.
In Progress	The connection is currently being processed for data extraction.	If the status displays In Progress, the Last Run time component displays the latest time the connection has processed the data in Briq. If the time on the status has not updated for a while, please log a bug and contact a member of the Connections team.
Unhealthy	The connection failed to bring data into Briq.	Click on the Unhealthy workflow and locate the table that is unhealthy. Click on See Details to get a detailed error message. The error message significantly helps the Connections team when placed into the bug ticket to be looked into.
On Hold	When the connection is failing due to input required from client end, the workflow is marked On-Hold until the credentials are reverified.	The connection chip will change to Needs Attention once marking it On-Hold, for visibility that the connection requires input. If your workflow was marked On-Hold, verify the credentials for validity To mark a workflow On-Hold, click on the 3 dots on the workflow and click on Mark as On. To reactivate an On-Hold workflow, click on the 3 dots and select Activate.
Deactivated	The connection is inactive, no data is actively pulled into Briq.	To deactivate a workflow, click on the 3 dots on the workflow and click on Deactivate. To reactivate the workflow, click on the 3 dots and select Activate.

Using the Audit Trail

Within the Connections workflow, the Audit Trail is a useful tool to debug or identify where in the connection process the workflow is producing an error.

Click the "Audit Trail" tab on the connections page.
To find failures, use the filtering option available on the Status column.
The message would provide detail as to where in the process the connection had failed. If the message displays an error on the client credentials, it is easy to verify. If you are unsure of the error message, please reach out to a member of the Connections team, and log a bug.

Best Practices for Logging Bugs

Bug Content

When encountering a bug in the connection, having as much information as possible will speed up the resolution process by identifying the bug early on. A few pieces of information that would help:

For unhealthy connections, access the workflow, and click on See Details to include the message.
Check the Audit Trail tab on the workflow, to note any error messages that appear.
Check the Files tab on the workflow to see if any files had come in for the expected tables and include in the ticket.

If the error message is straightforward, such as invalid client credentials, or a firewall access issue, the client should be made aware of it, and a ticket on the IM board is to be created to track the task. If the error message is unclear and or it is an issue with the product, create a ticket on the SDT board for Product/Engineering.

Adding a Standard Connection