MacroView ClauseBank Version 8.2

Size: px

Start display at page:

Download "MacroView ClauseBank Version 8.2"

Alexander Luke Little
6 years ago
Views:

1 MacroView ClauseBank Version 8.2 Effective: April 2016 MacroView Business Technology Pty Limited ACN ABN Level 12, 171 Clarence Street Sydney NSW 2000 Australia GPO Box 5149 Sydney NSW 2001 Australia Telephone Facsimile info@macroview.com.au Web

2 Purpose of this document This document describes the functionality and intended usage of MacroView ClauseBank. It is also a guide for Administrators responsible for the maintenance of MacroView ClauseBank. Legal Notice Disclaimer Trademarks Copyright MacroView ClauseBank and components are produced and licensed by MacroView Business Technology Pty Limited (MacroView). This guide contains material that is copyright to MacroView. It should not be copied or otherwise reproduced without express permission from MacroView. Every precaution has been taken in the preparation of this documentation however; MacroView assumes no responsibility for errors or omissions, or for damages resulting from the use of the information contained herein. MacroView and MacroView ClauseBank are registered trademarks of MacroView Business Technology Pty Limited in Australia, USA, Canada and all countries that are signatories to the Madrid convention. Microsoft, Microsoft PowerPoint, Microsoft Word, Microsoft Outlook and Microsoft SharePoint are trademarks of Microsoft Corporation MacroView Business Technology Pty Limited. Effective: April 2016

3 Contents 1 Introduction Technical Requirements Workstations Servers SharePoint Online (Office 365) ClauseBank Server Installation Summary Essential Environment Prerequisites Upload & Deploy the MacroView ClauseBank Solution SharePoint Server Farm with Multiple Front-End Servers Installation Steps Activate the MacroView ClauseBank License Online License Activation Offline License Activation Repurposing a License Key Enable the ClauseBank Expiry Job Enable ClauseBank Usage Logging Activate ClauseBank on a Site Collection MacroView ClauseBank Core Feature MacroView ClauseBank Feature Creating a ClauseBank Site SharePoint MacroView ClauseBank Feature Creating a ClauseBank Site SharePoint Creating a ClauseBank Site SharePoint ClauseBank site won t be visible in Office until after Search Service updates Creating Clauses Libraries SharePoint 2007 and SharePoint SharePoint Activating ClauseBank for use on SharePoint Online (Office 365) License Activation and Renewal Activating a new license key or Office 365 tenancy Activating and deactivating a product license Renewing a product license Registering a new account Restricted Functionality with SharePoint Online (Office 365) Installing the MacroView ClauseBank Client Summary Installation Steps Automated Installation Ensure that.net Framework is installed Windows 7/8 or Vista Ensure that.net Programmability for Microsoft Office is available Microsoft Office Microsoft Office Microsoft Office Ensure that Visual Studio Tools for Office (VSTO) is installed Run MacroView ClauseBank Setup Add a ClauseBank content source Automating the Client Installation Active Directory Publish and Assign with Group Policy Group Policy Configuration Upgrading MacroView ClauseBank Effective: April 2016

4 6.1 Server Upgrade Prepare ClauseBank Sites Retract MacroView ClauseBank Solution Delete MacroView ClauseBank Solution Add and Deploy MacroView ClauseBank Solution Update ClauseBank Sites Client Upgrade Install MacroView ClauseBank Client Re-Activating a MacroView ClauseBank License Re-Run the MacroView Activation feature See Section View your MacroView License details Removing MacroView ClauseBank Software Removing MacroView ClauseBank Server Retract MacroView ClauseBank Solution Delete MacroView ClauseBank Solution Removing MacroView ClauseBank Client Windows 8, Windows 7 or Vista Effective: April 2016

5 1 Introduction MacroView ClauseBank makes it easy to publish, retrieve and insert frequently needed standard text and graphics into your Word documents and Outlook messages. It also supports the retrieval and insertion of slides and graphics into a Microsoft PowerPoint presentation. Whether you generate sales proposals, financial plans, legal documents or general correspondence, ClauseBank makes Word, Outlook and PowerPoint more productive. All organisations have standard text and graphics that are frequently required for inclusion in documents being generated. With MacroView ClauseBank this material is published in a convenient central SharePoint website. This site can be accessed over any internet connection, which means that all staff, regardless of their location, can have convenient and immediate access to the latest standard material. MacroView ClauseBank ensures that only up to date material is retrieved from this central SharePoint website. The automatic Expiry Alert 1 feature of MacroView ClauseBank assists in maintaining the content so that it is up to date. MacroView ClauseBank eliminates the time wasted in searching for material in previously generated documents and the risk of using an out-of-date copy. Clauses can contain MacroView Precedent mark-up tags and can be used in conjunction with MacroView Precedent. MacroView ClauseBank is the result of MacroView s extensive experience with the development of custom document automation solutions for some of Australia s leading banks, law firms and many other organisations. This is combined with leading technical skills in Microsoft Office and Microsoft SharePoint. 1 MacroView ClauseBank Expiry Alert feature is only available for on-premises SharePoint servers Effective: April 2016 Page 1

6 2 Technical Requirements 2.1 Workstations MacroView ClauseBank Client can run on workstations with: Microsoft Windows Vista or Windows 7/8.x (64 bit recommended) Microsoft Office 2007, Office 2010 & Office 2013 (with Office Programmability enabled) Microsoft Internet Explorer 8 or above. Workstations running Office 2007 also require: Microsoft.NET Framework 4.0 SP1 Visual Studio Tools for Office (VSTO) 4.0 Microsoft Office 2007 PIAs Workstations running Office 2010 also require: Microsoft.NET Framework 4.0 SP1 Visual Studio Tools for Office (VSTO) 4.0 Microsoft Office 2010 PIAs Workstations running Office 2013 also require: Microsoft.NET Framework 4.0 SP1 Visual Studio Tools for Office (VSTO) 4.0 Microsoft Office 2013 PIAs 2.2 Servers MacroView ClauseBank Server 2 can run on servers with: Microsoft Windows Servers 2003, 2003 R2, 2008, 2008 R2 (x86 or x64), and 2012 With any of: Microsoft Office SharePoint Server 2007 (MOSS 2007) Microsoft SharePoint Server 2010 Microsoft SharePoint Foundation 2013 Microsoft SharePoint Server SharePoint Online (Office 365) When performing an upgrade, the server will need to be updated prior to any of the clients. Running an old server version with a newer client is definitely not recommended. Unexpected results and errors will occur. The MacroView ClauseBank client software can be used with SharePoint Online (Office 365) or on-premises servers without the server component installed, provided the MacroView ClauseBank license has been activated for use with SharePoint Online (Office 365) (refer section 4). 2 MacroView ClauseBank Server cannot be installed on SharePoint Online (Office 365). Effective: April 2016 Page 2

7 3 ClauseBank Server Installation Note: This is not required for use with SharePoint Online (Office 365) servers. Refer to section 4 for information on activating MacroView ClauseBank for use with SharePoint Online (Office 365). The steps in this section must be performed using the account that the SharePoint Farm was setup with or an account with membership to all of the following: 1. Local Administrators group on every WFE 2. SharePoint Farm Administrators group 3. The db_owner role for the Config Database (2007 only) 4. The SharePoint_Shell_Access role on the Configuration Database (2010 only) 3.1 Summary Ensure that the essential environment prerequisites are in place Upload & Deploy the MacroView ClauseBank Solution Activate the MacroView ClauseBank License Enable ClauseBank features Create a sample ClauseBank site 3.2 Essential Environment Prerequisites By default in a SharePoint installation Allow Anonymous is not enabled for the SharePoint web site. For correct operation of MacroView ClauseBank, Allow Anonymous must NOT be enabled. Should you require anonymous access, create a secondary web application in SharePoint which maps (extends) to the same content store. 3.3 Upload & Deploy the MacroView ClauseBank Solution MacroView ClauseBank uses a custom.net web service to extend the capabilities of Microsoft SharePoint. This custom web service and other MacroView ClauseBank Server components are shipped as part of a SharePoint Solution. This Solution needs to be uploaded and activated SharePoint Server Farm with Multiple Front-End Servers In cases where there are multiple front-end web servers in a SharePoint server farm, the MacroView ClauseBank Solution can be installed on any front-end server. Once deployed, the MacroView ClauseBank Features will automatically be available on all SharePoint Servers in the Farm Installation Steps On the SharePoint server: Unzip the MacroViewClauseBankServer.zip file to the c:\temp folder on the SharePoint server Before executing the installation script you must first navigate to the appropriate location for your version of SharePoint. If you have MOSS 2007 navigate to the folder: C:\program files\common files\microsoft shared\web server extensions\12\bin If you have SharePoint Server 2010 navigate to the folder: C:\program files\common files\microsoft shared\web server extensions\15\bin Effective: April 2016 Page 3

8 If you have SharePoint Server 2013 navigate to the folder: C:\program files\common files\microsoft shared\web server extensions\15\bin Execute the following command: stsadm -o addsolution -filename "c:\temp\macroview ClauseBank.wsp" Launch the SharePoint Central Administration Console If you have MOSS 2007 then select the Operations tab and under Global Configuration select Solution Management If you have SharePoint Server 2010 select System Settings on the left and then select Manage Farm Solutions under the Farm Management heading If you have SharePoint Server 2013 select System Settings on the left and then select Manage Farm Solutions under the Farm Management heading Within the Solution Management page select MacroView ClauseBank.wsp and deploy the MacroView ClauseBank Solution Select a convenient time to deploy the solution 3.4 Activate the MacroView ClauseBank License Licence keys are issued on an organisation basis. A single licence key may be used multiple times on different SharePoint farms. The activation process need only be run once per SharePoint farm. Each time the activation process is run any number of MacroView products can be licenced on that SharePoint farm. If a product expires and the license renewal has been paid, the activation process must be re-run to update SharePoint with the new expiry date. See section 7 for details on how to re-activate a MacroView ClauseBank Server license to extend this Expiry Date (e.g. following payment for licenses or license renewal). Activating a product will record license key details in the configuration database for the SharePoint Farm. The license key contains (in encrypted form) your Customer Details, License Expiry Date and Licensed Seat Count Online License Activation Open the SharePoint Central Administration console If you have MOSS 2007 select the Operations tab and under MacroView Licensing select Manage product licensing If you have SharePoint Server 2010, select System Settings on the left and under MacroView Licensing click on Manage product licensing If you have SharePoint Server 2013, select System Settings on the left and under MacroView Licensing click on Manage product licensing Click Online Activation Enter your License Key and click Next Select your Product (MacroView ClauseBank) and click Finish Offline License Activation Open the SharePoint Central Administration console If you have MOSS 2007 select the Operations tab and under MacroView Licensing, select Manage product licensing Effective: April 2016 Page 4

9 If you have SharePoint Server 2010, select System Settings on the left and under MacroView Licensing click on Manage product licensing If you have SharePoint Server 2013, select System Settings on the left and under MacroView Licensing click on Manage product licensing Click Offline Activation Click Generate Activation Request and save the Request (XML) file On a computer with internet connectivity navigate to Enter your Licence Key and attach the Request file you just saved Click the green arrow and save the Activation (XML) file Go back to the SharePoint Central Administration console and upload the Activation file Figure 1: MacroView License Activation Page - Upload Repurposing a License Key License keys are used to activate one or more of our products on a SharePoint server farm. If you wish to split up the products you have purchased across multiple server farms this can be done by deactivating an individual product on one farm and activating it on another using the same license key. For instructions on how to do this please contact MacroView Support. 3.5 Enable the ClauseBank Expiry Job MacroView ClauseBank generates and sends automatic alerts when clauses are made subject to expiry. This process is handled by the ClauseBank Expiry Job which is installed as a Web Application Feature. Launch the SharePoint Central Administration Console. Select the Application Management tab Under the SharePoint Web Application Management heading select Manage Web Application features. Select the correct web application. Activate the MacroView ClauseBank Expiry Job for each Web Application that will contain ClauseBank sites. Figure 2: Manage Web Application Features Page Effective: April 2016 Page 5

3.6 Enable ClauseBank Usage Logging MacroView ClauseBank can optionally record clause usage information for all ClauseBanks in your server farm.

10 3.6 Enable ClauseBank Usage Logging MacroView ClauseBank can optionally record clause usage information for all ClauseBanks in your server farm. This information is captured to a ClauseBank Usage list in SharePoint Central Administration. To enable clause usage logging for a Web Application: Launch the SharePoint Central Administration Console Select Application Management Under the SharePoint Web Application Management heading select Manage Web Application features Select the correct web application Activate the MacroView ClauseBank Usage Logging feature for the selected Web Application Figure 3: Manage Web Application Features Page Note: On activation, the MacroView ClauseBank Usage Logging feature will verify that a ClauseBank Usage list exists in the SharePoint Central Administration site and create it if necessary. The feature will also grant the application pool account of the selected Web Application contribute access to this list. The ClauseBank Usage list can be accessed by clicking the Clause Usage Log link under the MacroView ClauseBank heading on the Application Management page. 3.7 Activate ClauseBank on a Site Collection The MacroView ClauseBank Solution contains a site collection feature and a site feature that support the proper operation of MacroView ClauseBank sites. These features deploy the following resources to the site collection: Clause, Word Clause, PowerPoint Clause, Placeholder Clause (content types) Clause Library (list definition) ClauseBank Sample Site (site template) Clause Expiry Event Receiver MacroView ClauseBank Core Feature This Feature adds a ClauseBank Sample Site template and Content Types that are required by MacroView ClauseBank and must be activated for any ClauseBank Site Collections: Ensure that you are logged in as a Site Collection Administrator. Using Internet Explorer, navigate to a SharePoint site collection e.g. Select Site Actions, Site Settings Click on Site Collection Features Activate the MacroView ClauseBank Core feature. Effective: April 2016 Page 6

Figure 4: Site Collection Features Page 3.7.2 MacroView ClauseBank Feature This feature adds the Clause Library list definition to a SharePoint site and enables the Clause Expiry event receiver.

11 Figure 4: Site Collection Features Page MacroView ClauseBank Feature This feature adds the Clause Library list definition to a SharePoint site and enables the Clause Expiry event receiver. The event receiver automatically sets the expiry date for a clause when an update frequency is specified. Note: The steps below require the MacroView ClauseBank Core site collection feature to be activated (outlined in section 3.7). Using Internet Explorer, navigate to the SharePoint ClauseBank site e.g. Select Site Actions, Site Settings and Site Features. Activate the MacroView ClauseBank site feature. Figure 5: Site Features Page 3.8 Creating a ClauseBank Site SharePoint 2007 Using Internet Explorer, navigate to a SharePoint site e.g. Select Site Actions, Site Settings and the Sites and Workspaces link Click on the Create link and ensure that the phrase ClauseBank is used within both the Title and URL name fields Select the ClauseBank Sample Site template (located within the Custom tab) and then click the OK button Figure 5: New SharePoint Site Page Effective: April 2016 Page 7

Ensure that read permissions (or higher) are granted to ALL potential ClauseBank users. 3.8.

The event receiver automatically sets the expiry date for a clause when an update frequency is specified.

12 Ensure that read permissions (or higher) are granted to ALL potential ClauseBank users MacroView ClauseBank Feature This feature adds the Clause Library list definition to a SharePoint site and enables the Clause Expiry event receiver. The event receiver automatically sets the expiry date for a clause when an update frequency is specified. Note: The steps below require the MacroView ClauseBank Core site collection feature to be activated (outlined in section 3.7). Using Internet Explorer, navigate to the SharePoint ClauseBank site e.g. Select Site Actions, Site Settings and Site Features. Activate the MacroView ClauseBank site feature. Figure 6: Site Features Page 3.9 Creating a ClauseBank Site SharePoint 2010 Using Internet Explorer, navigate to a SharePoint site e.g. Select Site Actions, Site Settings and click on Solutions under the Galleries heading. Click on the Solutions tab and select Upload Solution Effective: April 2016 Page 8

above Go to site actions and then click on New Site.

13 Browse to the ClauseBank Site.wsp file on your PC and upload it. Note: This wsp file is available on the ClauseBank download site Now select the solution and click Activate on the ribbon above Go to site actions and then click on New Site. From here you will be able to pick the ClauseBank sample site To make this template available in SharePoint 2010 it must be added to the Page Layout and Site Template Settings Page. This page is located in Site Settings. Effective: April 2016 Page 9

14 Effective: April 2016 Page 10

3.10 Creating a ClauseBank Site 3.10.1 SharePoint 2013 Using Internet Explorer, download the following ClauseBank site template for

$zi p Extract to C:\temp Navigate to the ClauseBank site Select Site Settings and then select Solutions Upload the solution from$

15 3.10 Creating a ClauseBank Site SharePoint 2013 Using Internet Explorer, download the following ClauseBank site template for SharePoint 2013 from Amazon p Extract to C:\temp Navigate to the ClauseBank site Select Site Settings and then select Solutions Upload the solution from c:\temp and Activate Figure 6: Upload the ClauseBankSampleSiteTemplate solution in SharePoint 2013 Figure 7: Browse for the solution in C:\Temp Effective: April 2016 Page 11

within the Custom tab) and then click the OK button.

16 Figure 8: Activate the solution in SharePoint 2013 Now create your ClauseBank site Go to Site Settings, Sites and Workspaces, and Create Fill in the Title and URL Select the ClauseBank Sample Site template (clausebanksp13 - located within the Custom tab) and then click the OK button. If the template is missing go back to Solutions above and check it is activated. Figure 9: Select the ClauseBank site template under Custom in SharePoint 2013 Effective: April 2016 Page 12

Figure 10: SharePoint 2013 Sample ClauseBank site with sample Clause Libraries Ensure that read permissions (or higher) are granted to ALL potential ClauseBank users. 3.10.2 ClauseBank site won t be visible in Office until after Search Service updates 3.

17 Figure 10: SharePoint 2013 Sample ClauseBank site with sample Clause Libraries Ensure that read permissions (or higher) are granted to ALL potential ClauseBank users ClauseBank site won t be visible in Office until after Search Service updates 3.11 Creating Clauses Libraries Note that in the Word, Outlook, or PowerPoint your new ClauseBank site won t be visible until the SharePoint search service has indexed the site. On most sites this will only be a few minutes to half an hour but check with your administrator if it isn t visible to users after half an hour. [And make sure the users have at least read permission to the site] SharePoint 2007 and SharePoint 2010 Using Internet Explorer, navigate to the ClauseBank site and add a Clauses document library. Select Site Actions and then Site Settings. Under the Site Administration heading select Site Libraries and Lists and then Create New Content. Select the Clause Library template Ensure that the Name field ends with the text Clauses or Slides and then select Create. Effective: April 2016 Page 13

Select Settings and then Document Library settings. Find and select the column named Category.

18 Figure 7: New Document Library Page in SharePoint 2007 Figure 8: New Document Library Page in SharePoint 2010 Browse to the newly created Clauses document library using Internet Explorer. Select Settings and then Document Library settings. Find and select the column named Category. Enter the category choices for this clause library into the Type each choice on a separate line: field and select OK. Effective: April 2016 Page 14

Figure 9: Change Column Page in SharePoint 2007 Figure 10: Change Column Page in SharePoint 2010 Note: Categories for a Clauses or Slides library must be populated for MacroView ClauseBank to

19 Figure 9: Change Column Page in SharePoint 2007 Figure 10: Change Column Page in SharePoint 2010 Note: Categories for a Clauses or Slides library must be populated for MacroView ClauseBank to function correctly SharePoint 2013 Using Internet Explorer, navigate to the ClauseBank site and add a Clauses document library. Site Settings and then Site Libraries and Lists. Select Create New Content and Add an app. Find and select Clause Library template. Ensure that the Name field ends with the text Clauses and then select Create. Effective: April 2016 Page 15

Alternatively, navigating to the ClauseBank site, select Site Contents and Add an App. Select the Clause Library template and ensure the Name field ends with the text Clauses and then select Create.

20 Alternatively, navigating to the ClauseBank site, select Site Contents and Add an App. Select the Clause Library template and ensure the Name field ends with the text Clauses and then select Create. Figure 14: New Document Library in SharePoint 2013 Browse to the newly created Clauses document library using Internet Explorer. Select Library and then Library Settings. Find and select the Column named Category. Enter the category choices for this clause library into the Type each choice on a separate line: field and select OK. Figure 15: Change Column Page in SharePoint 2013 Note: Categories for a Clauses library must be populated for MacroView ClauseBank to function correctly. Effective: April 2016 Page 16

4 Activating ClauseBank for use on SharePoint Online (Office 365) No MacroView DMF server components are installed when using MacroView ClauseBank with Office 365 / SharePoint Online.

21 4 Activating ClauseBank for use on SharePoint Online (Office 365) No MacroView DMF server components are installed when using MacroView ClauseBank with Office 365 / SharePoint Online. In order to use MacroView ClauseBank to access Office 365 / SharePoint Online tenancies, organisations first need to associate their MacroView license with their Office 365 tenancy via the MacroView Licensing Website. Once license association is complete all that is required is the installation of the MacroView DMF or MacroView Message client software. MacroView Licensing Website The MacroView Licensing website provides access to the MacroView Knowledgebase, Download site and information on MacroView Services that will ensure you get the most out of you MacroView deployment. Figure 11: MacroView Licensing Site ( If you are already logged in to the MacroView Licensing site, you can simple click View Licenses. If you are not yet logged in click Log in, then select the appropriate option to log in with any of your Office 365, Microsoft or Google account credentials. 4.1 License Activation and Renewal Figure 12: MacroView Licensing site login page showing account options If the account used has not already been associated with a MacroView License Key you will need to first register a new account (refer to serction 4.2) The licences summary page lists the product name, seat count, expiry date and status of every MacroView product associated with your account that is licensed for use on SharePoint Online (Office 365). Effective: April 2016 Page 17

22 Figure 13: MacroView License page showing current license status From this screen you can: Activate a new license key or Office 365 tenancy licence. Activate or deactivate a products Renew a product license Activating a new license key or Office 365 tenancy If you need to activate and additional Office 365 tenancy or have been provided a new for License Key for MacroView ClauseBank from MacroView it must activated in order to use the associated products. To activate the new license key or add the Office 365 tenancy click on Activate New License. Figure 14: MacroView License page showing Add New License option Next enter the License Key and Office 365 URL then click Continue. Figure 15: Activate New License screen Effective: April 2016 Page 18

You will then be provided a list of products associated with that license or tenancy so that you can choose which products to activate. Select the required products and click Finish.

23 You will then be provided a list of products associated with that license or tenancy so that you can choose which products to activate. Select the required products and click Finish. Figure 16: Product activation page Activating and deactivating a product license To activate or deactivate product click the refresh button then select which products you wish to have activated and click OK Figure 17: MacroView Licensing product activation dialog Note: You cannot deactivate all products. At least one product license must be selected Renewing a product license 4.2 Registering a new account Following payment for additional licenses or license renewal you will need to renew your license for use on SharePoint Online (Office 365). To renew a product license click the refresh button on the license summary page, select any additional products you wish to activate and then click OK. A new account must be associated with a valid License Key which would have been provided by MacroView for MacroView ClauseBank. You must have this License Key available in order to register a new account. Note that only one account can currently be associated with each license key. To register a new account Log in on the MacroView Licensing site and select the appropriate button to register with any of your Office 365, Microsoft or Google account credentials. Effective: April 2016 Page 19

Figure 18: MacroView Licensing site login page showing account options You will then be prompted by the relevant account provider to trust the MacroView Licensing site.

24 Figure 18: MacroView Licensing site login page showing account options You will then be prompted by the relevant account provider to trust the MacroView Licensing site. You must grant this access in order to register the account. Enter the license key provided by MacroView and the Office 365 URL for the SharePoint Online (Office 365) tenancy you wish to register and click Continue. Figure19: MacroView Licensing site new account registration page Then select the products you wish to have activated from the list of products associated with the entered license key and click OK Figure 21: MacroView Licensing product activation dialog Note: At least one product license must be selected The license summary page will then be loaded showing current active licenses associated with this account. 4.3 Restricted Functionality with SharePoint Online (Office 365) When using MacroView ClauseBank with Office 365 / SharePoint Online most functionality is available, including navigating clause libraries, inserting clauses, inserting and expanding ClauseLinks, creating new clauses, and so on. However the Office 365 server cannot have MacroView ClauseBank Server Effective: April 2016 Page 20

25 installed and as a results there are some restrictions on functionality. These include: No content expiry support. No content expiry alerts to content experts No ClauseBank usage logging Navigation by categories. MacroView ClauseBank can be used to access content that is stored in libraries that do contain the MacroView ClauseBank content type provided the site has been configured to meet specific requirements. Refer to the MacroView ClauseBank Administration Guide for more information on setting up ClauseBank sites on SharePoint Online (Office 365). Effective: April 2016 Page 21

26 5 Installing the MacroView ClauseBank Client 5.1 Summary The MacroView ClauseBank Client installation is handled by a Windows Installer. MacroView ClauseBank is a.net application and relies on the Microsoft.Net Framework and.net Programmability for Microsoft Office (which in turn requires VSTO support). Note: Ensure there are no applications running on the client workstation before commencing the installation Installation Steps Login as Administrator Ensure that Microsoft.Net Framework 4.0 is installed (Office 2007/2010) Ensure that.net Programmability for Microsoft Office is available Ensure that the correct VSTO is installed Ensure that the appropriate Office PIA s are installed Run the MacroView ClauseBank Setup.exe Add a ClauseBank content source Test the client installation Automated Installation The ClauseBank installation can be automated using standard deployment techniques see section 5.7 for more details. 5.2 Ensure that.net Framework is installed Windows 7/8 or Vista The.Net Framework 2.0 should be available, as it is pre-installed The.Net Framework 3.5 (required for Office 2007 and 2010 add-ins) is not pre-installed by default for Office Ensure that.net Programmability for Microsoft Office is available MacroView ClauseBank installs customisations into Office 2007, 2010 and For this reason, MacroView relies on.net Programmability for Microsoft Office being installed and available on the client workstation. Note that.net Programmability must be installed for each Office product Word, PowerPoint and Outlook. The Manual Client Installation procedure described in section 5.4 will verify all ClauseBank client prerequisites, including.net programmability support for Microsoft Office. Effective: April 2016 Page 22

5.3.2 Microsoft Office 2007 The following screen shots shows how to determine whether.net Programmability support is available for Microsoft Word 2007.

27 5.3.2 Microsoft Office 2007 The following screen shots shows how to determine whether.net Programmability support is available for Microsoft Word Clicking on the highlighted node will cause support to be added. Figure 27: Microsoft Office Net Programmability Support Microsoft Office 2010.Net Programmability support is installed by default in Office Microsoft Office 2013.Net Programmability support is installed by default in Office Ensure that Visual Studio Tools for Office (VSTO) is installed 5.5 Run MacroView ClauseBank Setup For Office 2007 and 2010, you are required to install VSTO v4 Runtime For Office 2003, you are required to install VSTO 2005 Second Edition Runtime Download the Client installation zip file (MacroViewClauseBankClient.zip) from the MacroView website Save and unzip it to a shared location and click to run ClauseBankSetup.exe the screen shown below in Figure will appear. Note: Extract the setup files to a local location prior to executing rather than going into the zip file with windows explorer and running the setup Effective: April 2016 Page 23

net Programmability is not available, the installer will display an

28 Figure 28: First screen displayed by MacroView ClauseBank client install Click Next to proceed. If VSTO or.net Programmability is not available, the installer will display an appropriate message. Figure 29: MacroView ClauseBank Client install - Terms and Conditions screen Effective: April 2016 Page 24

ClauseBank Client install - 'Next to start' screen Figure 31: MacroView

29 The MacroView ClauseBank Client installation will next proceed automatically and display a message when complete Figure 30: MacroView ClauseBank Client install - 'Next to start' screen Figure 31: MacroView ClauseBank Client install successful Click Finish Effective: April 2016 Page 25

Note: The content sources may have already have been configured by an Administrator. Figure 20: The Content screen within ClauseBank Options.

30 5.6 Add a ClauseBank content source Before you can use ClauseBank you must first have one or more ClauseBank content sources configured. In the Content area of ClauseBank Options, you can add, edit or remove ClauseBank content resources. Note: The content sources may have already have been configured by an Administrator. Figure 20: The Content screen within ClauseBank Options. When you click the Add button the Add new source dialog displays. Figure 21: The ClauseBank Add new source dialog. If you enter a server name and address and tick the Search for ClauseBank sites option, when you click OK ClauseBank will perform a search and will Effective: April 2016 Page 26

31 5.7 Automating the Client Installation return all sites with 'ClauseBank' in the site title. If your ClauseBank source settings change, ClauseBank will refresh your ClauseBank tree-view and clear your ClauseBank tree-view cache. Organizations can use a variety of approaches to automate the deployment of MacroView ClauseBank to user workstations. In many cases this deployment will be handled by a System Management utility Active Directory Publish and Assign with Group Policy For organizations that do not have a formal deployment utility, MacroView ClauseBank recommends using the Software Installation feature of Active Directory (AD) Group Policy. By defining a new Software Installation Package that uses the MacroView ClauseBank Client MSI (available from the MacroView ClauseBank download site and will need to be extracted from the EXE file using WinZip or WinRar) an organization can perform a bulk deployment of MacroView ClauseBank. The scope of the installation Package can be defined to be either groups of users or nominated computers. Note that if you have an existing version of MacroView ClauseBank installed and used a deployment method other than Group Policy, the existing version will not be upgraded or replaced Group Policy Configuration Regardless of the method used to deploy the ClauseBank client software, MacroView ClauseBank settings can be applied across an organization by using a Group Policy Administrative Template (ADM file). An ADM file (MacroViewClauseBank.adm) is available for download from the MacroView ClauseBank Download and Installation page. This ADM provides a convenient method for specifying default SharePoint servers in the MacroView tree-view. MacroView recommends that administrators review the ADM settings in the file and configure for their organization. Note that any settings enabled in the ADM will override and lock the corresponding setup option in the MacroView ClauseBank client. Figure 32: Group Policy Configuration of MacroView ClauseBank Effective: April 2016 Page 27

32 6 Upgrading MacroView ClauseBank 6.1 Server Upgrade This is not required for use with SharePoint Online (Office 365) servers. Refer to section 4 for information on activating MacroView ClauseBank for use with SharePoint Online (Office 365) Prepare ClauseBank Sites Before upgrading the MacroView ClauseBank Server solution, the MacroView ClauseBank site feature must be deactivated in each ClauseBank site. This feature attaches the Clause Expiry event receiver to clause libraries and should not be activated while a solution upgrade is carried out. This will ensure that the event receiver is registered correctly after the upgrade is complete. Using Internet Explorer, navigate to the SharePoint ClauseBank site e.g. Select Site Actions, Site Settings and Site Features Deactivate the MacroView ClauseBank site feature Retract MacroView ClauseBank Solution Running the following command on a SharePoint server located in a SharePoint Server Farm will deactivate the MacroView ClauseBank Solution on all Web Front End servers in that Farm: stsadm -o retractsolution -name "MacroView ClauseBank.wsp" immediate or Delete MacroView ClauseBank Solution Running the following command on a SharePoint server located in a SharePoint Server Farm will remove the MacroView ClauseBank Solution from all Web Front End servers in that Farm: stsadm -o deletesolution -name "MacroView ClauseBank.wsp" override or Add and Deploy MacroView ClauseBank Solution Unzip the MacroViewClauseBankServer.zip file to the c:\temp folder on the SharePoint server. Run: stsadm -o addsolution -filename "c:\temp\macroview ClauseBank.wsp" Launch the SharePoint Central Administration Console Select the Operations tab and under Global Configuration select Solution Management Within the Solution Management page select MacroView ClauseBank.wsp and deploy the MacroView ClauseBank Solution Select a convenient time to deploy the solution Update ClauseBank Sites After the ClauseBank Server solution has been deployed, the MacroView ClauseBank site feature can be reactivated in each ClauseBank site. Using Internet Explorer, navigate to the SharePoint ClauseBank site e.g. Select Site Actions, Site Settings and Site Features Activate the MacroView ClauseBank site feature Effective: April 2016 Page 28

33 6.2 Client Upgrade Install MacroView ClauseBank Client All versions of MacroView ClauseBank prior to v8 must be removed before the new version is installed. To do this, go to Control Panel and use Programs and Features in Windows Vista/7. Unzip the MacroViewClauseBankClientx86.zip file to a local location. Run the MacroViewClauseBankClient_x86.exe and follow the upgrade prompts Effective: April 2016 Page 29

34 7 Re-Activating a MacroView ClauseBank License For information on renewing MacroView ClauseBank licenses for use on SharePoint Online (Office 365) refer to Section 4. MacroView licenses are managed by a MacroView License Activation web service running on a central MacroView ClauseBank server. When it is first installed and activated, MacroView ClauseBank will have an initial Expiry Date set to 45 days from the date the License Key was sent from MacroView. On receipt of payment for license renewals or additional licenses, MacroView will update the MacroView Licensing database and advise the relevant contact at the Customer organization. The Customer organization will then need to use the MacroView License Activation page to collect the updated Expiry Date and Licensed Seat Count details. The MacroView License Activation feature is installed as part of the MacroView ClauseBank Solution. This License Activation feature supports automatic online activation with the MacroView License Activation web service or offline activation if your SharePoint server does not have internet connectivity. 7.1 Re-Run the MacroView Activation feature See Section View your MacroView License details To view your current MacroView license information select the Operations tab and then the MacroView License Details link. This page lists your licensed products, their expiry dates and the number of licensed seats. Figure 33: MacroView License Details Page Effective: April 2016 Page 30

35 8 Removing MacroView ClauseBank Software 8.1 Removing MacroView ClauseBank Server Retract MacroView ClauseBank Solution Running the following command on a SharePoint server located in a SharePoint Farm will deactivate the MacroView ClauseBank Solution on all Web Front End servers in that Farm: stsadm -o retractsolution -name "MacroView ClauseBank.wsp" immediate Delete MacroView ClauseBank Solution Running the following command on a SharePoint server located in a SharePoint Farm will remove the MacroView ClauseBank Solution from all Web Front End servers in that Farm: stsadm -o deletesolution -name "MacroView ClauseBank.wsp" override 8.2 Removing MacroView ClauseBank Client Windows 8, Windows 7 or Vista Click Start, Control Panel, Programs and Features Select MacroView ClauseBank.NET Client, Uninstall Effective: April 2016 Page 31

MacroView Unique Document Numbering Version 5.0

MacroView Unique Document Numbering Version 5.0 Administration Guide Effective: October 2013 MacroView Business Technology Pty Limited ACN 081 117 777 ABN 29 081 117 777 Level 12, 171 Clarence Street Sydney