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.

What's in this article:

Table of Contents
stylenone

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 Added
    3. Next, click the download icon for

How to Set Up the SQL Agent Integration with MSPbots

  1. Log in to MSPbots. Go to Integrations then search for SQL Agent.
    Integrations SQL AgentImage Removed

  2. Open SQL Agent and click on the Download link to download
    1. the MSPbots SQL Agent Client
  3. file
    1. to
  4. the SQL Server Management computer
    1. start downloading the installer file.
  5. download_SQLAgentClientImage RemovedExecute
    1. Image Added
    2. After the download is complete, follow the prompts to install the MSPbots SQL Agent
  6. .exe as an administrator
    1. client.
    2. During the setup, select Automatic Start and Create a desktop shortcut, then click Next. 
  7. mspbots sql agent_exeImage Removed
    1. sql setupImage Added
  8. Go back to the MSPbots app. Copy the Secret and Data Server strings from the SQL Agent page to the Setup window.
    secret_data serverImage Removed

  9. Complete the installation by clicking Next on the Setup window.
    mysql setup windowImage Removed 
  10. Next, run the MSPbots MS-SQL Server Agent as an administrator. 

  11. Return to the MSPbots app and click the + Add Connector button. 
    add connectorImage Removed

  12. Expand the drop-down options for SQL Server // and enter the following:
    1. IP 
    2. Database Name
    3. User ID 
    4. Password
      MySQLImage Removed
    5. Optional step:
      you can use the following SQL as an example to create a readonly DB user and password (please change the password '123456')

      GRANT SELECT ON *.* TO 'mspbots_sql_agent'@'%' IDENTIFIED BY '123456';

  13. Click Save And Sync.

    Note
    titleImportant

    The following operations will be completed with assistance from MSPbots support.  

  14. On the MSPbots app, go to Datasets. Choose a dataset and click the ellipsis ... > Edit
    edit datasetImage Removed

  15. When the Edit window appears, find the Data Cleaning tab, click it, and select SQL as Refresh Type. 
    data cleaningImage Removed

  16. Click the add icon and set the configurations for the SQL agent. 
    add configImage Removed
  17. Click Save to start data sync with MSPbots. 
    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 Added
    2. 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 Added

Set up the MSPbots Agent Connector

...

  1. Go to Integrations on the MSPbots app menu.
    integrationsImage Added
  2. Search for SQL Agent and click it to open the connection settings. 
    Image Added
  3. 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.


  4. 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.

  5. Click Save And Sync

Create a dataset and validate the data

...

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

    new datasetImage Added
  3. Next, go to the Data Cleaning tab to show the Validate SQL section below.
    1. Select a database from the DB dropdown list. 
    2. Scroll down to the Validate SQL section, fill in the SQL field. The most common SQL statement to use here is “select * from TABLENAME”. 
    3. 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
  4. Click 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.
    Image Added
  5. 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"
Content by LabelshowLabelsfalsemax5showSpacefalsetitleRelated TopicsexcludeCurrenttruecqllabel in ("integration","sql","agent")