docave governance automation...governance automation provides ways to create and govern your...

Click here to load reader

Upload: others

Post on 27-Jun-2020

5 views

Category:

Documents


0 download

TRANSCRIPT

  • Administrator Guide

    DocAve®

    Governance Automation

    Service Pack 5 Cumulative Update 2

    Issued February 2017

  • 2

    DocAve Governance Automation

    Table of Contents

    What’s New in this Guide ........................................................................................................................... 10

    About DocAve Governance Automation ..................................................................................................... 11

    Submitting Documentation Feedback to AvePoint .................................................................................... 12

    Understanding Governance Automation Terminology............................................................................... 13

    Updating Previous Versions of Governance Automation ........................................................................... 14

    Updating Your Governance Automation Instance .................................................................................. 14

    Performing Additional Governance Automation Updates...................................................................... 14

    Uninstalling and Reinstalling Governance Automation Solutions ...................................................... 15

    Updating the Request Access Solution for SharePoint 2013 .............................................................. 16

    Updating External Workflow Integration Sites ................................................................................... 16

    Updating the Governance Automation App ....................................................................................... 17

    Planning Your Governance Automation Installation .................................................................................. 19

    Where should I install the Governance Automation Manager? ............................................................. 19

    How many DocAve/Governance Automation servers do I need? .......................................................... 19

    Which DocAve modules are required for Governance Automation? ..................................................... 19

    What about SQL Server? ......................................................................................................................... 19

    Enterprise-level Installation Recommendations ......................................................................................... 20

    Installing Governance Automation on a Windows Network Load Balancing Cluster ............................. 22

    Configuring Windows Network Load Balancing Cluster ..................................................................... 22

    Installing Governance Automation on the Network Load Balancing Cluster ..................................... 24

    Installing Governance Automation for High Availability ......................................................................... 24

    Configuring Windows Failover Clustering ........................................................................................... 24

    Adding Servers to the Created Failover Cluster .................................................................................. 26

    Configuring High Availability for Governance Automation................................................................. 27

    Installation Requirements ........................................................................................................................... 29

    Minimum Server (Hardware) Requirements .......................................................................................... 29

    DocAve 6 and Governance Automation Services on Same Server ..................................................... 29

    Dedicated, Single-Instance SQL Server ............................................................................................... 29

    Server Requirements for DocAve Agents ............................................................................................ 29

    Supported Software ................................................................................................................................ 30

  • 3

    DocAve Governance Automation

    Required Permissions for Governance Automation Service Accounts ................................................... 31

    Required Services on DocAve 6/Governance Automation Server .......................................................... 32

    Ports Used by Governance Automation ................................................................................................. 33

    Installation of Governance Automation ..................................................................................................... 34

    Updating Your DocAve or SnapManager for SharePoint Version ........................................................... 34

    Installing Governance Automation ......................................................................................................... 34

    Installing the DocAve Update for Governance Automation ............................................................... 34

    Installing the SnapManager for SharePoint Update for Governance Automation ............................. 35

    Installing Governance Automation via the Installation Wizard .......................................................... 36

    Unattended Installation .......................................................................................................................... 39

    Generating the Answer File ................................................................................................................ 40

    Importing the GovernanceAutomationUnattendedInstallation.dll File ............................................. 43

    Installation Commands ....................................................................................................................... 44

    Optional Governance Automation Installations ......................................................................................... 46

    Installing the DocAve Governance Automation Web Part ..................................................................... 46

    Deploying the DocAve Governance Automation Web Part Solution .................................................. 46

    Inserting the Web Part into a SharePoint Site .................................................................................... 48

    Installing DocAve Governance Automation Site Directory Web Part ..................................................... 50

    Deploying the DocAve Governance Automation Site Directory Web Part Solution ........................... 50

    Inserting the Web Part into a SharePoint Site .................................................................................... 52

    Installing the Governance Automation App ........................................................................................... 54

    Governance Automation App Pre-Installation Checklist .................................................................... 54

    Required Permissions.......................................................................................................................... 54

    Preparing the Environment to Host Apps ........................................................................................... 55

    Running the App Package Installation Wizard .................................................................................... 59

    Adding the Governance Automation App to a SharePoint Site .......................................................... 60

    Inserting Governance Automation App Part....................................................................................... 61

    Deploying the Governance Automation Policy Bar Solution .................................................................. 63

    Post-installation Procedures ....................................................................................................................... 64

    Allowing Full Control Permission to the DocAve Private Key ................................................................. 64

    Enabling the Service Account to Listen to the Governance Automation Workflow Service Port .......... 64

    Changing the Certificate in IIS Manager ................................................................................................. 65

  • 4

    DocAve Governance Automation

    Applying User-Defined Certificates ......................................................................................................... 66

    Applying a Governance Automation License .......................................................................................... 67

    Logging into Governance Automation for the First Time ....................................................................... 67

    Configuring Authentication Types .......................................................................................................... 67

    Configuring AD Authentication ........................................................................................................... 67

    Configuring ADFS Authentication ....................................................................................................... 67

    Setting Windows Authentication as the Default Login Method ......................................................... 68

    Synchronizing Authentication Configuration Changes to Governance Automation .......................... 70

    Configuring E-mail Notification Settings ................................................................................................. 70

    Registering SharePoint Online Admin Centers/Site Collections ............................................................. 70

    Configuring Language, Time Zone, Date/Time Format, and Office 365 Account Settings ..................... 71

    Getting Started with Governance Automation ........................................................................................... 72

    Configuring Account Manager ................................................................................................................ 72

    Managing Governance Automation Groups ....................................................................................... 72

    Managing Administrator Accounts ..................................................................................................... 73

    Managing Business Users .................................................................................................................... 74

    Creating New User Groups.................................................................................................................. 74

    Adding or Removing Users .................................................................................................................. 74

    Enabling a User Profile Service ............................................................................................................... 75

    Retrieving User Information from a Custom Database ...................................................................... 75

    Configuring Departments........................................................................................................................ 76

    Retrieving Department Information from a SharePoint User Profile Service..................................... 76

    Manually Adding New Departments ................................................................................................... 77

    Configuring Approval Process ................................................................................................................. 77

    Creating or Editing Approval Processes .............................................................................................. 78

    Building Customized Approval Processes ........................................................................................... 84

    Configuring Policies ................................................................................................................................. 85

    Creating or Editing Site Collection Policies ......................................................................................... 86

    Creating or Editing Content Database Policies ................................................................................... 96

    Configuring Services ................................................................................................................................ 97

    Create Site Collection Service ............................................................................................................. 98

    Create Site Service ............................................................................................................................ 110

  • 5

    DocAve Governance Automation

    Create My Site Service ...................................................................................................................... 119

    Create Library/List Service ................................................................................................................ 124

    Site Collection Lifecycle Management Service ................................................................................. 129

    Site Lifecycle Management Service .................................................................................................. 133

    Change Site Collection Contact or Administrator Service ................................................................. 137

    Change Site Contact Service ............................................................................................................. 141

    Content Move Service ....................................................................................................................... 144

    Change Site Collection Settings Service ............................................................................................ 154

    Change Site Metadata Service .......................................................................................................... 157

    Change Library/List Settings Service ................................................................................................. 161

    Grant Permissions Service................................................................................................................. 164

    Change Permissions Service .............................................................................................................. 170

    Clone or Transfer User Permission Service ....................................................................................... 174

    Custom Service .................................................................................................................................. 179

    Additional Governance Automation Configurations ................................................................................ 183

    Importing Existing Site Collections and Sites ........................................................................................ 183

    Creating an Export Plan ..................................................................................................................... 183

    Modifying the Scan Result File .......................................................................................................... 184

    Importing the Configured Scan Result File ....................................................................................... 185

    Validating Data after Importing a Scan File ...................................................................................... 189

    Configuring Metadata ........................................................................................................................... 191

    Searching and Filtering Metadata ..................................................................................................... 191

    Creating or Editing Metadata ............................................................................................................ 192

    Deleting Metadata ............................................................................................................................ 196

    Configuring Questionnaires .................................................................................................................. 196

    Displaying and Searching Questionnaires ......................................................................................... 196

    Creating or Editing Questionnaires ................................................................................................... 197

    Activating, Deactivating, Copying, and Deleting Questionnaires ..................................................... 198

    Configuring E-mail Templates ............................................................................................................... 199

    Searching and Filtering E-mail Templates ......................................................................................... 199

    Creating or Editing E-mail Templates ................................................................................................ 199

    Deleting E-mail Templates ................................................................................................................ 200

  • 6

    DocAve Governance Automation

    Configuring Execution Schedules .......................................................................................................... 200

    Displaying and Searching Execution Schedules ................................................................................ 200

    Creating or Editing Execution Schedules .......................................................................................... 200

    Deleting Execution Schedules ........................................................................................................... 201

    Configuring Request Access Settings .................................................................................................... 201

    Preparing SharePoint ........................................................................................................................ 201

    Configuring Request Access Settings ................................................................................................ 203

    Restarting IIS (for SharePoint 2010 Only) ......................................................................................... 203

    Exporting and Importing Configuration Data........................................................................................ 203

    Exporting Configuration Data ........................................................................................................... 204

    Importing Configuration Data ........................................................................................................... 204

    Configuring External Workflow Integration Settings ............................................................................ 205

    Starting Microsoft SharePoint Foundation Sandboxed Code Service ............................................... 205

    Displaying and Searching External Workflow Integration Profiles ................................................... 205

    Creating or Editing External Workflow Integration Profiles ............................................................. 205

    Deleting External Workflow Integration Profiles .............................................................................. 206

    Creating External Workflows in SharePoint ...................................................................................... 206

    Hiding or Revealing Sections to Business Users .................................................................................... 211

    Configuring Export Locations ................................................................................................................ 212

    Searching Report Export Locations ................................................................................................... 212

    Creating or Editing Export Locations ................................................................................................. 212

    Deleting Export Locations ................................................................................................................. 212

    Configuring SharePoint Permission Levels ............................................................................................ 213

    Displaying and Searching Permission Levels ..................................................................................... 213

    Creating or Editing Permission Levels ............................................................................................... 213

    Deleting Permission Levels ............................................................................................................... 213

    Configuring Administrator Notifications ............................................................................................... 213

    Configuring the Timer Service ............................................................................................................... 214

    Configuring System General Settings .................................................................................................... 216

    Configuring Category Management ...................................................................................................... 216

    Displaying and Searching Categories ................................................................................................ 216

    Creating or Editing Categories .......................................................................................................... 217

  • 7

    DocAve Governance Automation

    Deleting Categories ........................................................................................................................... 217

    Configuring Recertification Profiles ...................................................................................................... 217

    Displaying and Searching Recertification Profiles ............................................................................. 217

    Creating or Editing Recertification Profiles ....................................................................................... 217

    Deleting Recertification Profiles ....................................................................................................... 219

    Configuring Text Validation Rules ......................................................................................................... 219

    Displaying and Searching Text Validation Rules ............................................................................... 220

    Creating or Editing Text Validation Rules.......................................................................................... 220

    Deleting Text Validation Rules .......................................................................................................... 221

    Modifying Governance Automation Configuration Settings after Installation ......................................... 222

    Re-registering Governance Automation after Uninstalling DocAve ..................................................... 222

    Monitoring and Reporting ........................................................................................................................ 223

    Monitoring All Requests ....................................................................................................................... 223

    Monitoring All Tasks ............................................................................................................................. 224

    Create, Archive, Delete, Extend Site Collection, and Create Site Tasks ............................................ 224

    Site Collection Lifecycle Management Tasks .................................................................................... 225

    Site Lifecycle Management Tasks ..................................................................................................... 225

    User Permission and Manual Archive Tasks ..................................................................................... 226

    Change Actions, Content Move, and Create Tasks ........................................................................... 227

    Permission Recertification Tasks....................................................................................................... 227

    Quota Threshold Tasks ...................................................................................................................... 229

    Content Database Policy Threshold Warning Task ........................................................................... 229

    Election Tasks .................................................................................................................................... 230

    Error Tasks ......................................................................................................................................... 230

    Audit Reports ........................................................................................................................................ 230

    User Activity Report .......................................................................................................................... 231

    Service Request Report ..................................................................................................................... 232

    Approval Process Report ................................................................................................................... 233

    Administration Reports ......................................................................................................................... 234

    Site Collection Report ....................................................................................................................... 234

    Site Report ........................................................................................................................................ 239

    Content Database Report ................................................................................................................. 240

  • 8

    DocAve Governance Automation

    Public Site Collection Directory ............................................................................................................. 241

    Managing Public Site Collection Directory Reports .......................................................................... 241

    Filtering Public Site Collection Directory Reports ............................................................................. 241

    Exporting Public Site Collection Directory Reports ........................................................................... 242

    My Sites ................................................................................................................................................. 242

    Managing My Sites Reports .............................................................................................................. 242

    Filtering My Sites Reports ................................................................................................................. 243

    Exporting My Sites Reports ............................................................................................................... 243

    Working with Requests and To-Do Lists ................................................................................................... 244

    Starting a Request ................................................................................................................................. 244

    Viewing My Requests ............................................................................................................................ 245

    Submitted Requests .......................................................................................................................... 245

    Saved Requests ................................................................................................................................. 246

    Viewing My To-Do List .......................................................................................................................... 247

    Viewing My Tasks .............................................................................................................................. 247

    Viewing My Recertification Reports ................................................................................................. 252

    Changing Branding Elements in Governance Automation ....................................................................... 256

    Changing the Title Style ........................................................................................................................ 258

    Changing the Logo and Logo URL.......................................................................................................... 260

    Changing the Theme Color.................................................................................................................... 263

    Changing the Navigation Bar Color ....................................................................................................... 267

    Changing the Table Style ....................................................................................................................... 269

    Changing the System Name Image on Login Page ................................................................................ 272

    Changing the System Logo Image on Login Page .................................................................................. 274

    Changing the About Background Image ............................................................................................... 276

    Changing the Governance Automation App Logo ................................................................................ 278

    Changing the Site Information Card Logo ............................................................................................. 278

    Supporting Custom CSS Files................................................................................................................. 278

    Governance Automation Web API SDK ..................................................................................................... 279

    Getting Started ...................................................................................................................................... 279

    Environment Requirement ............................................................................................................... 279

    Required DLL File............................................................................................................................... 279

  • 9

    DocAve Governance Automation

    Supported Features in Governance Automation Web API SDK ............................................................ 279

    Implementing Governance Automation API for Create Site Collection Request ................................. 280

    Logging into Governance Automation .............................................................................................. 280

    Managing Create Site Collection Requests ....................................................................................... 281

    Appendix A: Configuring a Filter Policy ..................................................................................................... 284

    Configuring Filter Policy to Use DocAve Granular Backup and Restore ............................................... 284

    Configuring Filter Policy to Use Audit Controller in DocAve Report Center ......................................... 284

    Configuring Filter Policy to Use Dead Account Cleaner in DocAve Administrator ............................... 285

    Configuring Filter Policy to Use DocAve Deployment Manager ........................................................... 286

    Appendix B: Configuring DocAve 6 Archiver Profiles ................................................................................ 287

    Appendix C: Configuring DocAve Deployment Manager Plans ................................................................ 289

    Creating a Deployment Mapping .......................................................................................................... 289

    Creating a Deployment Plan ................................................................................................................. 291

    Appendix D: Configuring a Policy Enforcer Profile .................................................................................... 292

    Configuring a Source Collection Policy ................................................................................................. 292

    Creating a Policy Enforcer Profile ......................................................................................................... 293

    Notices and Copyright Information .......................................................................................................... 294

  • 10

    DocAve Governance Automation

    What’s New in this Guide

    Updated the Creating or Editing Site Collection Policies for SharePoint Online section.

    Updated the Creating or Editing Content Database Policies section.

  • 11

    DocAve Governance Automation

    About DocAve Governance Automation

    Traditionally, administrators create SharePoint objects or manage their data in SharePoint manually by

    following a series of requirements. The number of human interactions that occur in business processes

    can inhibit speed and the quality of decisions.

    Governance Automation provides ways to create and govern your SharePoint 2010 and SharePoint 2013

    objects automatically, both SharePoint on-premises and SharePoint Online, by submitting rich and

    customizable predefined service requests which can trigger corresponding approval processes and

    policies to accomplish the processes. This automation results in more speed, overall effectiveness of the

    interactions and often a reduction in errors.

    This documentation is for administrators to leverage Governance Automation for the automated, end-

    to-end service and information management; if you are a business user of Governance Automation,

    refer to the DocAve Governance Automation User Guide for Business Users.

    http://www.avepoint.com/assets/pdf/sharepoint_user_guides/DocAve_Governance_Automation_Business_User_User_Guide.pdf

  • 12

    DocAve Governance Automation

    Submitting Documentation Feedback to AvePoint

    AvePoint encourages customers to provide feedback regarding our product documentation. Click the

    following URL to access the Submit Your Feedback form on our Web site:

    http://www.avepoint.com/resources/documentation-feedback/?flush=1

    http://www.avepoint.com/resources/documentation-feedback?flush=1

  • 13

    DocAve Governance Automation

    Understanding Governance Automation Terminology

    If you are new to Governance Automation, it may be helpful to review the Key Terms list to familiarize

    yourself with terms such as “service”, “policy”, and “approval process”, which will be used throughout

    this user guide.

    Once you have familiarized yourself with Governance Automation terminology, it is important to

    understand how the different features and functionalities work together. This knowledge is essential to

    properly configure the software for your organization.

    In Governance Automation, administrators can set up services that perform SharePoint or DocAve

    operations. These services can be made available to only the relevant departments/purposes so that

    they can be customized to be most effective for each department/purpose. A Service may have a policy

    associated with it so that if your organization has specific rules on certain SharePoint operations, you

    can ensure that all services with the same associated policy will be compliant to your organization’s

    standards. Services will also have at least one approval process configured so that when a user submits a

    request for a specific service, the appropriate parties (such as the user’s manager) are notified and can

    provide the necessary approval. Once the service request has been fully approved, Governance

    Automation performs the SharePoint and/or DocAve processes according to the customized settings

    configured for that service.

    http://www.avepoint.com/assets/pdf/sharepoint_user_guides/Governance_Automation_Key_Terms.pdf

  • 14

    DocAve Governance Automation

    Updating Previous Versions of Governance Automation

    Before you update to Governance Automation Service Pack 5 Cumulative Update 2, be sure that you

    have followed the instructions in Updating Your DocAve or SnapManager for SharePoint Version.

    After updating DocAve, proceed with the Governance Automation update procedure described below.

    Updating Your Governance Automation Instance

    This procedure assumes that you have met the conditions described in Updating Your DocAve or

    SnapManager for SharePoint Version and that you have already downloaded and extracted the

    DocAve_Governance_Automation_SP5_CU2_UpgradePackage.zip file.

    Complete the following steps to update your Governance Automation instance:

    1. Extract the DocAve_Governance_Automation_SP5_CU2_UpgradePackage.zip file. You will see the following ZIP files in the DocAve_Governance_Automation_SP5_CU2_UpgradePackage folder: DocAve_Update_for_Governance_Automation_1.5.2.zip and DocAve_Governance_Automation_1.0_SP5_CU2.zip.

    2. In the DocAve Control Panel > Update Manager, install the DocAve_Update_for_Governance_Automation_1.5.2.zip update. This update ensures proper communication between DocAve and Governance Automation. For more information about how to install this update, refer to Installing the DocAve Update for Governance Automation.

    3. In the DocAve Control Panel > Update Manager, install DocAve_Governance_Automation_1.0_SP5_CU2.zip update in the Governance Automation tab to update Governance Automation on your selected servers.

    4. Verify that the DocAve Manager and Agent update was applied successfully by navigating to Control Panel > Update Manager > View History and checking the Version and Date columns of the newly installed update.

    Performing Additional Governance Automation Updates

    If you deployed Governance Automation solutions in Governance Automation Service Pack 5 Cumulative

    Update 1, note the following:

    If you deployed the following solutions, you must uninstall and then reinstall them after you update your Governance Automation instance to Service Pack 5 Cumulative Update 2. For more information, refer to Uninstalling and Reinstalling Governance Automation Solutions.

    o GAWebPart.wsp (for Governance Automation Web part)

    o GASubSiteDirectory.wsp (for Governance Automation site directory Web part)

    o GAPolicyBar.wsp (for Site Policy Bar)

    o GARequestAccessSP2010.wsp (for the Request Access feature in SharePoint 2010)

  • 15

    DocAve Governance Automation

    If you deployed the GARequestAccessSP2013.wsp solution (for the Request Access feature in SharePoint 2013), you must update this solution after you update your Governance Automation instance to Service Pack 5 Cumulative Update 2. For more information, refer to Updating the Request Access Solution for SharePoint 2013.

    If you deployed the GASPWorkflowIntegration.wsp solution (for the integration between Governance Automation and external workflows), you must Updating External Workflow Integration Sites after you update your Governance Automation instance to Service Pack 5 Cumulative Update 2.

    If you installed the Governance Automation App in Service Pack 5 Cumulative Update 1, you must

    update the app after you update your Governance Automation instance to Service Pack 5 Cumulative

    Update 2, if you want the following app changes to take effect on your sites:

    When the language of the site where the app and app parts reside is French, the app and app parts are displayed in French.

    The My Tasks app part is renamed to My To-Do List.

    For more information, refer to Updating the Governance Automation App.

    Uninstalling and Reinstalling Governance Automation Solutions

    After updating Governance Automation, you must uninstall and then reinstall the following Governance

    Automation solutions if you installed them before the update:

    GAWebPart.wsp (for Governance Automation Web part)

    GASubSiteDirectory.wsp (for Governance Automation site directory Web part)

    GAPolicyBar.wsp (for Site Policy Bar)

    GARequestAccessSP2010.wsp (for the Request Access feature in SharePoint 2010)

    Complete the following steps:

    1. Navigate to SharePoint Central Administration > System Settings > Farm Management, and then click Manage farm solutions.

    2. Click the .wsp file name, and then click Retract Solution.

    3. Click Back to Solutions and the status of the previously selected solution is Not Deployed.

    4. Click the solution, and then click Remove Solution. A confirmation window appears.

    5. Click OK to remove the solution.

    6. After uninstalling the solutions, reinstall them. For more information, refer to the following sections:

    Installing the DocAve Governance Automation Web Part

    Installing DocAve Governance Automation Site Directory Web Part

    Deploying the Governance Automation Policy Bar Solution

    Deploying the Governance Automation Request Access Solution

  • 16

    DocAve Governance Automation

    Updating the Request Access Solution for SharePoint 2013

    After updating Governance Automation, you must update the solution GARequestAccessSP2013.wsp if

    you deployed the solution before the Governance Automation update.

    Complete the following steps:

    1. On the SharePoint Web front-end server where you deployed the solution GARequestAccessSP2013.wsp, navigate to SharePoint 2013 Management Shell. Right-click it and select Run as administrator.

    2. Enter the following command:

    stsadm –o upgradesolution –name "GARequestAccessSP2013.wsp" -filename

    "C:\Program Files\AvePoint\GovernanceAutomation\SharePoint

    Solutions\GARequestAccessSP2013.wsp" -immediate –allowgacdeployment

    *Note: Replace C:\Program Files\AvePoint\GovernanceAutomation\SharePoint Solutions\GARequestAccessSP2013.wsp with the path where the solution is stored.

    3. Press Enter. You will see the message Operation completed successfully when the solution is successfully updated. Close the SharePoint 2013 Management Shell window.

    4. Navigate to C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\LAYOUTS\GA.

    5. Right-click the AccessDenied.aspx file and select Copy.

    6. Navigate to C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\LAYOUTS and paste the copied .aspx file into this directory.

    Updating External Workflow Integration Sites

    After updating Governance Automation, you must update external workflow integration sites if you

    deployed the GASPWorkflowIntegration.wsp solution before the Governance Automation update. The

    external workflow integration sites are the site collections or sites that you defined when Creating or

    Editing External Workflow Integration Profiles.

    Complete the following steps to update an external workflow integration site:

    1. Navigate to an external workflow integration site.

    2. Manually delete the following lists from the site: Service Request, Request Metadata, My Site Bulk Data, Content Move Mappings, and Security Groups.

    *Note: Do not delete these lists from the site Recycle Bin. They need to be restored later.

    3. If you entered a site collection URL in the external workflow integration profile, navigate to Site Settings > Web Designer Galleries > Solutions. If you entered a site URL in the external workflow integration profile, go to the site’s site collection and navigate to Site Settings > Web Designer Galleries > Solutions.

    4. Select the GASPWorkflowIntegration solution and click Deactivate on the ribbon.

    5. Select the GASPWorkflowIntegration solution and click Delete on the ribbon.

  • 17

    DocAve Governance Automation

    6. Click Upload Solution on the ribbon.

    7. In the Add a document window, click Browse….

    8. In the Choose File to Upload window, browse to the GASPWorkflowIntegration.wsp file. By default, the .wsp file is located in the …\AvePoint\GovernanceAutomation\SharePoint Solutions\SharePoint Workflow Integration directory on the Governance Automation server.

    9. Click Open and then click OK.

    10. In the Solution Gallery – Activate Solution window, click Activate.

    11. Go to the Recycle bin of the site collection or site that you defined in the external workflow profile, and restore the lists that are deleted in step 2.

    *Note: After these lists are restored, they are not displayed on the Quick Launch. You can make them displayed by completing the following steps:

    a. Navigate to List Settings > List name, description and navigation.

    b. In the Navigation field, choose Yes.

    c. Click Save to save your change.

    After new Governance Automation requests are submitted, new items will be created in the Service

    Request, Request Metadata, My Site Bulk Data, Content Move Mappings, and Security Groups lists.

    *Note: By default, the site feature DocAve Governance Automation Service Request is not active, and

    the related function works. Do not activate this feature.

    Updating the Governance Automation App

    After updating Governance Automation, you can update the Governance Automation App if you

    installed the app before the Governance Automation update and you want the app changes below to

    take effect on your sites.

    When the language of the site where the app and app parts reside is French, the app and app parts are displayed in French.

    The My Tasks app part is renamed to My To-Do List.

    *Note: Make sure you have the Required Permissions prior to updating the Governance Automation

    App.

    Complete the following steps to update the Governance Automation App:

    1. Running the App Package Installation Wizard to update the previous app file to the one in Governance Automation Service Pack 5 Cumulative Update 2.

    2. Navigate to each site where the Governance Automation App was added.

    3. Click Site Contents on the Quick Launch.

    4. In the Site Contents interface, find Governance Automation, and then click the click for more information ( ) button next to it.

  • 18

    DocAve Governance Automation

    5. Click ABOUT. A new interface appears.

    6. Click GET IT to get the new version of the Governance Automation App.

    7. In the Do you trust Governance Automation? window, click Trust IT. The Governance Automation App in the current site will be updated to the new version.

  • 19

    DocAve Governance Automation

    Planning Your Governance Automation Installation

    Governance Automation provides for several installation scenarios that depend upon the size of your

    organization. This guide provides both minimum and recommended specifications and configurations

    for small- and large-scale deployments. Before proceeding, note the following:

    To install Governance Automation, DocAve 6 (Manager and Agents) must be installed first. For more information on installing DocAve 6, refer to the DocAve 6 Installation Guide.

    Ensure that your versions of DocAve 6 and Governance Automation are compatible. Refer to the AvePoint KB article Governance Automation, DocAve, and SnapManager for SharePoint Support Matrix for more information.

    Where should I install the Governance Automation Manager?

    To minimize network calls, the Governance Automation Manager should always be installed on the

    same server as the DocAve Control Service, Media Service, and if applicable, the Report Service. Note

    that this may require you to increase your server (hardware) specifications, so carefully review the

    information in Minimum Server (Hardware) Requirements.

    How many DocAve/Governance Automation servers do I need?

    Governance Automation is an end-user-facing application, so for high availability and load balancing

    purposes, you should always plan for at least two DocAve/Governance Automation servers in your

    production environment. For more information about how to install Governance Automation for high

    availability and load balancing, refer to Installing Governance Automation on a Windows Network Load

    Balancing Cluster and Installing Governance Automation for High Availability.

    Note that larger Enterprise environments should plan on additional Governance Automation servers. As

    a general rule, each DocAve/Governance Automation server can handle about 300 concurrent requests.

    AvePoint’s recommendation is that for environments with more than 200,000 users, three (3)

    DocAve/Governance Automation servers should be used.

    Which DocAve modules are required for Governance

    Automation?

    At a minimum, you must be running DocAve 6 Administrator to use Governance Automation.

    What about SQL Server?

    For all Governance Automation installations, AvePoint recommends a separate dedicated, single-

    instance SQL Database. Note that SQL Server clustering is not mandatory but is recommended for high

    availability purposes.

    http://www.avepoint.com/assets/pdf/sharepoint_user_guides/DocAve_6_Installation_Guide_SP4.pdfhttp://www.avepoint.com/community/kb/governance-automation-docave-and-snapmanager-for-sharepoint-support-matrixhttp://www.avepoint.com/community/kb/governance-automation-docave-and-snapmanager-for-sharepoint-support-matrix

  • 20

    DocAve Governance Automation

    Enterprise-level Installation Recommendations

    To minimize network calls between DocAve 6 and Governance Automation, the DocAve Manager and

    Governance Automation Manager should always be installed on the same server. DocAve Agents should

    be installed on multiple SharePoint Web Front-end servers of a specific farm. This automatically

    achieves load balancing and high availability on the Application level, which means that:

    The DocAve Agent service will automatically choose which Media services will distribute jobs according to CPU and memory utilization of the servers that have Media services installed on them (load balancing).

    The DocAve Control service will automatically choose which Agent services will execute the Governance Automation jobs according to CPU and memory utilization of the servers that have Agent services installed on them (load balancing).

    The DocAve Media service will automatically switch to a standby Media service if the primary Media service goes down (HA).

    Figure 1: Diagram of load balanced DocAve and Governance Automation Managers and Agents.

  • 21

    DocAve Governance Automation

    Load Balancer for AvePoint Managers(Windows Network Load Balancing Cluster)

    AvePoint ManagerDocAve 6 Manager- DocAve 6 Control Service- DocAve 6 Report Service- DocAve 6 Media ServiceGovernance Automation Manager

    AvePoint ManagerDocAve 6 Manager- DocAve 6 Control Service- DocAve 6 Report Service- DocAve 6 Media ServiceGovernance Automation Manager

    DocAve and Governance Automation Manager with Network Load Balancing

    SharePoint Web ServerDocAve 6 Agent Installed- Governance Automation Agent Type

    SharePoint Web ServerDocAve 6 Agent Installed- Governance Automation Agent Type

    3

    SharePoint Farm with DocAve Agents

    1

    6

    5

    4

    2

    DocAve / Governance Automation Communication1. User interacts with GA UI through load balanced GA URL. 2. Communication is redirected from the load balancer to the GA Manager Server3. In order to perform actions, e.g. provisioning, GA Manager communicates with DA 6 Control Service4. DA6 Control Service communicates with DA6 Agent that has the GA Agent Type and performs action.5. DA6 Agent reports back to DA6 Control Service with Job status.6. DA6 Control Service reports back to GA Manager with Job status.

    Figure 2: Diagram of network load balanced communications between DocAve and Governance Automation.

    To achieve load balancing and HA failover on the System level (load balancing and HA failover of

    clustered servers), follow the instructions listed in the sections below. Note that a Network Load

    Balancing cluster provides high availability at a limited level by detecting the status of the clustered

    server: if one clustered server fails, the network traffic will be immediately distributed to another server

    within that cluster. However, as is the case with all user-facing applications, a Windows Failover Cluster

    is also recommended in the event that all servers in a Network Load Balancing cluster go down.

  • 22

    DocAve Governance Automation

    Installing Governance Automation on a Windows Network Load

    Balancing Cluster

    A Network Load Balancing cluster can enhance the accessibility of Governance Automation by

    distributing the network traffic to the clustered servers that have Governance Automation installed on

    them.

    Refer to the sections below for instructions on installing Governance Automation on a Windows

    Network Load Balancing cluster.

    Configuring Windows Network Load Balancing Cluster

    Make sure Windows Server 2008 or above is installed on the servers you are about to have in a Network

    Load Balancing cluster. The following instructions show how to install and configure the Windows

    Network Load Balancing cluster on Windows Server 2012.

    Installing Windows Network Load Balancing Feature

    Complete the following steps to install the Windows Network Load Balancing feature on Windows

    Server 2012.

    1. On any server that will be in the Network Load Balancing cluster, navigate to Start > Administrative Tools > Server Manager.

    2. Click Add Roles and Features on the left pane to run Add Roles and Features Wizard.

    3. In the Before you begin page, click Next to proceed to the next step.

    4. Select Role-based or feature-based installation as the Installation Type. Click Next.

    5. In the Server Selection interface, select Select a server from the server pool and then select the current server from the loaded server list.

    6. Click Next to proceed to the next step. The Server Role interface appears. Click Next.

    7. Select Network Load Balancing from the Feature list. In the pop-up window, click Add Feature.

    8. Click Next to proceed to the next step.

    In the Confirmation interface, deselect the Restart the destination server automatically if

    required. checkbox, as the Network Load Balancing feature does not require a server restart.

    Click Install to start installing the Network Load Balancing feature.

    9. Click Close to exit this wizard when the installation process ends.

    10. On the server where the Network Load Balancing feature is installed, turn off the firewall state of the DocAve and Governance Automation ports.

    Complete the following steps to turn off the firewall state of these ports.

    a. Navigate to Start > All Programs > Control Panel > Windows Firewall > Advanced settings.

  • 23

    DocAve Governance Automation

    b. Right-click Inbound Rule in the left pane and click New Rule. The New Inbound Rule Wizard interface appears.

    c. In the Rule Type interface, select Port as the rule type. Click Next. The Protocol and Ports interface appears.

    d. Select TCP as the protocol and Specific local ports to apply this rule to. Enter the DocAve ports including the Control service port, the Media service port, the Media service data port, the Report service port and the Agent port as well as the Governance Automation port. For example, 14000, 14001, 14002, 14003, 14004, and 15000. Click Next.

    e. In the Action interface, select Allow the connection as the action to take when a connection matches the specified condition. Click Next. The Profile interface appears.

    f. Select the Domain checkbox to apply this rule to the domain profile.

    g. Click Next to proceed to the next step.

    h. Enter a rule name and an optional Description, if desired.

    i. Click Finish to exit the wizard.

    11. On the server where the Network Load Balancing feature is installed, navigate to Start > All Programs > Administrative Tools > Services. Ensure the status of the Computer Browser service is started.

    *Note: Repeat the steps above to install the Network Load Balancing feature on each server in which

    you will configure the Network Load Balancing.

    Creating a New Network Load Balancing Cluster

    Complete the following steps to create a new Network Load Balancing cluster:

    1. On a server where you have installed the Network Load Balancing feature, navigate to Start > All Programs > Network Load Balancing Manager.

    2. Right-click Network Load Balancing Cluster in the left pane and click New Cluster.

    3. In the Host text box, enter the IP address of the current server in which you are logging and then click Connect.

    4. Click Next to proceed to the next step.

    5. Click Next to view the New Cluster: Cluster IP Address interface.

    6. Click Add… to view the Add IP Address interface.

    7. Enter your desired IP address that will be used as the cluster IP.

    8. Click OK to go back to the New Cluster: Cluster IP Address interface.

    9. Click Next and select Unicast as the Cluster operation mode in the Cluster Parameters interface.

    10. Click Next to enter the Port Rules interface.

    11. Click Add…; the Add/Edit Port Rule window appears.

  • 24

    DocAve Governance Automation

    12. Select Multiple host in the Filtering mode section and click OK.

    13. Click Finish in the Port Rules interface. The new Network Load Balancing cluster is now successfully created.

    Connecting to the Existing Network Load Balancing Cluster

    Complete the following steps to connect to the existing Network Load Balancing cluster:

    1. On another server where you have installed the Network Load Balancing feature, navigate to Start > All Programs > Network Load Balancing Manager.

    2. Right-click Network Load Balancing Cluster in the left pane and click Connect to Existing.

    3. In the Host text box, enter the IP address that you have configured as the cluster IP when creating the Network Load Balancing cluster. Then, click Connect.

    4. When the cluster is connected successfully, select the cluster and click Finish.

    *Note: To configure multiple Network Load Balancing clusters, repeat the steps above on each server.

    Installing Governance Automation on the Network Load Balancing Cluster

    Before installing Governance Automation Service Pack 5 Cumulative Update 2, make sure that the Agent

    services and Manager services of DocAve 6 Service Pack 5, Service Pack 5 Cumulative Update 1, or

    Service Pack 6 are installed on servers in the Network Load Balancing cluster. Refer to steps below to

    install Governance Automation on the configured Network Load Balancing nodes.

    1. Install Governance Automation on the server of one node that has DocAve Manager installed. Proceed to Installing Governance Automation for detailed instructions.

    2. On the server of another node that has DocAve Manager installed, install Governance Automation. Make sure you use the same Governance Automation Configuration Database and Governance Automation Audit Database that you configured when installing Governance Automation on the first server.

    3. If there are other nodes in the cluster, repeat step 2 to install Governance Automation on each server.

    Installing Governance Automation for High Availability

    To install Governance Automation in a failover cluster using the Windows Failover Cluster feature, see

    the sections below.

    Configuring Windows Failover Clustering

    Make sure Windows Server 2008 or above is installed on the servers you are about to have in a failover

    cluster. The following instructions show how to install and configure the Windows Failover Cluster on

    Windows Server 2012, but can also be followed for Windows Server 2008.

  • 25

    DocAve Governance Automation

    Installing the Windows Failover Clustering Feature

    The following instructions explain how to install the Windows Failover Clustering feature on Windows

    Server 2012.

    1. On the server in which you will configure Failover Clustering, navigate to Start > Administrative Tools > Server Manager.

    2. Click Add Roles and Features on the left pane to run Add Roles and Features Wizard.

    3. In the Before you begin page, click Next to proceed to the next step.

    4. Select Role-based or feature-based installation as the installation type. Click Next.

    5. In the Server Selection interface, select Select a server from the server pool and then select the current server from the loaded server list.

    6. Click Next to proceed to the next step. The Server Role interface appears. Click Next.

    7. Select Failover Clustering from the Feature list. In the pop-up window, click Add Feature.

    8. Click Next to proceed to the next step.

    In the Confirmation interface, deselect the Restart the destination server automatically if

    required. checkbox, as the Windows Failover Clustering feature does not require a server

    restart. Click Install to start installing the Failover Clustering feature.

    9. Click Close to exit this wizard when the installation process ends.

    10. Repeat the steps above to install the Windows Failover Clustering feature on each server that will be a part of a Failover Clustering.

    Validating the Hardware Configuration

    Complete the following steps to validate whether the configuration of a selected server supports

    failover:

    1. On a server where you have installed the Failover Clustering feature, navigate to Start > All Programs > Failover Cluster Manager.

    2. Right-click Failover Cluster Manager in the left pane and click Validate Configuration ….

    3. Click Next in the Before you Begin interface to proceed to next step. The Select Servers or a Cluster interface appears.

    4. Enter the name of servers you want to have in the cluster in the Enter name field. Click Add to add the entered server in the Selected servers list.

    *Note: These servers you entered must have the Failover Clustering Feature installed on them.

    5. Click Next to proceed to next step.

    6. Select Run all tests (recommended) in the Testing Options interface. Click Next.

    7. In the Confirmation interface, click Next to start the validation.

    8. Click Finish to exit this wizard after the validation process ends.

  • 26

    DocAve Governance Automation

    Creating a New Windows Failover Cluster

    Refer to the following instructions to create a new Windows Failover cluster:

    1. On a server where you have installed the Failover Clustering feature, navigate to Start > All Programs > Failover Cluster Manager.

    2. Right-click Failover Cluster Manager in the left pane and click Create Cluster….

    3. In the pop-up Create Cluster Wizard, click Next in the Before you Begin interface to proceed to next step. The Select Servers interface appears.

    4. In the Enter name field, enter the names of the servers that have the Failover Clustering feature installed. Click Add to add the entered servers in the Selected servers list. These servers will be added to the cluster you are about to create. Click Next to proceed to next step.

    5. In the Validation Warning interface, the question Do you want to run configuration validation tests before continuing? appears.

    If you executed validation of these servers in Validate a configuration …, select No. I do not require support from Microsoft for this cluster, and therefore do not want to run the validation tests. When I click Next, continue creating the cluster.

    If you have not yet executed validation of these servers, select Yes. When I click Next, run configuration validation tests, and then return to the process of creating the cluster.

    6. Click Next to proceed to next step.

    7. Enter the name that clients will use when accessing this service and configure the IP address. Then, click Next. The Confirmation interface appears.

    8. Click Next to create a cluster.

    9. Click Finish to exit this wizard when the creation process ends.

    Adding Servers to the Created Failover Cluster

    Complete the following steps to add a new cluster node to a created cluster if you need:

    1. On a server where you have created Failover Clusters, navigate to Start > All Programs > Failover Cluster Manager.

    2. In Failover Cluster Manager, select your desired cluster on the left pane. Then, click Add Node… on the right pane to add a node to the selected cluster.

    3. In the pop-up Add Node Wizard, click Next in the Before you Begin interface to proceed to next step. The Select Servers interface appears.

    4. In the Enter name field, enter the names of the servers that have the Failover Clustering feature installed. Click Add to add the entered servers in the Selected servers list. These entered servers will be add to the cluster you are about to create as cluster nodes.

    *Note: These servers you entered must have the Failover Clustering Feature installed on them.

    5. Click Next to proceed to next step.

  • 27

    DocAve Governance Automation

    6. In the Validation Warning interface, the question Do you want to run configuration validation tests before continuing? appears.

    If you executed validation of these servers in Validate a configuration …, select No. I do not require support from Microsoft for this cluster, and therefore do not want to run the validation tests. When I click Next, continue creating the cluster.

    If you have not yet executed validation of these servers, select Yes. When I click Next, run configuration validation tests, and then return to the process of creating the cluster.

    7. Click Next to proceed to next step. The Confirmation interface appears. Click Next.

    8. Click Next to start configuring the cluster.

    9. Click Finish to exit this wizard when the configuration process ends.

    *Note: If desired, refer to the Microsoft TechNet article Configure and Manage the Quorum in a

    Windows Server 2012 Failover Cluster for the instruction and configuration of the quorum in a failover

    cluster.

    Configuring High Availability for Governance Automation

    Complete the following steps to configure High Availability for Governance Automation installations:

    1. Log into the cluster nodes you configured in the Create Cluster Wizard and install Governance Automation on them. Proceed to Installing Governance Automation for detailed instructions.

    *Note: During each installation, enter the current machine’s hostname or IP address when configuring the Governance Automation Host.

    *Note: Use the same Governance Automation Configuration Database and Governance Automation Audit Database during the installations.

    2. After the installations, log into one of the cluster nodes, and navigate to Start > All Programs > Failover Cluster Manager.

    3. Right-click Services and applications and select Configure a Service or Application from the drop-down menu. The High Availability Wizard appears.

    4. In the In the Before you begin page, click Next to proceed to the next step.

    5. In the Select Service or Application interface, select the Generic Service and then click Next.

    6. Select Governance Automation Timer and then click Next.

    7. In the Client Access Point interface, enter the name that clients will use when accessing this service and configure the IP address. Then, click Next.

    8. Continue by keeping the default settings and finish the configurations.

    9. In the Failover Cluster Manager, select the service you created above and right-click it. Select Add a resource > 4 – Generic Service.

    10. Select Governance Automation Workflow and then click Next.

    11. Continue by keeping the default settings and finish adding the service.

    http://technet.microsoft.com/en-us/library/jj612870.aspxhttp://technet.microsoft.com/en-us/library/jj612870.aspx

  • 28

    DocAve Governance Automation

    12. If Governance Automation Workflow is offline, right-click it and click Bring this resource online.

    13. Modify the Global.config configuration file on each node:

    a. Navigate to Governance Automation installation directory …\AvePoint\GovernanceAutomation\Config and find the Global.config file.

    b. Find the attribute WorkflowService and modify the Host value to the Client Access Point name that is entered in the Client Access Point interface.

    Figure 3: Modifying the Host value.

    c. Save and close the configuration file.

    14. Navigate to Start > Application Tools > Services on each node, then restart Governance Automation Timer service and Governance Automation Workflow service.

    *Note: If there are other servers in the cluster, repeat the steps above to configure each server.

  • 29

    DocAve Governance Automation

    Installation Requirements

    Minimum Server (Hardware) Requirements

    The following specifications are the minimum required. AvePoint recommends exceeding these values

    for improved Governance Automation performance.

    DocAve 6 and Governance Automation Services on Same Server

    Component Minimum Specification

    Number of CPU Cores 64-Bit, 4 Cores

    Physical Memory 16 GB (Available)

    Available Disk Space 50 GB or above

    Dedicated, Single-Instance SQL Server

    Component Minimum Specification

    Number of CPU Cores 64-Bit, 4 Cores

    Physical Memory 16 GB (Available)

    Available Disk Space 60 GB or above

    Server Requirements for DocAve Agents

    For some operations, Governance Automation leverages DocAve Agents. To account for this additional

    load, ensure that your Agent servers meet or exceed the following specifications.

    Component Minimum Specification

    Number of CPU Cores 64-Bit, 4 Cores

    Physical Memory 4 GB (Available/dedicated for DocAve Agent)

    Available Disk Space 50 GB or above

  • 30

    DocAve Governance Automation

    Supported Software

    Component Supported

    Operating System Windows Server 2008 Windows Server 2008 R2 Windows Server 2012 Windows Server 2012 R2 Windows 7

    SharePoint Versions Microsoft SharePoint Server/Foundation 2010 (up to and including Service Pack 2) Microsoft SharePoint Server/Foundation 2013 (up to and including Service Pack 1) *Note: The Governance Automation App is only supported on Microsoft SharePoint Server/Foundation 2013 (up to and including Service Pack 1).

    SQL Server Version Microsoft SQL Server 2008 Microsoft SQL Server 2008 R2 Microsoft SQL Server 2012 Microsoft SQL Server 2014

    .Net Framework Version .NET Framework 4.5 or above

    PowerShell Version PowerShell 2.0 or above

    Web Browsers Internet Explorer 8 (Does not support the Questionnaire feature) Internet Explorer 9, 10, and 11 Google Chrome

    Compatible DocAve Products Administrator (required for Governance Automation) Content Manager Deployment Manager Granular Backup and Restore Report Center Scheduled Storage Manager Connector Archiver Vault File Share Navigator

  • 31

    DocAve Governance Automation

    Required Permissions for Governance Automation Service

    Accounts

    In most cases, organizations generally use one service account to achieve permissions for Governance

    Automation services and the application pool. If using one service account for all Governance

    Automation services and the application pool, permissions for this account should be as follows:

    The database role of DB_Owner for Governance Automation Configuration Database and Governance Automation Audit Database.

    The Full Control permission to the private key of DocAve. For instructions on how to grant these permissions, refer to Allowing Full Control Permission to the DocAve Private Key.

    Permission for the service account to listen to the Governance Automation Workflow Service port. For more information, refer to Enabling the Service Account to Listen to the Governance Automation Workflow Service Port.

    The Read and Write permission to the GovernanceAutomation folder in Governance Automation installation directory …\AvePoint\GovernanceAutomation.

    The database role of DB_DataReader and DB_DataWriter for DocAve Archiver Database (if manual archiving will be used).

    Below is a breakdown of permissions for each Governance Automation service and the application pool:

    Service account for Governance Automation Workflow Service:

    o The database role of DB_Owner for Governance Automation Configuration Database and Governance Automation Audit Database.

    o The Full Control permission to the private key of DocAve. For instructions on how to grant these permissions, refer to Allowing Full Control Permission to the DocAve Private Key.

    o Permission for the service account to listen to the Governance Automation Workflow Service port. For more information, refer to Enabling the Service Account to Listen to the Governance Automation Workflow Service Port.

    o The Read and Write permission to the GovernanceAutomation folder in Governance Automation installation directory …\AvePoint\GovernanceAutomation.

    o The database role of DB_DataReader and DB_DataWriter for DocAve Archiver Database (if manual archiving will be used).

    Service account for Governance Automation Timer Service:

    o The Full Control permission to the private key of DocAve. For instructions on how to grant these permissions, refer to Allowing Full Control Permission to the DocAve Private Key.

    o The Read and Write permission to the GovernanceAutomation folder in Governance Automation installation directory …\AvePoint\GovernanceAutomation.

  • 32

    DocAve Governance Automation

    o The database role of DB_DataReader and DB_DataWriter for DocAve Archiver Database (if manual archiving will be used).

    Service account for Application Pool:

    o The Full Control permission to the private key of DocAve. For instructions on how to grant these permissions, refer to Allowing Full Control Permission to the DocAve Private Key.

    o The Read and Write permission to the GovernanceAutomation folder in Governance Automation installation directory …\AvePoint\GovernanceAutomation.

    Required Services on DocAve 6/Governance Automation Server

    Service Name Details .Net Framework Features The Windows features, including WCF Activation,

    HTTP Activation, and Non-HTTP Activation must be installed.

    Net.Tcp Port Sharing Service Net.Tcp Port Sharing Service is started.

    Windows Process Activation Service Windows Process Activation Service is started.

    Process Model, .NET Environment, and Configuration APIs are installed.

    World Wide Web Publishing Service World Wide Web Publishing Service is started.

    Web Server(IIS) Role Windows features installed:

    Web Server

    Common HTTP Features (Static Content, Default Document)

    Application Development (ASP.NET, .NET Extensibility, ISAPI Extensions and ISAPI Filters)

    Management Tools (IIS Management Console, IIS 6 Management Compatibility and IIS 6 Metabase Compatibility)

  • 33

    DocAve Governance Automation

    Ports Used by Governance Automation

    Refer to the table below for the ports that are used by Governance Automation:

    Port Usage Enabled By

    15000 Web site Port – Used to access Governance Automation Web site.

    Governance Automation Web site.

    6008 Workflow Service Port – Used to host Governance Automation Workflow Service.

    Windows Communication Foundation Service hosted by Governance Automation Workflow Service.

    *Note: Port 15000 requires HTTPS.

  • 34

    DocAve Governance Automation

    Installation of Governance Automation

    Now that you have determined how you will configure Governance Automation in your environment,

    you are ready to install the application. Follow each step below in the order provided.

    1. Updating Your DocAve or SnapManager for SharePoint Version

    2. Installing the DocAve Update for Governance Automation or Installing the SnapManager for SharePoint Update for Governance Automation

    3. Installing Governance Automation via the Installation Wizard

    Updating Your DocAve or SnapManager for SharePoint Version

    DocAve 6 Service Pack 5, DocAve 6 Service Pack 5 Cumulative Update 1, DocAve 6 Service Pack 6, or

    SnapManager 8.2 for SharePoint is required to work with Governance Automation Service Pack 5

    Cumulative Update 2. If necessary, update your DocAve instance to DocAve 6 Service Pack 5, Service

    Pack 5 Cumulative Update 1 or Service Pack 6, or update your SnapManager for SharePoint instance to

    SnapManager 8.2 for SharePoint before proceeding with your Governance Automation update. For

    details on how to update your DocAve or SnapManager for SharePoint instance, refer to the DocAve 6

    Control Panel Reference Guide or the SnapManager for SharePoint Control Panel User’s Guide.

    For a compatibility matrix between Governance Automation, DocAve, and SnapManager for SharePoint,

    refer to the AvePoint KB article Governance Automation, DocAve, and SnapManager for SharePoint

    Support Matrix.

    After updating DocAve or SnapManager for SharePoint to a compatible version, you can proceed with

    your Governance Automation installation.

    Installing Governance Automation

    Before installing Governance Automation, ensure that your version of DocAve or SnapManager for

    SharePoint is compatible with Governance Automation. See Updating Your DocAve or SnapManager for

    SharePoint Version for more information. After this is complete, proceed with the instructions in the

    sections below.

    *Note: You can automate your Governance Automation deployment using the unattended installation

    feature of Governance Automation. For instructions on how to perform an unattended installation, refer

    to Unattended Installation.

    Installing the DocAve Update for Governance Automation

    To ensure proper communication between DocAve and Governance Automation, a DocAve update

    specific to Governance Automation must be manually installed.

    http://www.avepoint.com/assets/pdf/sharepoint_user_guides/Control_Panel_Reference_Guide.pdfhttp://www.avepoint.com/assets/pdf/sharepoint_user_guides/Control_Panel_Reference_Guide.pdfhttp://www.docave.com/KB/Lists/KB/DispErrorArticle.aspx?ID=850http://www.docave.com/KB/Lists/KB/DispErrorArticle.aspx?ID=850

  • 35

    DocAve Governance Automation

    In the Governance Automation installation package ZIP file, you will see the

    DocAve_Update_for_Governance_Automation_1.5.2.zip file. Follow the instructions below to install

    the DocAve update:

    1. Log into the DocAve 6 Manager and navigate to Control Panel > Update Manager.

    2. On the Manage Updates interface, click Browse. Find and load the DocAve_Update_for_Governance_Automation_1.5.2.zip file into DocAve Manager.

    3. Click Install on the ribbon. In the Server Selection pop-up window, all available Manager services are shown in the Manager tab and all available farms are shown in the Agent tab.

    4. On the Manager tab, select the Install the update for all the managers below checkbox. The update will be installed on all of the Manager services.

    5. On the Agent tab, select the Agent services you want to update

    6. Click Install. The progress displays in the Status column. After the installation completes, a message appears indicating that the installation was successful.

    7. Click Finish.

    8. To verify that the update was successful, navigate to Control Panel > Update Manager > View History and check the Version column of the newly installed update.

    Installing the SnapManager for SharePoint Update for Governance

    Automation

    To ensure proper communication between SnapManager for SharePoint and Governance Automation, a

    SnapManager for SharePoint update specific to Governance Automation must be manually installed.

    In the Governance Automation installation package ZIP file, you will see the

    SMSP_Update_for_Governance_Automation_1.5.2.zip file. Follow the instructions below to install the

    SnapManager for SharePoint update:

    1. Log into SnapManager for SharePoint Manager and navigate to Control Panel > Update Manager.

    2. On the Manage Updates interface, click Browse. Find and load the SMSP_Update_for_Governance_Automation_1.5.2.zip file into SnapManager for SharePoint Manager.

    3. Click Install on the ribbon. In the Server Selection pop-up window, all available Manager services are shown in the Manager tab and all available farms are shown in the Agent tab.

    4. On the Manager tab, select the Install the update for all the managers below checkbox. The update will be installed on all of the Manager services.

    5. On the Agent tab, select the Agent services you want to update.

    6. Click Install. The progress displays in the Status column. After the installation completes, a message appears indicating that the installation was successful.

    7. Click Finish.

  • 36

    DocAve Governance Automation

    8. To verify that the update was successful, navigate to Control Panel > Update Manager > View History and check the Version column of the newly installed update.

    Installing Governance Automation via the Installation Wizard

    After installing the DocAve update, complete the following steps to configure Governance Automation

    Installation Wizard:

    1. Locate the DocAve Governance Automation directory. Double-click the Setup.exe file.

    2. A window appears to remind you to install the DocAve or SnapManager for SharePoint update. This update can be installed before or after your Governance Automation installation. For more information on installing the update, refer to Installing the DocAve Update for Governance Automation or Installing the SnapManager for SharePoint Update for Governance Automation. Click OK to proceed with the installation.

    3. In the Welcome screen, choose to install DocAve Governance Automation in English, Japanese or French by selecting the language pack from the drop-down menu, then click Next.

    4. Enter your Name and Organization into the provided field. Click Next.

    5. Carefully review the Governance Automation License Agreement. After you have read the agreement, check the I accept the terms in the license agreement checkbox, and click Next.

    6. By default, Governance Automation will be installed in C:\Program Files\AvePoint. To change this location, click Browse. Click Next.

    7. Set up the Service Configuration:

    a. DocAve Control Service Address ‒ Configure the DocAve Control Service Host and the DocAve Control Service Port.

    DocAve Control Service Host ‒ Enter the hostname or IP address of the machine where DocAve Control Service is installed.

    DocAve Control Service Port ‒ Enter the DocAve Control Service port number used to communicate with DocAve Control Service. The default port number is 14000.

    b. Governance Automation Host – Enter the hostname or IP address of the machine where Governance Automation will be installed.

    c. IIS Web Site Settings ‒ Configure the IIS Web site settings for the Governance Automation. You can select to use an existing IIS Web site or create a new IIS Web site. The IIS Web site is used to access Governance Automation.

    Use an existing IIS web site ‒ Select an existing IIS Web site from the drop-down list, and if necessary, you can adjust the Web Site Port used to access the Governance Automation.

    Create a new IIS web site ‒ Enter the Web site name for creating a new IIS Web site for Governance Automation. The default Web Site Port number used to access Governance Automation is 15000, you do not need to change it unless a known port conflict exists.

  • 37

    DocAve Governance Automation

    Web Site Port ‒ Enter the port number for Governance Automation communication. The default port number is 15000.

    d. Application Pool Settings ‒ Configure the IIS application pool that will collect and manage requests that are sent to the Web site configured in the step above. You can select an existing application pool or create a new application pool.

    Use an existing application pool ‒ Select an existing application pool from the drop-down list. If you choose to use an existing application pool, the Application Pool Account settings are greyed out and cannot be changed.

    Create a new application pool ‒ Enter the application pool name and application pool account settings to create a new IIS application pool for the corresponding Web site. In the Application Pool Account field, enter the username and password for the account.

    *Note: For the required permissions of the application pool account, refer to Required Permissions for Governance Automation Service Accounts.

    e. Governance Automation Workflow Service – The Governance Automation Workflow service is a local service that needs to be manually started before Governance Automation can be used. Configure the Workflow Service Port and Service Account.

    Work