Annexes
Glossary
- 2G: Second Generation (of the GSM technology) - 2G was launched in the 1990s. It’s more efficient than the first-generation of the GSM technology because it uses digital signalling to compress the information being sent over the radio spectrum. 2G also enabled the SMS, MMS and GPRS services.
- 3G: Third Generation (of the GSM technology) - 3G offers far more capacity than 2G (i.e., higher download speeds). 3G is around ten times faster than GPRS. See also UMTS.
- 4G: Fourth Generation (of the GSM technology) - 4G delivers significantly faster download speeds than 3G. 4G is a data-only network. Voice calls are transmitted using a specific VoIP technology. See also LTE.
- API: Application Programming Interface - Specification of how software components should interact with each other (e.g., CoSwitched control panel and a customer’s system).
- APN: Access Point Name - Name of the data access gateway between the mobile device and the public internet or a private network. CDR: Call Detail Record - Data record created by a communications network that contains attributes that are specific to a phone call or other communication transaction that was handled by the network.
- CSV: Comma Separated Values - Tabular data (numbers and text) format in plain-text form separated by some character or string, most commonly a literal comma or tab.
- Download: Data transferred onto a computer (or other device) from another computer or the internet.
- EDGE: Enhanced Data rates for GSM Evolution - Technology that enhances GPRS to improve data transmission rates. EDGE is considered a pre-3G technology.
- GPRS: General Packet Radio Service - GPRS is a standard that describes how data is transferred over the mobile network to and from the devices on 2G networks.
- GPS: Global Positioning System - Space-based satellite navigation system that provides location and time information anywhere on or near the Earth where there is an unobstructed line of sight to four or more GPS satellites.
- GSM: Global System for Mobile Communications - GSM is a set of technologies and standards that provide the blueprints that telecoms operators use to build mobile networks. GSM is the dominant technology for mobile communications in most parts of the world.
- HSPA: High Speed Packet Access - Technology that extends and improves the performance of existing Third Generation of the GSM technology.
- ICCID: Integrated Circuit Card IDentifier - Each SIM card is internationally identified by its ICCID. ICCIDs are stored in the SIM cards and are also engraved or printed on the SIM card.
- IMEI: International Mobile Station Equipment Identity - An identification, usually unique, to identify mobile network devices, as well as some satellite phones.
- IMSI: International Mobile Subscriber Identity - Identifies the user of a mobile network. Each SIM card has one or more IMSI. SIM cards with multiple IMSIs are known as Multi-IMSI SIM cards.
- IP: Internet Protocol - Principal communications protocol in the Internet protocol suite for relaying data across network boundaries. Its routing function enables internetworking, and essentially establishes the Internet.
- IP Address: Identification assigned to each device (e.g., computer or mobile phone) participating in a computer network that uses the Internet Protocol for communication. IP Addresses can be private or public, and dynamic or static.
- LTE: Long Term Evolution - Key technology of the Fourth Generation of the GSM technology
- M2M: Machine-to-Machine - Communications between machines using fixed or mobile networks.
- MCC: Mobile Country Code - Used in combination with MNC, identifies mobile network operators and some satellite mobile networks.
- MMS: Multimedia Messaging Service - Technology to send messages that include multimedia content to and from mobile devices.
- MNC: Mobile Network Code - Used in combination with MCC, identifies mobile network operators and some satellite mobile networks.
- MNO: Mobile Network Operator - Provider of wireless communications services that owns or controls the elements necessary to sell and deliver services to an end user, including radio spectrum allocation.
- MO: Mobile Originated - Call or message being sent in from a mobile device (i.e., outgoing call or message).
- MSISDN: Mobile Subscriber ISDN Number - A number uniquely identifying a subscription in a GSM or a UMTS mobile network.
- MT: Mobile Terminated - Call or message being sent to a mobile device (i.e., incoming call or message).
- MVNO: Mobile Virtual Network Operator - Network provider that does not own radio access network and spectrum license and may also not own some core network elements.
- PIN: Personal Identification Number - Numeric password shared between a user and a system that can be used to authenticate the user to the system (e.g., SIM card).
- PUK: PIN Unlock Key - Code to reset a PIN that has been lost or forgotten.
- SIM: Subscriber Identity Module - Integrated circuit that securely stores the IMSI and the related key used to identify and authenticate subscription on mobile devices.
- SMS: Short Message Service - Text messaging service component of phone, Web, or mobile communication systems.
- SMS-C: SMS-Center - Name of a network element that stores, forwards, converts and delivers SMS messages.
- UMTS: Universal Mobile Telecommunications System - Key technology of the Third Generation of the GSM technology. Upload: Data transferred from a computer (or other device) to another computer or the Internet.
- USSD: Unstructured Supplementary Service Data - Technology used by GSM mobile phones to communicate with the network operator’s system (e.g., balance enquiry).
- VPN: Virtual Private Network - Virtual point-to-point connection across a public network as if it is directly connected to a private network. Source: 4G Americas, ETSI and Wikipedia
Exports
Some of the data stored by the platform, such as CDRs, can be exported as files by the user (e.g., as CSV files).
Export Format
The platform supports the following export formats:
- Comma-separated Values (CSV) - Tabular data (numbers and text) in plain text. Each line of the file is a data record. Each record consists of one or more fields, separated by commas. The file is exported with a ‘.csv’ extension.
- Portable Document Format (PDF) - Tabular data (numbers and text) exported as a table inside a PDF file sent by email. Each row of the table is a record. Each record consists of one or more fields. The file is exported with a ‘.pdf’ extension.
- Email - Tabular data (numbers and text) exported as a table in an email. Each row of the table is a record. Each record consists of one or more fields.
- ZIP - Some data may require more than one CSV file. In those cases, the platform may show the option to compress all files inside a ZIP archive. The file is exported with a ‘.zip’ extension.
- Print - Directly prints the viewed table. Each row of the table is a record. Each record consists of one or more fields.
The exports file name has the following structure m2m-<name_of_export>-<date_YYYYMMDDHHmmSS>.csv (e.g. sims_list_20160824094730.csv). For exports related to a specific SIM Card, the file name has the following structure m2m-sim-<sim_iccid>-<name_of_export>-<date_YYYYMMDDHHmmSS>.csv (e.g.m2m-sim-8944503540145553069-notifications-20170825090030.csv).
Field Format
The fields are exported with the following format:
- Date - Text with date in ISO 8601 format with the UTC time zone (e.g., ‘‘2016-08-06 23:45:00+00:00’‘).
- Phone number (i.e., MSISDN) - ITU.T E.164 specification with Country Code + National Destination Code or Number Planning Area + Subscriber Number (e.g., ‘‘447408812027’’ - CC=44, NDC=7408 and SN=812027). If phone number doesn’t apply, the field will be empty or ‘’None’‘.
- Label - Text with up to 255 alphabetic and numeric characters. This field cannot have a blank value.
- Description - Text with up to 1000 alphabetic and numeric characters. This field can be empty.
Field Selection
Each export only gets the fields that are visible. To include or exclude fields select them in the button “Show/Hide columns”.
If you order by a specific field and then hide the column, when exporting the table data the order will not be included in the query.
Filter Selection
Each export only gets the rows that filtered, when filtering rows the export will increase the download time. To filter the row use the filter boxes on each field header.
SIM Cards Export
The table below lists the content of the exported files for SIM cards.
| Field | Description | Possible Values |
|---|---|---|
| ICCID | ICCID number of the SIM card. | “8912345678901234567” |
| Primary IMSI | Primary International mobile subscriber identity (i.e., IMSI) associated with the SIM card. | “23123456789000” |
| Label | Label set by the user for the SIM card. | “Default” |
| Primary MSISDN | Primary phone number (i.e., MSISDN) associated with the SIM card. | “441234567890” |
| SIM Type | Shows the SIM Card type (i.e. Mini-SIM, Multi-SIM, etc ) | "Mini-SIM" "Micro-SIM" "Nano-SIM" "Multi-SIM" "Solderable-SIM" |
| Rate Plan | current Rate Plan associated with the SIM Card. | “1GLOBAL M2M” |
| SIM Status | Status of the SIM card. | “Provisioned” “Test Mode” “Pre-Active” “Active” “Suspended” “Blocked” “Retired” |
| Data Status | Status of the Data service of the SIM card. | “Activated” or “Suspended” |
| Session Status | Status of the currents Data Session. | “Online” or “Offline” |
| Data | Current monthly Data usage in KBytes. | “1234563” |
| SMS Out | Current monthly SMS Originated usage. | “10” |
| Country | Name of the country of the network of the operator that the device is connected to. | “United Kingdom” or “N/A” |
| Network | Network name of the operator that the device is connected to. | “1GLOBAL UK” or “N/A” |
| Last Seen Date | Shows the last seen date of the SIM Card (i.e. last time the SIM Card had a Location Update). | “2016-06-07 14:50:57+00:00” |
| Provisioned Date | Shows the provisioning date of the SIM Card. | “2016-06-07 14:50:57+00:00” |
| Date First Activated | Shows the first time the SIM Card got active. | “2016-06-07 14:50:57+00:00” |
| Device IMEI | Shows the Devices that the SIM Card is currently attached. | “35123456789012” or “N/A” |
| Tags | List of Tag associated with the SIM Card separated by comma. | “Tag1, Tag2” or “N/A” |
| IP Address | IP Address currently attached to the SIM Card. | “127.0.0.1” |
| Attributes | Each attribute created has its own column. | “ID-75” or “N/A” if no value added to the attributes |
Specific accounts may have additional fields exported in the file (e.g., IMSI and APN). A specific file specification should be provided to the customer.
The life-cycle of the SIM card is specific of the account and associated service profiles. Some states may not be available in a specific account (e.g., Test state).
Location Updates Export
The location update procedure allows a mobile device to inform the cellular network, whenever it attaches to a new network, it moves from one location area to the next or at periodic times (usually every hour). The platform stores the Location Updates signalling messages received from the network. The table below lists the content of the exported files for Location Updates.
| Field | Description | Possible Values |
|---|---|---|
| Date | Date of when the Location Update signalling message was received by the network. | “2016-06-07 14:50:57+00:00” |
| Country | Name of the country of the network of the operator that the device is connected to. | “United Kingdom” |
| Network Name | Network name of the operator that the device is connected to. | 1GLOBAL UK” |
| MCC | Mobile Country Code (three digit number). | “234” |
| MNC | Mobile Network Code (three digit number). | “015” |
For a detailed description of Mobility Management function of the cellular networks, please refer to 3GPP Technical Specification TS 23.012 Location management procedures.
Specific accounts may have additional fields included in the Location Update (e.g., IMSI). A specific Location Update specification should be provided to the customer.
Location Updates table (accessed through the SIM card detail page) only shows the elements associated to the SIM card in question.
Call Detail Records Export
The platform create a new Call Detail Record (CDR) for any event (e.g., SMS) or session (e.g., call). The table below lists the content of the exported files for CDRs.
| Field | Description | Possible Values |
|---|---|---|
| Country | Name of the country of the network of the operator that the device is connected to. | “United Kingdom” |
| Network | Network name of the operator that the device is connected to. | “1GLOBAL UK” |
| Start Date | Date that the event started (e.g., start of call, start of Data session or date SMS was sent). | “2016-06-07 14:50:57+00:00” |
| End Date | Date that the event stop (e.g., end of call, end of Data session or date SMS was sent). | “2016-06-07 14:55:31+00:00” |
| Origin Number | Phone number (i.e., MSISDN) of the originator of the event (e.g., who sent the SMS). | “441234567890” or “N/A” |
| Destination Number | Phone number (i.e., MSISDN) of the terminator of the event (e.g., who received the SMS). | “441234567890” or “N/A” |
| Duration | Duration of the session/event. | “124” (Seconds for calls, units for SMS and Kilobytes for Data sessions). |
| CDR Type | Type of the event (e.g., Data session). | “Mobile Terminated Call” (MTC) “Mobile Originated Call” (MOC) “Mobile Terminated SMS” “Mobile Originated SMS” “Data” |
Specific accounts may have additional fields included in the CDR (e.g., Disconnect Reason). A specific CDR specification should be provided to the customer.
Call Detail Record table (accessed through the SIM card detail page) only shows the elements associated to the SIM card in question.
Rules Export
The platform stores an history of all the rules that where applied in SIM cards in the account. The table below lists the content of the exported files of the applied rules.
| Field | Description | Possible Values |
|---|---|---|
| Date | Date when the rule triggered. | “2016-06-07 14:50:57+00:00” |
| Label | Name of the rule triggered. Configured by rule. | “Default” |
| Rules Class | Rule class which the notification represents. | “Usage Rule” or “Event Rule” |
| Rule Trigger | Trigger configured that created the rule notification. | “New Device”, “Data Usage”, “Inbound call(s)”, “New Country/Network”, “New Data Session”, “Inbound SMS”, “New Platform Simple |
| Change Sim Card Status Action | The SIM card status that the SIM Card changed if the rule triggered. This only happens if the options is configured in the rule. | “Active”, “Suspend”, “Retire” or “N/A” |
| Change Data Status Action | The data status that the SIM Card changed if the rule triggered. This only happens if the options is configured in the rule. | “Active”, “Suspend”, or “N/A” |
| Send Email | Email where the message was sent. This only happens if the options is configured in the rule. | “somemail@example.com” or “” |
| Send SMS | Number where the message was sent. This only happens if the options is configured in the rule. | “44123456789012” or “” |
| Send Push API | URL where the message was sent. This only happens if the options is configured in the rule. | “http://domain/test” or “” |
| Message | Message sent to the email or SMS. | “New short message Type: MT, Content: example, Date:2016-06-07 14:50:57+00:00” |
This Rule table (accessed through the SIM card detail page) shows the elements associated to the SIM card in question.
Notifications Export
For each change of services status related to the SIM cards the platform creates a notification. The tables below lists the content of the exported files of the notifications.
| Field | Description | Possible Values |
|---|---|---|
| Type | Notification type | “SIM Card Updated” |
| Description | Description of affected | “SIM Card”, “Data Service” or “Rate Plan” |
| New State | New service state | “Provisioned”, “Pre-Active”, “Active”, “Suspended”, “Blocked” “Retired”, “Removed” or “Set” |
| New Value | New values that the notification might store. | “1GLOBAL M2M” or “N/A” |
| Date | Date when the notification was created. | “2016-06-07 14:50:57+00:00” |
This Notification table (accessed through the SIM card detail page) shows the elements associated to the SIM card in question.
Devices Export
The platform has the capability to find and store the device associated with the SIM Cards. The tables below lists the content of the exported files for the devices.
| Field | Description | Possible Values |
|---|---|---|
| International Mobile Station Equipment Identity | MEI number of the Device | “35123456789012” |
| Date First Registered | Date of the first time registered in the platform. | “2016-06-07 14:50:57+00:00” |
| Label | Label set by the user for the Device. | “Default” |
| Sim Card ICCID | ICCID of the Card attached to the device. | “8912345678901234567” or “N/A” |
Report Export
Some reports have the option to export the data. To download the CSV file with the data click on the button “Export Data”.
The report exports file name has the following structure m2m-<name_of_export>-report-export-<date_YYYYMMDDHHmmSS>.csv (e.g. m2m-usage-rule-report-export-20170825091249.csv).
Data and SMS Usage Report
The usages report export will include the following fields in the file:
| Field | Description | Possible Values |
|---|---|---|
| Start Date | Date that the record started. The start date will always coincide with starting month, day, hour or billing cycle. | “2016-06-07 14:50:57+00:00” |
| End Date | Date that the record stopped. The start date will always coincide with starting month, day, hour or billing cycle. | “2016-06-07 14:55:57+00:00” |
| ICCID | ICCID of the SIM Card that generated the usage. | “8912354678901234567” |
| Total Usage | Usage done in between the start and end dates. Data usage counted in KB. | “1024” |
Location Report
The locations report export will include the following fields in the file:
| Field | Description | Possible Values |
|---|---|---|
| Date | Date of when the Location Update signalling message was received by the network. | “2016-06-07 14:50:57+00:00” |
| ICCID | ICCID of the SIM Card that generated the usage. | “8912354678901234567” |
| Country | Name of the country of the network of the operator that the device is connected to. | “United Kingdom” |
| Network Name | Operator name that the device is connected to. | “1GLOBAL UK” |
| MCC | Mobile Country Code (three digit number). | “234” |
| MNC | Mobile Network Code (three digit number). | “015” |
Event and Usage Rules Report
The rules report export will include the following fields in the file:
| Field | Description | Possible Values |
|---|---|---|
| ICCID | ICCID of the Card that triggered the rule. | “8912345678901234567” |
| Date | Date when the rule triggered. | “2016-06-07 14:50:57+00:00” |
| Label | Name of the rule triggered. Configured by rule. | “Default” |
| Rule Trigger | Trigger configured that created the rule notification. | “New Device”, “Data Usage”, “Inbound call(s)”, “New Country/Network”, “New Data Session”, “Inbound SMS”, “New Platform Simple Short Message (SMS)”, “New SIM Card State”, “Number of Data Sessions”, “Outbound SMS” or “Outbound call(s)” |
| Change Sim Card Status Action | The SIM card status that the SIM Card changed if the rule triggered. This only happens if the options is configured in the rule. | “Active”, “Suspend”, “Retire” or “N/A” |
| Change Data Status Action | The data status that the SIM Card changed if the rule triggered. This only happens if the options is configured in the rule. | “Active”, “Suspend”, or “N/A” |
| Send Email | Email where the message was sent. This only happens if the options is configured in the rule. | “somemail@example.com” or “N/A” |
| Send SMS | Number where the message was sent. This only happens if the options is configured in the rule. | “44123456789012” or “N/A” |
| Send Push API | URL where the message was sent. This only happens if the options is configured in the rule. | “http://domain/test” or “N/A” |
| Message | Message sent to the email or SMS. | “New short message Type: MT, Content: example, Date:2016-06-07 14:50:57+00:00” |
Notifications Report
The notifications report export will include the following fields in the file:
| Field | Description | Possible Values |
|---|---|---|
| Date | Date when the notification was created. | “2016-06-07 14:50:57+00:00” |
| Type | Notification type | “SIM Card Updated” |
| Source Type | What does the Source value represents | “ICCID” |
| Source | Source value that the notification is associated. | “8912354678901234567” |
| Description | Description of affected | “SIM Card”, “Data Service” or “IMEI” |
| New State | New service state | “Provisioned”, “Pre-Active”, “Active”, “Suspended”, “Blocked” “Retired” or “Removed” |
Audit Trail Export
For each action done in the platform an audit trail is created. The tables below lists the content of the exported files of the audit trails.
| Field | Description | Possible Values |
|---|---|---|
| Interface | The interface type of the action audited | “Web/Mobile”, “API, “Backend Action”, “Operator” or “Periodic Action” |
| Object | Object type of the action audited | "Account Charge" "Zone" "SubAccounts" "Organization Users" "User" "FTP Setup" "Tag" "Organization" "Attribute" "Billing Settings" "Password" "GGSN" "Rules Sent" "Rules" "Devices" "SIM Card" "Invoice" "Other Charge" "Settings "Profile |
| Action | Action type of the action audited | “Send SMS” “Order” “Suspend” “Activate” “Move” “Delete” “Test State” “Change Primary IMSI” “Change Primary MSISDN” “New Rate Plan” “Suspend Data” “Activate Data” “Edit” “Move to Sub Organization” “Move to another Organization” “Sudo logout” “Sudo login” “Swapped” “Assign Rate Plan” “Pre-Active” “Removed” “Retired” “Provisioned” “Add” “APN” “VPN” “Rule Fired” “Remove IP” “Remove Fixed IP” “Add IP” “Unblock” “Lock” “Charge” “Assign Fixed IP” “Logout” “Login |
| User Email | Email of the user that perform the action audited. | “test@example.com“ |
| Date | Date when the action audited. | “2016-06-07 14:50:57+00:00” |
| Message | Message with details of the action audited. | “User Logged In.” |