DocAve® 6 Deployment Manager

DocAve® 6 Deployment Manager
DocAve® 6 Deployment Manager
User Guide
Service Pack 5
Revision A
Issued February 2015
DocAve 6: Deployment Manager
1
Table of Contents
What’s New in this Guide ............................................................................................................................. 5
About Deployment Manager ........................................................................................................................ 6
Complementary Products ......................................................................................................................... 7
Submitting Documentation Feedback to AvePoint ...................................................................................... 8
Before You Begin........................................................................................................................................... 9
AvePoint’s Testing Policy and Environment Support................................................................................ 9
Supported Software Environments....................................................................................................... 9
Supported Hardware............................................................................................................................. 9
Supported Backup and Recovery .......................................................................................................... 9
Configuration .......................................................................................................................................... 10
Agents ..................................................................................................................................................... 10
Required Permissions ............................................................................................................................. 10
Deployment Manager for SharePoint On-Premises ........................................................................... 10
Deployment Manager for SharePoint Online ..................................................................................... 12
Getting Started............................................................................................................................................ 14
Launching Deployment Manager ............................................................................................................ 14
Navigating DocAve ...................................................................................................................................... 15
Understanding Deployment Manager ........................................................................................................ 16
Deployment Manager Interface.............................................................................................................. 17
Online vs. Offline Deployment ................................................................................................................ 18
Deployment Mappings................................................................................................................................ 19
Creating a Deployment Mapping ............................................................................................................ 19
Deployment Mapping Notes ............................................................................................................... 23
Deploying One Source Object to Multiple Site Collections or Sites in Destination ................................ 25
Offline Deployment for Objects in a Web Application ........................................................................... 26
Offline Solution Deployment .................................................................................................................. 27
Configuring Restricted File System Files ..................................................................................................... 29
Deployment Plans ....................................................................................................................................... 30
Creating a Deployment Plan ................................................................................................................... 30
2
DocAve 6: Deployment Manager
Advanced Predefined Scheme Settings .............................................................................................. 31
Managing Deployment Plans .................................................................................................................. 32
Configuring Queues Locally......................................................................................................................... 34
Downloading Queue as Excel Files .......................................................................................................... 34
Configuring Queue Excel Files ................................................................................................................. 34
Uploading Queue Excel Files ................................................................................................................... 37
Queue Tools ................................................................................................................................................ 38
Managing Solutions..................................................................................................................................... 39
Pre-Creating Solution Queues................................................................................................................. 39
Solution Tools.......................................................................................................................................... 40
Deploying Apps ........................................................................................................................................... 41
Creating a Deployment Mapping for Deploying Apps ............................................................................ 41
How to Find the Apps Node ................................................................................................................ 41
Helpful Notes for Deploying Apps....................................................................................................... 41
Deploying the App Catalog Site to Destination....................................................................................... 41
Deploying One App to Multiple Site Collections or Sites in Destination ................................................ 43
Offline Deployment for Apps in a Web Application................................................................................ 44
Configuring Queues Locally..................................................................................................................... 44
App Tools .................................................................................................................................................... 45
Checking for App Updates ...................................................................................................................... 45
Pushing App Updates .............................................................................................................................. 46
Using Compare ............................................................................................................................................ 47
Performing a Compare Job ..................................................................................................................... 47
Comparing in Different Tree Levels ........................................................................................................ 49
Rules for Comparing Objects in a Web Application ............................................................................ 49
Rules for Comparing Web-Front End .................................................................................................. 53
Rules for Comparing Farm Solution .................................................................................................... 55
Rules for Comparing Shared Services ................................................................................................. 56
Using Custom Compare .............................................................................................................................. 59
Advanced Settings....................................................................................................................................... 60
Using SharePoint Management Shell.......................................................................................................... 61
Appendix A – Conflict Resolution – Web Application Deployment ............................................................ 62
DocAve 6: Deployment Manager
3
Appendix B – Conflict Checks ...................................................................................................................... 66
Appendix C – Supported and Unsupported Elements for Web Application Deployment .......................... 67
Appendix D – Supported and Unsupported Workflow Type ...................................................................... 69
Appendix E – Design Elements Deployment ............................................................................................... 70
Appendix F – Web Front-End Deployment ................................................................................................. 71
Appendix G – Solution Deployment............................................................................................................ 72
Appendix H – Managed Metadata Service Deployment............................................................................. 73
Appendix I – Deployment Manager Customization Table .......................................................................... 74
Appendix J – Advanced Settings in Configuration Files .............................................................................. 98
AgentCommonWrapperConfig.config ................................................................................................ 98
Restoring Specified Web Properties ................................................................................................... 98
Appendix K – Accessing Deployment Manager Using Hot Keys ................................................................. 99
Home Page .......................................................................................................................................... 99
Plan Manager .................................................................................................................................... 100
App Tools .......................................................................................................................................... 100
Solution Tools for Farm Solutions ..................................................................................................... 100
User Solution Tools for User Solutions ............................................................................................. 101
Queue Tools ...................................................................................................................................... 101
Notices and Copyright Information .......................................................................................................... 102
4
DocAve 6: Deployment Manager
What’s New in this Guide


Improvements and enhancements to Deployment Mapping Notes in Deployment Mappings.
New scheduling enhancements in Deployment Plans.
DocAve 6: Deployment Manager
5
About Deployment Manager
Effective management and automation of release operations to promote content, customizations, and
design elements throughout SharePoint 2010, SharePoint 2013, SharePoint Online and SharePoint onpremises is vital to a successful deployment. Without proper planning or control, errors or changes
during the staging process could result in poor application reliability, increased time-to-value, and
project delays.
DocAve Deployment Manager offers a robust solution that automates the change management of
SharePoint solutions, customizations, and Web-front end elements, thereby:

Minimizing human error and cost overruns

Accelerating service delivery

Facilitating preproduction testing and deployment operations
*Note: Deployment Manager also support to deploy SharePoint 2013 objects to SharePoint Online.
6
DocAve 6: Deployment Manager
Complementary Products
Many products and product suites on the DocAve 6 platform work in conjunction with one another. The
following products are recommended for use with Deployment Manager:

DocAve Content Manager for SharePoint when the deployment of customizations also
includes content or structural changes

DocAve Replicator for SharePoint for copying SharePoint content within the same
SharePoint farm or from one SharePoint farm to another

DocAve Data Protection for setting backup and recovery points prior to adjusting
SharePoint governance policies in this product
DocAve 6: Deployment Manager
7
Submitting Documentation Feedback to AvePoint
AvePoint encourages customers to provide feedback regarding our product documentation. You can
Submit Your Feedback on our website.
8
DocAve 6: Deployment Manager
Before You Begin
Refer to the sections for below for system requirements for Deployment Manager.
AvePoint’s Testing Policy and Environment Support
Supported Software Environments
AvePoint is committed to testing against all major versions and service packs of SharePoint as well as the
latest versions of Windows and SQL Server, as Microsoft announces support and compatibility.
Supported Hardware
AvePoint is committed to maintaining a hardware agnostic platform to ensure that DocAve operates on
common Windows file sharing and virtualization platforms. To ensure that DocAve is hardware agnostic,
AvePoint tests hardware that is intended to support SharePoint and DocAve infrastructure, storage
targets, and hardware-based backup and recovery solutions, as supported by AvePoint’s partnerships.
AvePoint directly integrates with the following platforms: any Net Share, IBM Storwize Family, FTP,
Amazon S3, AT&T Synaptic, Caringo Storage, Del DX Storage, EMC Centra, HDS Hitachi Content Platform,
Rackspace Cloud Files, TSM, and Windows Azure Storage.
All other hardware platforms that support UNC addressable storage devices are supported.
*Note: Most of the hardware partnerships referenced in this guide are intended to make use of
advanced functionality (such as snapshot mirroring, BLOB snapshots, indexing, long-term storage,
WORM storage, etc.), and are not indications that any changes to the product are required for basic
support. In most cases, hardware can be supported with no change to the product.
Supported Backup and Recovery
DocAve supports BLOB backup storage according to the list of hardware platforms above. BLOB
snapshot functionally, however, is currently only supported on OEM versions and NetApp hardware.
DocAve supports SQL content and Application database backups via the SharePoint Volume Shadow
Copy Service (VSS) on all Windows and SQL server platforms listed above. DocAve also supports
snapshot-based SharePoint VSS on all hardware listed above where the hardware partner has certified
support with Microsoft.
DocAve supports application and configuration server backups for all the supported software
environments listed above. DocAve 6 SP5 supports VM backup via Hyper-V/VMWare for the following
operating systems: Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2, and
Microsoft Hyper–V Server 2012 R2.
DocAve 6: Deployment Manager
9
Configuration
In order to use Deployment Manager, the DocAve 6 platform must be installed and configured properly
on your farm. Deployment Manager will not function without DocAve 6 present on the farm.
Agents
SharePoint Agents are responsible for running DocAve jobs and interacting with the SharePoint object
model. DocAve must have one agent installed on at least one of the Web front-end (WFE) servers.
DocAve Agents enable DocAve Manager to communicate with the respective servers, allowing for
Deployment Manager to function properly.
*Note: The use of system resources on a server increases when the installed agent is performing
actions. This may affect server performance. However, if the agent installed on the server is not being
used, the use of system resources is very low and, therefore, the effect on server performance is
negligible.
For instructions on installing the DocAve Platform, DocAve Manager, and DocAve Agents, see the
DocAve 6 Installation Guide.
Required Permissions
To install and use Deployment Manager properly, ensure that the following permissions are met.
Deployment Manager for SharePoint On-Premises
To install and use Deployment Manager properly, ensure that the agent account has the following
permissions:
1. Local System Permissions: These permissions are automatically configured by DocAve during
installation. Refer to Local System Permissions for a list of the permissions automatically
configured upon installation.
2. SharePoint Permissions: These permissions must be manually configured prior to using
DocAve 6 Deployment Manager they are not automatically configured.

User is a member of the Farm Administrators group. Since Administrator works across
farms and on all SharePoint settings and configurations, this account is needed in order
to provide the best and most complete quality of service.

In SharePoint 2010 or SharePoint 2013:
o

User Profile Service Application permissions:
o
10
Full Control to all zones of all Web applications via User Policy for Web
Applications
In SharePoint 2010
DocAve 6: Deployment Manager
o

Use Personal Features

Create Personal Site

Use Social Features
In SharePoint 2013

Create Personal Site (required for personal storage, newsfeed, and
followed content)

Follow People and Edit Profile

Use Tags and Notes

Managed Metadata Service: Term Store Administrator

Business Data Connectivity Service: Full Control
3. SQL Permissions: These permissions must be manually configured prior to using DocAve 6
Deployment Manager.

Database Role of db_owner for all the databases related with SharePoint, including
Content Databases, Config Database, and Central Admin Database

dbcreator, securityadmin and processadmin server roles in SQL Server
*Note: The AgentService.exe account is used to start the Deployment Manager job. If the
AgentService.exe account is the agent account, it requires the permissions listed above. If it is not the
agent account, it does not require any special permissions.
*Note: To deploy the newsfeed, the Agent account must be a system account. To deploy apps, the
Agent account cannot be a system account.
Local System Permissions
The following local system permissions are automatically configured during DocAve 6 installation:

User is a member of the following local groups:
o
IIS WPG (for IIS 6.0) or IIS IUSRS (for IIS 7.0)
o
Performance Monitor Users
o
DocAve Users (the group is created by DocAve automatically; it has the
following permissions):

Full Control to the Registry of HKEY LOCAL
MACHINE\SOFTWARE\AvePoint\DocAve6

Full Control to the Registry of
HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\eventlog

Full Control to the Communication Certificate
DocAve 6: Deployment Manager
11

Permission of Log on as a batch job (it can be found within Control Panel
> Administrative Tools > Local Security Policy > Security Settings > Local
Policies > User Rights Assignment)

Local Administrator

Full Control Permission for DocAve Agent installation directory
Deployment Manager for SharePoint Online
The following permissions are required for Deployment Manager to perform a Deployment Manager job
for SharePoint Online.
Local System Permissions for Agent Account
The Agent account is on the machine that has network connection or has Agent Proxy Settings. This
must be done before registering the SharePoint Online site collections.
DocAve automatically configures the Local System permissions during installation. If there are no strict
limitations within your organization on the permissions that can be applied, you can simply add the
DocAve Agent Account to the local Administrators group to apply all of the required permissions.

User is a member of the following local groups:
o
IIS WPG (for IIS 6.0) or IIS IUSRS (for IIS 7.0)
o
Performance Monitor Users
o
DocAve Users (the group is created by DocAve automatically; it has the
following permissions):

Full Control to the Registry of HKEY LOCAL
MACHINE\SOFTWARE\AvePoint\DocAve6

Full Control to the Registry of
“HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\EventLog
”

Full Control to the Communication Certificate

Permission of Log on as a batch job (it can be found within Control
Panel > Administrative Tools > Local Security Policy > Security
Settings > Local Policies > User Rights Assignment)

Full Control Permission for DocAve Agent installation directory
Required Permissions for the User Used to Register SharePoint Online Site Collections
The user that is used to perform the Deployment Manager job for SharePoint Online must have the
following permissions:

12
User is a member of the Site Collection Administrator group.
DocAve 6: Deployment Manager

User Profile Service Application:
o
Follow People and Edit Profiles
o
Use Tags and Notes

Managed Metadata Service: Term Store Administrator

Apps: Read permission to the library “Apps for SharePoint” in Catalog Site.
DocAve 6: Deployment Manager
13
Getting Started
Refer to the sections below for important information on getting started with Deployment Manager.
Launching Deployment Manager
To launch Deployment Manager and access its functionality, complete the following steps:
1. Log in to DocAve. If you are already in the software, click the DocAve tab.
2. From the DocAve tab, click Administration to view the Administration modules.
3. Click Deployment Manager to launch this module.
Figure 1: DocAve module launch window.
AvePoint recommends using Health Analyzer to check the prerequisites you need to correctly use
DocAve Deployment Manager.
*Note: Only users in the DocAve Administrators group can use Health Analyzer.
*Note: For the rule Agent Account Cannot be SharePoint System Account, you can ignore the result of
this rule if you are not going to deploy apps on the specific Web applications.
For more information about Health Analyzer, refer to the DocAve 6 Control Panel Reference Guide.
14
DocAve 6: Deployment Manager
Navigating DocAve
DocAve mimics the look and feel of many Windows products, making for an intuitive and familiar
working environment. While there are many windows, pop-up displays, and messages within DocAve
products, they share similar features and are navigated in the same ways.
Below is a sample window in DocAve. It features a familiar, dynamic ribbon, and a searchable, content
list view.
Figure 2: Navigating DocAve.
1. Ribbon Tabs—Allows users to navigate to the DocAve Welcome page and within the active
module.
2. Ribbon Panes – Allows users to access the functionality of the active DocAve module.
3. Manage columns ( ) – Allows users to manage which columns are displayed in the list. Click the
manage columns ( ) button, and then select the checkbox next to the column name in the
drop-down list.
4. Hide the column ( ) – Allows users to hide the selected column.
5. Search – Allows users to search the List View pane for a keyword or phrase. You can select
Search all pages or Search current page to define the search scope.
*Note: The search function is not case sensitive.
6. Management Pane – Displays the actionable content of the DocAve module.
DocAve 6: Deployment Manager
15
Understanding Deployment Manager
When Deployment Manager is launched, you are redirected to the Home tab where you can manage
plans, access the individual settings control panels for customizing plans, and monitor the status of
currently running and scheduled plans. This is where you can execute jobs, including solutions
deployment and retraction, comparing two selected nodes of the same SharePoint object level,
deploying Web applications, Web front-end deployment, and Shared Services deployment.
Deployment manager is intended for moving customizations and design changes through their lifecycle
on SharePoint. A plan represents a complete set of customizations that can be moved and deployed
together. We recommend using plans to track design changes corresponding to the movement of
business solutions, such as custom pages, workflows, content types, or other features as one complete
set. Each plan can have:

Entire Web applications

Design elements such as site templates

Solutions and features

Service applications: managed metadata

Locally deployed assemblies and reference files: file system files, IIS settings, GAC,
Custom Features, and SharePoint Site Definitions, etc.
For detailed information on what exactly is deployed for each element, refer to:
o
Appendix C – Supported and Unsupported Elements for Web Application
Deployment
o
Appendix E – Design Elements Deployment
o
Appendix F – Web Front-End Deployment
o
Appendix G – Solution Deployment
o
Appendix H – Managed Metadata Service Deployment
Deployment Manager has Job Monitor integrated so that you can check the status of deployed plans
without leaving the Deployment Manager interface. If Job Monitor is accessed within Deployment
Manager, it will display all of the Deployment Manager jobs.
To learn more about Job Monitor, see the DocAve 6 Job Monitor Reference Guide.
Security Trimming can be used to limit the functionality in Deployment Manager that a user can use. For
details on using security trimming, refer to the DocAve 6 Control Panel Reference Guide.
16
DocAve 6: Deployment Manager
Deployment Manager Interface
In Deployment Manager, you will see the following areas:
1. Tabs – Switch between the tabs in Deployment Manager.
2. Ribbon – Toolbar where you can perform certain actions to your mappings and configure
related settings.
3. Source Pane – Here you can navigate through SharePoint farm structures to find the object you
wish to deploy from.
4. Destination Pane – Here you can navigate through SharePoint farm structures to find the
desired node to deploy to.
5. Queue – List of deployment mappings awaiting execution.
6. Search fields – Find the desired object via keyword. This is useful if you know what object you
are looking for but are not certain where the content lives, or if you have many multiple large
environments, this can save you some time finding the desired object.
Figure 3: Deployment Manager User Interface.
DocAve 6: Deployment Manager
17
Online vs. Offline Deployment
For the objects under the Web application level, Deployment Manager allows you to perform an online
deployment. If the source node and the destination node are able to communicate with each other, the
solutions may be deployed via online deployment. To perform an online solution deployment, follow the
instructions under Creating a Deployment Mapping.
If the source node and the destination node are unable to communicate with each other, solutions and
design elements may still be deployed via an offline deployment. Offline deployment involves exporting
the solutions and design elements from the source node to an Export Location, and then importing the
solutions or design elements from the Export Location to the destination node. To perform an offline
solution deployment, see the Offline Solution Deployment section of this guide. For the information on
how to configure a Logical Device, refer to DocAve 6 Control Panel Reference Guide.
*Note: When deploying a solution, the source solution will be loaded to the destination farm through
the SharePoint API, and the SharePoint timer job will deploy the solution to the destination farm.
DocAve will check the deploying status of the solution in the backend and get the status from the timer
job. If the time it takes to check the deploying status exceeds five minutes, the deployment solution job
will finish with exceptions due to performance reasons. For more details, navigate to SharePoint Central
Administration.
18
DocAve 6: Deployment Manager
Deployment Mappings
Creating a deployment mapping is the first step to many of the common uses of Deployment Manager.
Itallows you to:

Quickly and easily perform a singular deployment. This may be useful for when a new
site is created, and you just wish to add a solution or apply a template to it.

Configure multiple deployments to run one after another. This may be useful if you have
multiple singular deployments to perform. This way you can create all of your mappings
during work hours, and then execute the deployments off hours.
Configure multiple deployments and save as a plan, which allows you to repeat the
deployment without having to recreate the same mapping and reconfigure the same
settings. This may be useful if you wish to keep the Destination node in sync with the
Source node. For example, you have a development environment, a testing
environment, a QA environment, and/or multiple farms. Each time you update the node
on the development environment, you may wish to have the testing environment
updated as well, then update the QA environment for further testing. You may then
wish to update all of your farms once the testing is finished. This way, rather than
creating a new deployment mapping each time, you can just rerun the plans created for
each deployment.
For more information, see the Creating a Deployment Plan section of this guide.
Creating a Deployment Mapping
To create a deployment mapping, complete the following steps:
1. In the Source pane, click on a farm to expand its object tree. Continue clicking the relevant
objects until you find the object you wish to deploy from. Select the source object.
2. In the Destination pane, click on a farm to expand its object tree. Continue clicking the relevant
object until you find the object you wish to deploy to. Select the destination object.
3. Click Add to Queue on the ribbon or on the lower right corner of the page. The Add to Queue
window will pop up. Depending on the mapping you are creating, some of the following settings
may be configured:
*Note: Deployments can only be mapped between a source and destination that are using the
same version of SharePoint.
*Note: If you manually create a site collection under a FBA Web application in the destination,
after clicking Add to Queue, a pop-up window will appear to let you select the administrator of
the site collection you are about to create.
DocAve 6: Deployment Manager
19
If the source and destination have different templates, a warning message will appear to warn
you that deployment may cause errors. Click OK to continue, or click Cancel to return to the
Source and Destination selection.

Reorder the Solutions – If there are multiple solutions being deployed, you may
configure the order that the solutions are deployed in by selecting the desired place in
the order column.

Conflict Resolution – Choose Skip, Merge or Replace from the Container level conflict
resolution drop-down menu. Check the Check lower objects checkbox to configure
content level conflict resolution. Choose Skip, Overwrite or Overwrite by Last Modified
Time from the Content level conflict resolution drop-down menu. For detailed
information on how Deployment Manager resolves conflicts based on these
configurations, see Appendix A – Conflict Resolution – Web Application Deployment. For
information on what criteria Deployment Manager checks to determine conflicts, see
Appendix B – Conflict Checks.

Mappings – If you have mapping settings in Control Panel, you may choose to apply
them to this deployment mapping when adding to the Queue. For more information on
these mapping settings, see the Advanced Settings section of this guide.

Filter Policy – A Filter Policy allows you to designate a specific object or data within each
SharePoint level from site collection down to item level.
o
Source – Select a Filter Policy from the drop-down menu to filter the source
object or data or select New Filter Policy to create a new one. For
instructions on creating a Filter Policy, see the Filter Policy section of the
DocAve 6 Control Panel Reference Guide.
o
Destination – Select a Filter Policy from the drop-down menu to filter the
destination object or data or select New Filter Policy to create a new one.
For instructions on creating a Filter Policy, see the Filter Policy section of the
DocAve 6 Control Panel Reference Guide.
*Note: A filter policy can be selected for the destination only when you deploy
the source Site, List/library, Content Type Group/Content type, Column
group/Column to multiple destination sites or site collections, otherwise the
Destination drop-down menu will be greyed out.
*Note: The filter policy in the Destination drop-down menu only filters at the
site collection level and site level filter rules configured in Filter Policy. Lower
level objects or data in the destination cannot be filtered even if the selected
Filter Policy contains rules applicable to those objects.

Source Content Settings – Select the source components that you want to deploy to the
destination:
o
20
Include security – Enable this option to deploy user and/or group
permissions to the destination node.
DocAve 6: Deployment Manager
o
Include user profile – Enable this option to deploy a user profile to the
destination node. Make sure that the selected destination’s Web
application is connected to the User Profile Service Application before you
select this option.
o
Include User Content – Enable this option to deploy the customized content
to the destination node. Deployment Manager does not deploy the
customized data. For example, the data in the Shared Documents will not be
deployed. If you want to deploy the customized data, select this option.

Workflow – Enable the Include workflow definition option to also deploy the
definition of existing source workflows to the destination node.

Deploy to Relative Lists and Sites – Enable this option to synchronize the source
content type to the destination. If you have deployed a content type from the source to
the destination before, with this option selected, the content type changes will be
synchronized to the destination after this deployment job. When this option is not
selected, the content type changes will not be synchronized to the destination content
type that has already been used by lists or sites.

Configuration – If you select a folder or an item in the source and then select a folder in
the destination, or if you select a root folder and select a list in the destination, this
option appears. Choose how to deal with the item dependent columns and content
types.
o
o

Select Deploy the item-dependent columns and content types to maintain
item integrity, and then select a conflict resolution method for these items’
columns and content types from the drop-down list:

Do not deploy the columns and content types, or the corresponding
items – Ignores the conflicting columns, content types, and the
corresponding items, and do nothing on the source and destination
node.

Overwrite the columns and content types – Overwrites the destination
columns and content types with the source node.

Append the columns and content types to destination – Keeps the
destination columns and content types when there is a conflict. In
addition, copy the source columns and content types to the destination
node with a numerical suffix added (for example, ColumnName_1,
ColumnName_2, etc.).
Select Do not deploy the item-dependent columns or content types.
Report the items if the corresponding column or content type is not found
in the destination. The corresponding items are not copied to the
destination. The job report will show items if the corresponding column or
content type is not found in the destination node.
Preserve the Null Column Values – Choose if you want to preserve the null value of
item columns in the source. Some values of the newly created columns may be null for
previous items, and this option allows you to choose whether to replace the null value
DocAve 6: Deployment Manager
21
with the value in the destination. By default, we will preserve the null value for those
items.

Web Configuration Settings – This option appears when you perform an IIS Site Files
level deployment. Choose if you want to include Web Configuration in the deployment
job. the following parameters are included for searching the related configuration in
web.config files:
configuration/SharePoint/PeoplePickerWildcards;
configuration/system.web/membership/providers;
configuration/system.web/roleManager/providers;
configuration/connectionStrings;
You can customize the parameters according to the XPath format in the left pane of the
interface.
Choose whether or not to include the parent node’s properties if the parent node does
not exist in the destination by clicking the checkbox.

Options – This option appears when you perform a Managed Metadata Service level
deployment. Choose the deployment mode, Full Deployment or Incremental
Deployment. A Full Deployment deploys all of the source content and settings to the
destination, while an Incremental Deployment only deploys the modified settings since
the last incremental or full deployment.
If selecting Incremental Deployment, the following options will be available:

22
o
Modifications – Choose if you want to deploy the modifications since the
last job.
o
Deletions – Choose if you want to deploy the deletions since the last job.
Apps – Choose if you want to deploy the apps from the source SharePoint 2013 farm to
the destination SharePoint 2013 farm, or from the source SharePoint 2013 farm to
SharePoint Online, or from the source SharePoint Online site to the destination
SharePoint Online site. Only when the Web application, site collection, site or app level
is selected in the source, and the corresponding destination node is selected, can this
function appear in the Add to Queue window. If you select Include apps, the App
conflict resolution drop-down list appears. Select the conflict resolution (if there is an
app whose product ID is same as the source one, a conflict will be judged):
o
Skip – The conflicted source app will be skipped to deploy to the
destination.
o
Only Upgrade – If the conflicted source app version is higher than the
destination one, the destination app will be upgraded. If the conflicted
source app version is lower than the destination one, the source app will
not be deployed, and the destination app cannot be upgraded.
DocAve 6: Deployment Manager
*Note: This option is not supported for the deployment from the source
SharePoint 2013 farm to SharePoint Online, or from the source SharePoint
Online site to the destination SharePoint Online site.
o
Replace – The conflicted destination app will be replaced with the source
app.

Security – This option appears when you perform a file system level deployment. Select
if you want to deploy the file’s security properties to the destination.

Manage Metadata Service Settings – Choose to copy the entire associated Managed
Metadata Services, the related term sets, or the terms and their parents associated
directly with the content to the destination node. Note that copying the Managed
Metadata Service will activate the service in the destination if it is not activated.

Refresh All Published Content Types – This option appears when you deploy the
content type. Select if you want to update all published content types the next time the
content type subscriber timer job runs.
To edit the deployment mapping, click on the Queue Tools tab. You will be redirected to the Queue
Tools tab of Deployment Manager. For more information, see the Queue Tools section of this guide.
After a deployment mapping is added to the Queue, the Queue Tools tab appears. Click the Queue
Tools tab to make changes to any of the mappings in the Queue. Refer to the Queue Tools section of
this guide for more information.
When you are finished adding deployment mappings to the Queue, click Run on the ribbon or at the
bottom of the screen.
To perform multiple deployments, create deployment mappings by repeating the steps in Creating a
Deployment Mapping. Each deployment mapping you configure will appear in the Queue. You can
change the order in which the deployment mappings are executed by clicking the corresponding dropdown menu in the Order column of the Queue, then selecting the desired place in the Queue. Note
thatfive deployment mappings are shown in the Queue. To change the number of deployment mappings
displayed in the Queue, click the Show rows drop-down menu beneath the Queue, then select the
desired number of deployment mappings to display.
Deployment Mapping Notes
Refer to the following notes for creating a deployment mapping:

Deployments can only be mapped between a source and destination that are using the
same version of SharePoint.

If you manually create a site collection under a FBA Web application in the destination,
after clicking Add to Queue, a pop-up window will appear to let you select the
administrator of the site collection you are about to create.
DocAve 6: Deployment Manager
23

If the source and destination have different templates, a warning message will appear to
warn you that the deployment may cause errors. Click OK to continue, or click Cancel to
return to the Source and Destination selection.

If you select list columns or list content types in the source, you can only select a list or
library in the destination.

If you select a workflow under a list content type in the source, the corresponding list
content type is automatically selected, and you can only select a list or library in the
destination.

Only the current version of the workflow created through SharePoint Designer is
displayed on the source farm tree. Select this workflow and select a destination node, all
of the workflow versions will be deployed to the destination.

All of the workflow versions generated because of the update of the reusable workflow
template (created through SharePoint Designer) are displayed on the source farm tree.
Select a workflow version and select a destination node, the selected workflow version
will be deployed to the destination.

Under the Shared Services node, expand the Managed Metadata Service node. The
Managed Metadata Services are displayed. The nodes Unpartitioned Mode and
Partitioned Mode are loaded under a service. If a Managed Metadata Service is not
partitioned, the data under the service is displayed under the Unpartitioned Mode
node. If a Managed Metadata Service is partitioned, the data is not displayed under
Partitioned Mode, the tenant administration sites and the related term stores are
displayed under the Partitioned Mod node. Right click a tenant administration site, a
drop-down list appears. Select View Site Collections, a window displaying all of the site
collections under the tenant administration site appears. Click a site collection, the site
collection is opened in the browser.
You can deploy a source node under Unpartitioned Mode to a destination node under
Unpartitioned Mode, deploy a source node under Unpartitioned Mode to a destination
node under Partitioned Mode, deploy a source node under Partitioned Mode to a
destination node under Unpartitioned Mode, or deploy a source node under
Partitioned Mode to a destination node under Partitioned Mode. For detailed
information on the elements that can be deployed from the source to the destination,
refer to Appendix H – Managed Metadata Service Deployment.
24
DocAve 6: Deployment Manager
Deploying One Source Object to Multiple Site Collections or Sites
in Destination
This allows you to deploy one source object to multiple site collections or sites by adding one mapping
to your queue. The source supported objects are site, list/library, site content type group/site content
type, site column group/site column, or app. The destination supported nodes are Web application and
site collection.


Deploying to multiple site collections – Select the source node, and select a destination
Web application, click Add to Queue, a pop-up window appears, you can select to
Deploy to Top-level site only or Deploy to all sites:
o
If you select Deploy to Top-level site only in the pop-up window, the Add to
Queue window appears, configure the mapping settings and Click OK to add
this deployment mapping to the Queue. For the details on how to configure
the mapping settings, refer to the Creating a Deployment Mapping section
in this guide. After the deployment job, the source object will be deployed
to all the top-level sites under the selected destination Web application.
o
If you select Deploy to all sites, the Add to Queue window pops up,
configure the queue settings and Click OK to add this deployment mapping
to the queue. For the details on how to configure the mapping settings,
refer to the Creating a Deployment Mapping section in this guide. After the
deployment job, the source object will be deployed to all the top-level sites
and sites under the selected destination Web application.
Deploying to multiple sites – Select the source node, and select a destination site
collection, click Add to Queue, a pop-up window appears, you can select to Deploy to
Top-level site only or Deploy to all sites:
o
If you select Deploy to Top-level site only in the pop-up window, the Queue
Settings configuration page appears, configure the queue settings and Click
OK to add this deployment mapping to the queue. After the deployment
job, the source object will be deployed to all the top-level sites under the
selected destination site collection.
o
If you select Deploy to all sites, the Add to Queue window appears,
configure the queue settings and Click OK to add this deployment mapping
to the Queue. After the deployment job, the source object will be deployed
to all the top-level sites and sites under the selected destination site
collection.
Note that when you select a site in the source, you can only select a Web application in the destination if
you want to perform the batch settings. If you select a site content type group/site content type, site
column group/site column as the source, and select a Web application or site collection as the
destination, you can only select Deploy to Top-level site only in the pop-up window.
DocAve 6: Deployment Manager
25
The top-level site can only be deployed to the destination top-level site. If you select a top-level site in
the source and select a Web application in the destination, click Add to Queue, and the Deploy to all
sites option will be greyed out.
Offline Deployment for Objects in a Web Application
To perform an offline deployment for the objects in a Web application, export the objects to an export
location and then import the objects to the desired destination node. Make sure the export location is
configured before this offline deployment. For the details on how to create an export location, please
refer to DocAve 6 Control Panel Reference Guide.
Follow the steps below to export the objects in a Web application:
1. Click Start with Data Export in the left-hand pane of the landing page, or click Data Export on
the ribbon. The Data Export interface appears.
2. Select the desired node in the Source pane. You can select the entire Web application or desired
objects within the Web application.
3. In the Destination pane, select the export location you wish to export the objects to from the
Export Location drop-down menu.
4. Click Add to Queue and configure settings in the Add to Queue window. For more information
on these settings, refer to the Creating a Deployment Mapping section in this guide.
5. Click OK to add to the queue, or Cancel to return to the Source and Destination selection
interface. If you wish to add other mappings, click Exit in the Destination pane, and the data
trees will appear in the Destination pane once again.
6. Once you have finished adding mappings to the Queue, click Save as a Plan to save this Queue
as a plan and follow the instructions in Creating a Deployment Plan. To execute the Queue
immediately, click Run on the ribbon or click Run located at the bottom of the screen.
Follow the steps below to import the Web application level objects:
1. Click Start with Data Import in the left-hand pane of the landing page, or click Data Import on
the ribbon. The Data Import interface appears.
2. Select the destination node in the Destination pane.
3. In the Source pane, select Design from the Import Type drop-down menu. The export locations
where the objects have been imported will be loaded in the Source pane.
4. Click on the desired export location. The folder named DesignManager2010 (for SharePoint
2010) or DesignManager2013 (for SharePoint 2013) will be loaded. Click on the folder, the
exported plans will appear. You can click the exported plan name to expand to the exported job
node, and then select a node. Click the exported job node to see the exported job data in the
data tree.
5. Click Add to Queue. The Add to Queue window will pop up.
26
DocAve 6: Deployment Manager
6. Configure settings in the Add to Queue window. For more information on these settings, refer
to the Creating a Deployment Mapping section in this guide.
7. Click OK to add to the queue, or Cancel to return to the Source and Destination selection
interface. Repeat the previous steps to add more design elements import mappings to the
Queue. If you wish to add other mappings, click Exit in the Source pane, and the data tree will
appear in the Source pane once again.
8. Once you have finished adding mappings to the Queue, click Save as a Plan to and follow the
instructions in Creating a Deployment Plan. To execute the Queue immediately, click Run on the
ribbon or click Run located at the bottom of the screen.
*Note: In the imported job, if you select an exported site collection node in the source, and select a site
collection in the destination, the user solution’s conflict resolutions are Skip, Overwrite, and Overwrite
by Last Modified Time. But in other jobs, the user solution’s conflict resolutions are Skip, Upgrade and
Retract/Re-deploy.
Offline Solution Deployment
To perform an offline solution deployment, export the solutions to a Logical Device and then import the
solution to the desired destination node. Make sure a Storage Policy is configured before this offline
deployment. For the details on how to configure a Storage Policy, refer to the DocAve 6 Control Panel
Reference Guide.
*Note: The EMC Centera, Dell DX Storage, Caringo Storage, OneDrive, Google Drive, and Box type
storage devices are not supported in an offline solution deployment.
To export the solutions, complete the following steps:
1. Click Start with Data Export in the left-hand pane of the landing page, or click Data Export on
the ribbon. The Data Export interface appears.
2. Select the desired solutions in the Source pane.
3. In the Destination pane, select the Storage Policy you want to export the solutions to from the
Solution Store drop-down menu.
4. Click Add to Queue. The Add to Queue window will pop up.
5. Enter a description for the solutions, then click OK to add to the queue, or Cancel to return to
the Source and Destination selection interface. Repeat the previous steps to add more solution
export mappings to the Queue. If you wish to add other mappings, click Exit in the Destination
pane, and the data tree will appear in the Destination pane once again.
6. Once you have finished adding mappings to the Queue, click Save as a Plan to save and follow
the instructions in Creating a Deployment Plan. To execute the Queue immediately, click Run on
the ribbon or at the bottom of the screen.
To import the solutions, complete the following steps:
DocAve 6: Deployment Manager
27
1. Click Start with Data Import in the left-hand pane of the landing page, or click Data Import on
the ribbon. The Data Import interface.
2. Select the destination node in the Destination pane.
3. In the Source pane, select Solution from the Import Type drop-down menu.
4. Select Solution Store from the Deploy from drop-down menu to access the storage policy to
which you have previously exported your solutions. Click on a logical device under Solution
Store to see the solutions the device contains. You can also select the File System from the
Deploy from drop-down menu to access the file system where the solutions you want to import.
Select the desired solutions by checking the corresponding checkboxes then click Add to Queue.
The Add to Queue window appears.
5. Select the desired Conflict Resolution method from the drop-down menu. For details on
different Conflict Resolution methods, refer to Appendix A – Conflict Resolution – Web
Application Deployment. For information on what criteria Deployment Manager checks to
determine conflicts, see Appendix B – Conflict Checks.
6. If more than one solution is in this mapping, sort the solutions into your desired order.
7. Click OK to add to the queue, or Cancel to return to the Source and Destination selection
interface. Repeat the previous steps to add more solution import mappings to the Queue. If you
wish to add other mappings, click Exit in the Source pane, and the data tree will appear in the
Source pane once again.
8. Once you have finished adding mappings to the Queue, click Save as a Plan to save this queue as
a plan. Follow the instructions in Creating a Deployment Plan to configure the plan settings. To
execute the Queue immediately, click Run on the ribbon or at the bottom of the screen.
28
DocAve 6: Deployment Manager
Configuring Restricted File System Files
In order to avoid affecting the function of the SharePoint system after the File System Deployment,
Deployment Manager also provides a way to block some files, which will be restricted to deploy from
the source to the destination.
To configure restricted file system files, complete the following steps:
1. Select File System Configuration on the ribbon of the Settings group. The File System
Configuration window appears. Click Close to exit the window.
All of the Web front-end servers are displayed in this window.
2. Select Configure after the Web front-end on which the files that you will configure reside, or
select the Web front-end, and then select Configure on the ribbon of the File System
Configuration window. The Configure interface appears.
*Note: You can also right click on the Web front-end server in the source farm tree, and then click
Configuration in the appeared menu to configure the restricted files on the Web front-end server.
1. Configure settings in the Configure interface:

Restricted File Type – Enter the file extensions in the text box. Use the semicolon (;) as
the separator. The file types in the corresponding Web front-end server will be
restricted from deployment to the destination.

Restricted Paths – The file paths and the files contained in those paths will be restricted
from deployment to the destination. Click Add to add more paths. Click the delete ( )
button to delete the added path.
2. Click OK to save the settings. Click Close to exit the Configure interface and return to the File
System Configuration window without saving any changes.
DocAve 6: Deployment Manager
29
Deployment Plans
Deployment mappings can be executed right away, or saved as plans to be executed at a later time. This
also allows you to repeat the same deployment without having to recreate all of the mappings or
reconfigure all of the settings.
Creating a Deployment Plan
To create a deployment plan, create deployment mappings by repeating the steps in Creating a
Deployment Mapping. Each deployment mapping you configure will appear in the queue. You can
change the order in which the deployment mappings are executed by clicking the corresponding dropdown menu in the Order column of the queue, then selecting the desired place in the queue. Five
deployment mappings are shown in the queue. To change the number of deployment mappings
displayed in the queue, click the Show rows drop-down menu beneath the queue, then select the
desired number of deployment mappings to display.
When you are finished adding deployment mappings to the queue, click Save as a Plan on the ribbon or
located at the bottom of the screen. You will be brought to the Save as a Plan interface. Configure the
following settings:

Plan Name – Type in a Plan Name and an optional Description.

Backup Environment Before Running Plan – Enable this option to back up the
destination environment before running the plan. You must then select a storage policy.
Enabling this option allows you to use the Rollback feature in Job Monitor.
*Note: The DocAve Agent must be installed on the machine where the SQL Server
resides for rolling back the Metadata Service deployment job.

Schedule Selection – Choose if you want to add a schedule.
If you select No Schedule, the plan is not run on any schedule and must be initiated
manually;
If you select Configure the schedule myself to configure a customized schedule, and run
the plan by schedule. Click Add Schedule and the Add Schedule window pops up.
30
o
Type – Select the type of recurring schedule: By hour, By day, By week, or
By month.
o
Schedule Settings – Set up the frequency for the scheduled job. If you select
the type as By hour, By week, or By month, you will have the option to
check the Advanced checkbox to configure more settings for the frequency.
For more information, see the Advanced Predefined Scheme Settings
section below.
DocAve 6: Deployment Manager
o
Range of Recurrence – Specify when to start and end the running recurring
schedule.

Start time – Set up the time to start the plan and Time Zone can be
changed under the Start time. Note that the start time cannot be earlier
than the current time.

No end date – Select this option to repeat running the plan until being
stopped manually.

End after specified occurrence(s) – Select this option to stop the plan
after specified occurrences that you configure in the text box.

End by – Set up the time to end the recurrence of plans and the Time
Zone can be changed under End by.
Click OK to save the settings. After configuring the schedule for this job, click
Calendar View to view the job in a calendar view.
*Note: If the plan is added to a plan group, the plan schedule will be managed
by the group schedule. The schedule settings defined here will take effect if the
plan is executed independent of the plan group or removed from the group.

Notification – Choose the type of notification and designate which DocAve user will
receive the e-mail notification report. Select a notification profile from the drop-down
list. Click View beside the drop-down list to view details of the notification profile, or
click New Notification Profile. For information on creating a notification profile, see the
DocAve 6 Control Panel Reference Guide.

Associate Plan Group – Add the plan to one or more plan groups to manage multiple
plans with common settings. Select a plan group from the drop-down menu or click New
Plan Group. For information on creating a plan group, see the DocAve 6 Control Panel
Reference Guide.
When you are finished configuring the plan settings, click Save on the ribbon or located at the bottom of
the screen. When a drop-down list appears, click Save to save the plan; click Save and Test Run to test
run the plan; or click Save and Run Now to run immediately. Click Cancel to return to creating
deployment mappings without saving the plan.
Advanced Predefined Scheme Settings
The following advanced settings are available for configuring a predefined scheme:
By Hour

Specify production time: From … to … – Run the backup job on the selected production
time.

Select time below – Select the time you want to run the backup job. To add several run
job time, click Add.
DocAve 6: Deployment Manager
31
By Week
Run every … week(s); On … – Specify the days of the week to run the plan on, and after how many
weeks to recur.
By Month

On day … of … – Select the day and the month to run the backup job.

Day … of every …month(s) – Select the day and the month interval to run the backup
job.

The … … of every … month(s) – Select the time and the interval for the backup job.

The … … of … – Select the day and the month for the backup job.
Managing Deployment Plans
Once a deployment plan has been created, you can access it by clicking on the Plan Manager tab. In the
Plan Manager interface, you will see a list of all Deployment Plans. You can customize how these plans
are displayed in a number of different ways:

Search – Filter the plans displayed by the keyword you designate; the keyword must be
contained in a column value. At the top of the viewing pane, type in the keyword for the
plan you wish displayed. You can select for search to Search all pages or Search current
page. Note that the search function is not case sensitive.

– You can manage which columns are displayed in the list so that only information
you want to see is shown. Click then check the checkbox next to the column name to
have that column shown in the list.
You may perform any of the following actions on a selected plan:

Edit – Click Edit on the ribbon, or right-click at the plan name and then select Edit from
the drop-down menu. You will be redirected to the Queue Tools interface. Click Edit
Plan Settings on the ribbon. Configure the settings described in the Creating a
Deployment Mapping section of this guide.

Delete – Click Delete on the ribbon, or right-click at the plan name and then select
Delete from the drop-down menu. A warning message will appear to confirm the
deletion. Click OK to delete the selected plan, or click Cancel to return to Plan Manager
without deleting the selected plan. The running job cannot be deleted.

Test Run – Click Test Run on the ribbon. The following objects are supported to be
tested in the destination:
o
32
Site Definition – The site definition is tested according to the template of
the selected site in the source.
DocAve 6: Deployment Manager
*Note: When the corresponding site or site collection is required to be created
in the destination for a deployment job, the destination will be tested if it
contains the site definition of the source site that will be deployed.
o
Assemblies – The assemblies are tested according to the Event Receiver.
*Note: Currently, only the assemblies used by the site or list type Event
Reviewer are supported to be tested.
o
Solutions and custom features – Refer to the following conditions of testing
the solutions and custom features:

When the site collection or site is selected in the source for performing
a deployment manager plan, the solutions or custom features are
tested according to the features of the selected site collection features
or site features in the source.

When the content type is selected in the source for performing a
deployment manager plan, the solutions or custom features are tested
according to the Feature ID of the selected content type in the source.

When the list is selected in the source for performing a deployment
manager plan, the solutions or custom features are tested according to
the Template Feature ID of the selected list in the source.
You can see the results of the test run in Job Monitor. For more information, see the
DocAve 6 Job Monitor Reference Guide.
*Note: The offline deployment plan does not support test runs.

Run Now – Click Run Now on the ribbon. You will see the message: The job is started,
please go to Job Monitor if you want to view the job details. Click the hyperlink to
access Job Monitor for Deployment Manager. For more information on Job Monitor, see
the DocAve 6 Job Monitor Reference Guide.
DocAve 6: Deployment Manager
33
Configuring Queues Locally
You can download the deployment queue as an Excel file to your computer to be configured locally.
After it is configured, it can be uploaded to DocAve Deployment Manager. This allows you to
conveniently deploy multiple objects from the source nodes to destinations instead of adding multiple
mappings to the Queue in the DocAve Deployment Manager.
Downloading Queue as Excel Files
Refer to the following steps to download the Excel file:
1. Create a deployment mapping according to your requirement. The Download Queues button
will be highlighted on the ribbon. For more information on how to create a deployment
mapping, refer to the Creating a Deployment Mapping section in this guide.
2. Click Download Queues, the browser download prompt appears.
3. Click Save and select a location where you want to store the file in the pop-up Save As window.
Configuring Queue Excel Files
You can configure all deployment mappings in an Excel file, including design element mappings, WFE
mappings, solution mappings, and shared service mappings. This section below illustrates how to
configure a Queue Excel file:

Design element type configuration:
Figure 4: Design element type configuration part in the Excel file.

o
Order – The order the mappings will be deployed. All cells in the same row
are configurations for a single mapping.
o
Plan Category – This indicates the mapping type. For the design element
mapping, the value of the Plan Category is design element.
o
Plan Type – There are three plan types for a design element mapping:
Deploy, Import, and Export.
Design element tree configuration:
Figure 5: Design element tree configuration part in the Excel file.
34
DocAve 6: Deployment Manager
o
Source Farm – Enter the source farm name. If the plan type is Import, you
need to leave this field blank.
o
Source Path – Enter the source path information. Refer to the following
table to configure the source path for each source object.
Source Object
Web application
Site collection
Top-level site
Site
Site settings
SharePoint designer
objects (in site level)
SharePoint designer
objects (in list level)
List
Site column
Content type
List settings
DocAve 6: Deployment Manager
Source Path
Web application name
For example: http://webapp:2000/
Site collection URL
For example: http://webapp:2000/sites/urlname
Site collection URL
For example: http://webapp:2000/sites/urlname
*Note: The value of the Source Node Level you specified
should be Site.
Site URL
For example: http://webapp:2000/sites/subsitename
Site URL/site settings
For example: http://webapp:2000/sites/subsitename/Site
Settings
Site URL
For example: http://webapp:2000/sites/urlname
*Note: The value of the Source Node Level you specified
should be DesignObjRootFolder.
List path
For example:
http://webapp:2000/sites/urlname/subsitename
/Lists/*:{listname}
*Note: The value of the Source Node Level you specified
should be DesignObjRootFolder.
Site URL/lists/*:{List Name}
For example:
http://webapp:2000/sites/urlname/subsitename/Lists/*:{li
stname}
Site URL/*:{Site Column Name}
For example:
http://webapp:2000/sites/urlname/*:{sitecolumnname}
Site URL/content type name
For example:
http://webapp:2000/sites/urlname/contenttypename
List path/list settings
For example:
http://webapp:2000/sites/urlname/subsitename/Lists/*:{li
stname}/List Settings
35
Source Object
Root folder
Folder
Item
Design folder (in site
level)
Design folder (in list
level)
Design item (in site
level)
Design item (in site
level)
File system folder
36
Source Path
List path
For example:
http://webapp:2000/sites/urlname/subsitename/Lists/*:{li
stname}
*Note: The value of the Source Node Level you enter
should be RootFolder.
Root folder path/folder name
For example:
http://webapp/sites/Lists/*:{listname}/foldername
Folder path/item ID or document name
For example:
http://webapp:2000/sites/urlname/Lists/*:{listname}/fold
ername/itemID or documentname
SharePoint designer objects path/*:{Design Folder Name}
For example:
http://webapp:2000/sites/urlname/*:{designfoldername}
SharePoint designer objects path/*:{Design Folder Name}
For example:
http://webapp:2000/sites/urlname/Lists/*:{listname}/desi
gnfoldername
Design folder path/item ID or document name
For example:
http://webapp:2000/sites/urlname/*:{designfoldername}/
itemID or documentname
Design folder path/item ID or document name
For example:
http://gxzhang2010/sites/Lists/*:{ListName}/itemID or
document name
Export location name/DesignManager2010/exported plan
name/exported job ID
Example: exportlocationname/DesignManager2010/jobID
DocAve 6: Deployment Manager
Uploading Queue Excel Files
Once you have finished configuring the Queue file, refer to the following steps to upload the Excel file:
1. In the Home tab of Deployment Manager, click Upload Queues on the ribbon, the browser
Open window appears.
2. Select the configured Excel file and click Open to upload it.
3. After clicking Open in the pop-up the window, you will see the following message: The job {0} is
started, please go to Job Monitor if you want to view the job details. You can click the link in
the message to go to the Job Monitor to see the uploading job information. The detailed
mapping information will be displayed in Job Monitor, refer to DocAve 6 Job Monitor Reference
Guide.
4. After the uploading job finished, an instant plan will be created, you can manage this plan in
Plan Manager.
DocAve 6: Deployment Manager
37
Queue Tools
Queue tools allow you to manage the Deployment mappings in the Home tab of Deployment
Manager. . The following actions can be performed in the Queue Tools tab:

Add New Mappings – Click Add New Mappings. This brings you back to the Home tab
to create a new deployment mapping.

Edit – Edit the selected mapping. Your selections will appear in the Source and
Destination pane where you can make changes to the mapping.
o
Edit Mapping Settings – Click Edit on the ribbon, and click Edit Mapping
Settings in the drop-down menu or click Mapping Settings on the lower-left
corner of the screen. The Mapping Settings interface appears. For the
details on how to configure the mapping settings, refer to the Creating a
Deployment Mapping section in this guide.
o
Edit Mapping Source and Destination – You can directly edit the selected
mapping’s source and the destination when you access to the Queue Tools
interface. Or you can make edits after you have edited the mapping
settings.
Once you have finished editing the selected mapping’s settings, the Edit Mapping
Source and Destination will be highlighted. Click Edit on the ribbon, and click Edit
Mapping Source and Destination from the drop-down menu or click Edit Mapping
Source and Destination on the lower-left of the screen.
38

Delete – Delete the selected mapping. A warning will pop-up confirming the deletion.
Click OK to proceed with the deletion, or click Cancel to return to the Queue Tools tab
without deleting the mapping.

Disable – Disable the selected mapping in the plan. Disabled mappings will be skipped
when the plan is run.

Enable – Enable the selected mapping in the plan.

Create Container – In the Destination pane, enter the name of a new container in the
available field then click Create Container. The Create Container interface appears.
Select the object type then choose the category for the new list or library from the dropdown menu.

Cancel – Exit the Queue Tools interface.

Edit Plan Settings – Click to access to the Edit Plan Settings interface. For more detailed
on how to configure the plan settings, refer to the Creating a Deployment Plan section
in this guide.

Save Mapping – Save any changes made to the selected mapping.
DocAve 6: Deployment Manager
Managing Solutions
The following two sections explain how to manage solutions through pre-creating solution queues and
using the solution tools.
Pre-Creating Solution Queues
Pre-creating solution queues allows you to configure groups of solutions to be managed together with
specific actions. Saved queues allow you to repeat similar actions without having to go through the
configuration steps each time.
To create a user solutions queue, complete the following steps:
1. Click Start with Online Deploy in the left-hand pane of the landing page or click Online Deploy
on the ribbon.
2. In the Source pane, click the farm name to expand its data tree. Then select a Web application
to expand the data tree to the User Solution Gallery node, click the User Solution Gallery and
select the user solution(s).
3. Click Add to Queue on the ribbon or on the middle lower part of this interface, the Add to
Queue window pops up.
4. Select the actions Activate, Deactivate or Upgrade for the solutions. For the details on the
actions for solutions, refer to the Solution Tools section in this guide.
5. Click OK to add to the queue, or Cancel to return to the Source and Destination selection
interface. Repeat the previous steps to add more solution import mappings to the queue.
6. Once you have finished adding mappings to the Queue, click Save as a Plan to save this queue as
a plan and follow the instructions in Creating a Deployment Plan. To execute the queue
immediately, click Run on the ribbon or at the bottom of the screen.
To manage farm solutions through adding to queue, complete the following steps:
1. Click Start with Online Deploy in the left-hand pane of the landing page.
2. In the Source pane, click the farm name to expand its data tree. Then click Farm Solutions and
select the farm solutions you want to manage.
3. Click Add to Queue on the ribbon, the Add to Queue window pops up.
4. Select the actions Retract or Remove for the farm solutions. For the details on the actions for
solutions, refer to the Solution Tools section in this guide.
You should also configure the Solution Information in this page. If you select to retract the farm
solutions, then choose the Web applications where you want to retract from. If you select to
remove this farm solutions, then you can view the solution information in the Solution
Information field.
DocAve 6: Deployment Manager
39
5. Click OK to add to the queue, or Cancel to return to the Source and Destination selection
interface. Repeat the previous steps to add more solution import mappings to the queue.
Once you have finished adding mappings to the queue, click Save as a Plan to save this queue as a plan
and follow the instructions in Creating a Deployment Plan. To execute the queue immediately, click Run
on the ribbon or click Run located at the bottom of the screen
Solution Tools
Whenever a solution is selected in the Source pane, the Solution Tools tab will appear at the top of the
Deployment Manager interface. Click on the Solution Tools tab to manage deployed solutions.
For farm solutions, you can perform the following actions on any selected solutions:

Details – Review detailed information about the selected solutions in a pop-up window.
In the Details pane, click on the tab to display information about the corresponding
solution. Click Retract on the ribbon to retract the solution, or click Remove on the
ribbon to remove the solution.

Retract –In the Retract Solutions interface, choose the Web application to retract each
solution. When you have finished making your selections, click OK to retract the
solution, or Cancel to return to the Solution Tools page. Retracted solutions remain in
the Solution Store and may be redeployed later.

Remove – Remove the solutions from the Solution Store. Once a solution has been
removed, it cannot be redeployed until it has been reinstalled to the Solution Store.
For the user solutions, you can perform the following actions on any selected solutions:
40

Activate – Activate the solution within the local farm.

Deactivate – Deactivate the solution within the local farm.

Upgrade – Upgrade the currently active solution to the selected version.
DocAve 6: Deployment Manager
Deploying Apps
In SharePoint 2013 and SharePoint Online, Deployment Manager supports deploying apps from the
source to the destination.
Creating a Deployment Mapping for Deploying Apps
If you select a Web application, site collection, site or app as the source node and then select a
destination node to create a deployment mapping, in the Add to Queue window, you can select to
deploy the source apps to the destination by selecting the Include apps checkbox. For detailed
information on creating a deployment mapping, refer to Creating a Deployment Mapping.
How to Find the Apps Node
If you want to deploy an app to the destination, you must first select an app in the source and then
select a destination node to create a mapping. To find the apps node in the source:
1. Click on the farm tree to expand to the site collection level.
2. Expand the site collection to the top-level site or to the site where the deployed apps reside.
The apps node appears under the top-level site or the site level.
Helpful Notes for Deploying Apps

You can deploy the source app to a destination web application, site collection or site. If
there is an app whose product ID is same as the selected source one in the destination,
the source app can also be deployed to this destination app.

You can deploy the app along with its app data by completing the following:
o
Select the desired app node and the related App Data node on the farm
tree.
o
Deploy the app by selecting the desired app node and deselecting the
related app data node on the source farm tree; then select the destination
node to perform the deployment.
Deploying the App Catalog Site to Destination
Deployment Manager also supports deploying the source App Catalog Site to a destination. You must
select the App Catalog Site as the source, and refer to the following conditions when selecting a
different destination node level:

Select a Web application as the destination:
o
If there is an App Catalog Site type site collection under the selected web
application that has the same relative URL as the source App Catalog Site,
DocAve 6: Deployment Manager
41
and the destination site collection has the same template as the source App
Catalog site, the source App Catalog Site, along with its data, will be
deployed to the destination site collection.


42
o
If there is an App Catalog Site type site collection under the selected web
application that has the same relative URL as the source App Catalog Site,
and the destination site collection has a different template from the source
App Catalog site, the source App Catalog Site will be deployed to the
destination site collection, but the deployed App Catalog Site cannot be
used to add apps.
o
If there is no App Catalog Site type site collection under the selected web
application that has the same relative URL as the source App Catalog Site,
an App Catalog Site will be created, and the source App Catalog Site, along
with its data, will be deployed to the destination site.
Select a site collection as the destination:
o
If the site collection is an App Catalog Site and has the same template as the
source, the source App Catalog Site, along with its data, will be deployed to
the destination site collection.
o
If the site collection is an App Catalog Site but has a different template from
the source, the source App Catalog Site will be deployed to the destination
site collection, but the deployed App Catalog Site cannot be used to add
apps.
o
If the site collection is not an App Catalog Site, the source App Catalog Site
will be deployed to the destination site collection, but the deployed App
Catalog Site cannot be used to add apps.
Manually create a site collection as the destination:
o
If the newly created site collection has been set to be an App Catalog Site in
SharePoint and its template is the same as the source, the source App
Catalog Site, along with its data, will be deployed to the destination site
collection.
o
If the newly created site collection has been set to be an App Catalog Site in
SharePoint and its template is different from the source, the source App
Catalog Site will be deployed to the destination site collection, but the
deployed App Catalog Site cannot be used to add apps.
o
If the newly created site collection is not set to be an App Catalog Site in
SharePoint, the source App Catalog Site will deploy to the destination site
collection, but the deployed App Catalog Site cannot be used to add apps.
DocAve 6: Deployment Manager
Deploying One App to Multiple Site Collections or Sites in
Destination
An app is supported to deploy to multiple site collections or sites in destination. For more information
on Deployment Mapping, refer to Deployment Mapping Notes. Refer to the following notes for creating
a deployment mapping:

Deployments can only be mapped between a source and destination that are using the
same version of SharePoint.

If you manually create a site collection under a FBA Web application in the destination,
after clicking Add to Queue, a pop-up window will appear to let you select the
administrator of the site collection you are about to create.

If the source and destination have different templates, a warning message will appear to
warn you that the deployment may cause errors. Click OK to continue, or click Cancel to
return to the Source and Destination selection.

If you select list columns or list content types in the source, you can only select a list or
library in the destination.

If you select a workflow under a list content type in the source, the corresponding list
content type is automatically selected, and you can only select a list or library in the
destination.

Only the current version of the workflow created through SharePoint Designer is
displayed on the source farm tree. Select this workflow and select a destination node, all
of the workflow versions will be deployed to the destination.

All of the workflow versions generated because of the update of the reusable workflow
template (created through SharePoint Designer) are displayed on the source farm tree.
Select a workflow version and select a destination node, the selected workflow version
will be deployed to the destination.

Under the Shared Services node, expand the Managed Metadata Service node. The
Managed Metadata Services are displayed. The nodes Unpartitioned Mode and
Partitioned Mode are loaded under a service. If a Managed Metadata Service is not
partitioned, the data under the service is displayed under the Unpartitioned Mode
node. If a Managed Metadata Service is partitioned, the data is not displayed under
Partitioned Mode, the tenant administration sites and the related term stores are
displayed under the Partitioned Mod node. Right click a tenant administration site, a
drop-down list appears. Select View Site Collections, a window displaying all of the site
collections under the tenant administration site appears. Click a site collection, the site
collection is opened in the browser.
You can deploy a source node under Unpartitioned Mode to a destination node under
Unpartitioned Mode, deploy a source node under Unpartitioned Mode to a destination
node under Partitioned Mode, deploy a source node under Partitioned Mode to a
destination node under Unpartitioned Mode, or deploy a source node under
DocAve 6: Deployment Manager
43
Partitioned Mode to a destination node under Partitioned Mode. For detailed
information on the elements that can be deployed from the source to the destination,
refer to Appendix H – Managed Metadata Service Deployment.
Offline Deployment for Apps in a Web Application
An app is supported to perform an offline deployment. Refer to Offline Deployment for Objects in a Web
Application for details.
Configuring Queues Locally
The app queue is also supported to configure locally. Refer to Configuring Queues Locally for details.
44
DocAve 6: Deployment Manager
App Tools
App Tools allows you to check the upgrade status of an app and upgrade the app. When you select the
Web Application, Site Collection, Site and App level in the source, the App Tools tab appears.
Checking for App Updates
Refer to the following steps to check whether the apps need to be updated:
1. Select a Web application, site collection or site in which the apps will be checked. The App Tools
tab appears.
2. Click the App Tools tab. The Check Update button appears on the ribbon.
3. Click Check Update on the ribbon. A message appears. You can select the Include apps that do
not need to be updated in the job details checkbox to include the information of the apps that
do not need to be upgraded in the job report. Then, click OK.
*Note: You can also click Add to Queue on the middle lower interface to add the mapping to
queue. You can add multiple mappings to queue and then click Check Update.
4. A message appears on the top of the screen. Click the Job Monitor link in the message.
5. In Job Monitor, after the job finishes, you can select the job, and then click View Details on the
ribbon. The Details interface appears.
6. Select Queue in the interface.
7. Select the mapping you want to view details for and click View Details in the ribbon.
8. In the Job Details interface, click the Details tab. If the value in the Update Status column is
true, the app will need to be upgraded.
If you want to download the job details, select the Job Monitor tab, then select the job, and click
Download on the ribbon. Select Download Job Details from the drop-down list and then save the Job
Details file. In the Excel report, you can view the Report tab to view the app update information.
DocAve 6: Deployment Manager
45
Figure 6: App Update Details in the Excel Report.
Pushing App Updates
Refer to the following steps to update the apps:
1. Select a Web application, site collection, site or app. The App Tools tab appears.
2. Click the App Tools tab. The Push Update button appears on the ribbon.
3. Click Push Update. A window appears. Refer to the following steps:
a. Configure the following settings in the window:
o
Method – There are two radio buttons in this field:

Update the selected apps – This radio button is only enabled when you
select apps that can be updated. Select the radio button and then click
OK. The selected apps will be updated.

Upload update report – Select this radio button, then upload the report
file. The apps in the report file will be updated.
o
Upload File – Select Upload to upload a previously exported report Excel
file. Refer to Checking for App Updates for details on how to export an Excel
report. You can edit the Excel report to add or remove the apps that you do
not want to upgrade.
o
Plan Name – Enter a name for the plan. Optionally, enter a description for
the plan.
b. Click OK to run the job.
46
DocAve 6: Deployment Manager
Using Compare
The compare feature allows you to identify differences between the source and the destination object.
This feature supports: Web applications, Web front-end, farm solutions, and shared services.
By using the compare feature, once the differences are identified between the source and destination,
you can select objects from either the source or destination to be deployed to the other side that does
not have the same object.
Performing a Compare Job
To compare objects, complete the following steps:
1. In the Home tab of Deployment Manager, click Compare on the ribbon. You will be redirected to
the Compare interface.
2. Under the Tree tab, within the Source pane, click the farm name to expand its data tree, and
gain access to its SharePoint objects.
3. Within the Destination pane, click the farm name to expand its data tree and gain access to its
SharePoint objects.
4. Click Web Applications, Web Front End, or Shared Services to expand the data tree to the node
you want to compare. Farm Solutions can be directly selected for comparing.
5. After selecting the nodes that you want to compare, click Compare on the ribbon or on the left
corner of the screen. A drop-down list appears.
6. Select either Compare Now or Generate Comparison Report (this option is only enabled when
you select objects under the Web Applications node):
*Note: SharePoint Online objects do not support the Generate Comparison Report function, if
you select the SharePoint Online objects to compare, the option will be greyed out.

Compare Now – You are redirected to a screen under the Comparison tab. The nodes
you selected under the Tree tab are displayed in the source pane and destination pane.
Expanding the data tree in the Source pane will also expand the data tree in the
Destination pane.
If there is a difference between the Source and Destination nodes on a certain object
level, the objects will be highlighted in light orange, and a checkbox will appear in front
of the source node.
When comparing objects in the Web application level, and there are differences
between the Source and Destination nodes on the files/items level, Site Settings level,
List Settings level and Apps level, an ellipsis button ( ) will appear after the source
node. If you click the ellipsis button ( ), a pop-up window appears displaying the
different compared elements.
DocAve 6: Deployment Manager
47
i.
Check the checkbox in front of an object to create a deployment mapping. An
arrow will appear between the Source pane and the Destination pane after you
check the corresponding checkbox.

If an object exists in the source tree, but does not exist in the
destination, a right arrow ( ) appears. In this case, the source object
will deploy to the destination.

If an object exists in the destination tree, but does not exist in the
source, a left arrow ( ) appears. In this case, the destination object will
deploy to the source.

If the compared source and destination have the different objects, a
two-way arrow ( ) appears. You can choose to deploy objects from
the source to the destination or from the destination to the source by
changing the arrow direction.
ii. Click Add to Queue on the ribbon to add this mapping to the queue. The Add to
Queue window will appear. For information on how to configure queue settings,
see the Creating a Deployment Mapping section of this guide.
All of the mappings will be added to the queue in the Home page. To run the job
directly, click Run in the ribbon or in the lower right corner of the Home page.
Or you can save this queue as a plan.

Generate Comparison Report – A pop-up window appears to confirm that you to
generate the comparison report. The comparison report shows the differences between
the source and destination nodes. You can select whether to include the objects that are
same in the selected source and destination nodes in the comparison report by selecting
the checkbox in the pop-up window.
i.
Click OK in the pop-up window to generate the comparison report. You can go
to Job Monitor to view the job information.
ii. After the job finishes, select the checkbox before the job, click Download on the
ribbon, and then click Download Job Details from the drop-down list to
generate the comparison report.
*Note: To refresh an object, right click the object then click Refresh to refresh the
object and expand it.
*Note: For sites, you can right click and select Copy URL to copy the URL of this node, or
click Open in browser to open it in the browser directly.
*Note: The selected objects in the source and destination must be using the same version of SharePoint
in order to enable the Compare button.
48
DocAve 6: Deployment Manager
Comparing in Different Tree Levels
Deployment Manager allows you to compare Web applications, Web-front end, farm solutions, and
shared services. The following sections illustrate the comparing rules and conditions of the objects in
each level.
Rules for Comparing Objects in a Web Application
Refer to the following rules when you compare the objects in a Web application:

Objects in the Web application support the comparison between:
o
The source site collection and the destination site collection
o
The source site and the destination site

You can directly select the user solution gallery node under the Tree tab in the Compare
page, and then click Compare on the ribbon to compare the user solutions under the
Comparison tab. Alternatively, you can select the user solution’s corresponding site or
site collection and click Compare on the ribbon to compare the user solutions under the
Comparison tab.

Site collections with the same URL cannot be compared.

Sites with the same URL cannot be compared.

If the workflow, item, file, content type, and column in the source are the same as
those in the destination, they cannot be loaded in the compare tree.

Specific rules for site content types:

o
The source and destination site content types are compared by their
content type IDs. If the IDs are the same, the site content types will be
compared by their settings.
o
The source and destination site content types with the different content
type IDs will be highlighted in the compare tree. You can add them to the
queue by selecting the corresponding checkbox.
o
If the source and destination content types have the same content type ID,
but their settings are different, the content type will be highlighted in the
compare tree. You can add to the queue by selecting the corresponding
checkbox.
o
If the source and destination settings of the content types are the same and
they have the same content type IDs, they will not be displayed in the
compare tree.
Specific rules for site settings: If there are some differences between the source and
destination site settings, the site settings will be highlighted in the compared tree. You
can add to queue by selecting the corresponding checkbox. Click the details button ( )
to view the detailed elements of the source and destination site settings.
DocAve 6: Deployment Manager
49


Specific rules for apps:
o
The source and destination apps are compared by their product IDs. If the
product IDs of the source app and the destination app are different, apps
will be highlighted in the compare tree. You can add to queue by selecting
the corresponding checkbox.
o
If the product IDs are the same, the apps will be compared by their versions;
if their versions are different, the apps will be highlighted in the compared
tree. You can add to queue by selecting the corresponding checkbox.
o
If there are some differences between the source and destination apps, the
apps will be highlighted in the compared tree. You can add to the queue by
selecting the corresponding checkbox. Click the details button ( ) to view
a detailed version information of the apps.
Specific rules for list settings:
o

If there are some differences between the source and destination list
settings, the list settings will be highlighted in the compared tree. You can
add to queue by selecting the corresponding checkbox. Click the details
button ( ) to view the detailed elements of the source and destination list
settings.
Specific rules for items:
o
The source and destination items are compared by their item IDs. If the item
IDs of the source item and the destination item are different, items will be
highlighted in the compare tree. You can add to queue by selecting the
corresponding checkbox.
o
If the item IDs are the same, the items will be compared by their last
modifiers, last modified time, version count and their latest versions. If their
last modifiers, last modified time, version count or their latest versions are
different, the items will be highlighted in the compared tree. You can add to
your queue by selecting the corresponding checkbox. Click the details
button ( ) to view the detailed differences of the source and destination
items.
o
If the items have the same IDs, and their last modifiers, last modified time,
version count and latest versions are the same, then they will be compared
by their versions. If their versions are different, they will be highlighted in
the compared tree. You can add to your queue by selecting the
corresponding checkbox. The pop-up bubble appears after clicking the
details button ( ), the following message appears: There are differences
between the source and destination versions of this file/item. To view the
differences, open the file/item in SharePoint.
For example, if the source and destination items’ ID, last modifiers, last modified
time, version count, and latest versions are the same, but the item versions in
the source are 1.0, 2.0, 4.0, then the item versions in the destination are 1.0,
50
DocAve 6: Deployment Manager
3.0, 4.0, then the items are different and they will be highlighted in the
compared tree.

Specific rules for files:
o
The source and destination files are compared by their names (including the
extension). If the source file name and the destination file name are
different, the files will be highlighted in the compare tree. You can add to
the queue by selecting the corresponding checkbox.
o
If the file names are the same, the files will be compared by their last
modifiers, last modified time, version count, and their latest versions. If
their last modifiers, last modified time, version count, or their latest
versions are different, the files will be highlighted in the compare tree. You
can add to your queue by selecting the corresponding checkbox. Click the
details button ( ) to view the detailed differences of the source and
destination files.
o
If the source and destination files have the same names, and their last
modifiers, last modified time, version count, and latest versions are the
same, then they will be compared by their versions. If their versions are
different, they will be highlighted in the compare tree. You can add to your
queue by selecting the corresponding checkbox. The pop-up message
appears after clicking the details button ( ), and the following message
is displayed: There are differences between the source and destination
versions of this file/item. To view the differences, open the file/item in
SharePoint.
For example, if the source and destination files’ name, last modifiers, last
modified time, version count, and latest versions are the same, but the file
versions in the source are 1.0, 1.1, 1.2, 1.3, and 2.0 and the file versions in the
destination are 1.0, 1.2, 1.3, 1.4, and 2.0, then the files are different and they
will be highlighted in the compared tree.
Supported Objects and Comparing Conditions for SharePoint On-Premises
The followings are the objects that are supported to be compared and their comparing conditions:
Supported Objects
Site settings
Look and Feel
Site Administration
DocAve 6: Deployment Manager
Elements Compared
Title, description, and icon (in SharePoint 2010)
Title, description, and logo (in SharePoint 2013)
Welcome page
Navigation
Tree view
Site theme (in SharePoint 2010)
Look (in SharePoint 2013)
Page layouts and site templates
Image Renditions (in SharePoint 2013)
Regional settings
51
Supported Objects
Site Collection
Administration
Site Actions
Reporting Services
Search
Sites
Apps
Site Workflow
Lists/libraries
List Workflow
Site content types
Site content type
workflow
Site columns
Elements Compared
RSS
Search and offline availability
Site Closure and Deletion (in SharePoint 2013)
Site Policies (in SharePoint 2013)
Features
Event Handlers
Reporting Services Site Settings
Search and offline availability (in SharePoint
2013)
Search Settings
URL
Product ID
Version
Name
Title
Name
ID
Content type settings
Name
ID
Column Properties
List settings
Title, description and navigation (in SharePoint 2010)
List name, description and navigation (in SharePoint 2013)
Versioning settings
Advanced settings
Rating settings
Audience targeting settings
Enterprise Metadata and Keywords Settings
Columns setting
Content type Setting
Event Handlers
Workflow Settings
Validation settings
RSS settings
List Properties
Information management policy settings
List column
ID
List content type
Parent site content type ID + list content type name
List content type Name
workflow
Folder
Name
Items
ID
Last Modifier
52
DocAve 6: Deployment Manager
Supported Objects
Elements Compared
Last Modified Time
Latest Version
Version Count
Versions
Name + file extension
Last Modifier
Last Modified Time
Latest Version
Version Count
Versions
Solution name + extension, solution status
Files
User solutions
Supported Objects and Comparing Conditions for SharePoint Online
Supported Objects
SharePoint Designer Objects (Site level)
Lists
Folder
File
Item
SharePoint Designer Objects (List Level)
Elements Compared
Folder Name
Name
Name
Name
TpGuid, Last Modifier, Version, Version Count,
Last Modified Time
Folder Name
Design Lists
Name
Rules for Comparing Web-Front End
Refer to the following rules when you compare the Web-front end level:


The Web-front end level supports the comparison between:
o
The source Web-front end and the destination Web-front end
o
The source IIS site files and the destination IIS Site files
o
The source IIS site and the destination IIS site
o
The source global assembly cache and the destination global assembly
cache
o
The source custom features and the destination custom features
o
The source SharePoint site definitions and the destination SharePoint site
definitions
o
The source file system and the destination file system
Specific rules for IIS site files:
o
The IIS sites will be highlighted in the compare tree if their IDs or names are
different. You cannot add to queue.
DocAve 6: Deployment Manager
53
o
If the source and destination IIS sites have the same ID or name, they will
not be highlighted. You can continue to load the files or folders by clicking
the IIS sites, these folders and files are compared by their names.

The source and destination folders or files will be highlighted if their
names are different, you can add to queue after selecting the
corresponding checkbox.

If the source and destination files under the IIS sites have the same
name, they will not be displayed in the compare tree.

If the source and destination folders under the IIS sites have the same
name, they are not highlighted. You can click the folders to expand to
the file level, but if the source and destination files under these folders
have the same name, they will not be displayed in the compare tree.
*Note: Web.config files are not supported to compare.




54
Specific rules for global assembly cache:
o
The source and destination global assembly cache files with the same names
will not be displayed in the tree.
o
The source and destination global assembly cache files with the different
names will be highlighted in the compare tree. You can add to your queue
by selecting the corresponding checkbox.
Specific rules for custom features:
o
The source and destination custom features with the same feature ID will
not be displayed in the compare tree.
o
The source and destination custom features with the different feature IDs
will be highlighted in the compare tree, you can add to your queue by
selecting the corresponding checkbox.
Specific rules for site definitions:
o
The source and destination site definitions with the same site template
names or configuration IDs will not be displayed in the compare tree.
o
The source and destination site definitions with the same site templates but
different configuration IDs will be highlighted in the compare tree. You can
add to your queue by selecting the corresponding checkbox.
o
The source and destination site definitions with the same configuration IDs
but different site templates will be highlighted. You can add to your queue
by selecting the corresponding checkbox.
o
The source and destination site definitions with the different site templates
and configuration IDs will be highlighted. You can add to your queue by
selecting the corresponding checkbox.
Specific rules for file system:
DocAve 6: Deployment Manager
o
The source and destination file system files or folders with the same names
and same modified time will not be displayed in the compare tree.
o
The source and destination file system files or folders with the different
names are highlighted in the compare tree. You can add to the queue by
selecting the corresponding checkbox.
o
The source and destination file system files or folders with the same names
but different modified time will be highlighted in the compare tree. You can
add to your queue by selecting the corresponding checkbox.
Supported Objects and Comparing Conditions
The followings are the objects that are supported to compare and their comparing conditions:
Supported Objects
IIS site files
IIS sites
Global assembly cache
Custom features
Site definitions
File System
Files
Folders
Comparing Conditions
In the Same Farm
Across Farms
ID
Name
Do not compare the IIS sites, only compare the
folders or files under the IIS sites, you can refer to
rules for IIS site files section for more
information.
Name
Name
Feature ID
Feature ID
Site template name
Site template name
Configuration ID
Configuration ID
Name, Last Modified
Name, Last Modified
Time
Time
Name, Last Modified
Name, Last Modified
Time
Time
Rules for Comparing Farm Solution
Refer to the following rules for comparing farm solutions:

The source and destination farm solutions with the same solution IDs will not be
displayed in the compare tree.

The source and destination farm solutions with the different solution IDs will be
highlighted in the compare tree. You can add to your queue by selecting the
corresponding checkbox.
DocAve 6: Deployment Manager
55
Supported Objects and Comparing Conditions
The followings are the objects that are supported to compare and their comparing conditions:
Supported Objects
Farm solutions
Solution ID
Comparing Conditions
Solution ID
Rules for Comparing Shared Services
Refer to the following rules for comparing shared services objects:



56
Specific rules for content type hub:
o
The source and destination content type hubs are compared by their
content type IDs. If their content type IDs are the same, the content type
hubs will be compared by their settings.
o
The source and destination content type hubs with different content type
IDs will be highlighted in the compare tree. You can add to queue by
selecting the corresponding checkbox.
o
If the source and destination content type hubs have the same content type
ID, but their settings are different, the content type hubs will be highlighted
in the compare tree. You can add to queue by selecting the corresponding
checkbox.
o
If the source and destination settings of the content type hubs are the same
and they have the same content type IDs, they will not be displayed in the
compare tree.
Specific rules for term group:
o
The source and destination term groups are compared by their names, if
their names are the same, then the term groups will be compared by their
settings.
o
The source and destination term groups with the different names will be
highlighted in the compare tree. You can add to queue by selecting the
corresponding checkbox.
o
If the source and destination term groups have the same name, but their
settings are different, the term groups will be highlighted in the compare
tree. You can add to queue by selecting the corresponding checkbox.
o
If the source and destination term groups have the same name and settings,
but the term sets in the term groups are different, the term groups will not
be highlighted. You can add the term sets under the term groups to queue
by selecting the corresponding checkbox.
Specific rules for term set:
DocAve 6: Deployment Manager

o
The source and destination term sets are compared by their names, if their
names are the same, then the term groups will be compared by their
settings.
o
The source and destination term sets with the different names will be
highlighted in the tree. You can add to queue by selecting the corresponding
checkbox.
o
If the source and destination term sets have the same settings and names,
and the terms under them are the same, the term sets will not be displayed
in the tree.
o
If the source and destination term sets have the same name but different
settings, they will be highlighted in the tree. You can add to queue by
selecting the corresponding checkbox.
o
If the source and destination term sets have the same name and settings,
but the terms in the term groups are different, the term groups will be not
be highlighted. You can add the term sets under the term groups to queue
by selecting the corresponding checkbox.
Specific rules for term:
o
The source and destination terms are compared by their names, if their
names are same, then the term groups will be compared by their settings.
o
The source and destination terms with different names will be highlighted in
the tree. You can add to queue by selecting the corresponding checkbox.
o
If the source and destination terms have the same name, but their settings
are different, the terms will not be highlighted in the tree. But there is no
checkbox in front of the term, you can only add to queue by selecting the
corresponding checkbox before the term set.
o
If the source and destination terms have the same name and settings, but
the deep-level terms are different, the current level terms will not be
highlighted. You can click the term to expand to the deep-level terms, the
deep-level terms will be highlighted. There is no checkbox in front of the
term, you can only add to queue by selecting the corresponding checkbox
before the term set.
DocAve 6: Deployment Manager
57
Supported Objects and Comparing Conditions
The following table includes the supported objects to compare and their comparing conditions:
Supported Objects
Content type hub
Term group
Term set
Term
58
Comparing Conditions
Content type ID
Settings
Name
Settings
Name
Settings
Name
Settings
DocAve 6: Deployment Manager
Using Custom Compare
Deployment Manager provides you with a way to customize your compare condition. The detailed
information of your desired compare objects will be listed in the comparison report.
For more information, refer
to …\AvePoint\DocAve6\Agent\Documents\SDK\DeploymentManager\AgentCommonCustomCompareA
PI.chm.
DocAve 6: Deployment Manager
59
Advanced Settings
For advanced users, Deployment Manager offers these additional settings that can be configured and
saved to run as part of more complex plans:

Domain Mapping is used to replace a source domain name with a domain name in the
destination. The user in the source group will be mapped to the destination user which
has the same name.

User Mapping is beneficial for migrating groups of users from one domain to another
and for migrating an individual user’s content and permissions to another user.

Language Mapping allows you to set a different language for the destination than the
language used in the source. By creating a rule for Language Mapping, you can apply
these rules without having to recreate them each time.

Export Location allows you to configure locations on external system storage that you
want Deployment Manager to export data. By configuring external system storage, you
can also export design elements to the file system. This is useful in cases where two
farms are unable to communicate with each other. You can use export locations to
perform offline deployments whereby you deploy from an external device.

Storage Policy allows you to select a logical device to use when storing solutions, or
when performing imports and exports for offline deployment.

Filter Policy allows you to set up filter rules so you can control what objects and data
within any SharePoint level appear so that you can target content to migrate more
precisely. By setting up and saving filter policies, you can apply the same filter policies to
different plans without having to recreate them each time.
While these settings can be accessed in Deployment Manager, they are configured in the Control Panel.
For more detailed information about these settings, see the DocAve 6 Control Panel Reference Guide.
60
DocAve 6: Deployment Manager
Using SharePoint Management Shell
Deployment Manager provides you with SharePoint Management Shell to directly perform the
SharePoint Management Shell Commands. Refer to the following steps to use SharePoint Management
Shell:
1. In the Home tab of Deployment Manager, click SharePoint Management Shell on the ribbon.
The SharePoint Management Shell interface appears.
2. Select a farm in the Farm Selection drop-down menu, the corresponding agents will be loaded.
3. Select an agent that is responsible for running the SharePoint Management Shell in the Agent
Selection drop-down menu.
4. Enter the SharePoint Management Shell command.
5. You can add the command to queue by clicking Add to Queue below the command or on the
ribbon, and then the SharePoint Management Shell interface will exit.
6. Repeat steps 1 through 5 to add more mappings to the queue.
7. Once you have finished adding mappings to the queue, click Save as a Plan to save this queue as
a plan and follow the instructions in Creating a Deployment Plan. To execute the queue
immediately, click Run located at the bottom of the screen.
DocAve 6: Deployment Manager
61
Appendix A – Conflict Resolution – Web Application Deployment
Check Lower Objects
 Check lower objects
unchecked


62
Skip
If there is no conflict
between source and
destination, a new
SharePoint object will be
created on destination.
If there is a conflict
between source and
destination, it will ignore
the conflicting data and
do nothing on source and
destination.
Merge
N/A

Replace
If there is no conflict, a new
SharePoint object will be
created on destination.

If there is a conflict for design
list, content type or content
column, it will update
destination data based on
source one.

If there is a conflict on source
and destination other than
design list, content type or
content column, it will update
destination data based on
source one. SharePoint object
will be created on destination.
DocAve 6: Deployment Manager
Check Lower Objects
 Check lower objects
checked


Content level: Skip
Skip
If there is no conflict on
the container level, a new
container will be created
on destination.

Merge
N/A
If there is no conflict on
the container level, a new
container will be created
on destination.

If there is no conflict on
the content level, new
content will be created
on destination.

If there is no conflict on
the content level, new
content will be created
on destination.

If there is a conflict on
the container, it will
ignore the conflict and do
nothing with the
container on source and
destination.

If there is a conflict on
the container level, it will
update destination
container based on
source one.

If there is a conflict on
the content level, it will
ignore the conflict and do
nothing with the content
on source and
destination.

DocAve 6: Deployment Manager
If there is a conflict on
the content level, it will
ignore the conflict and do
nothing with the content
on source and
destination.
Replace
63
Check Lower Objects
 Check lower objects
checked

Content level: Overwrite

Check lower objects
checked

Overwrite by last
modified time
64

Skip
If there is no conflict on
the container level, a new
container will be created
on destination.

Merge
N/A
If there is no conflict on
the container level, a new
container will be created
on destination.

If there is no conflict on
the content level, new
content will be created
on destination.

If there is no conflict on
the content level, new
content will be created
on destination.

If there is a conflict on
the container level, it will
ignore the conflict and do
nothing with the
container on source and
destination.

If there is a conflict on
the container level, it will
update destination
container based on
source one.

If there is a conflict on
the content level, it will
update the content on
destination based on the
source data.

If there is a conflict for
content level, it will
update the conflict on
destination based on the
source data.

If there is no conflict on
the container level, a new
container will be created
on destination.

N/A
If there is no conflict on
the container level, a new
container will be created
on destination.

If there is no conflict on
the content level, new
content will be created
on destination.

If there is no conflict on
the content level, new
content will be created
on destination.

If there is a conflict on
the container level, it will
ignore the conflict and do

If there is a conflict on
the container level, it will
update the destination
Replace
DocAve 6: Deployment Manager
Check Lower Objects
Skip
nothing with the
container on source and
destination.


DocAve 6: Deployment Manager
If there is a conflict on
the content level, and the
modified time of source
content is later than the
destination one, it will
update the conflicting
content on destination
based on the source data.
If there is conflict on the
content level, and the
modified time of source
content is earlier than the
destination, it will ignore
the conflict and do
nothing with the content
on source and
destination.
Merge
container based on
source one.

If there is a conflict on
the content level, and the
modified time of source
content is later than the
destination one, it will
update the content on
destination based on the
source data.

If there is a conflict on
the content level, and the
modified time of source
content is earlier than the
destination, it will ignore
the conflict and do
nothing with the content
on source and
destination.
Replace
65
Appendix B – Conflict Checks
Objects
Site Collection
Site
List
Folder
Document
Item
Content type
Column
Apps
Workflow
66
Conflict Resolution Checking Rules
Checking Rules
URL
URL
List Title
Folder Name
Name
TP_IP
Find and compare By Schema, id, name or parent
Find and compare By Schema, id, InternalName, StaticName
or DisplayName
Product ID
Workflow Name
DocAve 6: Deployment Manager
Appendix C – Supported and Unsupported Elements for
Web Application Deployment
Source Content
Web application
Site collection
Site
Site settings
SharePoint designer objects
Announcements
Calendar
MicroFeed
AppData
Content and structure reports
Customized reports
Composed looks
Links
Reusable content
Shared documents
Site collection help
Tasks
Team discussion
Cache profiles
Content type publishing error log
Converted forms
Form templates
List template gallery
Long running operation status
Master page gallery
Notification list
Quick deploy Items
Relationships list
Reporting metadata
Reporting templates
Shared packages
Site assets
Site collection documents
Site collection images
Site pages
Project policy item list
Solution gallery
Style library
Suggested content browser locations
Taxonomy hidden list
Theme gallery
DocAve 6: Deployment Manager
Status
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Unsupported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
67
Source Content
User information list
Variation labels
Web part gallery
wfpub
Workflow tasks
Content types
Site columns
User solution gallery
InfoPath templates
68
Status
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
Supported
DocAve 6: Deployment Manager
Appendix D – Supported and Unsupported Workflow
Type
SharePoint Version
Workflow Type
SharePoint Built-in Workflow
SharePoint Designer Workflow
Nintex Workflow
Visual Studio Workflow
Visio Workflow
Azure Workflow
DocAve 6: Deployment Manager
SharePoint 2010
SharePoint 2013
SharePoint Online
Supported
Supported
Supported
Supported
Unsupported
Unsupported
Supported
Supported
Supported
Unsupported
Unsupported
Unsupported
Supported
Supported
Unsupported
Unsupported
Unsupported
Supported
69
Appendix E – Design Elements Deployment
Source Element Destination Element Handle
Web application Web application
For Web application level: do nothing.
For the sub levels under Web application: deploy the site
collection to the destination, refer to Site Collection to
Site Collection for details.
Site collection
Site collection
For site collection level: deploy the settings, features,
users, groups, permissions and related data of services
(metadata service) of site collection to the destination.
For the sub levels under site collection: deploy the root
site to the destination, refer to Site to Site for details.
Site collection
Web application
The same as Site Collection to Site Collection.
Site
Site
For site level: deploy features, content types, columns, site
settings, navigation and securities to the destination.
For the sub levels under site: deploy the following objects
to destination.
1. List.
2. SharePoint designer objects.
3. Design list.
4. Site.
5. Site settings.
70
DocAve 6: Deployment Manager
Appendix F – Web Front-End Deployment
Source Element
IIS site
Destination Element
IIS site files
GAC
Custom feature
GAC
Custom features
Site definition
Site definitions
File System
File System
DocAve 6: Deployment Manager
Handle
Deploy all the files (excluding web.config) under IIS virtual
directory of relevant IIS site, FBA node in the web.config
file under the virtual directory, and the FBA node in the
web.config file under Security Token.
Deploy all the GAC files.
Deploy related folders under C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\FEATURES (In SharePoint 2013,
the related folders are under C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\FEATURES), and referred files
for custom features and dll files in GAC to the destination.
Deploy related folders under C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\SiteTemplates (In SharePoint
2013, the related folders are under C:\Program
Files\Common Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\SiteTemplates), referred files of
site definition, and features to the destination.
Deploy the source file system files or folders to the
destination file system.
71
Appendix G – Solution Deployment
Source Element
Farm solution
Farm solution
Farm solution
User solution
User solution
User solution
User solution
Storage policy
Destination Element
Farm
Web application
Storage policy
Farm
Web application
Site collection
Storage policy
Farm
Storage policy
Web application
Storage policy
Site collection
File system
File system
Farm solution
Farm
Web application
N/A
Farm solution
N/A
User solution
N/A
User solution
N/A
User solution
N/A
72
Handle
Deploy a solution to a farm.
Deploy a solution to a Web application.
Export a solution to the storage policy.
Deploy a user solution to a farm.
Deploy a user solution to a Web application.
Deploy a user solution to a site collection.
Export a user solution to the storage policy.
Import a solution from the storage policy and deploy it
to a farm.
Import a solution from the storage policy and deploy it
to a Web application.
Import a solution from the storage policy and deploy it
to a site collection.
Deploy a solution to a farm.
Deploy a solution to a Web application.
Retract the solution on the source under the Solution
Tools tab separately.
Remove the solution on the source under the Solution
Tools tab separately.
Activate the solution on the source under the Solution
Tools tab separately.
Deactivate the solution on the source under the
Solution Tools tab separately.
Upgrade the solution on the source under the Solution
Tools tab separately.
DocAve 6: Deployment Manager
Appendix H – Managed Metadata Service Deployment
Global term group
Destination
Element
Global term group
Term group
Global term group
Term group
Term group
Term set
Term group
Term set
Term set
Content type hub
Content type hub
Content type
Content type hub
Source Element
DocAve 6: Deployment Manager
Handle
Deploy all the term groups under global term group to
the destination, refer to Term Group to Term Group for
details.
Deploy the term group to the destination, refer to Term
Group to Term Group for details.
Deploy the description of term group, configurations of
group managers and contributors, and all the term sets
under it to the destination. For how to deploy the term
set, refer to Term Set to Term Set.
Deploy the term set to the destination, refer to Term Set
to Term Set for details.
Deploy the term set properties (including Description,
Owner, Contract, Stakeholders, Submission Policy and
configurations of Available for Tagging to destination),
terms under the term set and term properties (including
Available for Tagging, Description, Deprecate and other
labels), and sub terms together with their properties to
the destination.
Deploy all the content types under content type hub to
the destination, refer to Content Type to Content Type
Hub for details.
Deploy the field links and settings of the content type to
the destination.
73
Appendix I – Deployment Manager Customization Table
The following is the customization table of Deployment Manager.
Deploy From/To/
What to deploy
Web application
Web application
Web application
Site collection
Site collection
Web application
Site collection
Site collection
Site collection
74
Source
Destination
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
Top-level site
Top-level site
Web application
Top-level site
Top-level site
Site collection
Top-level site
Top-level site
Top-level site
Site settings
Site settings
Top-level site
DocAve 6: Deployment Manager
Source
Destination
Screenshot
75
Deploy From/To/
What to deploy
Site settings
Site settings
Site
SharePoint designer objects
SharePoint designer objects
SharePoint designer objects
SharePoint designer objects
SharePoint designer objects
Design folder
Apps
App
Web Application
Apps
App
Site Collection
76
Source
Destination
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
Source
Destination
Apps
App
Top-level Site
Apps
App
Site
Apps
App
App (the app node can be deployed
to the app node when you select the
same app in the source and
destination, but the source and
destination sites where the app
resides are different.)
DocAve 6: Deployment Manager
Screenshot
77
Deploy From/To/
What to deploy
Design folder
Design folder
SharePoint designer objects
Design item
Design item
SharePoint designer objects
Design item
Design item
Design folder
List/library
List/library
Web application
78
Source
Destination
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
List/library
List/library
Site collection
List/library
List/library
Top-level site
List/library
List/library
List/library
List/library
List/library
Site
DocAve 6: Deployment Manager
Source
Destination
Screenshot
79
Deploy From/To/
What to deploy
List settings
List settings
List
Root folder
Root folder
Library
Folder
Folder
Folder
Item
Item
Folder
80
Source
Destination
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
Source
Destination
Workflow under lists
Workflow
List/Library
Workflow under list content type
Workflow
List/Library
DocAve 6: Deployment Manager
Screenshot
81
Deploy From/To/
What to deploy
Source
Destination
Site
Site
Web application
Site
Site
Site collection
Site
Site
Top-level site
Site
Site
Site
82
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
Source
Destination
Workflow under site
Workflow
Top-level site
Workflow under site
Workflow
Site
Design list
Design list
Web application
DocAve 6: Deployment Manager
Screenshot
83
Deploy From/To/
What to deploy
Design list
Design list
Site collection
Design list
Design list
Top-level site
Design list
Design list
Site
Design list
Design list
Design list
84
Source
Destination
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
Content type group
Content type group
Web application
Content type group
Content type group
Site collection
Content type group
Content type group
Top-level site
Content type group
Content type group
Site
DocAve 6: Deployment Manager
Source
Destination
Screenshot
85
Deploy From/To/
What to deploy
Source
Destination
Workflow under site content type
Workflow
Web application
Workflow under site content type
Workflow
Site collection
86
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
Source
Destination
Workflow under site content type
Workflow
Top-level site
Workflow under site content type
Workflow
Site
DocAve 6: Deployment Manager
Screenshot
87
Deploy From/To/
What to deploy
Site column
Site column
Web application
Site column
Site column
Site collection
Site column
Site column
Top-level site
Site column
Site column
Site
88
Source
Destination
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
Source
Destination
Workflow under top-level site
Workflow
Top-level site
Workflow under top-level site
Workflow
Site
User solution
User solution
Farm
DocAve 6: Deployment Manager
Screenshot
89
Deploy From/To/
What to deploy
User solution
User solution
Web application
User solution
User solution
Site collection
SharePoint Web applications
SharePoint Web applications
IIS site files
SharePoint websites
SharePoint websites
IIS site files
90
Source
Destination
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
SharePoint website
SharePoint website
SharePoint website
GAC files
GAC files
Global assembly cache
Custom features
Custom features
Custom features
DocAve 6: Deployment Manager
Source
Destination
Screenshot
91
Deploy From/To/
What to deploy
SharePoint site definitions
SharePoint site definitions
SharePoint site definitions
File System
File
Folder
File System
Folder
Folder
92
Source
Destination
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
Source
Destination
File System
File/Folder
Disk
Farm solution
Farm solution
Farm
Farm solution
Farm solution
Web application
DocAve 6: Deployment Manager
Screenshot
93
Deploy From/To/
What to deploy
Source
Destination
Global term group
Global term group
Global term group
Term group
Term group
Global term group
94
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
Source
Destination
Term group
Term group
Term group
Term set
Term set
Term group
DocAve 6: Deployment Manager
Screenshot
95
Deploy From/To/
What to deploy
Source
Destination
Term set
Term set
Term set
Content type hub
Content type hub
Content type hub
Content type
Content type
Content type hub
96
Screenshot
DocAve 6: Deployment Manager
Deploy From/To/
What to deploy
Source
Destination
SharePoint Online object
SharePoint Online object
SharePoint Online object
SharePoint 2013 object
SharePoint 2013 object
SharePoint Online object
DocAve 6: Deployment Manager
Screenshot
97
Appendix J – Advanced Settings in Configuration Files
AgentCommonWrapperConfig.config
Configure the AgentCommonWrapperConfig.config file to specify whether to restore custom properties
in SharePoint property bag.
Go to the machines with DocAve Agent installed and open the … \AvePoint\DocAve6\Agent\bin
directory to find the AgentCommonWrapperConfig.config file.
Restoring Specified Web Properties
Open the AgentCommonWrapperConfig.config file and find the WrapperCommon node. Within this
node, find the <RestoredAllWebProperties>False</RestoredAllWebProperties> node and the
<SpecialWebPropertyNames></SpecialWebPropertyNames> node. These two nodes are added to the
configuration file automatically when you first run a Deployment Manager job.
98

If you do not want to restore custom properties in property bag, use the default False
value. When using the False value, you can also add the specific custom properties in
the SpecialWebPropertyNames node, and the custom properties you specified will be
restored. Use the semicolon sign to separate the custom properties, for example,
<SpecialWebPropertyNames>property1; property 2;
property3</SpecialWebPropertyNames>. Note that the build-in properties in property
bag are all restored.

If you want to restore all properties including the custom and build-in properties,
change False to True. When using the True value, you can add the specific properties in
the SpecialWebPropertyNames node, and the properties you specified will not be
restored.
DocAve 6: Deployment Manager
Appendix K – Accessing Deployment Manager Using Hot
Keys
In order to work faster and improve your productivity, DocAve supports hot key mode for you to
perform corresponding actions quickly by only using keyboard. To access hot key mode from the
Deployment Manager interface, press the Ctrl + Alt + Z key combination on your keyboard.
The following table provides a list of hot keys at the top level. Using the hot key listed below to access to
the corresponding product interface. For example, continue pressing H to jump to the Home tab.
Operation Interface
Hot Key
Home
Plan Manager
DocAve Home Page
DocAve Online Community
Control Panel
Job Monitor
Plan Group
Health Analyzer
H
P
1
2
3
4
5
6
Home Page
To access the Home page using hot keys in the Deployment Manager interface, press the Ctrl + Alt + Z
key combination to access hot key mode, and then press H on the keyboard to enter the Home page.
The following table provides a list of hot keys for functionalities on the ribbon of the Home page. For
example, continue pressing Y to jump to the Online Deploy interface.
Online Deploy
Data Export
Data Import
New Plan
Add to Queue
Compare
Create Container
DocAve 6: Deployment Manager
Functionality Name and Hot Key
Y
O
I
NP
Q
OK
Cancel
P
Compare
CC
Add to Queue
Close
OK
Cancel
O
C
P
Compare
N
Now
Generate
R
Comparison
Report
Q
X
O
C
99
Upload Queues
Download Queues
SharePoint Management Shell
File System Configuration
Functionality Name and Hot Key
UQ
DQ
SS
FS
Configure
C
Close
Export Location
Storage Policy
Filter Policy
M
Mappings
Job Monitor
Save as a Plan
Domain Mapping
User Mapping
Language Mapping
A
Test Run
Run
OK
Close
O
C
X
E
SP
FP
DM
UM
L
J
Save
Save and Run Now
Save and Test Run
Cancel
T
R
Q
P
T
C
Plan Manager
The following table provides a list of hot keys for functionalities on the Plan Manager page.
Edit
Delete
Test Run
Run Now
Functionality Name and Hot Key
E
D
T
R
App Tools
The following table provides a list of hot keys for functionalities on the App Tools page.
Check for Updates
Push Update
Functionality Name and Hot Key
C
P
OK
Cancel
O
C
Solution Tools for Farm Solutions
The following table provides a list of hot keys for functionalities on the Solution Tools for Farm Solutions
page.
100
DocAve 6: Deployment Manager
Details
Functionality Name and Hot Key
Remove
RM
D
Retract
R
Remove
M
Close
Retract
X
RT
Close
OK
Cancel
X
O
C
OK
Cancel
O
C
User Solution Tools for User Solutions
The following table provides a list of hot keys for functionalities on the Solution Tools for User Solutions
page.
Functionality Name and Hot Key
A
D
U
Activate
Deactivate
Upgrade
Queue Tools
The following table provides a list of hot keys for functionalities on the Queue Tools page.
Edit
E
Delete
Disable
Enable
Create Container
Add New Mappings
Edit Plan Settings
Save Mapping
Cancel
DocAve 6: Deployment Manager
Functionality Name and Hot Key
Edit Mapping Settings
Edit Mapping Source and
Destination
D
I
B
CC
M
EP
S
X
P
Q
101
Notices and Copyright Information
Notice
The materials contained in this publication are owned or provided by AvePoint, Inc. and are the property
of AvePoint or its licensors, and are protected by copyright, trademark and other intellectual property
laws. No trademark or copyright notice in this publication may be removed or altered in any way.
Copyright
Copyright © 2012-2015 AvePoint, Inc. All rights reserved. All materials contained in this publication are
protected by United States and international copyright laws and no part of this publication may be
reproduced, modified, displayed, stored in a retrieval system, or transmitted in any form or by any
means, electronic, mechanical, photocopying, recording or otherwise, without the prior written consent
of AvePoint, 3 Second Street, Jersey City, NJ 07311, USA or, in the case of materials in this publication
owned by third parties, without such third party’s consent. Notwithstanding the foregoing, to the extent
any AvePoint material in this publication is reproduced or modified in any way (including derivative
works and transformative works), by you or on your behalf, then such reproduced or modified materials
shall be automatically assigned to AvePoint without any further act and you agree on behalf of yourself
and your successors, assigns, heirs, beneficiaries, and executors, to promptly do all things and sign all
documents to confirm the transfer of such reproduced or modified materials to AvePoint.
Trademarks
AvePoint®, DocAve®, the AvePoint logo, and the AvePoint Pyramid logo are registered trademarks of
AvePoint, Inc. with the United States Patent and Trademark Office. These registered trademarks, along
with all other trademarks of AvePoint used in this publication are the exclusive property of AvePoint and
may not be used without prior written consent.
Microsoft, MS-DOS, Internet Explorer, Office, Office 365, SharePoint, Windows PowerShell, SQL Server,
Outlook, Windows Server, Active Directory, and Dynamics CRM 2013 are either registered trademarks or
trademarks of Microsoft Corporation in the United States and/or other countries.
Adobe Acrobat and Acrobat Reader are trademarks of Adobe Systems, Inc.
All other trademarks contained in this publication are the property of their respective owners and may
not be used without such party’s consent.
Changes
The material in this publication is for information purposes only and is subject to change without notice.
While reasonable efforts have been made in the preparation of this publication to ensure its accuracy,
AvePoint makes no representation or warranty, expressed or implied, as to its completeness, accuracy,
or suitability, and assumes no liability resulting from errors or omissions in this publication or from the
use of the information contained herein. AvePoint reserves the right to make changes in the Graphical
User Interface of the AvePoint software without reservation and without notification to its users.
AvePoint, Inc.
Harborside Financial Center, Plaza 10
3 Second Street, 9th Floor
Jersey City, New Jersey 07311
USA
102
DocAve 6: Deployment Manager
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement