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 onto 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. The link to download the BrightGauge Agent is on this screen (Item "A" above). 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 email@example.com. If you want to limit the firewall exception to inquiries from our IP addresses, you can see them above item "B" in the image above (blurred out here, login to see the addresses).
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 below and match the corresponding numbered fields:
1. Connection Name (any name you'd like to refer to it within BrightGauge
2. The external IP address for the BrightGauge Agent on your network
3. Port Opened on our firewall
4. Internal IP Address for the Database or Machine Name (if using multiple SQL instances, use the IP or machine name followed by a back slash and then the instance name: 192.168.1.100\instance or SQLServer\instance)
5. Database name
6. 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).
7. Username you created in the database
8. Password you created for that username
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.