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

Transcription

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

2 Table of Contents 1 Introduction Table of values Mandatory CSV header lastname Mandatory CSV header firstname Mandatory CSV header Mandatory CSV header userid Optional - devicename Optional - wp8username Optional - password Optional - mdmid Optional - group Optional - msisdn Optional - autoassignmentmsisdn Optional - platform Optional - ownership Optional - serialnumber Optional - enroll Optional - privateimsi Optional - privateimsi Optional knoxactivation Optional pin Optional pin Optional puk Optional puk Optional UserCustomParam:param_name Optional CustomParam:param_name Optional iskmedevice Optional client_variant Optional enrollment_type UserID or as Primary System identifier? CSV delimiter CSV file Test CSV file (MDM server 5.08) Selecting the CSV file Import operation indicators Manipulation of existing devices PMDM_CSV_Import_5.31.0x_EN.docx Page 2 / 23 ^Home

3 UserID as Primary ID: Moving a registered device to a different user UserID as Primary ID: Modify a registered devices name address as Primary ID: Move a registered device to a different user Address as Primary ID: 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 Foreign languages support Bulgarian Table of Figures Figure 1 CSV import fuction... 4 Figure 2 CSV file encoding selection Figure 3 Successful import of CSV data Figure 4 CSV test file prerequisites Figure 5 Expected import results Figure 6 Bulk deletion of registered users Figure 7 Strict header formatting must be observed List of Tables Table 1 CSV import element descriptions Table 2 Troubleshooting matrix PMDM_CSV_Import_5.31.0x_EN.docx Page 3 / 23 ^Home

4 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: Navigate to 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 non-numeric 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.31.0x_EN.docx Page 4 / 23 ^Home

5 1.1 Table of values The system administrator would create a spread sheet, using the " 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. All CSV header values are case sensitive and must be created as displayed Mandatory CSV header lastname Mandatory CSV header lastname User last name "user details" Doe Mandatory CSV header firstname Mandatory CSV header firstname User last name "user details" John Mandatory CSV header Mandatory CSV header Unique user identifier in all 7P MDM systems this will be either " or "user details" See UserID or ? JohnDoe@company.com Mandatory CSV header userid Mandatory CSV header userid Unique user identifier in all 7P MDM systems this will be either "userid" or "user details" See UserID or ? PMDM_CSV_Import_5.31.0x_EN.docx Page 5 / 23 ^Home

6 1.1.5 Optional - devicename devicename A given (friendly) name to help describe or identify the device Friendly name of device SalesS Optional - wp8username wp8username The Microsoft windows user name used to enroll a device(mobile phone "user details" Windows 8.x, Windows 10 mobile, Windows 10 device username User.mdm_instance@abc.com 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 Optional - password password The associated password for the Microsoft windows user name "user details" Windows 8.x, Windows 10 mobile, Windows 10 device password P@55w0Rd Optional - mdmid mdmid The IMEI (International Manufacturer's Equipment Identification)of the device IMEI of the device PMDM_CSV_Import_5.31.0x_EN.docx Page 6 / 23 ^Home

7 1.1.9 Optional - group group Which user group(s) "user details" Groups that the user is a member of Sales;Marketing;Admin The group identifiers must be created within the tenancy that the CSV import will be executed Optional - msisdn msisdn telephone number International format Optional - autoassignmentmsisdn autoassignmentmsisdn telephone number International format Optional - platform platform Manufacturer Valid header value ios or IOS, then platform type will be displayed as IOS Valid header value - Android, then platform will be displayed as Android Valid header value - OSX, then platform will be displayed as OSX Valid header value WindowsPhone8, WP8, Windows, Win, then platform will be displayed as Win Valid header value - Symbian or S60, then platform type will be displayed as S60 Android 7PMDM_CSV_Import_5.31.0x_EN.docx Page 7 / 23 ^Home

8 Optional - ownership ownership Corporate(1) Private(2) If empty then "None Defined" 1 Optional - serialnumber serialnumber Serial # of the device The serial number of the device Optional - enroll enroll The preferred ( or convenient) device enrollment address of the user An alternate address john.doe@company.com Optional - privateimsi1 privateimsi1 The preferred ( or convenient) device enrollment address of the user Optional SIM number Optional - privateimsi2 privateimsi2 The preferred ( or convenient) device enrollment address of the user Optional SIM number PMDM_CSV_Import_5.31.0x_EN.docx Page 8 / 23 ^Home

9 Optional knoxactivation knoxactivation Enable KNOX activation Enable = 1, Disable = Optional pin pin Personal; Identification # Personal; Identification # Optional pin2 Pin2 Personal; Identification #2 Typically 8 digit code Optional puk puk Personal Unblocking Key Typically 8 digit code Optional puk2 Puk2 Personal Unblocking Key 2 Typically 8 digit code PMDM_CSV_Import_5.31.0x_EN.docx Page 9 / 23 ^Home

10 Optional UserCustomParam:param_name UserCustomParam:param_name A defined variable "user details" See Settings>Custom Params Exchange_Username Optional CustomParam:param_name CustomParam:param_name A defined variable See Settings>Custom Params Ikarus_Password Optional iskmedevice iskmedevice A defined variable 0 = No, 1 = Yes Optional client_variant Client_variant A defined variable 1 and gale (Generic Android lock enabled ( API 23) non-samsung) gale Optional enrollment_type Enrollment_type A defined variable 0 = device, 1 = work profile 1 7PMDM_CSV_Import_5.31.0x_EN.docx Page 10 / 23 ^Home

11 1.2 UserID or as Primary System identifier? 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 Primary MDM Server User 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 CSV Import Options 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 7PMDM_CSV_Import_5.31.0x_EN.docx Page 11 / 23 ^Home

12 contd. Choose file Import button Message area Opens a file browser, so the administrator can select the input CSV file Begins the import process Either a "import successful" or error message displayed Table 1 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 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.31.0x_EN.docx Page 12 / 23 ^Home

13 Test CSV file (MDM server 5.08) msisdn,lastname,firstname, ,userid,devicename,wp8username,password,mdmid,group,platform,ownership,enroll ,privateimsi1,private Imsi2,UserCustomParam: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.31.0x_EN.docx Page 13 / 23 ^Home

14 1.7 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: Please note that MDM servers may be configured to use a UserID or address as the user s Primary ID. The method to manipulate existing data has slight difference, depending on the unique system identifier used UserID as Primary ID: Moving a registered device to a different user The original CSV modification import clearly shows that device name "NameChange09" is associated with User ID 1378 UserID csv import example file #1 msisdn,lastname,firstname, ,userid,devicename,serialnumber ,Lastname8,Firstname8,f8.v8@7.com,1377,NameChange08, ,Lastname9,Firstname9,f9.v9@7.com,1378,NameChange09, Original deployment After the completion of the reduced CSV file import, file #1, an examination of "Users and devices" confirms that device "NameChange09" has been allocated to User ID 1378, (lastname9,firstname9). 7PMDM_CSV_Import_5.31.0x_EN.docx Page 14 / 23 ^Home

15 UserID csv import example file #2 msisdn,lastname,firstname, ,userid,devicename,serialnumber After Redeployment 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) UserID as Primary ID: Modify a registered devices name The original CSV modification import clearly shows that device name "NameChange09" is associated with User ID 1378 UserID csv import example file #1 msisdn,lastname,firstname, ,userid,devicename,serialnumber ,Lastname8,Firstname8,f8.v8@7.com,1377,NameChange08, ,Lastname9,Firstname9,f9.v9@7.com,1378,NameChange09, Original device name 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). 7PMDM_CSV_Import_5.31.0x_EN.docx Page 15 / 23 ^Home

16 UserID csv import example file #3 msisdn,lastname,firstname, ,userid,devicename,serialnumber One, After device name change 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) address as Primary ID: Move a registered device to a different user The original CSV modification import clearly shows that device name "NameChange09" is associated with f9.v9@7.com address ID csv import example file #1 msisdn,lastname,firstname, ,devicename,serialnumber ,Lastname8,Firstname8,f8.v8@7.com,NameChange08, ,Lastname9,Firstname9,f9.v9@7.com,NameChange09, Original deployment After the completion of the reduced CSV file import, an examination of "Users and devices" confirms that device "NameChange09" has been allocated to the user f9.v9@7.com (lastname9,firstname9). 7PMDM_CSV_Import_5.31.0x_EN.docx Page 16 / 23 ^Home

17 address ID csv import example file #2 msisdn,lastname,firstname, ,devicename,serialnumber After Redeployment After the completion of the reduced CSV file import, an examination of "Users and devices" confirms that device "NameChange09" has been allocated to user (lastname8,firstname8) Address as Primary ID: Modify a registered devices name The original CSV modification import clearly shows that device name "NameChange09" is associated with user f9.v9@7.com address ID csv import example file #1 msisdn,lastname,firstname, ,devicename,serialnumber ,Lastname8,Firstname8,f8.v8@7.com,NameChange08, ,Lastname9,Firstname9,f9.v9@7.com,NameChange09, Original device name After the completion of the reduced CSV file import, an examination of "Users and devices" confirms that device "NameChange09" has been allocated to user f9.v9@7.com (lastname9,firstname9). 7PMDM_CSV_Import_5.31.0x_EN.docx Page 17 / 23 ^Home

18 address ID csv import example file #1 msisdn,lastname,firstname, ,devicename,serialnumber One, After device name change 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 (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 Mandatory parameter missing File system error / 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 Any other error (for example some missing rights on server side). Table 2 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.31.0x_EN.docx Page 18 / 23 ^Home

19 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 as the Primary ID, then set the first name, last name and ID field to "Pool" For MDM systems that are s address as the Primary ID, 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.31.0x_EN.docx Page 19 / 23 ^Home

20 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

21 2.2 Bulk CSV delete process The database is then scanned using the following search criteria: 1. UserId or address depending upon which preference is set on the MDM server, 2. address if no addresses are available then the search will continue with, 3. Lastname which again, if no entries exist then the search will finally proceed to, 4. 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 is advised which devices have been found, and whether they have an active MDM client and if so whether the MDM client is deactivated (preferred option) before deletion. 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.31.0x_EN.docx Page 21 / 23 ^Home

22 3 3.1 Foreign languages support This chapter includes any tips that may help system administrators in the preparation of their specific language CSV files. Bulgarian How to import CSV document with Cyrillic symbols to Microsoft Excel and correctly render them in this program 1. Export CSV file and save it. 2. Open Excel. 3. Import the data using Data-->Import External Data --> Import Data. 4. Select the file type of "csv" and browse to your file. 5. In the import wizard change the File_Origin to "65001 UTF" (or choose correct language character identifier). 6. Change the delimiter to comma (or any other sign that you would like to use). 7. Select where to import to and Finish. 7PMDM_CSV_Import_5.31.0x_EN.docx Page 22 / 23 ^Home

23 List of changes Version Date Changes Reason Author Jan-18 Version release 5.31 Tony Dargis Author: Tony Dargis Version: English Date: 03 Jan. 18 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.31.0x_EN.docx Page 23 / 23 ^Home