This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Manage Devices

Specific tasks for managing devices.

1 - Add Linux Device

Install the maiLink Agent on a Linux-based system.

Prerequisites


  1. You have administrator rights to install software

Step 1: Begin installing Agent software on remote device


  1. In a browser, log into your maiLink account at app.maidata.io.
  2. Navigate to the Software tab.
  3. Locate the proper version, for example 64bit linux, mailink-agent_{version}_linux_amd64.deb, right click and copy the Link/URL.
  4. Go to your Terminal window and navigate to your home directory run the following command. Your coppied url will vary.
wget https://github.com/maiData/releases/releases/download/{version}/mailink-agent_{version}_linux_amd64.deb
  1. Run the following command (replacing version) in the directory you have transfered the .deb file to.
sudo apt install ./mailink-agent_{version}_linux_amd64.deb

Output

Reading package lists... Done
Building dependency tree
Reading state information... Done
Note, selecting 'mailink' instead of './mailink-agent_22.5.3_linux_amd64.deb'
The following NEW packages will be installed:
  mailink
0 upgraded, 1 newly installed, 0 to remove and 105 not upgraded.
After this operation, 13.8 MB of additional disk space will be used.
Get:1 /home/maidata/Downloads/mailink-agent_22.5.3_linux_amd64.deb mailink amd64 22.5.3 [5,537 kB]
Selecting previously unselected package mailink.
(Reading database ... 108002 files and directories currently installed.)
Preparing to unpack .../mailink-agent_22.5.3_linux_amd64.deb ...
 Please provide the device key:
 :>
Progress: [ 20%] [#####################.....................................................................................]
  1. Leave the installer as shown above and proceed to Step 2.

  1. Navigate to the Devices page.
  2. Click on Create Device.

  3. Enter a Device Name and Device ID (Serial Number is recommended).
  4. Click + to add tags that help identify the system, such as:
    1. Site Name
    2. Address
    3. IP Address

  5. Click Create to save the settings and open the Device Info page for the new device.

Step 3: Create a Device Key for the new device.


  1. Click on Device Keys side tab.

  2. Click on Create Key.

  3. Click on Copy Device Key to save the key to the Clipboard.

Step 4: Finish the Agent Installation


  1. Return to the Agent installer on the remote device.
  2. Paste the content of the clipboard (Right Click or Ctrl + Shift + V) into the Installer screen, and then hit .
  3. The installer will complete as follows…
Unpacking mailink-agent (22.9.11) ...
Setting up mailink-agent (22.9.11) ...
 Setting permissions
 Creating logging directory
 Creating linux configuration file
 Creating plugin directory structure
 Setting up service
  1. Verify the Agent is running by running this command
sudo systemctl status mailink-agent.service

Output

● mailink-agent.service - maiData maiLink Service
   Loaded: loaded (/etc/systemd/system/mailink-agent.service; enabled; vendor preset: enabled)
   Active: active (running) since Mon 2022-09-19 20:18:02 UTC; 1min 29s ago
 Main PID: 7713 (mailink-agent)
    Tasks: 13 (limit: 500)
   CGroup: /system.slice/mailink-agent.service
           ├─7713 /usr/bin/mailink-agent run --mailink-home /etc/mailink
           └─7784 /etc/mailink/mailink-agent-plugin serve

Step 5: Verify the Agent is Connected


  1. Navigate to the Devices page in the maiLink webpage.
  2. Verify that the device is connected to the maiLink SRM Cloud by observing a small solid green dot in the upper left section of the “About Device” page.

Success!


The new device is now connected. If you have the maiLink Client installed on your machine, you will be able to access the new device remotely.

If you have issues, contact your Administrator or email maiData Customer Support at maiData at service@maidata.io.

2 - Add Windows Device

Install the maiLink Agent on a Windows-based system

Prerequisites


  1. You have installed maiLink Client on your computer
  2. You have downloaded or transferred the maiLink agent installer
  3. You have administrator rights to install software

Step 1: Begin installing Agent software on remote device


  1. In a browser, log into your maiLink account at app.maidata.io.
  2. Navigate to the Software tab.
  3. Select maiLink Agent and Windows.
  4. Click on the installer mailink-agent_{version}_windows_amd64.exe for the latest version of the Agent software.
  5. Follow the instructions until you arrive at the maiLink Agent Device key screen.

  6. Leave the installer as shown above and proceed to Step 2.

  1. Navigate to the Devices page.
  2. Click on Create Device.

  3. Enter a Device Name and Device ID (Serial Number is recommended).
  4. Click + to add tags that help identify the system, such as:
    1. Site Name
    2. Address
    3. IP Address

  5. Click Create to save the settings and open the Device Info page for the new device.

Step 3: Create a Device Key for the new device.


  1. Click on Device Keys side tab.

  2. Click on Create Key.

  3. Click on Copy Device Key to save the key to the Clipboard.

Step 4: Finish the Agent Installation


  1. Return to the Agent installer on the remote device.
  2. Click in the large installer text entry box and paste (Ctrl-V) the Device Key from the clipboard. Click Install.

  3. Then continue following the instructions until the installer completes.

Step 5: Verify the Agent is Connected


  1. Navigate to the Devices page in the maiLink webpage.
  2. Verify that the device is connected to the maiLink SRM Cloud by observing a small solid green dot at the left.

Success!


The new device is now connected. If you have the maiLink Client installed on your machine, you will be able to access the new device remotely.

If you have issues, contact your Administrator or email maiData Customer Support at maiData at service@maidata.io.

3 - Add Windows Client

Install the maiLink Client on a Windows-based system to gain secure remote access for service.

Prerequisites


  1. You have administrator rights to install software on the desired computer

  1. In a browser, log into your maiLink account at https://app.maidata.io.
  2. Navigate to the Software tab.
  3. Locate and download the Latest Client Software Version installer, the installer is the executable (.exe) file.
  4. The installer will have you register your client as part of the install steps, simply enter the Name you want as a reference for your client (e.g. Work laptop) and add a simple Description (e.g. HP Pavilion).

  5. complete the installation by returning to the installer window and clicking next and then Finish to complete the installation.

Success!


You can verify local client is registered by observing the green light indicator on the top right of the header!

If you have issues, contact your Administrator or email maiData Customer Support at maiData at service@maidata.io.

4 - Import Devices

How to Mass-Import Devices into maiLink.

This document tells you how prepare a CSV file for mass import into maiLink – it’s the quickest way to add a batch of new devices.

Note: The syntax of the CSV file matters, so please follow this guidance carefully.

Note: Once your CSV file is ready, contact support@maidata.io for help. Our team will upload the file for you. We offer this service as a protection for all our customers to prevent accidental SQL injection issues.

Creating a CSV File

Most users will create an Excel file containing the required data and then simply export it into a CSV file. The Excel file will be created by exporting data from some sort of asset manager, CRM system, or other database. Once the data is in Excel, it will be manipulated to meet the CSV Requirements below.

If you think your CSV file is ready, contact support@maidata.io.

CSV Requirements

The CSV file you create should have the following:

  1. Values seperated by commas (',').
  2. Any values containing commas enclosed in double quotes ('"').
  3. One header row.
  4. Any number of additional rows, where each row corresponds to one unique device.
  5. The following column headers in row 1:
Column Heading Cell Meaning
A Device ID A unique identifier for the device on this row. Should be globally unique within your organization. Often a serial number.
B Device Name A friendly name for this device.
C Model The type of device. Often the manufacturer’s name for the model.
D Address The address at which the devices in installed. Should include street address, city, state/province, postal/zip code, country. It is not necessary to put commas in between sections of the address. So, you can have 1 Able Street Missisauga ON Canada rather than 1 Able Street, Missisauga, ON, Canada.
E Device Tag 1 Key The value of a device tag that will be filled with the text given in column E for the device of a given row.
F Device Tag 2 Key The value of a device tag that will be filled with the text given in column F for the device of a given row.
G Device Tag 3 Key The value of a device tag that will be filled with the text given in column G for the device of a given row.
zz Device Tag xx Key The value of a device tag that will be filled with the text given in column zz for the device of a given row.