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

The following is required to connect the agent: 

Internal IP of the SQL Server 

To get the internal IP: 

    1. Launch the Control Panel and open Network and Sharing Center
      network and sharingImage RemovedGo back to Integrations and click the Add Connector 
    2. On the Network and Sharing Center, click your Connection
      wifi connectionImage Removed
    3. When the Wi-Fi Status window appears, click the Properties button. 
      wifi propertiesImage Removed
    4. Take note of your IPv4 Address
      IP addressImage Removed

db_datareader permissions

    1. Open your SQL server and select db_datareader permissions for MSPbots.
      Warning

      Giving any account full DB access is not recommended.

       
      db user permissionsImage Removed
    2. Click OK.

...

...

    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, then click Next
      sql setupImage Modified
  3. 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
    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 Modified

Set up the MSPbots Agent Connector

...

...

  1. Go
  2. back to 
  3. to Integrations on the MSPbots app menu.
    integrationsImage Added
  4. Search for SQL Agent and click it to open the connection settings. 
    Image Added
  5. Click the +Add Connector button
  6. Integrations and click the Add Connector button

  7. image sql add connectorImage Modified
    Info
  8. Last
  9. 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.


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

        image sql agent infoImage Modified

        Note

        If you have installed multiple MSPbots agents with different databases in different network segments, you

    • need
      • have to select the device name where you manually installed the MSPbots Agent

    • is installed. The agent is found
      • . You can find the device name in the Agent selection box. Select the one under the corresponding gateway of the database

    • in the Agent selection box
      • .

    • 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. 
  2. new agent datasetImage Removed
  3. new agent datasetImage Added
  4. When the New window appears,

  5. click
  6. click Integration and select SQL Agent. Don't forget to fill in the dataset Name and Description fields.

    new datasetImage Modified
  7. Next, go to the Data Cleaning tab to show the Validate SQL section below.
    1. Select a database from
  8. the
    1. 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
  9. “select DB name and sync frequencyImage Removed
    Scroll down to the Validate SQL section, fill in the SQL field, and input your desired
    1. “select * from TABLENAME”.
    1.  
    2. Input your desired 
    1. 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. 

  10. Click

    1. DB name and sync frequencyImage Added
  11. 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.
  12. validate dataset previewImage Removed
  13. Image Added
  14. 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 Modified
  2. Click Confirm on the Tips popup that appears. 
  3. confirm log downloadImage Removed 
  4. tipsImage Added
  5. Next, select the location to save the logs, provide a filename, and click Save.
  6. Send the file to support@mspbots.ai

Related Topics

...

Content by Label
showLabelsfalse
showSpacefalse
excludeCurrenttrue
cqllabel = "sql"