Below, you will find a step-by-step guide outlining how to get all of your Aptora data flowing into BrightGauge.
One important thing to note: we will be referencing the SQL Server Database throughout this documentation. The reason for this is because SQL Server serves (pun intended!) as the foundation for our Aptora Integration; if you are housing your Aptora data in a different way, please reach out to our Support Team by selecting Help > Open a Ticket from the top menu bar.
Step 1 - Log in to your BrightGauge Account
If you haven’t created an account yet, go here to get started.
Once logged in, to get started:
- New Accounts
On first login, from the account Overview page, click on the "Add a Datasource" button.
- Existing Accounts
Click on the "Data" menu at the top righthand corner of the screen, and select "Datasources" from the drop down menu.
Find the "Aptora" icon under "All" or "Other".
Whether a new or existing account, you'll come to datasource settings screen below. Leave this page open as it will be used in Step 4. You can now proceed to the next steps.
Step 2 - Download and Install BrightGauge Agent
You’ll need to download and configure the BrightGauge Agent so that we can communicate with the SQL Server associated with your Aptora account. Click Download to download the agent. Documentation to help setup configure the BrightGauge Agent can be found here. Make sure to install the BrightGauge agent on a machine somewhere within the same network as your Aptora (MS-SQL) database. If you have issues, there are some known issues here or email firstname.lastname@example.org.
Step 3 - Create a SQL user within the SQL Server database
Once the agent is up and running, you’ll now need to create a local SQL user within the database. Here’s a guide on how to do that. Make sure to enable the user to log into the database. You’ll need to put the database name into #5 in the screenshot above.
Step 4 - Configure the Datasource Settings
Refer to the screenshot above and match the corresponding numbered fields:
- Name: A name for the connection.
- Agent Host: The computer on which the agent is installed.
- Database Internal IP/Hostname: Internal IP address or hostname for the database server (if using multiple SQL instances, use the IP or machine name followed by a backslash and then the instance name: 192.168.1.100\instance or SQLServer\instance).
- Database Name: The database name (e.g., cwwebapp_brightgauge).
- Database Internal Port: This field is for advanced SQL setups not using the default SQL port (1433). Enter the non-default port in this field. Leave BLANK if using the default SQL port (1433).
- Database Username: Your database username.
- Database Password: Your database password.
Step 5 - Test Connection
Once you've filled out all of the fields, make sure to test the connection. If successful, save the connection.
Please note, a common issue we have seen clients experience is with the "AutoFill" feature in web browsers inputting the wrong the credentials for the database user field. When a test connection is successful, the page is refreshed and the autofill takes effect automatically without the user realizing. The user then selects save, accidentally saving the autofilled credentials which are incorrect. A way to prevent this issue is to open a private browsing window (or incognito window) to fill out the datasource configuration page, or simply retyping the credentials after the test connection and clicking "Save".
Once you’ve saved the connection it's now off to build some new datasets! Help documents for SQL building in BrightGauge can be found here.
Your Default Datasets
- Bill Items
- Customer Jobs Details
- Customer Sales
- Opportunity Data
- Time Sheets
- Work Orders
For additional information, please check out our support forums here.