pdfdocs Desktop 3.3 Objective Integration Setup & User Guide Copyright DocsCorp International Unit Trust Lvl 5, 66 Clarence St

Transcription

1 pdfdocs Desktop 3.3 Objective Integration Setup & User Guide Copyright DocsCorp International Unit Trust Lvl 5, 66 Clarence St Sydney NSW AUSTRALIA Ph: Fax: Web: 25 th Sept 2012

2

3 Table of contents TABLE OF CONTENTS... 3 WHAT S AVAILABLE IN PDFDOCS DESKTOP 3.3 OBJECTIVE INTEGRATION?... 5 OBJECTIVE INTEGRATION... 5 INSTALLATION AND SYSTEM REQUIREMENTS... 6 INSTALLING PDFDOCS DESKTOP... 6 WINTALK... 6 SYSTEM REQUIREMENTS... 7 pdfdocs Desktop 3 - System Requirements... 7 SUPPLEMENTARY SOFTWARE REQUIREMENTS... 8 FILE SERVER SYSTEM REQUIREMENTS - NON-TERMINAL SERVER ENVIRONMENT... 9 FILE SERVER REQUIREMENTS - TERMINAL SERVER/CITRIX ENVIRONMENT... 9.NET FRAMEWORK ADOBE ACROBAT READER ENABLING OBJECTIVE INTEGRATION IN PDFDOCS DESKTOP...11 HOW TO ADD AND CONFIGURE OBJECTIVE INTEGRATION Enable Objective Integration OBJECTIVE EXTENDERS pdfdocs Desktop 3.3 and above pdfdocs Desktop OBJECTIVE PROTOCOL pdfdocs Desktop 3.3 and above pdfdocs Desktop WINTALK_APPLICATION_COMPATIBILITY_POLICY.XML OBJECTIVE EXTENDERS - WORKFLOWS...15 Load into Project Save as New Document Save as New Version as PDF SAVE INTO OBJECTIVE...16 HOW TO SAVE INTO OBJECTIVE Organiser Project - Save Into Objective Binder Project - Save Into Objective

4 IMPORT FROM OBJECTIVE...18 HOW TO IMPORT FROM OBJECTIVE TO AN ORGANISER PROJECT HOW TO ADD FROM OBJECTIVE TO A BINDER PROJECT Add Item APPENDIX A TROUBLE SHOOTING...21 PDFDOCS DESKTOP SUPPORT...22 HOW TO LOG A SUPPORT CALL

5 What s available in pdfdocs Desktop 3.3 Objective Integration? The following features and enhancements are available in pdfdocs Desktop v3.3. Objective Integration Save into Objective Import from Objective to an Organiser Project Add item from Objective to a Binder Project Save documents from Organiser Project or Binder Project to Objective From Objective o Load into Project o Save as New Document o Save as New Version o as PDF o Drag n Drop 5

6 Installation and System Requirements Installing pdfdocs Desktop pdfdocs Desktop needs to be installed in order to enable and configure integration with Objective. Please refer to the installation guides for pdfdocs Desktop for further information. pdfdocs Desktop 3 Installation Instructions pdfdocs Desktop 3 Active Directory Machine Assigned Installation Instructions pdfdocs Desktop 3 Active Directory User Assigned Installation Instructions pdfdocs Desktop 3 Terminal Services and Citrix Metaframe Information Guide WinTalk Objective WinTalk needs to be installed, and is a requirement for integration between pdfdocs Desktop and Objective. Please refer to your installation guides for Objective. 6

7 System requirements pdfdocs Desktop 3 - System Requirements Minimum Client Workstation Specifications Recommended Client Workstation Specifications Processor 1GHz 1.6GHz or faster Operating System Microsoft Windows XP with SP2 or 3 (32-bit and 64-bit) Microsoft Windows Vista with or without SP1 (32-bit and 64-bit) Microsoft Windows 7 (32-bit and 64-bit) Microsoft Windows Server 2003 with SP2 (32-bit and 64-bit) running Terminal Services / Citrix Metaframe Microsoft Windows Small Business Server 2003 with SP1 Microsoft Windows Server 2008 Microsoft Windows XP with SP2 or 3 (32-bit and 64-bit) Microsoft Windows Vista with or without SP1 (32-bit and 64-bit) Microsoft Windows 7 Microsoft Windows Server 2003 with SP2 (32-bit and 64- bit) running Terminal Services / Citrix Metaframe Microsoft Windows Small Business Server 2003 with SP1 Microsoft Windows Server 2008 Memory 512MB 1GB or higher Hard Disk Approximately 250MB of available hard-disk space for installation and up to an additional 100MB of working space for files being converted, depending on the size of files being converted. Approximately 250MB of available hard-disk space for installation and up to an additional 100MB of working space for files being converted, depending on the size of files being converted. Microsoft.NET Framework Microsoft.NET Framework 3.5 SP1 Microsoft.NET Framework 3.5 SP1 Microsoft Office (Optional Integration) Microsoft Office 2010 (32 bit & 64 bit) Microsoft Office 2007 Microsoft Office 2003 with SP1 Microsoft Office XP with SP2 Microsoft Office 2010 (32 bit & 64 bit) Microsoft Office 2007 Microsoft Office 2003 with SP2 or higher Microsoft Office XP with SP3 or higher (Optional Integration) MAPI compliant system MAPI compliant system (e.g. Microsoft Outlook or Lotus Notes) Other Third Party Adobe Reader 6.01 Microsoft Internet Explorer 6 SP2 Adobe Reader 9.1 or higher Microsoft Internet Explorer 6 SP2 or higher * Figures are approximate values based on a range of performance tests. Memory usage may vary for a number of reasons, such as the number other applications running at the same time or the non-deterministic behavior of the Microsoft.NET Framework Garbage Collector. Figures should only be used as a guide and may vary from one system to another. ^ Figures do not include temporary files or page file disk space which may be required to perform certain actions. 7

8 Supplementary software requirements Software Required version Internet download link Internet Explorer Microsoft Internet Explorer 6 SP2 mspx.net Framework 3.5 SP1 required.net Framework Full Redistributable Package This download contains the entire.net Framework 3.5 and is a good option for pushing out the installer to many machines. Framework Online Installer This download is a bootstrapped installer for.net Framework 3.5. It will detect what components are already installed, and only download what is required for your system. If.NET Framework 2.0 is already installed, only the 3.0 and 3.5 components will be required to be downloaded. An internet connection is required for this option. =333325FD-AE52-4E35-B D977D32A6&displaylang=en Windows Installer 3 To install.net Framework 3.5, Windows Installer 3 or higher is required. The.NET Framework 3.5 installation packages will automatically detect for Windows Installer 3. If you require Windows Installer 3, the link is provided below. =889482FC-5F56-4A38-B838-DE776FD4138C&displaylang=en MDAC (generally already installed) 2.6 or higher Adobe Reader 6.01 or higher Microsoft Office Compatibility Pack for Word, Excel & PowerPoint 2007 File Formats =941b3470-3ae9-4aee-8f43-c6bb74cd1466&displaylang=en 8

9 File server system requirements - non-terminal Server environment Under normal systems pdfdocs does not specifically use the file server as it is loaded on each individual workstation. (The exception is when running under Terminal Server/Citrix see next section for information). Only 2 files are stored on the file server. You can use any file server that can be viewed as a network drive by your Windows workstation. All versions of Microsoft, Novell and Linux servers are supported. The server will require about 30 Mb of disk space to store the pdfdocs installer and the server.ini licensing file. No software actually runs on the server, so there is no usage of RAM. File server requirements - Terminal server/citrix environment pdfdocs will operate under the following server based systems: Windows 2003 Terminal Server or Small Business Server Citrix Metaframe It will not operate under Windows NT Terminal server. When installing pdfdocs under terminal server, it should be installed on the server when logged on as Administrator and via the Add/Remove programs option within Control Panel. For each logged on user under Terminal Server, 25 Mb of memory is required on the server for the pdfdocs print monitor to operate. Each user which has the pdfdocs program window open, they will use an additional 28Mb of RAM on the server. Therefore, when calculating memory requirements for your server, you should allow 53Mb RAM per user. For more information on configuring pdfdocs for Terminal Server environments, consult Framework 3.5 pdfdocs was developed in Microsoft s Visual Studio (C#/VB.NET) and requires.net Framework 3.5 to operate. If your operating system is anything less than Windows XP Service Pack 1, you may not have the.net framework already installed. If you are not sure if you have this installed on your workstation, go to Start Menu Control Panels Add/Remove Programs and look for the program Microsoft.NET Framework v 3.5. Please refer to the section above in relation to the installation of Microsoft.NET Framework

10 Adobe Acrobat Reader pdfdocs creates PDF documents that are viewable in Adobe Acrobat Reader. You do not need to purchase any Acrobat software to use pdfdocs you only need the free Reader to view PDF documents. Documents that were created by pdfdocs can be modified using Acrobat v6/v7/v8/v9/v10 professional or standard. Please note that if you want to prevent people modifying documents created by pdfdocs, ensure that you have set up security on the PDF document. 10

11 Enabling Objective Integration in pdfdocs Desktop How to add and configure Objective Integration pdfdocs Desktop needs to be installed, in order to enable and configure integration with Objective. Please ensure pdfdocs Desktop is installed before proceeding. Enable Objective Integration From pdfdocs Desktop select Edit > Settings > Integrations > General This will launch the Integrations Settings window, which provides for the integration configuration with a document management system. If Objective uses Single Sign On, only the Server and Port No. needs to be configure. All options need to be configured if Objective does not use Single Sign On. Information entered here will be written to the users pdfdocs.ini, further information on this can be sourced through the admin guides, links for which are provided on page 6. 11

12 Objective Extenders pdfdocs Desktop 3.3 and above Objective Extenders providing for integration to pdfdocs Desktop 3.3 need to be configured with the following URL s: Load into Project - ObjectiveIntegrator:${this.name}/${this.id}/IMPORT Save as New Document - ObjectiveIntegrator:${this.name}/${this.id}/NEWDOCUMENT Save as New Version - ObjectiveIntegrator:${this.name}/${this.id}/NEWVERSION as PDF - ObjectiveIntegrator:${this.name}/${this.id}/ pdfdocs Desktop 3.2 Objective Extenders providing for integration to pdfdocs Desktop 3.2.x need to be configured with the following URL s: Load into Project - pdfdocs:${this.name}/${this.id}/import Save as New Document - pdfdocs:${this.name}/${this.id}/newdocument Save as New Version - pdfdocs:${this.name}/${this.id}/newversion as PDF - pdfdocs:${this.name}/${this.id}/ 12

13 Objective Protocol pdfdocs Desktop 3.3 and above The registering of the Objective Protocol is automatic as part of the installation of pdfdocs Desktop 3.3 pdfdocs Desktop 3.2 With the installation of pdfdocs Desktop 3.2.x, you will need to register on the client the Objective protocol. Copy the text below in to a new text file and save your changes. Rename the text file so that it has a file extension of.reg and save the changes. Running the.reg file, will register the Objective protocol. Windows Registry Editor Version 5.00 [HKEY_CLASSES_ROOT\PdfDocs] "URL Protocol"="" files\\pdfdocs\\resources\\objectiveintegrator.exe" [HKEY_CLASSES_ROOT\PdfDocs\shell] [HKEY_CLASSES_ROOT\PdfDocs\shell\open] files\\pdfdocs\\resources\\objectiveintegrator.exe\" \"%1\"" The install location will need to be edited, for example in cases where pdfdocs Desktop has been installed on a 64bit client, and the install location is: c:\program files (x86)\pdfdocs\resources\objectiveintegrator.exe 13

14 wintalk_application_compatibility_policy.xml The Wintalk_application_compatibility_policy.xml will need to be updated with the following information: The location of the xml will be (for example) C:\Program Files\Objective\Navigator 7\Extensions\WinTalk Open the xml in an xml or text editor application and add the following information: <application> <display_name>pdfdocs</display_name> <process_name>pdfdocs.exe</process_name> <compatible>true</compatible> <release policy="prompted"> <strategy> <filesystem/> </strategy> </release> </application> <application> <display_name>objectiveintegrator</display_name> <process_name>objectiveintegrator.exe</process_name> <compatible>true</compatible> <release policy="prompted"> <strategy> <filesystem/> </strategy> </release> </application> Close and save your changes. 14

15 Objective Extenders - workflows Once all configuration requirements have been met, users will have a number of options available to them when working with documents in Objective. The following workflows are only applicable for single document selection, and will not work if multiple documents are selected in Objective. Load into Project Right click on selected document, select pdfdocs then Load into Project. The selected document will be sent to pdfdocs Desktop. Save as New Document Right click on selected document, select pdfdocs then Save as New Document. The selected document will be converted to PDF, with options to profile the new document back into Objective. Save as New Version Right click on selected document, select pdfdocs then Save as New Version. The selected document will be converted to PDF, with options to profile the document back in to Objective as a new version of the original source document. as PDF Right click on selected document, select pdfdocs then as PDF. The selected document will be converted to PDF and added to a newly created message. 15

16 Save Into Objective How to Save Into Objective Organiser Project - Save Into Objective The following steps are assuming that Objective has been set as the configured DMS, refer to page 11 for additional information. If the Save Into Objective icon is used on the toolbar, this will collate all checked documents that appear in the document list. If you wish to save a single document, or a collection of documents, select and highlight the required document(s) then right click and select Save Into Objective. The same action is persisted through a right click on a thumbnail(s). You will be presented with the Save As options window, choose A New Document or A new version of existing document. Select OK then choose the required location to save. 16

17 Once a document has been saved in to Objective, the document will need to be released from an Edit state. This is due to a limitation within the Objective api. Binder Project - Save Into Objective The selection of the Make Binder icon on the toolbar, will present the user with options. Selecting Single PDF Binder will present an additional checkbox Save into Objective. Once the Make Binder process is started by selecting OK, upon completion, options to save as a New Document or New version of existing document will be preseneted ahead of the Objective browser window. 17

18 Import from Objective How to import from Objective to an Organiser Project To import a document from Objective, select the Import (Objective) icon on the Desktop toolbar The user will be presented with a choice from where the document is to be imported from, select Objective Browse through to the relevant location and select the required document from the right hand pane. Select Open to import the selected document in to the Organiser Project. The document will be converted to PDF during the import workflow. 18

19 How to add from Objective to a Binder Project A Binder Project is an area into which you can add individual files, providing the ability to collate PDF and non-pdf documents into a single or multi document Binder Project. The Binder Project when generated will have a table of contents, with the choice of retaining the documents in their native format or having them converted to PDF. For further information on Binder Projects please refer to the pdfdocs Desktop User Guide available through Help > Help in pdfdocs Desktop. Add Item From within a Binder Project, select the Add Item icon on the toolbar Alternatively, you can right click within the document area, or right click on the tree view, to be presented with the Add Item options 19

20 Selecting Objective will connect pdfdocs Desktop to your Objective server, and present you with an Objective browser window. Select the required document to import and click Open. The selected document will be added to the Binder Project, maintaing the document in its native format. 20

21 Appendix A Trouble Shooting If issues are being experienced with connectivity to the Objective server, then the following tests can be conducted. In most cases, any connectivity issues related to pdfdocs may be due to incorrect parameters entered in to the integration settings window. By performing simple tests through Internet Explorer, server name and port numbers can be established. pdfdocs Desktop integration with Objective utilises WebTalk, which may be configured differently to the standard port of 443. Launch Internet Explorer and enter in the following links 1. Displays document 1234 xml information on the web page Prompts to download the document 1234 If in the tests above, prompts for username and password are received, this would indicate an issue with Objective Single Sign-on (SSO). If no information is displayed, check the URL entered for correct server name and document ID. If the Objective Extenders are not working, ensure that they are configured correctly. Refer to page 12 for additional information. You may need to ensure that Objective protocol has been registered in the clients registry. Refer to page 13 for additional information. The Wintalk_application_compatibility_policy.xml will need to be updated. Refer to page 14 for additional information. 21

22 pdfdocs Desktop Support How to log a support call We are committed to helping our customers get the most out of their investment in our software. In addition to our reliable products, you can count on our dedicated team of experienced support professionals to provide fast, dependable service for your organization. Please click here to log a support call. 22

23 Copyright DocsCorp International Unit Trust All rights reserved. pdfdocs is a trademark of DocsCorp International Unit Trust. This program is licensed to be installed on the number of workstations shown. pdfdocs cannot be installed simultaneously on any more workstations than that specified, regardless of the location of those workstations. Each user under Windows Terminal Services, or similar technology which has pdfdocs available, is deemed a 'workstation' according to this license. pdfdocs is protected by copyright law and international treaties. Unauthorized reproduction or distribution of this program, or any portion of it, may result in severe civil and criminal penalties, and offenders will be prosecuted to the maximum extent possible under law. 23