Module 05:
Handling Data in Bulk
Module Duration: 3 Hours
© 2012 Avaya, Inc. All rights reserved, Page 1
Module Objectives
After completing this module, you will be able to:
– Import / export data to / from SMGR in bulk.
Module Duration: 45 Minutes
© 2012 Avaya, Inc. All rights reserved. Page 2
Module 05: Handling Data In Bulk
Lesson 01: Importing Data
Lesson Duration: 20 Minutes
© 2012 Avaya, Inc. All rights reserved, Page 3
Provisioning Manually? Administrative Headache!
SMGR will manage
large numbers of users
Lesson Duration: 20 Minutes
© 2012 Avaya, Inc. All rights reserved. Page 4
Importing In Bulk
Initially provisioning an enterprise
Moving lots information into a new Avaya Aura® installation
Supposes data must
already exist
somewhere!
© 2012 Avaya, Inc. All rights reserved. Page 5
Importing In Bulk (continued)
Modify large batches of records
– Company takeover – change of email addresses
– Need to modify all of the contact centre staff application sequencing
© 2012 Avaya, Inc. All rights reserved. Page 6
Importing In Bulk – What can be Imported/Exported?
User Profiles (Including Communication Profile)
Application Sequencing
Personal Contact Lists
Shared Addresses
Presence Access Control Lists (ACL)
SMGR Roles
Element Inventory Details
Etc.
© 2012 Avaya, Inc. All rights reserved. Page 7
Importing In Bulk – The Process
SMGR Data is represented as xml
XML data can be read by SMGR and
added to back in to the database repository
SMGR doesn’t say how to create xml file –
it only determines the structure of the data
– Use of Avaya ProVision?
<xml>
Note: if the data is currently held in <data>
– Lotus Domino </data>
</xml>
– Microsoft Active Directory
– or other LDAP based backend
The SMGR LDAP synchronisation tool
should be used instead of bulk import /
export
© 2012 Avaya, Inc. All rights reserved. Page 8
Import Performance
Initial provisioning of SMGR may involve a large dataset
Bulk Import supports 60 records / minute
5,000 Users in a single 600Mb file
100,000 Users max in one import – spread across multiple
files of 5,000 users per file
– Larger numbers of users can be imported, but will need to
be split over multiple import tasks
<xml> <xml>
<data> <data>
</data> </data>
</xml> </xml>
© 2012 Avaya, Inc. All rights reserved. Page 9
Importing – Failed Records?
Any records that fail to import are collated and offered for download through
SMGR UI
Failed records can then be analysed, modified and re-imported
NB: XML syntax errors will prevent import
<xml>
<data>
</data>
</xml>
Failed to import
<xml>
<data>
</data>
</xml>
© 2012 Avaya, Inc. All rights reserved. Page 10
Importing – Failed Records? (continued)
SMGR supports both full and partial User data importing
Can update existing user’s details – E.g. Add a contact
<xml> <xml>
● Communication ● Contacts
Profile ● Roles
● Contacts
● Address </xml>
● Roles
</xml>
© 2012 Avaya, Inc. All rights reserved. Page 11
Importing Data – 2 Ways
1. Dedicated Import / Export pages
2. From under the relevant element
manager sections
© 2012 Avaya, Inc. All rights reserved. Page 12
Importing User Data
Select import XML file
<xml>
Configure import <data>
</data>
– Determine error handling – </xml>
what to do when a problem
is encountered Abort or
continue?
– Determine if the import will
be of whole records or
partial records
– Determine action when a
duplicate record is found.
– Skip
– Merge
– Replace
– Delete
© 2012 Avaya, Inc. All rights reserved. Page 13
Scheduling Import of User Data
Large imports will take time. Consider scheduling during a maintenance window.
© 2012 Avaya, Inc. All rights reserved. Page 14
Failed Records? (continued)
Import failures will be listed
Under ‘Manage Job’ click to view
the failed job
© 2012 Avaya, Inc. All rights reserved. Page 15
Failed Records?
Job details
page will
summarize
important
information
Dialog at
bottom will
show where &
what errors
occurred
Click to
‘Download’
failed records
© 2012 Avaya, Inc. All rights reserved. Page 16
Exercise: Bulk Import Users
Objective & Outcome
The objective of this exercise is to learn the process of using bulk import.
By the time you are done, you should have imported an additional user.
1. Navigate to Home > Services > Bulk Import and Export > Import > User
Management > Users
2. Select the import file. Browse to ‘importUser.xml’ file on the desktop
3. Configure import options
– Choose to continue processing other records on failure
Team Activity
– Select complete import
Student B to drive,
– If the user already exists, select to overwrite with the new one with student A
– Import immediately (don’t schedule) shadowing
4. Import the users. Click Import
5. Check success
– Periodically refresh the Manage Job pane. Look for ‘Successful’ status
– Check the list of users and locate the newly imported user
Student A
Student B
© 2012 Avaya, Inc. All rights reserved. Page 17
Question
On processing a record that cannot be imported, will SMGR
rollback?
© 2012 Avaya, Inc. All rights reserved. Page 18
Importing User Data
There is no 'roll-back' after successful import – each record is handled individually
Consider a batch import where some records fail due to bad data
– After correcting the data, rather than rolling back to pre-import state, re-run the import
with Skip selected. Any records that imported correctly the first time will be skipped.
© 2012 Avaya, Inc. All rights reserved. Page 19
Importing User Data (continued)
Sensitive information (user's passwords) can be supplied in the user data XML
SMGR can handle encrypted data, deciphering encoder data before adding to the
database
– Helps keep data safe whilst moving in file format
Encrypt Utility
um_bulkimport-encryptUtil.zip
password1
For further instructions on encrypting
import passwords, see the appendix. %z[323£*&3
© 2012 Avaya, Inc. All rights reserved. Page 20
Importing User Data – Some Useful Info
Login name treated as unique identifier
– As such, ‘loginname’ cannot be updated by bulk import
– If loginname matches existing record – SMGR will either replace, skip or delete that
record depending on how the import is configured
SMGR data often references other data in the system – import order matters!
If importing users, roles & contacts:
1. Roles
2. Public Contacts | Shared Contacts
3. Users
If importing Presence ACL:
1. Users
2. Presence Data
© 2012 Avaya, Inc. All rights reserved. Page 21
Importing: Other SMGR Data
Other SMGR data can also be imported in similar fashion
Inventory, Roles, Routing policies etc.
Useful since partners / professional
services may want to provision as much as
possible in advance of going on site to
complete deployment
© 2012 Avaya, Inc. All rights reserved. Page 22
Configuring Default Import Options (& Other Defaults)
© 2012 Avaya, Inc. All rights reserved. Page 23
Configuring Default Import Options (& Other Defaults)
(continued)
0 = Skip
1 = Merge
2 = Replace
3 = Delete
© 2012 Avaya, Inc. All rights reserved. Page 24
Module 05: Handling Data In Bulk
Lesson 02: Exporting Data
Lesson Duration: 20 minutes
© 2012 Avaya, Inc. All rights reserved, Page 25
Lesson Duration: 20 Minutes
© 2012 Avaya, Inc. All rights reserved, Page 26
Exporting SMGR Data – 2 Export Mechanisms
Some data may be exported via the Other data, such as Roles and
SMGR menus Users may be exported from the
command line
Routing Info
SM host
resolution table
© 2012 Avaya, Inc. All rights reserved. Page 27
Exporting SMGR Data
Exporting data via the web interface packages records into zip files.
Save exported
XML info as ZIP
on local machine
© 2012 Avaya, Inc. All rights reserved. Page 28
Exporting SMGR Data (continued)
The exported ZIP file may be extracted and its xml files viewed.
NRPExportData.zip
© 2012 Avaya, Inc. All rights reserved. Page 29
Exercise: Export All Routing Data
Objective & Outcome
The objective of this exercise is to learn how to export SMGR data using
the Web Interface. By the time you are done, you should have an exported
ZIP file that contains xml file(s) that represent SMGR routing policies and
surround data.
1. Navigate to Home > Services > Bulk Import and Export > Export > Routing >
All Data.
2. Click Export. Select Save and choose the local desktop as the save
location. Save the exported file. Team Activity
Student A to drive,
3. Navigate to the student desktop and open the ZIP file. Examine content with student B
shadowing
Student A
Student B
© 2012 Avaya, Inc. All rights reserved. Page 30
Exporting SMGR Data from the Command Line – Needs SSH
SSH
● Not all data is exportable from the SMGR
UI
● Users & Roles are (currently) only
exportable from the command line
● To export users and roles,
– SSH into the SMGR server
– Run Putty
– Enter IP address of SMGR server –
see student lab guide (eg
17216.2.103)
– From the CLI console enter the SMGR
username and password – see student
lab guide (eg admin/admin)
© 2012 Avaya, Inc. All rights reserved. Page 31
Exporting SMGR Data – Export Utilities Location
Once logged in to SMGR with SSH, the export utilities are found at
● /opt/Avaya/Mgmt/6.2.12/upm/bulkexport/exportutility
– Check release version – yours could be different
6.2.12
● Tool to export users
● The config directory contains
a configuration tool that
determines which records
are exported
© 2012 Avaya, Inc. All rights reserved. Page 32
Exporting SMGR Data
● Inside the ‘config’ directory, you’ll find the
bulkexportconfig.properties file
● Use this to configure:
– The number of records to be
exported
– Export file size
– Export file destination
● Note the default file export location
© 2012 Avaya, Inc. All rights reserved. Page 33
Exporting SMGR Data – sh exportUpmUsers.sh
Command to export users shown above
Can override defaults (in bulkexportconfig.properties) using optional parameters
● f : Export file name prefix
E.g
● r : Records per file
● d : Destination Folder
● s : Record starting index
● e : End offset index (number of
records)
© 2012 Avaya, Inc. All rights reserved. Page 34
Exercise: Export User Data using CLI Utilities
Objective & Outcome
The objective of this exercise is to learn to use SMGR’s CLI utilities to export
data. By the time you are done, you will have SSH’d in to SMGR, triggered the
export of data, and will have an exported data file ready for inspection.
1. SSH in to SMGR
– Run Putty from the student desktop.
– Enter IP address of SMGR server – see student lab guide (eg 172.16.2.103)
– From the CLI console enter the SMGR username and password – see student Team Activity
lab guide (eg admin/admin) Student B to drive,
with student A
2. Navigate to export utilities
shadowing
– type: cd /opt/Avaya/Mgmt/6.2.12/upm/bulkexport/exportutility
3. Run the export shell
– type: sh exportUpmUsers.sh
SMGR will take a few moments to export the file
Student A
4. Check the exported file
– Navigate to the export directory.
type: cd /opt/Avaya/Mgmt/6.2.12/upm/bulkexport/
– check for file with name something like ‘exportfile_133043382932.zip’
Student B
© 2012 Avaya, Inc. All rights reserved. Page 35
CLI Exporting SMGR Data – Scheduling
You can also schedule an export to be performed
– t : Set export scheduled time
YYYY:MM:DD:HH:MM:SS
– E.g:
exportUpmUsers.sh -t
2010:05:01:12:00:00
???
1st of May 2010, at Midday
Script regular
data exports?
© 2012 Avaya, Inc. All rights reserved. Page 36
CLI Exporting SMGR Data
Data exported
from the
command line
can be imported
through the GUI.
© 2012 Avaya, Inc. All rights reserved. Page 37
Export XML Format
XML File can be amended for use in ‘partial’ import
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<tns:users xmlns:tns="http://xml.avaya.com/schema/import"
xmlns:ns3="http://xml.avaya.com/schema/import_csm_mm"
xmlns:ns4="http://xml.avaya.com/schema/import_csm_cm"
xmlns:ns5="http://xml.avaya.com/schema/import_sessionmanager"
xmlns:ns6="http://xml.avaya.com/schema/deltaImport"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xml.avaya.com/schema/import userimport.xsd">
<tns:deltaUserList xmlns:ns3=http://xml.avaya.com/schema/import1
xmlns:tns="http://xml.avaya.com/schema/deltaImport"
xmlns:xsi="http://www.w3.org/2001/XMLSchema instance"
xsi:schemaLocation="http://xml.avaya.com/schema/deltaImport userdeltaimport.xsd ">
<tns:user>…</tns:user> <tns:userDelta>…</tns:userDelta>
<tns:users>…</tns:users> <tns:deltaUserList>…</tns:deltaUserList>
© 2012 Avaya, Inc. All rights reserved. Page 38
Separate CLI for Exporting Roles
● SMGR ‘Roles’ are exported via the
command line, in a similar way to
exporting Users
© 2012 Avaya, Inc. All rights reserved. Page 39