EMnify User Guide...• Assign a SIM to an endpoint by clicking Assign SIM (visible if an endpoint has no SIM assigned) Assigning the SIM to the endpoint will allow it to connect to

EMnify User Guide2019-10-25

Version 1.8

Table of ContentsRevision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1. Login Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

2. EUI Start Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

3. Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

4. Endpoints. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

4.1. Endpoint Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

4.2. Endpoint Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

5. SIMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

5.1. SIM Ordering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

5.2. SIM Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

5.3. SIM Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

6. Service Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

6.1. Service Profile Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

6.2. Service Profile Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

6.3. Service Profile Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

6.4. Quota Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

6.5. Prepaid Balance Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

6.6. Operator Blacklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

7. Tariff Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

7.1. Tariff Profile Creation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

7.2. Tariff Profile Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

8. Data Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

9. Stats: Traffic Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

10. Stats: Data Analytics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

11. Billing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

12. Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

12.1. New User Creation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

12.2. User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

13. Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

14. API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

15. Tokens, IPs and VPN Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

15.1. Application Tokens: Creation and Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

15.2. Data Streams: Creation and Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

15.3. IP Address Space Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

15.4. VPN Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

15.5. IPSec Tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

16. Account settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

16.1. Password Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

16.2. MFA Keys and Trusted Devices: Creation and Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

17. Log Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Contact us for support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Revision HistoryVersionNumber

Revision Date Description

1.2 30.01.2019 Added Permissions section which describes permitted operations for users basedon their User Role.Updated screenshots to latest version of EUI in cases where deprecated contentwas displayed.

1.3 05.02.2019 Added Quota Management - users may set SMS and Data Quotas.Added Prepaid Balance Management - users may set monetary limits for endpointusage.Added Operator Blacklist - users may add an operator to an endpoint blacklist.Added Breakout Region to Service Profile Management section - users may selectthe internet breakout region that endpoints will use.

1.4 15.02.2019 Removed Permissions chapter and chunked permissions information into tableswithin relevant sections.Added: Sections describing User Role permissions by topic:Endpoint Management Permissions, Sim Management Permissions, Service ProfilePermissions, Tariff Profile Permissions, User Management Permissions, MFA KeysPermissions.

1.5 26.02.2019 Renamed document to User GuideUpdated screenshots in Quota Management, API, Application Tokens: Creationand Management.Added section IPSec Tunnel, users may contact support for implementation ofIPSec functionality.

1.6 25.03.2019 Updated URL to EMnify login page

1.7 07.06.2019 Updated screenshots in Endpoints section reflecting changes as of EUI 2.22.0Added print functionality for invoices in Billing section.

1.8 02.08.2019 Updated Endpoints section to describe SMS-MT and NI-USSD tests.

EMnify User Guide Version 1.8 | 2019-10-25

EMnify User Guide | Version 1.8 1

Chapter 1. Login PageNavigate to https://cdn.emnify.net/#/login to view the login dialog. The current status of the EMnify system isdisplayed in a panel under the login form. A more detailed version displaying the system status by service is visible atstatus.emnify.com.

To log in, enter your Email and Password and click LOG IN.

Figure 1. Login page (left) Status Page (right)

Version 1.8 | 2019-10-25 EMnify User Guide

2 EMnify User Guide | Version 1.8

https://status.emnify.com/

Chapter 2. EUI Start PageThe "Start" page of the EUI consists of a top navigation bar for accessing various management views, quick-actionbuttons in the center of the page, a list of help resources at the bottom and an additional panel with the currentEMnify services status.

Figure 2. EUI Start Page



Chapter 3. DashboardThe Dashboard panel gives you a quick overview of your devices and their connectivity status:

Figure 3. Dashboard Panel

Current Month Data Volume

The amount of data consumed by your devices during the current calendar month – downstream (received by yourdevices) and upstream (sent from your devices).

Current Month Cost

The cost of the data consumed by your devices during the current calendar month in Euro

Data Traffic (MB)

A graph of current data consumption of your devices for the last hours - downstream/upstream. Dataconsumption at specific points in time is displayed as a tooltip by hovering the cursor over the diagram.

Endpoint Status

Current status of your endpoints - Online or Offline (hovering the cursor over the graph displays the currentnumber of endpoints online or offline)

An endpoint represents a mobile device, router or embedded system connected via EMnify.

Alerts Section

This section shows important status updates of endpoints which may require attention. The alerts marked WARNare considered urgent.

Clicking on one of the alerts will redirect to the "Alerts" panel of the EUI, which can also be accessed by pressingthe icon in the top-right corner of the screen. See Alerts for more information.

Figure 4. Alert Example



Pressing the Disarm button will ignore alerts of that type for this endpoint. When Disarm hasbeen selected for an endpoint, the text "Disarmed" will be displayed instead of a button.Pressing the Disarm button shown in the example screenshot above will disable alerts for PDPContext Request rejected for endpoint Quench 1.



Chapter 4. EndpointsThe Endpoints view allows you to create and manage endpoints. The main page of the panel gives you an overview ofall your endpoints with the following details: the ID, Name, Service and Tariff Profiles associated with them, IPaddress, Status (Enabled / Disabled), Connectivity status (Online / Offline / Attached / Blocked) and Data Usage (inMB, current calendar month).

Figure 5. Endpoints View

Status Description

Offline Endpoint has not attached to the EMnify core network yet or the device had previously attachedbut the visited network signaled the absence of connectivity for the last 1-2 days.

Online Endpoint has an active data connection (PDP context)

Attached Endpoint has successfully attached to the EMnify Core network and the visited network has notsignaled back that the device is offline. Usually the visited network informs the EMnify Corewithin 1-2 days after a device went offline.

Blocked The device is not granted service. Endpoints are assigned this status when they have exceededtraffic limits.

Table 1. Endpoint Status Description

4.1. Endpoint Creation

To create a new endpoint,

1. Press the Create Endpoint button in the top right corner of the Endpoints panel.



2. Enter a name for the new endpoint.

3. Select the ICCID of the SIM you want to assign to this endpoint. This can be selected from the pool of activatedSIMs which are not yet assigned to other endpoints.

4. Select Service and Tariff Profiles and click Create endpoint.

Figure 6. Create Endpoint Dialog

4.2. Endpoint Management

Clicking on an individual endpoint allows for configuration and viewing the details of an endpoint. When an endpointis selected (highlighted with bold text in the list of endpoints) an additional four panels are available under theendpoint list:

Details, Configuration, Operator Blacklist, Stats, Events, SMS.

Figure 7. Endpoint Management

• Disable the endpoint by clicking Disable. Disabled Endpoints will not be able to use any tele-services and will notcreate any chargeable events.

• Delete the endpoint by clicking Remove.



Deleting endpoints cannot be undone - use this option when you want to permanently deletethe endpoint.

• Release the SIM from the endpoint by clicking Release SIM (visible if an endpoint has a SIM assigned).Released SIMs will stay in your SIM repository and can be reassigned to other endpoints later.

• Assign a SIM to an endpoint by clicking Assign SIM (visible if an endpoint has no SIM assigned) Assigning theSIM to the endpoint will allow it to connect to the network using this SIM.

• Apply Changes to an endpoint using the Reset connectivity button in case of service or Tariff Profile changes toan endpoint.

The Reset connectivity action is often used to resolve connectivity issues.This button suspends and activates the SIM as well as disables and enables the endpoint. Thevisited network will be informed about the change in the Service Configuration so the devicepolicies will be applied upon next attach.

When an endpoint is online, the more dropdown has two enabled options for testing the connectivity of the device.

Perform SMS-MT Test

Selecting this option will send an SMS to the endpoint via the REST API and the user is directed to the SMSconsole in the EUI where the status of the SMS delivery is displayed.

Perform NI-USSD Test

Selecting this option will create a Network-Initiated USSD session toward the endpoint.

IMSI International Mobile Subscriber Identity - a unique number identifying a GSM subscriber.



ICCID Integrated Circuit Card Identifier – a unique number identifying a SIM card.

IMEI International Mobile Equipment Identification number – unique id number of the device

IP Address A private static IP address (can be used to reach the endpoint after establishing VPN connection)

MSISDN Mobile Station International Subscriber Directory Number – an international mobile phonenumber.

PDP Context A data structure present on both the serving GPRS support node (SGSN) and the gateway GPRSsupport.

Table 2. Endpoint Management Acronyms

The IMEI shown in the EUI is in the format of IMEI + SV (software version).

Details Tab

This tab allows you to access the detailed information of the endpoint. The details tab displays the following fourcolumns

Device Details

A summary of the endpoint details. This includes the Name and Status of the device with a list of identifiers;the IMSI, MSISDN, ICCID, IMEI (see Endpoint Management Acronyms) of the device. Below this is the ServiceProfile with a description of the services the device may use, such as Data and SMS.

Connectivity

This displays Connectivity Status and Connectivity Type (2G / 3G / 4G), the Network provider name andcountry, IP address, Status of the PDP Context (Active or Inactive)

Data Usage

Data usage for both data traffic and SMS and a graph showing usage over time.

Costs

The column on the right displays the costs associated with the endpoint and a progress bar indicatingpercentage of monthly limit used.



Figure 8. Connectivity Widget Figure 9. Connectivity Widget (More Info view)

If the device is connected via 2G, the Endpoint Location will be displayed in the right column of the Endpoint Detailsview:

Figure 10. Location Widget

Configuration Tab

This tab allows you to change the name of the endpoint, lock the SIM to this endpoint only (press the button),select Tariff and Service Profiles from the drop-down lists and assign tags to the endpoint for better sorting. Thetariff and service profiles define the functionality and coverage of the endpoint – see Tariff Profiles and ServiceProfiles for more information.



Locking the SIM to the endpoint will make the SIM work with this endpoint only. Placing theSIM into any other device while this feature is enabled will prevent the SIM from being used.This can be used as a preventive measure to counter fraud and improve security.

Figure 11. Endpoint Configuration Tab

Stats Tab

This tab provides an overview of the amount of services the endpoint used during a certain timeframe and thecosts associated with them. The timeframe can be selected on top of the tab by typing in from-to dates or usingthe button to select a time range from a calendar. Press Reload to manually update the data. The stats can alsobe exported to a .csv file by pressing Export button.

Data viewed in the Stats Tab is available for the past 90 days

Figure 12. Endpoint Stats Tab

Data TX The amount of data sent upstream by the endpoint

Data RX The amount of data sent downstream to the endpoint

SMS MT Mobile Terminated – SMS received by and endpoint

SMS MO Mobile Originated – SMS sent by an endpoint

Table 3. Endpoint Stats Acronyms

Events Tab

This tab provides an overview of the events associated with this specific endpoint, allowing to switch between theimportant and general ones (press the Severity button to cycle between WARN and INFO notifications). Press Reloadto manually update the data. The data can also be exported to a .csv file by pressing Export button.



Figure 13. Events Tab

SMS Tab

This tab provides an overview of the SMS that were sent and received by an endpoint. This includes the ID of themessage, the Type (MO/MT see Endpoint Stats Acronyms), Submit Date, Expiry Date, Finalized Date, Status(may be Pending / Buffered / Delivered / Failed / Canceled), Source address, Destination address and thePayload (the information that was sent via an SMS).

Press Reload to manually update the data. The data can also be exported to the .csv file by pressing Exportbutton.

Figure 14. Events Tab

SMS Console

Click Open SMS Console to send an SMS to the device. A dialog will open which allows a message to be sentto the endpoint. It is also possible to view the SMS that were previously sent to the endpoint.



Figure 15. SMS Console

To send an SMS to the device:

1. Enter message text

2. Enter a source address (number or text that will be shown on the device when it receives the message). Can beone of the following:

◦ Phone number, up to 15 digits (international format is indicated with a + symbol in front)

◦ Short code, up to 6 digits

◦ Alphanumeric string, up to 11 characters (the endpoints will not be able to reply to the alphanumeric source).

3. Optional: the Load SMS dropdown box allows to copy a previously-sent message

4. Click Submit SMS.

4.2.1. Endpoint Management Permissions

Action Admin Observer User

Retrieve an endpoint by ID

Update, Delete an endpoint by ID

Retrieve the blacklisted Operators for an Endpoint

Add, Remove Operator from Blacklist of Endpoint by ID

List all Endpoints




Create new endpoint

Retrieve connectivity information of an Endpoint



Chapter 5. SIMsThe SIMs panel allows you to order, register and manage EMnify SIMs.

Figure 16. SIMs Panel

The main page provides an overview of your SIMs, providing the following information:

ID A numeric ID of the SIM

ICCID The Integrated Circuit Card Identifier of the SIM

Status This may be one of the followingIssued – SIM registered to your account in the EUIActivated – SIM that was activatedSuspended – A suspended SIM

Issuer name The name of the company the SIM is assigned to

Endpoint number A numerical ID of the associated endpoint

IMSI The current SIM IMSI (see Endpoint Management Acronyms)

MSISDN The current SIM MSISDN (see Endpoint Management Acronyms)

Vendor name The SIM vendor

Form-factor info The physical form factor of the SIM (see SIM Form Factor Acronyms)

Date of production The SIM production date

5.1. SIM Ordering

To order SIMs, click the Order SIMs button located in the top right corner of the SIMs panel.



Figure 17. SIM Order Dialog

1. Select the number and type of SIMs by batch size and form factor.

2. Enter the amount of SIMs/SIM batches of each type.

3. Click Proceed with Shipping Details.

If you want to order a custom number of SIMs, contact our sales team: call at +49-30-5557-33333 , or contact us via email at [email protected].

Most of our SIMs come in a 3-in-1 (1/2/3FF) or 4-in-1 (1/2/3/4FF) form-factors, so they should fit most devices.

Acronym Description

2FF mini SIM card

3FF Micro SIM card

4FF Nano Sim card

MFF SMD SIM card embedded in the device during manufacturing

Table 4. SIM Form Factor Acronyms

Enter your shipping details, select shipping option and click Proceed with Payment Details:



tel:+49-30-5557-33333

tel:+49-30-5557-33333

mailto:[email protected]

Figure 18. SIM Order Shipping Dialog

The VAT Identification number must also be added. If the customer does not have a business activity, this field mightbe left empty. Refer to the following link regarding the relevant VAT information, based on the country:

https://ec.europa.eu/taxation_customs/sites/taxation/files/resources/documents/taxation/vat/traders/vat_community/vat_in_ec_annexii.pdf



Figure 19. Confirm Payment of SIM Order

Enter the payment details and click Confirm Payment Method and "Verify Order".

5.2. SIM Registration

To register the SIMs, click on the Register SIM Batch button on the SIMs Panel. Enter the BIC code of the SIM or SIMbatch and click Verify BIC.



Figure 20. Batch Register SIMs Dialog

Next, you will have the option to activate the SIM or SIM Batch. Check "I want the SIM(s) to be activated now" andclick Confirm Registration.

Figure 21. Batch Register SIMs Dialog, Confirmation step

If you do not want to activate all SIMs from the batch now, you can click Cancel and then activatethe SIMs manually, one by one. To do that, go to the "SIM" panel in the EUI, select the SIM youwant to activate and click Activate button on top of the panel.

5.3. SIM Management

Clicking on a certain SIM will give you more control and information about the SIM:



Figure 22. SIM Management Panel

• Activate the SIM by clicking Activate (this button is visible if the SIM has been Suspended) SIM Hosting Feesmay apply for activated SIMs depending on your tariff plan.

• Suspend the SIM by clicking Suspend SIM (this button is only visible after the SIM has been Activated).Suspended SIMs are not be able to use any tele-services and will not cause any chargeable events. This status isbilling-relevant and will affect your SIM Hosting Fees accordingly.

Access the "Details", "Events" and "Stats" tabs to manage the SIM Details to view and manage the current SIM



status, data consumption and the costs associated.

SIM

SIM Status (Issued / Activated / Suspended), ICCID, IMSI and MSISDN

Model

SIM type (Classic/Industrial), Vendor, Form factor (3-in-1, 4-in-1, Mini, Embedded), Memory size and Productiondate and time

Connectivity

SIM connectivity status (Online / Offline / Attached / Blocked), Network Operator and Country, MSC, PDP Contextstatus, GGSN, SGSN CP and SGSN DP (see Connectivity Acronyms).

Data Usage

Data traffic usage and the costs associated with data consumption.

Figure 23. SIM Details Tab

MSC Mobile Switching Center, part of GSM architecture which controls the network switchingsubsystem elements.

GGSN Gateway GPRS Support Node - part of the GSM infrastructure, the GGSN is responsible for theinteroperation between the GPRS network and external packet switched networks.

SGSN Serving GPRS Support Node - a main component of the GPRS network, which handles all packetswitched data within the network, e.g. the mobility management and authentication of the users.

Table 5. Connectivity Acronyms

The MSISDN is a SIM’s "phone number", which you can use to send SMS to the device (add 00before the number). Additionally, SMS-MT functionality should be enabled in a service profileassociated with this SIM.

Events Tab

This tab provides an overview of the events associated with this specific SIM, allowing to switch between theimportant and general ones (press Severity switch to cycle between WARN and INFO notifications). Press Reload tomanually update the data. The data can also be exported to a .csv file by pressing Export button.



Figure 24. SIM Events Tab

Stats Tab

This tab provides you with overview of the amount of services the SIM used during a certain timeframe and thecosts associated with them. The timeframe can be selected on top of the tab by typing in from-to dates or usingthe button to select a time range from a calendar. Press Reload to manually update the data.

The stats can also be exported to a .csv file by pressing Export button.

Figure 25. SIM Stats Tab

5.3.1. Sim Management Permissions


SIMs

Retrieve SIMs by ID

Update, Delete SIMs by ID

List available SIM Statuses

List of available SIMs



Chapter 6. Service ProfilesA Service Profile is a set of rules which defines the services and functionality of an endpoint or multiple endpoints.The Service Profiles panel allows you to create and manage such service profiles.

The main page provides an overview of the Service profiles that were previously created and listed is the ID, Name,Description and the number of endpoints that use the Service Profile.

Figure 26. Service Profile Panel

6.1. Service Profile Creation

To create a new Service profile, click on Create Service Profile button in the top right corner of the panel.

In the pop-up window, enter the name and the description and press Create Service Profile.

Figure 27. Create Service Profile Dialog

6.2. Service Profile Management

To change the settings of the service profile, click on it in the Service profiles list.

You will now be able to:

• Delete the service profile by clicking Remove button on top of the panel



Service Profiles that are currently assigned to Endpoints or that have any Usage Limitsdefined cannot be removed. The new custom created Service profile will only have USSDenabled by default.

The "Details", "Basic Configuration", "SMS" and "Service Limits" tabs are visible to manage the Service Profile.

Details Tab

This tab provides an overview of the current selected Service profile: Name, Description, Number of endpointsusing it, list of services enabled by this Service Profile (Data, USSD, SMS MO, SMS MT) and limits on these services.

Figure 28. Service Profile, Details Tab

Basic Configuration Tab

This tab allows you to change the basic settings of the Service Profile. After all the necessary changes have beenmade, click the Save button.

Figure 29. Service Profile, Basic Configuration Tab

Name A user-configurable name

Description A short description of the service profile

Available NetworkTechnologies

3G and 4G data connections may be toggled on or off.2G cannot be turned off

Service Selection Data, SMS MO, SMS MT services may be toggled on or off.USSD cannot be disabledVoice cannot be enabled

Internet Breakout Region A dropdown dialog allows for selecting the Internet Breakout Region to be used byendpoints which have this service profile assigned. One of the following regions maybe selected with the option to use a VPN for each region:eu-west-1us-east-1ap-southeast-1



Supplementary Functions This section allows to enable Quotas (see Quota Management) and Prepaid Balance(see Prepaid Balance Management).

SMS Tab

This tab allows you to change the SMS-related settings of the Service profile. SMS exchange between endpointsand external SMS messaging can be enabled or disabled by clicking the toggle switches. The drop-down list onthe right allows for selecting the method of exchanging A2P SMS (via RestAPI, SMPP or SMS Console) ordisabling this feature.

Figure 30. Service Profile, SMS Setting Tab

P2P (Peer-to-Peer) SMS - SMS exchanged between devicesA2P (Application-to-Peer) SMS – SMS exchanged between the device and an applicationserver

Service Limits Tab

This tab allows you to set the limits on the usage of certain services by endpoints that have this Service profileassigned. The total sum of the usage limit spans all devices. When the total sum of usage for a service by allendpoints reaches the limit, all devices with this Service Profile will be denied service while the limit is in effect.The existing limits can be deleted by clicking the button next to the limit. After all the necessary changes havebeen made, click Save.

Figure 31. Service Profile, Service Limits Tab

To add new limit, click on Add Service Limit button and selecting the type of service to apply a limit to (Data,SMS MO, SMS MT, Voice or USSD). Select the limit amount from the drop-down menu and click Add Limit.



Figure 32. Service Profile, Add Service Limit Dialog

6.3. Service Profile Permissions


Retrieve list of available Countries

Retrieve list of available Currencies

Retrieve single Currency details by ID

Retrieve List of available Services

List available Traffic Limits for a Service by ID

Retrieve Service Profiles

Create Service Profiles

Retrieve Service Profiles by ID

Update, Delete Service Profiles by ID

Add, Delete services from Service Profiles

Add, Delete Traffic Limit from Service

Retrieve the ESME interface types

6.4. Quota Management

Quota Management for data and SMS can be activated in the service profile and will be applied to all endpointsassigned that service profile. The initial quota is zero and therefore endpoints which have quota management enabledbut no quota set will be blocked from using SMS or data services.



Figure 33. Quota Management Enabled

API integration is required to view, edit and delete data and SMS quotas for endpoints. For detailsof how to make the relevant API requests, please refer to the EMnify API Documentation.

When enabled, widgets display the quota information on the Endpoint Details tab. The circular progress bars showthe usage of data and/or SMS per endpoint and an upper threshold if one is set:

Figure 34. Endpoint Details Tab with Quota Management widgets

Data and SMS quota objects both have the following properties:

• status can be one of the following:

◦ ACTIVE - the endpoint can currently connect and has (data/SMS) remaining in the quota

◦ EXHAUSTED - the endpoint has exceeded the quota volume. For data, an action on exhaustion can be defined.

◦ EXPIRED - the quota has expired; the endpoint is denied from using (data/SMS) services until a new quota isadded.

• volume - the remaining volume on this quota in (MB for data, number for SMS)

• expiry_date - a timestamp when this quota will expire and the endpoint will be denied from using further(data/SMS) services regardless of whether the quota volume was used or not.

Aside from the common quota properties, an action upon exhaustion for Data Quotas may be set:

Action on Exhaustion

Determines what action should be expected when quota thresholds have been hit. One of the following threeoptional actions may be set:

• Throttle - bandwidth will be throttled to the defined peak throughput until the quota expires



https://cdn.emnify.net/api/doc/

• Block - data service will be instantly blocked once volume used up, regardless if the expiry date is alreadyreached or not

• auto_refill - may be true/false, refill the quota with the last-added volume on a daily basis

Additionally, threshold reached event for SMS Quotas may be set:

Threshold Percentages

The optional threshold_percentage may be activated on SMS quotas which determines when to send ThresholdReached events. An event is sent when a percentage of the SMS quota is reached.

6.5. Prepaid Balance Management

Balance management is activated in the service profile will be applied to all endpoints assigned to that service profile.The initial balance is zero and therefore endpoints with prepaid balance management applied without a balance setwill be blocked from any tele-services.

Figure 35. Prepaid Balance Enabled

API integration is required to create, top-up and update prepaid balance for endpoints. For detailsof how to make the relevant API requests, please refer to the EMnify API Documentation.

The balance of an endpoint contains the following properties:

• amount - current balance in currency with up to 6 decimal precision

◦ The amount may reach an negative value either by a deduction through the API or deferred processing ofusage charges

◦ If the amount is 0 or negative the endpoint will be barred from using tele-services, meaning;

▪ Location updates will be rejected

▪ PDP context requests will be rejected

▪ MO-SMS will not be acknowledged and time out

• currency - nested object with info on the currency presented by the balance

• last_updated - timestamp when the balance was last updated (either by usage fees deducted or amountmodified through the API)

• expiry_date - when the expiry_date is reached, the balance will be automatically reset



https://cdn.emnify.net/api/doc/

6.6. Operator Blacklist

For each endpoint, it’s possible to add operators to a blacklist. This will prevent the endpoint from connecting to thatoperator network.

Figure 36. Endpoint Operator Blacklist

To add an operator to the blacklist of an endpoint:

1. Open the Operator Blacklist tab

2. Click the Add Operator button

3. Select an operator by country from the drop-down menu



Figure 37. Operator Blacklist Dialog

To remove an operator from the blacklist of an endpoint:

1. Open the Operator Blacklist tab

2. Click the button to remove an operator from the blacklist of that endpoint

Figure 38. Operators currently added to Blacklist



Chapter 7. Tariff ProfilesA Tariff Profile defines the usage tariff and coverage that an endpoint may utilize. The Tariff Profiles panel allows youto create and manage Tariff Profiles. The main page provides an overview of existing Tariff Profiles:

Figure 39. Tariff Profiles Panel

ID A Numeric ID of the Tariff Profile

Name The user-defined Tariff Profile name

Description A short description of the Tariff Profile

Tariff The specific type of tariff used

used by The number of endpoints that use the profile.

Table 6. Tariff Profiles Panel

7.1. Tariff Profile Creation

To create a new Tariff Profile, click on Create Tariff Profile button in the top right corner of the panel. In the pop-upwindow, enter the name, description, select a standard Tariff from the drop-down list as a basis and select CreateTariff Profile.

Creating new Tariff Profiles and assigning them to various groups of endpoints allows you tochange the coverage that these endpoints will have around the world to have more control overthe costs and connectivity.



Figure 40. Create Tariff Profile Dialog

7.2. Tariff Profile Management

To change the settings of the Tariff Profile, select it from the Tariff Profiles list.

You will now be able to:

• Delete the Tariff Profile by clicking Remove button on top of the panel

• Access the "Configuration" and "Rate Zones" tabs to manage the Tariff Profile

Tariff Profiles that are currently in use by any endpoints cannot be removed.

Configuration Tab

This tab allows you to change the basic settings of the Tariff Profile: Name, Description and select the Tariff fromthe drop-down list.

Figure 41. Tariff Profile Configuration Tab

Rate Zones Tab

This tab allows you to enable and disable the rate zones – the regions or price ranges where your endpoints canconnect to a network. Enabling and disabling Rate Zones is done by clicking on a Rate Zone details box in the RateZone Selection panel. Rate zones that are currently disabled are marked in red while the enabled rate zones are



marked in green.

Figure 42. Tariff Profile, Rate Zones Tab

The country names which will be included in your coverage are displayed in the Coverage field. The number of staricons represents the number of supported network operators in this country. The list can also be exported to a .csvfile by clicking on the Export Button.

You can change the countries' list view from 'Grid' to 'List' by clicking buttons on the top-leftside of the Coverage panel.

7.2.1. Tariff Profile Permissions


List of available Ratezone Statuses

List of available Tariff Statuses

Retrieve Tariff details by ID

Retrieve Tariffs

Retrieve list of tariff plan statuses

Create Tariff Profiles

List Tariff Profiles

Retrieve Coverage of a Tariff Profile

Retrieve single Country details by ID




List Operators

Retrieve my currently active tariff plan



Chapter 8. Data PackagesThe Data Packages panel allows you to buy a data package for a certain region according to your tariff. The mainpage provides an overview of the Data Packages currently enabled for your account

Figure 43. Data Packages Tab

ID The numerical ID of a Data Package

Tariff Which tariff the data package is associated with

Ratezone The rate zone for which the package is active

Volume The total data volume of the package

Rate The total price of the package

Payment The payment type

Status The status of the data package.May be Active or Canceled

Activated The date of activation of the data package

Until The time until the package is valid

Expired Whether the data package is expired or not

Table 7. Data Packages Panel

To buy a new data package, click on the Buy Data Package button on top right of the panel.

In the pop-up window, select tariff and the preferred data package from the drop-down lists, click"I Have Read And Accept The Terms And Conditions" checkbox and click on Buy Data Package For x € button.



Figure 44. Purchase Data Package Dialog



Chapter 9. Stats: Traffic StatisticsThis panel is accessed by clicking on Stats in the top navigation bar and selecting Traffic Statistics from thedropdown menu. This page provides an overview of the services used by all of your endpoints during a user-definedtimeframe:

Figure 45. Traffic Statistics Dashboard

The timeframe can be selected on top of the tab by typing in from-to dates or using the button to select a timerange from a calendar. Click Reload to manually update the data. The selected stats can be exported to a .csv file bypressing Export.



Chapter 10. Stats: Data AnalyticsThe Data Analytics Dashboard can be accessed by clicking on "Stats" panel and selecting "Data Analytics" sub-panel.This provides tools to analyze the status of your M2M/IoT network and the amount of services consumed by yourendpoints:

Figure 46. Data Analytics Dashboard

Dashboard Description

Overview Current Month General overview of your network state: number of active SIMs and servicesconsumed, successful PDP contexts and list of SIMs that can be sorted according tothe different parameters

Data Usage by ServiceProfile

Overview of data consumption by different Service Profiles

Global Distribution A map of the endpoints locations (if available)

Usage by Endpoint Overview of the data consumption by different Endpoints

Live Traffic Live data consumption and PDP contexts statistics

CDR Export Detailed data consumption statistics for export

Traffic by Mobile Network Overview of the data consumption in different Mobile Networks or Countries

SIM Database Overview of the SIMs in use

Traffic History Overview of the data consumption in general and the number of unique endpoints

Data Traffic Per Ratezone Overview of the data consumption in different Ratezones

The Data Analytics panel is still under active development. The full list of features may change infuture, therefore, general descriptions of the functionality is described here.

To return to the Data Analytics dashboard, click on Dashboard button in the top-left corner of the current view.



Figure 47. Data Analytics - Network Activity Dashboard

Figure 48. Data Analytics - Current Month Statistics



Figure 49. Data Analytics - Mobile Network Traffic Statistics



Chapter 11. BillingThe Billing panel allows you to have an overview on the current costs of the services used during the month.

The billing period can be selected in the top-left corner of the panel next to Billing Period. This allows the user toselect a month from a drop-down menu. Clicking Reload refreshes the data shown in this panel.

To change the payment method, click the Payment Details button. The selected data can be exported to a .csv file bypressing Export.

Figure 50. Billing Panel

More detailed information can be viewed by clicking the arrows which expands the rows to display nested fields:

Figure 51. Expanded Items in Billing Panel

When viewing a billing period which is in the past, a Print Invoice button is available.



Figure 52. Print Invoice

Clicking on Print Invoice opens a new page with the generated invoice which may then be saved as PDF by usingthe browser’s print option (CMD+P) and selecting Save as PDF:

Figure 53. Generated Invoice Figure 54. Save as PDF



Chapter 12. UsersThe Users panel allows you to create and manage the user accounts and their rights.

Figure 55. Users Panel

There are 4 roles that users may assume:

Administrator Unrestricted access

User Can edit Endpoint and SIM configurations

Observer read-only access

Support A special role which allows support access to child organizations

Table 8. Summary of User Roles

The main page provides an overview of the users that currently have access to the EUI:

ID Numerical ID of the user

Name Full name of the user

Username The username (typically email address) of the user

Organization name The name of the organization the user belongs to

Status The status may be one of the following statuses: Active, Activation Pending, Suspended,Deleted

MFA If the user has Multi-Factor Authentication enabled or not

Role The user Access level

Created Date of the user account creation

Table 9. Users Panel Description

12.1. New User Creation

To create a new user, press Create user button on the top right corner of the panel. Enter user’s name, email andselect his role from the drop-down menu (Administrator/ User/Observer/Support) and click Create user button.



Figure 56. Create New User Dialog

The system will send an activation letter to new user’s email. Until he clicks on the link in the mail, the user will bemarked as Activation Pending.

Figure 57. Create New User, Activation Pending

12.2. User Management

To change the settings of the user account, click on a user on the Users panel.



Figure 58. User Management

With a user selected, it’s possible to perform the following actions:

• Suspend the user account by clicking Suspend button on top of the panel.Suspended users will not be able to log in to the system or use the API.

• Delete the user account by clicking Remove button on top of the panel.This permanently removes the user from your organization and cannot be undone.

You can create a new user with the same email address as a deleted user.

• Access rights of a user may be assumed by pressing Request Support Access. Support will then have the samepermissions as the assumed user within their organization.

• Manage user account settings select the Details and Configuration tabs.

Details Tab

This tab provides you with a summary of the user details including the ID, Name, email, Organization, Status,status of MFA security for this account, the user Role, and Creation Date.

Figure 59. User Details Tab

Configuration Tab

This tab allows you to change the name of the user and select a status from a drop-down menu. It’s also



possible to add roles to the user by clicking Add role. Roles can be deleted by clicking the button. A usermay have more than one role assigned.

Figure 60. User With Multiple Roles Assigned

After the changes have been made, click Save button.

12.2.1. User Management Permissions

The permissions to manage users varies on the organization hierarchy; users may create anddelete members of their own and direct child organizations. For a description of the permittedoperations, see the EMnify API Documentation.

User Management Action Admin Observer User

Create Support Token to assume permissions of a User by ID

Update, Delete Users

Retrieve my user role permissions

Update User password

Create, List Users

Add, Delete Role from a User

Delete, List trusted devices for a given user

Create, Retrieve Application Token

Edit an Application Token



https://cdn.emnify.net/api/doc/EMnify-API-collapsible.html#user-management-user-collection-&-creation

Chapter 13. AlertsThe Alerts Panel can be accessed by pressing the icon in the top right corner of the EUI. This panel allows you tohave an overview of all notifications which are relevant to your M2M/IoT network, e.g. changing of SIM cards statuses,movement of SIMs and PDP Context-related changes.

The data is provided in the form of table which shows the following information: ID of the notification, date and time,severity (INFO / WARN), source (Network or API), organization name, endpoint which was affected, ICCID and thedescription of the event occurred.

Figure 61. Alerts Panel

High-priority notifications are marked as WARN and the number of notifications with this status will be shown next tothe Alerts icon. If you do not want to receive the notifications of a certain type for a certain endpoint anymore, clickthe Disarm button next to the notification description.

Actions Admin Observer User

Retrieve Organization / Endpoint Alerts

Retrieve events of a User by ID

Retrieve events of an IMSI / SIM



Chapter 14. APIThe API Documentation can be accessed by pressing the icon in the top right corner of the EUI. A new browser tabwith the system API documentation will open.

Figure 62. EMnify Rest API Documentation

Authentication via the API is possible by using user credentials or an application token. If you planto build an application (e.g. running on your own server), it’s recommended to generate anapplication token (see Application Tokens: Creation and Management for more information).



Chapter 15. Tokens, IPs and VPN SetupThis panel can be accessed by clicking on the button in the top right corner of the EUI. It allows you to:

• Create an Application Token to start using the API

• Manage Data Streams

• Manage IP addresses

• Setup a VPN connection to the EMnify cloud

Figure 63. EMnify Tech Settings Page

15.1. Application Tokens: Creation and Management

The Application Token section allows for creating and managing Application Tokens. These tokens are text keys thatare used to authenticate with the Rest API. To create a new token, click Create Application Token button. In the pop-up window, enter a description for the use of the token and click Create Application Token.



Figure 64. Create Application Token Dialog

You will not be able to view the token via the EUI again! Store it in a safe place in yourenvironment.

Figure 65. Create Application Token, Success Dialog

The token will now be displayed in the list of tokens on the main page of the panel:

Figure 66. List of Application Tokens

An application token can be revoked by pressing the cross button and confirming the action by clicking OK. Accessfor this token will be no longer permitted and the token will be removed from this list.

If you want to see a list of revoked tokens, click Show Revoked Application Tokens. This ishidden by clicking Hide Revoked Application Tokens.



Figure 67. Revoked Application Tokens

15.2. Data Streams: Creation and Management

This section allows you to create and manage the data streams. To create the new data stream, click on Add DataStream button.

Figure 68. Tech Settings Page, Data Streams Panel

Select the API type from the drop-down list and enter the details needed – the information requested depends on thetype of the API or Integration you are using.

After the data stream was successfully created, you will be able to pause, resume and delete it by clicking on theappropriate buttons to the right of the stream:

Figure 69. Tech Settings Page, Active Data Stream

A description of all available integrations is detailed in the following document: Data StreamerUser Manual

15.3. IP Address Space Allocation

This section allows you to manage the IP subnets assigned to your account. It provides you with an overview of howmany IPs have been already assigned to the endpoints and how many more are still available.

Figure 70. IP Address Space Allocation

When the available IP addresses number will be low, the Allocate IP Address Space button will become active andallow you to add another IP subnet for new endpoints.



https://s3.eu-central-1.amazonaws.com/emnify-public-docs/data_streamer/user_manual/Data_Streamer_User_Manual.pdf

https://s3.eu-central-1.amazonaws.com/emnify-public-docs/data_streamer/user_manual/Data_Streamer_User_Manual.pdf

15.4. VPN Configuration

This section provides the information on how to setup the VPN connection between your server and the EMnify cloudon Linux and Windows.

Figure 71. Tech Settings Page, VPN Configuration

For more details, see our OpenVPN Integration Guides

15.5. IPSec Tunnel

If you require an IPSec tunnel, please contact support at [email protected].



https://support.emnify.com/hc/en-us/sections/115001113889-VPN


Chapter 16. Account settingsThis panel can be accessed by clicking on the button in the top right corner of the EUI. It provides an overview ofyour account information and allows you to:

• Review your account information

• Change your password

• Add Multi-Factor Authentication (MFA) protection to your account

• Register trusted devices

Figure 72. Account Settings Page

16.1. Password Change

To change your password, click the Change password button. Your old password must be entered followed by a newpassword. In the confirmation dialog, click Chane Password:



Figure 73. Account Settings Page, Change Password Dialog

16.2. MFA Keys and Trusted Devices: Creation and Management

Multi-factor authentication adds another layer of security to your account – to create the new MFA key, click on theAdd MFA Key button, enter your password and click on Add MFA Key in the pop-up window.

Figure 74. Account Settings Page, Add MFA Key Dialog

You will now see the "shared secret" key and a QR code that can be entered in an MFA application. If you don’t haveone, click on the relevant buttons to download "Google Authenticator" app from the Google Play or the App store.



Figure 75. Account Settings Page, MFA Application QR Code

After you install the app and scan the QR code, it will provide a 6-digit code for the MFA Code field. Enter this 6 digitcode, click Activate MFA Device and select OK.

Figure 76. Account Settings Page, MFA Enabled

Each time you log in to the system from this point onwards, you will be required to enter a code generated by the appinstalled on your mobile device.

If you can’t login to the EUI with the correct MFA code, check the time settings of the mobiledevice on which you are using the MFF authenticator app and the device you use to access theEUI: the time and time zone should be set as "automatically obtained from the network", notentered manually.



Figure 77. Default User Login dialog

Figure 78. MFA dialog

If you click "Don’t ask me again on this computer" after entering MFA code, the device which you use to access theEUI will be added to the trusted devices list, and will not require entering MFA key again in the future.

The MFA Key will be asked for again if you change the operating system of your computer or loginwithin a different browser.

To disable the MFA and delete the trusted devices, click on the icon in the appropriate fields:

Figure 79. Account Settings Page, Remove MFA Key or Trusted Devices

16.2.1. MFA Keys Permissions

MFA Keys Action Admin Observer User

Generate user shared secret key for MFA

Activate user shared secret key for MFA

List available MFA Key Statuses

Delete shared secret key for MFA of a user by ID



MFA Keys Action Admin Observer User

List of trusted devices for own user

Delete a trusted device by ID for own user

List available MFA Key Types

Delete my shared secret key for MFA

List of trusted devices for own user

Delete a trusted device for own user



Chapter 17. Log OutPress the button in the top right corner of the EUI to log out.



Contact us for supportYou can contact our support team via the following channels:

1. Chat Please log in to EUI and click on the chat button in right/bottom corner, a support representative will beavailable for who can also transfer your chat to a technical expert as needed.

2. Email You can reach us at [email protected] anytime and your request will be logged in our ticket system andprocessed by one of our technical experts. To facilitate a swift response, include the following information in youremail:

◦ Your company name

◦ The ICCIDs of your SIMs in question

◦ The type of device you are using

◦ A short description of the issue

◦ A phone number where we can reach you

3. Phone You can call us at +49-30-5557333555, make sure you have the ICCIDs of your SIMs available. Wehandle support requests according to their severity:

◦ Critical incidents will be handled 24/7 at any day of the year. The best way to report critical problems issubmit them by email, you will receive a receipt with a Ticket ID assigned.

◦ Operational issues: Requests for information and requests for new configurations will be handled duringbusiness days in Germany 09:00-17:00 CET.




tel:+49-30-5557333555

Documents

EMnify User Guide...• Assign a SIM to an endpoint by clicking Assign SIM (visible if an endpoint has no SIM assigned) Assigning the SIM to the endpoint will allow it to connect to