Vizit 4.1 Installation Guide

Transcription

1 Vizit 4.1 Installation Guide

2 Contents Running the Solution Installer... 3 Installation Requirements... 3 The Solution Installer... 3 Activating your License... 7 Online Activation... 7 Offline Activation... 8 Vizit Deployment Targeted Vizit Deployment Configuring Vizit Essential as an Embedded Viewer Adding Custom JavaScript Vizit Web Part Properties Integrating with Search Results Activating Vizit Scanning Upgrading or Removing the Solution Contact Us Phone Website Support Tips Doc Version 4.1 2

3 Running the Solution Installer The following steps describe how to install Vizit. The Installer is very easy to use, has clear instructions, and is fast. These instructions are here in case you get stuck. Remember, to install Vizit you need SharePoint Farm Administrator Access. Installation Requirements Security Access: SharePoint Server Farm Administrator Access SharePoint 2010: Foundation and Server 64-bit, four cores for small deployments 64-bit, eight cores for medium deployments Windows Server 2008 R2 SQL Server 2005 SP2 64-bit edition or SQL Server 2008 R2 64-bit edition The Solution Installer 1. Copy the Installer to any SharePoint Server that is running the Central Administration Process. Launch the installer by right clicking the icon and selecting Run as administrator. Click Next to begin. 3

4 2. The Installer will perform a System Check. If all is green, click Next to proceed. 3. Read and accept the End-User License Agreement. Click Next. 4

5 4. Select all Site Collections on which you would like to install Vizit. It is not necessary to select your Central Administration Web Application. Vizit will automatically be installed here. 5. The Installer will install the SharePoint solution on your Farm, deploy it to the Web Applications associated with the Site Collections you chose in the previous step and activate the features in those locations. 5

6 6. You will see a list of solution deployments and feature activations. Click Next. 7. Now the installation is complete. Click Close to close the Solution Installer window. Navigate to Central Administration to enter your License Key for the software. 6

7 Activating your License There are two ways you can activate your License. Online Activation is the easiest way if your SharePoint server has access to the internet. Offline Activation is necessary if your SharePoint server does not have direct access to the internet. Online Activation 1. Navigate to Central Administration. Scroll down to the Vizit Administration links. Click Manage License. 2. Enter your License Key in the Serial Number text field and select the web front end(s) you would like to activate Vizit on. Click the Activate button. 3. The system will then communicate with the licensing server to activate your software. 7

8 Offline Activation If your server is not online, use the offline activation method. Follow the instructions below to activate offline: 1. Navigate to Central Administration. Scroll down to the Vizit Administration links. Click Manage License. 2. Enter your License Key in the Serial Number text field and select the web front end(s) you would like to activate Vizit on. Click the Activate button. 3. You will then receive a message indicating your server does not have access to the internet along with instructions to follow to activate your License offline. 8

9 4. You will be prompted to download a file titled OfflineActivation.xml. Save this file to a computer that DOES have access to the internet. 5. On the computer that you saved your Offline Activation file to, navigate to flineactivation. Click the Browse button and select your OfflineActivation.xml file. Select Activate. 6. You will then be prompted to download a file titled License.xml from licensing.vizit.com. Save this file so you can access it from the machine that is displaying Vizit s Manage License page in Central Administration. 9

10 7. Return to your Central Administration Manage License page where you are activating your Vizit License. Select the Browse button in Step 5. Browse to your License.xml file and select the Upload button. 8. Your Vizit software is now licensed. Vizit Deployment After installation and activation is complete, Vizit previews and buttons will show up next to your documents in your Document Libraries and Search results for the Web Applications/Site Collections you chose during the installation process: Note: The Type column must be present in your SharePoint document library view for Vizit previews and buttons to show up. Clicking on the First Page Preview will open up the document in Vizit Essential: 10

11 The button directly to the right of Vizit Essential is Vizit Pro, a comprehensive all-in-one document management interface: 11

12 Targeted Vizit Deployment Vizit contains features to help you to customize your deployment. These features allow you to have complete and easy control over where Vizit shows up -- from your entire Farm down to a single page. They are automatically installed by default. The first is our farm-wide Vizit Everywhere feature. This feature by default is not enabled. If you would like Vizit to show up in your entire farm, you would simply enable this feature. To do this, go to Central Administration, then System Settings, then Manage Farm Features. Select Activate next to the Vizit Everywhere feature. Administrators can still disable (or re-enable) Vizit at various levels within your Farm: For Web Applications, Site Collections, and Sites, there are two complementary features: Vizit Everywhere and Disable Vizit Everywhere: Web Application (Enable/Disable) Site Collection (Enable/Disable) Site (Enable/Disable) You can activate or deactivate these features by going to your Site Actions menu > Site Settings, then either Site Collection Features under Site Collection Administration or Manage Site Features under Site Actions. For example, if Vizit Everywhere is activated at the Site Collection level, it can be turned off on a single Site of that Site Collection by activating the Disable Vizit Everywhere Feature on that particular Site: In the above example, you will first need to make sure that the Vizit Everywhere feature is not Active before activating the Disable Vizit Everywhere feature: If you would like to deploy Vizit only to a single page, it is necessary to place the Vizit Web Part onto your page. The Vizit feature must be activated in order for the Vizit Web Part to be available: After activating the Vizit feature, go to your Site Actions Menu, then Edit Page: 12

13 Click on the link to Add a Web Part. From the Categories Menu, select the Vizit folder, then select Add : A green check will appear indicating that the Vizit Web Part is correctly configured: From the Page Tab in the upper left, select the red X to exit out of edit mode: Vizit will now show up on your SharePoint page. 13

14 Configuring Vizit Essential as an Embedded Viewer In order to embed Vizit Essential to your SharePoint page, you will need to add the Vizit Web Part following the above steps under Targeted Vizit Deployment regarding deploying Vizit to a single page. After adding the Web Part and ensuring it has been correctly configured, the next step is to edit the Web Part properties. 1. In the Vizit Web Part Menu, select Edit Web Part. This will display the Vizit Web Part properties. 2. Check the Embed and Show Buttons checkboxes and enter the Height and Width for your Viewer. 3. Click Apply to save your settings. 4. Click Stop Editing in the upper left corner of your page to exit out of edit mode. Your SharePoint Page should now look similar to the following depending on what Web Part Zone you added Vizit to: 14

15 By default, the first document in your Document Library will be displayed in Vizit Essential unless you specify otherwise in the Document URL property of the Vizit Web Part. You can also uncheck the option for Show Instant Previews in SharePoint Central Administration under Configure Settings. Your SharePoint previews would then be replaced with a button instead of a Preview: 15

16 Adding Custom JavaScript Follow the same directions under Configuring Vizit Essential as an Embedded Viewer. When you get to the Vizit Web Part Properties, select the Advanced checkbox, then the Customize" button. Note that once you check the Advanced checkbox, the Customize button will become enabled and the other properties will be disabled. A model dialog will pop up: This is where you will place your custom JavaScript. The Documentation button will link to our API documentation for reference. 16

17 Vizit Web Part Properties Embed: Checking this box will display the Viewer as an inline viewer. Show Buttons: Will turn on or off the Vizit Preview and buttons attached to the Document Library. Document URL: Adding a SharePoint URL pointing to a document will set a default document to automatically load into the Viewer. Height: Sets the height of the Viewer on the page. Width: Sets the width of the Viewer on the page. Advanced (Customize): Opens a model dialog to write custom JavaScript. Integrating with Search Results Vizit will automatically integrate with your Search results out-of-the-box. This includes your standard SharePoint Search, Search Center Sites and FAST Search. You will just need to make sure that Vizit Everywhere is activated at the correct scope. First Page Previews and the Vizit Pro button will be returned with your Search Results. Activating Vizit Scanning The Vizit Scanning feature is automatically installed along with your Vizit software. In order to scan a document, you must first activate the Vizit Scanning feature. Click on your Site Actions menu, then Site Settings, then Site Collection Features. Activate the Vizit Scanning feature: Select the Document Library on your site that you would like to scan a document to. On the Document Library ribbon, under the Documents tab, you will now see a new button titled Scan Document : 17

18 Upgrading or Removing the Solution If you would like to upgrade your software from your existing Vizit solution or would like to uninstall the software then follow the steps below: 1. Run the Solution Installer. Once you get past the System Check, the installer will display the Upgrade or Remove screen: 2. Select Upgrade, then select Next to install a more recent version of the software. 3. Select Remove, then select Next to uninstall the software from your SharePoint farm. 18

19 Contact Us For questions about installing Vizit, please contact Vizit Support: Phone Vizit NA Toll Free: (855) Vizit International: +1 (425) Website Open a support ticket by visiting our website at and clicking on Create Support Case underneath the Support header located at the bottom of every page. This will create a ticket in our Support System. Send an detailing your question to support@vizit.com. This will also create a ticket in our Support System. Support Tips Please include as much information in your Support ticket as possible. Screenshots are very helpful as well as steps you took that led to any errors during the installation process. 19