Searching...

Matching results

    How to register systems to multiple partners?

    If you have an ALMS “Reseller” or “Enterprise” account, you can register and preconfigure devices to many of your ALMS Partners at once. Partners are other companies that are connected to your account. For more info about account administration and Partners, see the Administration documentation.

    The Import for multiple partners link on the Registration page allows you to upload a CSV containing settings for multiple devices, along with a TARGET_COMPANY field where you can specify companies to which the devices will be registered. This can help streamline your workflows and register devices to multiple accounts all in one registration.

    Please note that you can only register one class of device (AirLink MP70, for example) at a time.

    Before you begin

    Partner registration requires that your partners have granted you rights to register and configure devices directly within their account by assigning a profile with sufficient rights to their partnership with you. For more information, see the Administration page . For a list of specific rights that should be included by your partner on the associated profile please refer to the list below.

    It is the Partner’s responsibility to grant you access rights; therefore some coordination between you and your Partners may be required. Partners that signed up using the referral URL will have automatically granted you all the required rights unless they took explicit actions to modify their partnership profile with you, the Reseller or Enterprise account holder. If your access has been restricted, the warnings described in the Import Dependencies section below will appear after you begin the registration process.

    Please ensure that your partners have enabled the rights listed below on your profile:

    • Entities > Settings > Create — enables you to clone templates
    • Entities > Applications > Publish — enables you to share applications
    • Entities > Systems > Create — enables you to create systems
    • Entities > Systems > Activate — enables you to activate systems
    • Account network > Partners > View and Account network > Profiles > View — enable you to view your rights

    To register multiple systems to multiple partners from a file:

    1. From the Register page, click Import for multiple partners.
    2. From Import Systems to Partners, click Download template. For more information on how to fill out the csv file, see Partner Registration CSV file format below.
    3. After completing and saving the template, click Select a CSV and upload your completed template.
    4. Optional: Click Pre-configure Systems if you wish to register devices with an initial configuration. See How to register systems with an initial configuration? for more information.
    5. Click Import. The Import Dependencies window appears, showing you all the registration steps and the corresponding partner companies where the steps will take place.

    Import Dependencies

    The Import Dependencies window may include some “dependency setup” steps, which result from the preconfiguration steps that you specified. These steps may require templates and/or applications to be either available, published, or shared with each partner for the configuration step to work within their context.

    This process requires that all of the system components you are using (templates, datasets, firmware, AAF applications) be initially available in your ALMS account before being published to your Partner’s account(s).* The Import Dependencies dialog provides a summary of the actions that will take place in each Partner account. Review the list of operations that will take place and click Setup dependencies and continue when correct.

    * You may need to create and/or publish these components before starting.

    • Create template: Re-creates the template that resides in your account in each of the partner accounts.
    • Publish Application: Makes an application that was released ready to install. For more information on publishing apps, see the Application documentation.
    • Reuse template: The wizard identified an equivalent template in the partner’s account that shares all the same settings. The partner’s template will be used in place of the template you specified.
    • Share Application: Shares a private application with specific partners. This step does not appear if the application is public.

    After you click Setup dependencies and continue, ALMS resolves the dependencies and proceeds with system registration.

    Missing Rights Error

    An error message, such as the one in red text shown below, appears when the target partner has not granted you rights to create the system/template in their company.

    If you see this warning, click Cancel (the Setup dependencies and continue button is unavailable). From there, you can either:

    • Contact your partner to be granted the missing rights through the profile rights management page.
    • Exclude partners, templates or application steps that caused dependency errors from your registration setup.


    Partner Registration CSV file format

    The file format is a .csv file (comma separated text file). Both comma ‘,’ and semi-colon ‘;’ are supported as separators.

    FIELD USE DESCRIPTION
    GATEWAY[IMEI] Mandatory for all gateways or routers running ALEOS IMEI of the system (gateway or router) to be created. Can be retrieved or scanned from the gateway.
    GATEWAY[REGISTRATION CODE] Mandatory for all gateways or routers running AirLink OS Registration Code of the system (gateway or router) to be created. Can be retrieved or scanned from the device label.
    GATEWAY[SERIAL NUMBER] Mandatory for all devices running ALEOS or AirLink OS Serial Number of the system (gateway or router) to be created. The serial number begins with 2 letters and can be from 13 to 16 characters (skip the dash ‘-’ if there is one). Can be retrieved or scanned from the device label.
    MSCI[HOST] Optional. Not required for devices communicating via LWM2M. To be filled in for the server-initiated option. If you are currently able to initiate communications out to the gateway either by public static IP or domain name, enter public IP address or complete domain name.
    COMMUNICATION[PASSWORD] Mandatory for devices communicating via MSCI. Optional for devices communicating via LWM2M.

    When communicating via MSCI, enter the ACEmanager password used to log in to this device directly. The password is required to allow ALMS to remotely change the ACEmanager password. It is also used to enable the ALEOS server-initiated communication option.

    When communicating via LWM2M, use this field to change the default ACEmanager password. The new password must be at least 8 characters long and include at least one number, letter, and special character.

    NAME Optional Name to be set for the system.
    LABELS Optional One or more label(s) to be applied to the created system. For providing several labels, use the pipe ‘|’ separator.
    MQTT[PASSWORD] Mandatory for establishing MQTT connection with a message broker The password is required for running applications that report MQTT to AirVantage (AVTA, for example). Use the default, Sierra-123, if using the AirVantage MQTT broker for telemetry. If using a third-party MQTT broker, enter the MQTT password for that broker.
    M3DA[PASSWORD] Mandatory for establishing M3DA connection The password is required for ALEOS Application Framework (AAF) applications. The password must be at least 8 characters long and include at least one number, letter, and special character.
    TARGET_COMPANY Mandatory to register system to desired company The UID of the company to which the system will be registered. To view the UID for each company, see the My Account page for the company. The UID is on the Account details page.

    TOP