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

Return to the regular view of this page.

Getting Started

How to get started with maiLink SRM.

maiLink SRM is a cloud-based software platform that helps you manage, service and learn from your products in the field.

1 - Defined Terms

Defined terms often used in maiLink SRM.

We use the following terminology throughout the maiLink software and documentation:

Term Meaning
Agent A maiLink software module that is installed into each product in the field.
Client A maiLink software module that a service technician will install on his/her local computer. When the Client software runs it enables the users’s maiLink portal to build tunnels that give the user secure remote access to a selected device in the field.
Condition A logical expression that is evaluated to determine if a workflow is to be triggered.
Device One instance of a product in the field.
Device Tag A key/value pair that defines one parameter for one device.
Device Type A deprecated name for a model.
Model A class of devices in which the devices share common characteristics. Usually a model describes one manufactured model of products, so all the devices are basically the same. Devices of the same model will have some differences, such as dates of manufacture and different serial numbers.
Model Tag A key/value pair that defines one parameter that is common for all devices of the same model.
Tag A key/value pair that defines one parameter. The term is used in association with models and devices. See Device Tag and Model Tag.
Trigger The selected type of occurence that will initiate a workflow. At present the choices are: manual, event, metric and status.
Workflow A user-defined automation process that will perform a set of steps. The workflow configuration includes the trigger type, model, name and condition, if applicable.

2 - Setting Up maiLink

Setting up maiLink SRM for your company.

Before setting up maiLink, it’s useful to think through what your team will need to accomplish with maiLink.

  • The team will use maiLink SRM software to.
    • Manage your fleet of devices that are deployed in the field (and used in your internal development labs, too).
    • Perform service on those devices.
    • Monitor performance of those devices.
  • The fleet is comprised of products that are different models.
    • All the devices of a model have similar characteristics.
    • The methods you use to access devices of that model are shared by all those devices.
  • Each device will have unique characteristics.
    • The most important is the device ID, which must be unique for your company, across all models.

Part 1: Add the Team

  1. Identify the individuals that need access to maiLink SRM to do their jobs. For security, only add the people that really need access to maiLink.
  2. Identify what permissions each user really needs. For security, only give peoples the roles they need to accomplish their work.
  3. Add each team member, defining the roles for every person. See Add User.

Part 2: Add your Connection Types

  1. Navigate to Settings (Gear) > Connection Types.
  2. Review all the predefined connection types (the name and port)
  3. If a connection type is to be added, click Create Connection Type.
    1. Enter the name, port number and a connection string.
    2. Click Create.
  4. If a connection type needs changing, click Edit on the corresponding row.
    1. Review the name, the port number and the connection string.
    2. Change anything you like and click Update.

Connection String

The connection string is a shorthand that can contain the port number. When you create a connection, the string is presented to you in an expanded form with {{port}} replaced by the port number. If the resulting string is a valid URL, it is presented as a link, to make connection in a browser window even faster.

Consider the following examples whent the port number is 12345:

Connection String Expanded Connection String Valid URL
{{port}} 12345 No
localhost:{{port}}/ localhost:12345/ No
http://localhost:{{port}}/ http://localhost:12345/ Yes
http://localhost:{{port}}/nr http://localhost:12345/nr Yes

Part 3: Add the Models

  1. Navigate to Models on the top bar.
  2. To add a model:
    1. Click Create Model.
    2. Enter the name for the model. Short and clear is best.
    3. Click in the Connection Types pull-down and click every connection type that applies to this model.
    4. Add model tags by clicking the plus (+) and then entering the tag name and value.
    5. Click Create.

Part 4: Add the Devices

Note: Before adding the devices, take note that each device will be given a unique device ID. The device ID must be unique within your company, including unique across all models. You cannot have a Model 100 device with serial number 12345 and also have a Model 200 device with the same serial number. Plan ahead to avoid creating a lot of rework.

To add a device:

  1. Navigate to Devices on the top bar.
  2. Click Create Device.
  3. Enter the name for the device. Short and clear is best.
  4. Enter the device ID, which should be a unique identifier such as serial number.
  5. Add model tags by clicking the plus (+) and then entering the tag name and value.
  6. Click Create.