Chat now with support
Chat with Support

Metalogix Essentials for Office 365 2.3 - User Guide

Metalogix Essentials for Office 365 User Guide
Administrator Architect Backup
Interface Overview Common Functions
Connecting to SharePoint and OneDrive for Business Connecting to Cloud Storage Global and SharePoint Administrators Hyper Backup Creating a Full Backup Creating an Update Backup Creating an Exchange Online Mailbox Backup Creating an Office 365 Group Backup Creating a OneDrive for Business Backup Backup Resume Backup Search Restore from Backup Scheduling Backup Jobs Retention Policies Import/Export Backup Archives Moving the Backup Location Backup Project Conversion
Drives
Interface Overview Common Functions
Connecting to Drives Copy Google Drive Copy File Share Copy My Sites to OneDrive for Business Copy Tenant Copy Box Copy Dropbox OneDrive Management Progress Tab Hyper Migration Path Length Overflow
File Manager Informant Migrator
Interface Common Functions
Connect to SharePoint and OneDrive for Business Global and SharePoint Administrators Copy Sites Live Compare Copy Lists and Libraries Copy, Move, and Tag SharePoint Content Copy Alerts Pre-Migration Report Azure Turbo Mode In-Place Tagging of SharePoint Items Incremental Copy Nintex Workflow Migration Orphaned Users Copy Preserving Content Authorship and Approve/Reject Statuses Save Site to XML Using Scripts and Integration With Windows Task Scheduler
Profile and Global Variables Public Folders for SharePoint Reporting and Re-Mapping Users and Templates Security Manager Term Store Manager Scripts Wizards Appendix

Common Functions

This section provides an overview of the common functions available in the Administrator tab.

Connecting to the Office 365 Tenant

The first step when you begin working with Administrator is to create your initial connection to your Office 365 Tenant.  It is from this connection project that you will be able to generate your reports, create custom filtered views, and create and run any custom actions.

info

NOTE:

·To make full use of all the Service Manager functionality provided, it is recommended that you provide the software with a Global Administrator login to the tenant and possibly a Domain Administrator if any reports or actions are required for Active Directory.

·An Office 365 Global Administrator is required for Office 365 connections.

·A Domain Administrator is required for on premise Active Directory connections.

·Two factor authentication and claims based connections are not supported.

To connect to your Office 365 Tenant:

1.Under the Administrator tab, select Office 365 in the Manage section of the ribbon.
Administrator10

2.Enter a unique connection project name in the "Name" field and enter the "User" and "Password" of the Global Administrator of the Office 365 tenant to which you wish to connect. Click Connect.
Administrator11

3.Once the connection has been successfully established, a new project will appear in the application's Navigator panel.
Administrator12

Default and Custom Views

After the connection has been made to Office 365, an Administrator project ServiceManager-Tenant-Level-icon  will be created in the Navigator and within that a number of sections known as Default Views.  These views are the lifeblood of the Administrator functionality as they allow for greater control and reporting across this tenant, its services, and dependencies, like Active Directory.
Admin-SM-Navigator-Project-Diagram

These views offer a number of options including creating new custom views, filtering, export/import and actions.  The following sections will describe these options in detail.

Tenant Level

The first level within an Administrator project is the tenant itself shown with this icon ServiceManager-365-Level-icon.  This will display the name of the Office 365 Tenant, with the Global Admin account that was provided during connection appearing in brackets to the right of it.  There are a number of menu options that are available at this level, but there are currently no views or reports that can be displayed.

Default Views

The next level is the Default Views and those are shown with this icon ServiceManager-DefaulView-icon.  Default views cannot be deleted nor modified, and they offer a "top to bottom" view of all users and attributes associated to this service.

To open a default view do the following:

1.Double click on the View name in the Navigator pane, or right click on the name and select Open.
Admin-SM-Default-View-Options

2.The view will load in the larger section to the right of the Navigator pane.
administrator13

info

NOTE: Depending on the location of the user and attributes needed to generate this view, you may be asked to provide additional credentials needed to authenticate.

3.From the view results, you can select one or more users and perform a number of actions using either the buttons in the application's ribbon
administrator14
the toolbar
administrator15
or the right click context menu which differs depending on the Default View that you have selected.
These actions include Quick Actions, Custom Actions, Exporting, Refreshing, and Editing.

info

NOTE: Because these default views are preconfigured to load all attributes, this operation may take a significant time to complete.  Please plan accordingly if you are working with a tenant that contains thousands of users or consider creating a custom view that may load in less time.  For example, instead of loading the default view "Exchange Online Mailboxes" perhaps consider creating a Custom View where you can display only the mailboxes where the Active Directory attribute "Department" contains "Sales" is generated.

Custom Views

Custom views are user created views that reside below a parent Default View and are signified with this icon ServiceManager-CustomViews-icon.  Custom views allow a user to read various attributes from different services with the use of filters, in order to create a combined view of users and their metadata.  The benefits of custom views is that you can combine information across the services, filter against the relevant attributes, and take less time to load the view than their default counterparts.

To create a new custom view do the following:

1.Right click the parent default view and choose the New option. This will open the Create View window.
Administrator17  

2.Enter a name for the custom view. the Section Name will automatically be populated based on the node for which you selected to create the new view. 
administrator18 

3. Starting with the Columns tab, expand the Office 365 service you wish to include and click the checkbox next to each relevant attribute.
administrator19

4.Switch over to the Filters tab if you wish to apply any filters to the results.
administrator20
Filters are configured with conditions (Equal, Not Equal, Contains, Does not Contain), drop down selections and text entry fields.  If you wish to rearrange the order of the columns, simply click and drag/drop the column to the new position you wish it to appear in.  If you wish to remove a column, simply switch back to the Columns tab and deselect this attribute.

5.Once you have configured the view to your liking click Ok.  You will be asked if you would like to open the created view - you an select yes or no. Selecting Yes will display the custom view immediately, selecting no will simply add the custom view to the Navigator section of the page where it can be accessed later.

Menu Options

Depending on the selected level, you will have a number of options available in the right click menu.  Below are the icons and descriptions for each option within each section.

Tenant Level

( administratoricon1 ) Import External List (CSV) - Imports a CSV file containing a list of users and their attributes.

( Admin-SM-Import-icon ) Import - Imports all custom views from another Service Manager project.

( Admin-SM-Export-icon ) Export - Exports all custom views.

( Admin-SM-Refresh-icon ) Refresh - Manually refreshes this project or view.  To enable Automatic View Refresh, please visit the Refresh section of this topic.

( Admin-SM-Manage-Custom-Actions-icon ) Manage Custom Actions - Opens the Manage Custom Actions menu.  This can also be accessed through the Custom Actions buttons in the ribbon.

Default Views

( Admin-SM-New-icon ) New - Creates a new custom view beneath this location.

( 2015_06_29_21_16_5414 ) Open - Open this selected default view.

( Admin-SM-Paste-icon ) Paste - Paste a copied custom view(s) as a child to this location.

( Admin-SM-Import-icon ) Import - Select a group of exported views to import to this location.

( Admin-SM-Export-icon ) Export - Export all custom views from this location.

( 2015_06_29_21_16_5414 ) Manage Conferencing Policies - Allows users to create new or modify existing conferencing policies for this location.

Custom Views

( Admin-SM-ImportData-icon(1) ) Open - Load the selected custom view.

( Admin-SM-Edit-icon ) Edit - Edit the columns or filters of the selected custom view.

( Admin-SM-Copy-icon ) Copy - Copy the selected custom view(s).

( Admin-SM-Export-icon ) Export - Export the selected custom view(s).

(administratoricon2) Delete - Delete the selected custom view(s).

info

NOTE: There is no way to undo the deletion of a custom view.

Edit Quick and Custom Actions

From any Default or Custom View, you may select one or more entries from the View's contents to perform an action against by using the right click menu.  The right click menu will provide you with a basic Edit or Update option most appropriate for the currently open view, a Quick Action which performs a single operation regardless of the view, or a Custom Action which is a pre-configured series of actions to be performed in order.  The descriptions and their use are detailed in the following sections.
View-Action-Menu

Refresh

Due to the amount of time it may take to open certain views, the entries are not automatically refreshed after any Action has been run.  To update the entries displayed in any View you may either:

·Select an entry, right click and choose Refresh.  This will refresh the entire View.
Administrator Quick and Custom Actions1

·Click the Refresh toggle button in the application's toolbar to enable automatic refreshes.  When toggled is on ( Admin-SM-Auto-Refresh-Enabled ), the View will refresh automatically at the completion of the action update.  When the refresh is toggled off ( Admin-SM-Auto-Refresh-Disabled ), the View will not update automatically and you will need to revert to manually refreshing using the right click menu in order to see the results in the application.
Administrator Quick and Custom Actions2

Basic Edit or Update Actions

When a Default View is open, you may select one or more entries, right click and have access to a view specific Edit or Update action.  For example, if you open the default "Office 365 Licenses" view, select one or more users and right click, the basic edit operation here will be to "Edit Licenses".  This action will allow you to edit the licenses associated to the selected users only.  A similar operation performed in another Default View will present a different Edit action.
Administrator Quick and Custom Actions3

In a Custom View, this basic edit action becomes a generic "Edit User" and provides access to all available services and attributes that can be updated.
Admin-SM-Edit-Update-Actions2

Quick Actions

Select any Default or Custom View. When the view is open, you may select one or more entries, right click and have access to a menu of Quick Actions.  Quick Actions, unlike the basic Edit or Update, are not specific to the current view and are configured to perform a single operation against the selected entries.  Using the previous example, if you opened the Default View "Office 365 Licenses", select a few entries, right click and hover over Quick Actions, this will open a list of quick action options - such as the Enable/Disable Account option, which allows you to disable the entries you selected.  The advantage to these Quick Actions is that you can perform an action without having to load the view that specifically contains these attributes.
Administrator Quick and Custom Actions4

Custom Actions

Unlike the Basic and Quick Actions, Custom Actions are a series of actions that are user created, upon execution of a custom action each action is performed in the sequence defined, from top to bottom. Custom Actions can be run from any Default or Custom View and are not specific to the one currently open.

In order to run a Custom Action, you must first create one.  To create a new custom action do the following:

1.Select the Tenant Level node within your Service Manager project and either double click on the Tenant Level node, right click the tenant level node and select Manage Custom Actions, or choose the "Open" option in the Custom Actions section of the top ribbon. This will open the Manage Custom Actions viewer.
CustomAction-Open-ManageCustomActions

2.From within the Custom Action view, either right click and select the menu "Create Custom Action" option, or choose the "Create" button in the Custom Action section of the top ribbon. This will open the Create New Custom Action window.
Administrator Quick and Custom Actions6

3.Enter a name and an appropriate description for the new custom action.
Administrator Quick and Custom Actions7

4.Select one or more actions from the left side Available Actions menu and either double click on it or click the Add button in the middle.  This Available Action will now be moved to the Selected Actions menu on the right side.

§At any time you can choose a Selected Action and either double click or click Remove to move it back to the Available Action menu.

§You may also choose a Selected Action and Move Up or Move Down to adjust the order of operations.
Administrator Quick and Custom Actions8

5.Certain actions will include a placeholder which must be configured to your specifications.  For example, the Office 365 Licenses action "Assign License(s)" has a placeholder where you must define which licenses to be assigned during the execution of this Custom Action. You access the configuration by double clicking on the placeholder next to the selected action. This opens a configuration menu for that specific action.
Administrator Quick and Custom Actions10

6.Complete the configuration for any placeholders that belong to the Selected Actions.
Administrator Quick and Custom Actions9

7.Once your custom action has been built to your requirements, click Finish to save the configuration and return to the Custom Action list.
Administrator Quick and Custom Actions11

Once one or more Custom Actions have been created, you can run them in one of a few ways:

You can run a Custom Action from the right click menu after entries have been selected from any View.
Administrator Quick and Custom Actions12

Or you can run a Custom Action from the "Manage Custom Actions" view.  The benefit of this approach is that you can specify which users to run the action against either by loading a static CSV file or dynamically by selecting an existing View.  In order to use this method do the following:

1.Open the "Manage Custom Actions" view by clicking the "Open" button in the Custom Actions section of the top ribbon or by selecting "Manage Custom Actions" from the tenant node's right click menu.
CustomAction-Open-ManageCustomActions

2.From the Manage Custom Actions view, select the Custom Action that you would like to run and either click the "Run" button in the Custom Actions section of the top ribbon, or right click on the custom actions and select "Run Custom Action" from the right click menu.
Administrator Quick and Custom Actions13

3.The Run Custom Action dialog box will now appear.  Select from the option to Load from CSV or Load from View.
Administrator Quick and Custom Actions14

·Load from CSV:  This option provides you with the ability to load a specific list of users for which to run the custom action against.  The CSV file should be formatted as a single column which contains the Office 365 User(s) accounts to be processed.  For example, user01@contoso.com. Load from CSV example file.

·Load from View:  This option allows you to select an existing view (default or custom) for which to run the custom action against.  The users which are displayed in the view are the only users for which this custom action will be.  Please note that this can be a dynamic list of users.  For example, if you create a simple custom view where "Sign-in Status equals Blocked" the list of users in this view on Monday may not be the same list of users on Friday, so the custom action may be run against a different set of users every time.

oYou may preview which users will be processed by the use of your custom view by simply selecting the view from the Load from View option and then clicking the Preview Results button.
Administrator Quick and Custom Actions15
This will open the preview results window, providing an overview of the users that were loaded.
Administrator Quick and Custom Actions16

·Delta:  The Delta option is only available when the Load from View option is selected and this action has already been run at least one time in the past against this specifically named view.  When enabled, this execution of the Custom Action will not process any objects in the current view results that were previously processed in an earlier run.  Using the previous example of a view which returns a list of users whose Sign-in Status is Blocked, if this view returns a total list of 4 users on Monday when the action is first run, then the next run on Friday this view may return the same 4 from Monday, plus an additional 2 users that have since been Blocked.  With Delta, the custom action will know that the original 4 users were already processed and therefore it will only process the additional 2 users that were added since the last time the action was run.

oYou may preview which users will be processed by the use of your custom view by simply selecting the view from the Load from View option and then clicking the Preview Results button.  If this custom action has already been processed against this view at least once in the past, then you may also preview the Delta results by clicking the Enable Delta option.  With Delta enabled, the Office 365 User accounts listed in red are the ones that would not have been processed during the next delta operation, while those listed in green would have been processed.
Administrator Quick and Custom Actions17

4.After you have either loaded the list of users from a CSV file or from an existing view, you may click the Finish button to begin immediately or the Generate Script or Schedule buttons to process them later.
Administrator Quick and Custom Actions18

5.Once the Custom Action has finished running, you can select the View Logs option from the pop-up window notifying you of the completion of the process, or you can select to view Logs later by selecting "logs" from the View section of the top banner.
Administrator Quick and Custom Actions19

Related Documents