Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This guide will help you do the following steps for connecting the MSPbots SQL agent to MSPbots:  .

What's in this article:

Table of Contents
stylenone

Verify if you are using a previous version of SQL Agent.

If you have SQL Agent 3.0 installed, proceed to Step 2. If an older version is installed, uninstall it first with the following steps:  

    1. Go to the Agent installation directory. 
    2. Find the unins000.exe uninstall file and run it. 
      uninstall SQL AgentImage Removed 

Download and install SQL Agent 3.0.

Complete the prerequisites

...

Please create a new read-only account in your SQL Server or MySQL as follows: How to Create a Read-only Account for Your SQL Server or MySQL. If you already have a read-only account specifically for communicating with MSPbots, please skip this prerequisite.

Connect the MSPbots agent

...

    1. Go to Integrations on the MSPbots app menu. 
    2. Find the SQL Agent and click the Config icon.
      SQL agent configImage Modified
    3. Next, click the download icon for the MSPbots SQL Agent Client to start downloading the installer file.
  1. download sql agentImage RemovedLocate and double-click on the downloaded installer
    1. Image Added
    2. After the download is complete, follow the prompts to install the MSPbots SQL Agent client.
    3. During the setup, select Automatic
  2. start
    1. Start and Create a desktop shortcut,
  3. then
    1.  then click Next
      sql setupImage Modified
  4. Follow the prompts.
    1. In the last step, tick the Launch MSPbotsAgentService checkbox and click Finish. The window will automatically close when the service starts.
      complete sql setupImage Modified
  5.  
  6. Open the Agent client by double-clicking on the shortcut you created in Step 2e above. 
  7. Log

Set up the MSPbots Agent Client.

    1. Launch the MSPbots agent and log in using your MSPbots account. You can Minimize or Close the window after login but do not log out. 
      login agent clientImage Modified

Set up the MSPbots Agent Connector

...

  1. Go
  2. back to Integrations and click the Add Connector button.
    add connectorImage Removed
  3. Scroll down to the SQL Server section and select a Database type.
    sql server database configImage Removed 
  4. Configure the following database information:
    For SQL Server 
    The Database IP information configuration rules are:
    Default instance + Default port (1433): IP
    Default instance + Custom port: IP,XXXX
    Default instance + Custom port: IP\ Instance Name,XXXX 
    For My SQL
    The Database uses the default port (3306): IP 
    The Database uses a custom port number: IP;port=XXXX 
    sql db ip settingsImage Removed
  5. to Integrations on the MSPbots app menu.
    integrationsImage Added
  6. Search for SQL Agent and click it to open the connection settings. 
    Image Added
  7. Click the +Add Connector button. 
    image sql add connectorImage Added
    Info

    The last success auth shows the last time when the MSPbots Agent successfully pulled the database configuration information. By default, this process is set to occur every 5 minutes.


  8. Fill in all of the following required fields. It may take a few moments for the agent to check in after installation.
    • Database Type - Select either SQL Server or MySQL.
    • Agent - The agent will auto-populate with the machine name you installed.
    • IP - Provide the internal IP address or FQDN of the SQL or MySQL server.
    • Database Name
    • Time Zone - Select the time zone used by the connected database.
    • User ID - This is the username of the user with read-only access to the database.
    • Password - This is the password of the user with read-only access to the database. 

      image sql agent infoImage Added

      Note

      If you have installed multiple MSPbots agents with different databases in different network segments, you have to select the device name where you manually installed the MSPbots Agent. You can find the device name in the Agent selection box. Select the one under the corresponding gateway of the database.

  9. Click Save And Sync
  10. After the configuration is complete, click Save And Sync
  11. Refresh your browser

Create a dataset and validate the data

...

...

  1. Go to Datasets on the MSPbots app menu and click the New
  2. SQL
  3. Agent Dataset button. 
  4. new sql datasetImage Removed
  5. new agent datasetImage Added
  6. When the New window appears, click Integration and select SQL Agent. Don't forget to fill in the dataset Name and Description fields.

  7. dataset name and descriptionImage Removed
  8. new datasetImage Added
  9. Next, go to the Data Cleaning tab to show the Validate SQL section below.
    1. Select a database from
  10. the
    1. the DB dropdown list. 

  11. DB name and sync frequencyImage Removed
    1. Scroll down to the Validate SQL section, fill in the SQL field
  12. , and input your desired Sync Frequency in minutes.
    1. . The most common SQL statement to use here is “select * from TABLENAME”. 
    2. Input your desired Sync Frequency in minutes.
      Tip

      Sync Frequency is currently limited to 30 minutes and can only be decreased for smaller datasets. For larger datasets, the frequency may be limited due to a large amount of data ingestion and the constraint it would place on both your server and ours. 


      DB name and sync frequencyImage Added
  13. Click
  14. Click 
  15. Confirm when done. This will show a preview of the data for your validation. You can customize or use the default character length for string-type fields, and the time field can be set with a timezone.
  16. validate dataset previewImage Removed
  17. Image Added
  18. Once you confirm the data is correct, click OK to create and save the dataset. The data will be synchronized in 10 minutes.

Save the logs and send the file to MSPbots Support Team

...

  1. Open the MSPbots Agent client and click the Save Log button on the upper right corner of the window. 
    save logImage Added
  2. Click Confirm on the Tips popup that appears. 
    tipsImage Added
  3. Next, select the location to save the logs, provide a filename, and click Save.
  4. Send the file to support@mspbots.ai

Related Topics

...

Content by Label
showLabelsfalse
showSpacefalse
excludeCurrenttrue
cqllabel = "sql"