Case and Matter contains three SharePoint solution files (.wsp) that must be added and deployed to the SharePoint server. These solutions are:
- MacroView DMF (Document Management Framework)
- MacroView UDN (Unique Document Numbering) and AOI (Advanced Office Integration)
- MacroView EDS (Enhanced Document Security)
You must have a Help Centre account and hold an evaluation or full license for MacroView Case and Matter to proceed with this guide. Click on the headings below to get started.
Overview
- Ensure your environment meets the essential prerequisites
- Download the MacroView DMF solution
- Add and deploy the MacroView DMF solution
- Activate your MacroView licences
- Enable the MacroView DMF search feature on your web application
1.1 Essential prerequisites
Before starting the installation process, make sure your SharePoint environment meets the following prerequisites:
- 'Allow Anonymous' access must be disabled
- Users must have a minimum of read access permission to the root site collection for each web application
- The application pool account for the SharePoint content store will require write access to the Windows temp folder, by default this path is C:\Windows\temp
1.2 Download the MacroView DMF solution
- Download the version of DMF Server that corresponds to your version of Microsoft SharePoint Server from the downloads site.
- If you cannot access the download site, please see the following knowledge base article for more information: Why don't I see all the downloads I expect to see?
1.3 Add and deploy the MacroView DMF solution
Preparation
- Log on to the server as a Farm Administrator (Note: a Domain Administrator may not be a farm administrator).
- Click Start, search for SharePoint Management Shell, right-click it and select Run as administrator.
Adding the solution
- On your SharePoint server, unzip the MacroView DMF solution file (MacroViewDMFServer.zip) and copy 'macroview dmf.wsp' to the folder 'c:\temp'.
- In the SharePoint Management Shell, type the following command to add the solution to your SharePoint server:
- Add-SPSolution -LiteralPath "c:\temp\macroview dmf.wsp"
Deploying the solution
Now that MacroView DMF has been added to your SharePoint server, it is now ready to be deployed.
You can deploy the solution using the SharePoint Central Administration interface or the SharePoint Management Shell.
Central Administration (SharePoint browser interface):
- Launch the SharePoint Central Administration console.
- Click System Settings. Under the Farm Management heading choose Manage Farm Solutions.
- On the Solution Management page, select MacroView DMF.wsp and deploy the solution.
- Select a time to deploy the solution.
PowerShell (command line interface):
- Install-SPSolution -Identity "MacroView DMF.wsp" –GACDeployment
Above: MacroView DMF solution deployed on SharePoint Server 2013
1.4 Activate your MacroView licences
MacroView product licences are managed by a licence activation web service running on a central MacroView server. Before it can be used from a client workstation the newly installed MacroView DMF web service must be activated.
There are two methods of activation depending on whether the server has internet connectivity or not. The easiest way to activate your licence is through online activation.
Online licence activation
If your SharePoint server has internet connectivity:
- Open the SharePoint Central Administration console.
- Select System Settings. Under MacroView Licensing, click Manage product licensing.
- Click Online Activation.
- Enter your licence key and click Next.
- Select your products to activate and click Finish.
Above: Select all MacroView products to activate on your server
Offline licence activation
If your SharePoint server does not have internet connectivity:
Step 1: Get an Activation Request file
- On the SharePoint Server, open the SharePoint Central Administration console.
- Select System Settings. Under MacroView Licensing, click Manage product licensing.
- Select Offline Activation.
- Click the Generate Activation Request button - this file is needed in the next step. Click Save when prompted to download the activation request file.
- Copy the downloaded file and move it to a computer with internet access.
Step 2: Get your licence key file
- Using a different computer that is connected to the internet, go to http://www.macroview.com.au/licensing/
- On this page, enter your licence key and upload your Activation Request file generated in step 1, then click Next.
- You will then be prompted to save a licence (XML) file to your machine.
- Copy this licence file and save it to your SharePoint server.
Above: The MacroView licensing site requires you to enter your licence key and activation request file
Step 3: Activate your server
- On your SharePoint server, go back to System Settings > Manage product licensing > Offline activation.
- In the Licence key file area, Browse to the location where you saved your licence (XML) file, select it then click Open.
- The file/file path will now appear in the browse box. Click OK to proceed with the licence activation.
Above: Upload your license key file then click OK to activate your software
Understanding your MacroView licence
It's important to remember that your MacroView licence is not tied to an individual user, but to your:
-
Server farm for SharePoint Server (on-premises), and/or
-
SharePoint Online tenancy, for SharePoint Online (Office 365)
This means that your SharePoint environment only needs to be licensed with MacroView once, and the amount of users able to connect are limited by the amount of user seats your organisation has purchased.
1.5 Enable the MacroView DMF search feature on your web application
MacroView DMF allows you to perform Keyword and Email metadata based searches from within Outlook or MacroView DMF Explorer.
Remember: SharePoint search will only return results once a full search crawl has been performed on your SharePoint server. See this Microsoft Support article to learn more about SharePoint search crawls.
To activate the DMF Search feature:
- On your SharePoint server, open SharePoint Central Administration and navigate to Application Management > Manage web applications
- Select your Web Application and click Manage Features in the ribbon menu
Above: Manage Features button in the Web Applications ribbon
- In the Manage Web Application Features window, find MacroView DMF Search and click Activate to enable the feature.
Overview
- Download the MacroView UDN solution
- Add and deploy the MacroView UDN solution
- Activate your UDN licence
- Create the UDN service application
- Set up your numbering schema
- Activate site collection features
2.1 Download the MacroView UDN solution
- Download the version of UDN Server that corresponds to your version of Microsoft SharePoint Server from the downloads site.
- If you cannot access the download site, please see the following knowledge base article for more information: Why don't I see all the downloads I expect to see?
2.2 Add and deploy the MacroView UDN solution
Preparation
- Log on to the server as a Farm Administrator (Note: a Domain Administrator may not be a farm administrator).
- Click Start, search for SharePoint Management Shell, right-click it and select Run as administrator.
Adding the solution
- On your SharePoint server, unzip the MacroView UDN solution file (MacroViewUDNServer.zip) and copy 'macroview unique document numbering.wsp' to the folder 'c:\temp'.
- In the SharePoint Management Shell, type the following command to add the solution to your SharePoint server:
- Add-SPSolution -LiteralPath "c:\temp\macroview unique document numbering.wsp"
Deploying the solution
You can deploy the solution using the SharePoint Central Administration interface or the SharePoint Management Shell.
Central Administration (SharePoint browser interface):
- Launch the SharePoint Central Administration console.
- Click System Settings. Under the Farm Management heading choose Manage Farm Solutions.
- On the Solution Management page, select Macroview Unique Document Numbering.wsp and deploy the solution.
- Select a time to deploy the solution.
PowerShell (command line interface):
- Install-SPSolution -Identity "macroview unique document numbering.wsp" –GACDeployment
To check that the UDN service has started:
- Go to the SharePoint Central Administration console.
- Under the heading System Settings, click Manage services on this server.
- Find the MacroView UDN Service and verify that the status is Started.
2.3 Activate your MacroView UDN licence
Ensure that MacroView Unique Document Numbering has been selected and activated in the MacroView product licensing page. Refer to section 1.4 of Install DMF Server above for more information.
2.4 Create the UDN service application
To create a new UDN service application:
- Go to the SharePoint Central Administration console.
- Under Application Management, select Manage Service Applications
- In the Service Applications ribbon menu, select New > MacroView UDN Service Application
- A new window will appear prompting you to specify details for the new UDN application. If you are unsure about what values to enter, we recommend the following:
- Service Application Name: MacroView UDN
- Database Server: Leave as default value
- Database Name: MacroView UDN
- Database authentication: Windows Authentication
- Application pool (Create new application pool): MacroView UDN
- Default Proxy Group: Tick 'Add to default proxy group'
- Click OK to create the UDN Service Application.
Once created, the service application will appear in the list.
2.5 Set up your numbering schema
Once the UDN application has been created, you will need to set up your unique numbering schema. This schema will control the numbering format given to document IDs in your nominated site collections.
To set up your numbering schema:
- Go to SharePoint Central Administration > Manage Service Applications and click the name of the UDN Service Application (e.g. MacroView UDN in the example above).
- On the Manage Unique Numbering page, click New Scheme.
- A new window will appear prompting you to enter the scheme, numbering and reference formats for your new UDN schema. To see the full list of format options, see Section 3.5 in the UDN Administration Guide available on the downloads site.
Above: Example unique document schema for MacroView UDN
2.6 Activate site collection features
Now that the MacroView UDN solution has been deployed and the service configured, you are now ready to add the UDN service to a SharePoint site collection
Tip: You must have SharePoint site Collection Administrator permissions to proceed.
To add MacroView UDN to your site collection:
- Go to your site collection in the SharePoint browser (e.g. http://macroview/sites/legal)
- Click the Settings cogwheel in the top-right corner and select Site Settings.
- Under the heading Site Collection Administration, select Site collection features.
- Activate the following features: Document ID Service and MacroView UDN Provider.
- Go back to Site Settings and select the option Unique Numbering Scheme under the Site Collection Administration heading.
- Choose your desired numbering scheme from the drop down menu provided. The option(s) in the drop down menu will reflect the scheme(s) you made in the previous step.
- Click OK to save your preferred numbering scheme.
You have now finished setting up MacroView UDN on your site collection.
Adding UDN to other site collections
To add this schema to other site collections in the future you will only need to complete the step Activate site collection features, since the service and schema has already been deployed on the server.
Overview
- Download the MacroView EDS solution
- Add and deploy the solution
- Activate your EDS licence
- Activate the web application feature
- Manage document security settings
3.1 Download the MacroView EDS solution
- Download the version of EDS Server that corresponds to your version of Microsoft SharePoint Server from the downloads site.
- If you cannot access the download site, please see the following knowledge base article for more information: Why don't I see all the downloads I expect to see?
3.2 Add and deploy the MacroView EDS solution
Preparation
- Log on to the server as a Farm Administrator (Note: a Domain Administrator may not be a farm administrator).
- Click Start, search for SharePoint Management Shell, right-click it and select Run as administrator.
Adding the solution
- On your SharePoint server, unzip the MacroView EDS solution file (MacroViewEDSServer.zip) and copy 'MacroView Enhanced Document Level Security.wsp' to the folder 'c:\temp'.
- In the SharePoint Management Shell, type the following command to add the solution to your SharePoint server:
- Add-SPSolution -LiteralPath "c:\temp\macroview enhanced document level security.wsp"
Deploying the solution
- Launch the SharePoint Central Administration console.
- Click System Settings. Under the Farm Management heading choose Manage Farm Solutions.
- On the Solution Management page, select Macroview Enhanced Document Level Security.wsp and deploy the solution.
- Select a time to deploy the solution.
3.3 Activate your EDS licence
Ensure that MacroView Enhanced Document Level Security has been selected and activated in the MacroView product licensing page. Refer to section 1.4 of Install DMF Server above for more information.
3.4 Activate the web application feature
- On your SharePoint server, open SharePoint Central Administration and navigate to Application Management > Manage web applications
- Select your Web Application and click Manage Features in the ribbon menu
Above: Manage Features button in the Web Applications ribbon
- In the Manage Web Application Features window, find MacroView Document Security - Core and click Activate to enable the feature.
3.5 Manage document security settings
- Go to the Central Administration Console and select Application Management.
- Under the MacroView Document Security heading, select Settings.
- Select your web application on the top-right side of the window.
- In the Document Security group, add a user group to give full control over all secured documents.
Summary
The three MacroView server components included with Case and Matter have been successfully added, deployed and configured on your server.
The next article will walk through installing the Case and Matter client software on your local Windows machine.