7PMDM Server x - CSV Import 7P Mobile Device Management. Rel: 1.0 /

Transcription

1 7PMDM Server x - CSV Import 7P Mobile Device Management Rel: 1.0 /

2 Table of Contents 1 Introduction Table of values UserID or ? CSV delimiter Example CSV file Test CSV file (MDM server 5.08) Selecting the CSV file Import operation indicators Manipulation of existing devices Moving a registered device to new (different) user Modify a registered devices name Troubleshooting Direct import device to device pool CSV Bulk delete The delete user CSV file format Bulk CSV delete process Table of Figures Figure 1 CSV import fuction... 3 Figure 2 CSV file encoding selection... 5 Figure 3 Successful import of CSV data... 6 Figure 4 CSV test file prerequisites... 6 Figure 5 Expected import results... 7 Figure 6 Bulk deletion of registered users Figure 7 Strict header formatting must be observed List of Tables Table 1 Table of values... 4 Table 2 CSV import element descriptions Table 3 Troubleshooting matrix PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 2 / 13 ^Home

3 1 Introduction One of the most efficient methods of registering multiple user and device details into the MDM server database is to utilise the Character Separated Values (CSV) import tool, which is conveniently located at the following location: Organization > Users and devices > CSV import Figure 1 CSV import fuction The "CSV import" tool allows the administrator to select a pre - populated CSV file from their local computer which can then be imported into the MDM server database. Before the data is committed to the MDM server database, specific integrity checks are executed on the importing data to ensure the data is correctly formed. Integrity checks include: Mandatory fields: All data is optional except for "first name, last name and or userid" ( OR userid is dependant on the global setting Settings>Base> Common options (all tenants) )which are mandatory. The mandatory data is the minimum that will be accepted to ensure a valid "CSV Import". Mobile telephone number: Within the MSISDN field, commonly known as the telephone number, all nonnumeric characters excluding the leading "+" (plus sign) will be stripped automatically, leaving an internationally formatted telephone number. e.g Custom parameters: Custom parameters, whether type "user" or "device" must be defined in the MDM server prior to CSV import. See Settings > Base > Custom Parameters Groups: Groups must be defined in the MDM server prior to CSV import (See Organisation > Hierarchies & Groups). Memberships of multiple groups can be achieved using the CSV import tool delimit the groups using the standard, a semi-colon (;), or defining your own group delimiter. e.g. Sales;North;Admin CSV file format: The CSV file should be created / saved in UTF-8 format, which can be authenticated using Notepad++, selecting the Encoding field and then selecting UTF-8. Another option is to generate and manipulate the data using Microsoft's Excel, and "save as CSV" function. Ensure to remove trailing commas at the end of each row. 7PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 3 / 13 ^Home

4 1.1 Table of values The system administrator would create a spread sheet, using the "CSV Header Values" as column headers, completing each user's information into successive rows until all the users information has been compiled into the spread sheet. When complete, the spread sheet must be saved in CSV format. The table below gives an overview of all the available parameters that can be described when using the CSV import utility. Mandatory CSV header Description Type Notes Example (case sensitive) lastname user last name "user details" Doe firstname user first name "user details" John (or userid) User unique identifier "user details" See UserID or ? john.doe@company.com userid (or ) User unique identifier "user details" See UserID or ? Optional CSV headers Description Type Notes Example (case sensitive) devicename A given name "device details" Friendly name of device SalesS5 wp8username Only reqd. if WP8 used "user details" Windows 8.x username password Only reqd. if WP8 used "user details" Windows 8.x password P@55w0Rd mdmid IMEI "device details" The IMEI of the device group #1 Which user group(s) "user details" Groups that the user is a Sales;Marketing;Admin member of msisdn telephone number "device details" International format platform Manufacturer "device details" Device platform type Android ownership Corporate(1) Private(2) "device details" If empty then "None Defined" 1 serialnumber Serial # of the device "device details" The serial number of the device enroll Enrollment address "device details" An alternate address john.doe@company.com privateimsi1 Optional IMSI "device details" Optional SIM number privateimsi2 Optional IMSI "device details" Optional SIM number knoxactivation Enable KNOX activation "device details" Enable = 1, Disable = 0 1 pin Personal; Identification # "device details" Typically 4 digit code 2768 pin2 Personal; Identification #2 "device details" Typically 4 digit code 3287 puk Personal Unblocking Key "device details" Typically 8 digit code puk2 Personal Unblocking Key 2 "device details" Typically 8 digit code UserCustomParam:param_name * 1 A defined variable "user details" See Settings>Custom Params Exchange_Username CustomParam:param_name #1 A defined variable "device details" See Settings>Custom Params Ikarus_Password Table 1 Table of values Note: *1 Items must be created within the tenancy that the CSV import will be executed All CSV header values are case sensitive and must appear within the CSV as they appear in the above table. e.g. "userid" must have capital "I" lower case "d" With Windows Phone 8 devices, if the IMEI field is blank, the MDM server will add an entry named Windows Phone when the user inserts their WP8 username. 7PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 4 / 13 ^Home

5 1.2 UserID or ? Navigate to Settings>Base> Common options (all tenants) The system administrator may wish to utilise the UserID associated with a user opposed to their address as the unique identifier credentials of the MDM server. "UserId" set as unique identifier " address" set as unique identifier This setting is only visible when viewing the Global tenant as the Global administrator. This is a system wide parameter, that once set, and users are installed using either UserID or as their unique identifier cannot easily be changed. Please consider this when changing this parameter. 1.3 CSV delimiter If different CSV delimiters have been used in the creation of the CSV file, the used delimiter must be passed to the CSV Import utility by inserting the appropriate delimiter in the appropriate field. Figure 2 CSV file encoding selection The following table describes the available options within the CSV Import facility 7PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 5 / 13 ^Home

6 CSV Import Options Description Delimiter The delimiter character used in the CSV file (default, (comma)) Group Delimiter The group delimiter character used in the "group" column (default ; (semi colon) Character encoding ISO CSV file encoding UTF-8 CSV file encoding Choose file Opens a file browser, so the administrator can select the input CSV file Import button Begins the import process Message area Either a "import successful" or error message displayed Table 2 CSV import element descriptions. Once the CSV file is completed, the administrator will be updated by the "Import successful" message displayed in the bottom of the CSV import pane. Figure 3 Successful import of CSV data If the prepared CSV file is inconsistent, or duplicate entries have inadvertently been inserted, an appropriate error message will be displayed instead of the "Import successful! message. 1.4 Example CSV file The following is an example CSV file, which has been exported "saved as CSV" from Microsoft Excel, selecting the "comma" as the CSV delimiter value. You may copy the example below, and save it as a CSV file in Notepad++ with UTF-8 encoding. Prior to testing be sure to create the following items: Figure 4 CSV test file prerequisites Navigate to Organisation > Hierarchies & Groups add the following groups: 2,3,4,5,6,7,8,and 9 Navigate to Settings > Base > Custom Parameters add the following custom parameters: cp_check, and ucp_check. 7PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 6 / 13 ^Home

7 Test CSV file (MDM server 5.08) msisdn,lastname,firstname, ,userid,devicename,wp8username,password,mdmid,group,platform,ownership,enroll ,privateimsi1,privateimsi2,use rcustomparam:ucp_check,customparam:cp_check E72,,, ,4,Symbian Selecting the CSV file Navigate to Organization > Users and devices, then select the "CSV import" button. The CSV import panel will appear. The "Choose File" button will allow the administrator to explore their file system for the prepared CSV file. Once selected, the name of the CSV file will be displayed adjacent to the "Choose File" button. Selecting the "Import" button on the CSV pane will commence the CSV import feature. The time to import user information from a prepared CSV file will depend upon the number of records within the CSV file 1.6 Import operation indicators Once completed, the administrator will be updated by the "Import successful" message displayed in the bottom of the CSV import pane. Figure 5 Expected import results The above screenshot displays the expected results after importing the example CSV data. 7PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 7 / 13 ^Home

8 Manipulation of existing devices Customers may wish to redeploy their mobile devices within their tenancy, without the need to enroll the device to a new user. The CSV import facility can be used to accomplish this task utilising a reduced CSV file to import the changes directly into the MDM server tenancy. This added functionality will allow administrators to: Redeploy a device (or multiple devices) to another user (within tenancy) Modify a device (or multiple devices ) name Both these tasks can be performed using the same modified CSV import file, but for purposes of clarity both tasks have been individually recorded below Moving a registered device to new (different) user The original CSV modification import clearly shows that device name "NameChange09" is associated with User ID 1378 msisdn,lastname,firstname, ,userid,devicename,serialnumber ,Lastname8,Firstname8,f8.v8@7.com,1377,NameChange08, ,Lastname9,Firstname9,f9.v9@7.com,1378,NameChange09, After the completion of the reduced CSV file import, an examination of "Users and devices" confirms that device "NameChange09" has been allocated to User ID 1378, (lastname9,firstname9). Original deployment After Redeployment After completion of the following reduced format CSV import - device "NameChange09" has been allocated to User ID 1377 msisdn,lastname,firstname, ,userid,devicename,serialnumber ,Lastname8,Firstname8,f8.v8@7.com,1377,NameChange08, ,Lastname9,Firstname9,f9.v9@7.com,1377,NameChange09, After the completion of the reduced CSV file import, an examination of "Users and devices" confirms that device "NameChange09" has been allocated to User ID 1377, (lastname8,firstname8). 7PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 8 / 13 ^Home

9 1.7.2 Modify a registered devices name The original CSV modification import clearly shows that device name "NameChange09" is associated with User ID 1378 msisdn,lastname,firstname, ,userid,devicename,serialnumber ,Lastname8,Firstname8,f8.v8@7.com,1377,NameChange08, ,Lastname9,Firstname9,f9.v9@7.com,1378,NameChange09, After the completion of the reduced CSV file import, an examination of "Users and devices" confirms that device "NameChange09" has been allocated to User ID 1378, (lastname9,firstname9). Original device name After device name change After completion of the following reduced format CSV import - device "NameChange09" has been allocated to User ID 1377 msisdn,lastname,firstname, ,userid,devicename,serialnumber ,Lastname8,Firstname8,f8.v8@7.com,1377,NameChange08, ,Lastname9,Firstname9,f9.v9@7.com,1378,HTC One, After the completion of the reduced CSV file import, an examination of "Users and devices" confirms that device name has changed to "HTC One" and still allocated to User ID 1378, (lastname9,firstname9). 1.8 Troubleshooting One of the following texts might appear during CSV import process. Message invalid Group does not exist WP8 username exists mdmid exists Msisdn exists Custom parameter unknown Parameter unknown Mandatory parameter /fields not available Mandatory parameter missing File system error Description / Solution The format of an entered address is not correct The group does not exist and must be defined The WP8 username exists within the MDM sever The IMEI already exists within the MDM system The MSISDN (phone number) already exists in the MDM system The custom parameters has not been created in the MDM system An unsupported parameter has been used in the CSV file header. A mandatory field is missing in the header of the CSV file. The information for a mandatory field is missing in the CSV document. Any other error (for example some missing rights on server side). Table 3 Troubleshooting matrix If in doubt, refer to the "Table of Values" to assist in either a missing, duplicated or poorly formatted value. Once corrected, re-apply the CSV file though the "import" button. 7PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 9 / 13 ^Home

10 1.9 Direct import device to device pool The CSV Import facility will allow administrators to directly import devices into the Device Pool, as opposed to a designated user. Once in the Device Pool, the administrator may deploy any device to selected users. For MDM systems that are UserID registered, then set the first name, last name and ID field to "Pool" For MDM systems that are s address registered, then set the first name, last name and field to "Pool" The following CSV example, where users are registered by their UserID: msisdn,lastname,firstname, ,userid,devicename,serialnumber ,Pool,Pool,f3.v3.pool@7.com,Pool,iPad, ,Pool,Pool,f4.v4.pool@7.com,Pool,iPad, ,Pool,Pool,f5.v5.pool@7.com,Pool,iPad, ,Pool,Pool,f6.v6.pool@7.com,Pool,iPad, ,Pool,Pool,f7.v7.pool@7.com,Pool,iPad, ,Pool,Pool,f8.v8.pool@7.com,Pool,iPad, ,Pool,Pool,f9.v9.pool@7.com,Pool,iPad, Will produce the following results: 7PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 10 / 13 ^Home

11 2 CSV Bulk delete The "CSV delete" button has been added to "User & devices" section of the MDM server user interface, just below the existing CSV Import button. Figure 6 Bulk deletion of registered users To commence the bulk deletion of user, devices and user information the administrator wold select the "CSV delete" button. Once operated an interface opens which is similar in look and feel as the "CSV import" functionality, here the administrator must select the prepared CSV file that contains the user information that must be deleted from the MDM server. 2.1 The delete user CSV file format The delete user CSV file must (strict) follow the same format of header information, including any case variance as in the following example: Figure 7 Strict header formatting must be observed. Sample CSV firstname,lastname,userid, FN_sample1,LN_sample1,sample101,sample@gmail.com101 7PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 11 / 13 ^Home

12 2.2 Bulk CSV delete process The database is then scanned using the following search criteria: UserId or address depending upon which preference is set on the MDM server, address if no addresses are available then the search will continue with, Lastname which again, if no entries exist then the search will finally proceed to, Firstname. There are no further parameters to define the search. Once the CSV data has been processed by the MDM server then the following information will be displayed to the administrator, allowing them to make the final decision with which user and device information is permanently deleted from the MDM server. a) Unique match users and devices which will be deleted - In this list there is one row of User followed by rows of matching devices of the user. b) Multiple matches of Users - the users under this list will not be deleted because multiple matches were found. c) No match found - no matching users found and shown under this heading. The administrator must confirm the permanent deletion from the displayed selected user and device information. Once the administrator accepts the users marked for deletion, they will be permanently removed from the MDM server. 7PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 12 / 13 ^Home

13 List of changes Version Date Changes Reason Author Version release Tony Dargis Author: Tony Dargis Version: EN Date: DocNr: n/a Proprietary Notice: All rights reserved. No part of the document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the written permission of SEVEN PRINCIPLES, Erna-Scheffler-Straße 1a, Köln. The information in this document is subject to change without notice. COPYRIGHT SEVEN PRINCIPLES PMDM_CSV_Import_5.11.0x_EN_1.0.docx Page 13 / 13 ^Home