Perceptive Document Composition

Transcription

1 Perceptive Document Composition Setup Version: 5.3 Written by: Product Documentation, R&D Date: May 2013

2 Perceptive Software. All rights reserved Document Composition is a trademark of Lexmark International Technology SA, registered in the U.S. and other countries. Perceptive Software is a stand-alone business unit within Lexmark International Technology SA. All other brands and product names mentioned in this document are trademarks or registered trademarks of their respective owners. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or any other media embodiments now known or hereafter to become known, without the prior written permission of Perceptive Software.

3 Table of Contents Technical Specifications... 1 Update... 2 Update from Version to Version Rebranding... 6 Backward Compatibility... 7.Net Setup... 7 General... 7 Document Composition Setup... 7 Windows Operating System... 7 Start the Installation... 7 Installation Procedure... 7 Permission Configuration... 8 Restart Windows... 8 Odin/MWS Database Setup... 9 Oracle... 9 MS SQL Server... 9 User Language Choose the User Language Help Files Repository Setup General Start the Installation Installation Procedure Modify Configuration General Special Settings for Windows Server 2008/2012 and Windows 7/ Modify UserRepository.config Modify Modus_MWS.exe.config Specify Normal.dotm Modify PDC.Client.exe.config Modify PDC.Studio.exe.config Start the Core Service Start Studio iii

4 Table Of Contents Enter Connection Data for the Odin/Mws Database in the Configuration Start the Services iv

5 Technical Specifications Server Hardware Min. 2 CPUs with 2 GHz Min. 4 GB RAM Max. 3 GB available hard disk space for the installation of: -.Net Framework 3.5 SP1 - Perceptive Document Composition complete Further hard disk space depending on the volume of documents Client Hardware Pentium D or higher Min. 512 MB RAM for the Document Composition Client Min. 2 GB RAM for the Composition Studio Max. 3 GB available hard disk space for the installation of: -.Net Framework 3.5 SP1 - Perceptive Document Composition complete (Client 40 MB) - Microsoft Word Supported Operating Systems Windows XP SP3 Windows Vista SP2 Windows 7 SP1 Windows 8 Windows 2003 Server SP2 Windows 2003 Server R2 SP2 Windows 2008 Server SP2 Windows 2008 Server R2 SP1 Windows 2012 Server Note for 64bit Systems: On a 64bit System, Perceptive Document Composition is executed in 32bit compatibility mode(wow64). Supported Databases MS Sql-Server Version 2005, 2008, 2008 R2 and 2012 Oracle version 10g and 11g. The installation of the 32bit Oracle client is necessary for the Document Composition server and the Composition Studio to access an Oracle database. 1

6 Supported Word Versions Word 2007 SP1 with installed VBA Word 2010 with installed VBA Supported LDAP Products Active Directory Novell edirectory SUN Directory Server Oracle Internet Directory Open LDAP Microsoft ADAM (Active Directory Application Mode) Virtualization Our applications support deployment in virtual environments running the operating systems mentioned above as long as these operating systems themselves have been officially approved for use in a virtual environment. The only prerequisite for deployment is that virtual environments are correctly configured. Virus Scanners Virus scanner activities can have adverse effects on Perceptive Document Composition production environments. These adverse effects may result in reduced processing performance or even in the termination of critical transactions. To rule out the eventuality of disruption to operations, it is imperative that the effective range of virus scanner activity is configured to ensure as minimal an impact as possible. Update Update from Version to Version Complete the following steps in the order stated to update an existing Version installation to Version Close applications Client / Studio Close the desktop program. Server Close all Studios and Clients accessing the Document Composition Server. Stop all Document Composition Windows services. 2

7 2. Save the Configuration Unpack the content of the zip file PDCUpdater.zip into a directory outside the program directory. Assign a directory to save the configuration files. The path of this backup directory must not be within the program directory, because environment variables are supported. Run the batch file backupconfiguration.cmd from a DOS box prompt, specifying the complete backup directory path: backupconfiguration.cmd <path of backup directory> 3. Uninstall and Install Having completed the backup of configuration files successfully, uninstall all preceding product versions (ModusOne) via Windows Control Panel. Start uninstall with the latest existing version. Perform an installation of program version 5.3 as described in chapter Document Composition Setup. Specify the same installation path as for the preceding installation. 4. Update the Configuration Run the batch file restoreconfiguration.cmd from a DOS box prompt, specifying the complete backup directory path: restoreconfiguration.cmd <path of backup directory> 5. Replace renamed exe-files with new versions Client / Studio / Server If you have copied and renamed the files ModusStudio.exe (new name PDC.Studio.exe) or ModusClient.exe (new name PDC.Client.exe) in your environment, you will have to replace these copies with newer versions from this release. Example: You have renamed ModusStudio.exe to ModusStudio_TST.exe. Please replace the file ModusStudio_TST.exe with PDC.Studio.exe from Release This can be done using the following DOS copy command: copy PDC.Studio.exe ModusStudio_TST.exe Replace ModusSuite.Runtime.WindowsServiceHost.exe If you are using Document Composition processes as Windows services you will have copied the file ModusSuite.Runtime.WindowsServiceHost.exe and renamed it. Please replace the renamed exe-file with the file PDC.WindowsServiceHost.exe (old name in release 5.2: ModusSuite.Runtime.WindowsServiceHost.exe) from Release as this file has been modified. Example: To run Odin processes you have copied and renamed the file ModusSuite.Runtime.WindowsServiceHost.exe to OdinService.exe and registered it as a Windows service. 3

8 Please replace the file OdinService.exe with the new file PDC.WindowsServiceHost.exe from Release This can be done using the following DOS copy command: copy PDC.WindowsServiceHost.exe odinservice.exe Note: To keep administration time for later updates to a minimum, we recommend putting all copy commands in a single cmd-file. 6. Update database schemes Server Unpack the content of the zip file Update530.zip in the installation directory. A folder named Update530 is created below the Admin directory containing the following files: - MSSql_Odin_Update_520_To_530.sql - MSSql_Rep_DB_Schema_Update_520_To_530.sql - MSSql_Rep_CreateFullTextIndex.sql - ORA_Odin_Update_520_To_530.sql - Ora_Rep_Create_Schema_Update_520_To_530.sql - Ora_Rep_CreateFullTextIndex.sql Please note: We recommend backing up all databases before updating their schemas. Preconditions: The following SQL scripts require schema version or a more recent patch. If you want to use the new full-text search feature from the start, please refer to section Create a fulltext search index. If you prefer not to use the feature immediately, you may perform the necessary steps later on. The SQL scripts are designed to be run more than once on the same schema without problems. Odin DB-Schema Please run the following SQL scripts on all Odin databases to update the schema: For Oracle databases Admin\Update530\ORA_Odin_Update_520_To_530.sql For SQL Server databases Admin\Update530\MSSql_Odin_Update_520_To_530.sql Repository DB-Schema Please run the following SQL script(s) on all Repository databases to update the schema: For Oracle databases Admin\Update530\Ora_Rep_Create_Schema_Update_520_To_530.sql Admin\Oracle\Ora_Rep_CreatePackage.sql For SQL Server Admin\Update530\MSSql_Rep_DB_Schema_Update_520_To_530.sql 4

9 databases 7. Update translations Client / Studio / Server If Document Composition is run in a language other German, the corresponding language resources must be updated. Please download the required language pack from the Perceptive Customer Portal ( download area. Replace your current cmd files, e.g. EN-US_ModusClient.cmd by the new cmd files, e.g. EN_PDC.Client.cmd. For more information, see chapter Choose the User Language. 8. Create a full-text search index The Search tab in the Navigator Window allows location of objects containing a specified text string. This full-text search feature requires an appropriate index in your database system. The MS SQL Server supports the feature via the component SQL Full Text, Oracle supports the feature via Oracle Text. For further information on database requirements for full-text search, please refer to the Configuration Manual. Full-Text Indexing of Repository DB Please run the following SQL scripts on all repository databases to verify the full-text capability of the database system and to add a full-text index to table MR_ITEM_BLOB: For Oracle databases Admin\Update530\Ora_Rep_CreateFullTextIndex.sql For Sql-Server databases Admin\Update530\MSSql_Rep_CreateFullTextIndex.sql 9. Assign the object right for Word Templates Studio The object right Word Template (74) is required to work with the new object Word Template. Please assign this right to all users who will work with Word Templates. 10. Optional step: Refresh the Odin Views Server The languages English (US), French, Spanish, Italian and Portuguese have been added to the Odin Views. The updated Odin-Views have to be imported to use these languages. Notes: The views are imported into the current system if other systems exists, repeat the steps 2 to 4 for each system. 5

10 The Odin views will be overwritten. Customer-specific modifications will get lost when importing and have to be added again. We therefore recommend to import the Odin Views only if you want to use one of the newly added languages. Complete the following steps to do this: 1. Start the Composition Studio. 2. In Studio, go to the Administration tab and click the Repository Import icon. 3. Enter odinview in the field Specification of the import directory. 4. Go to the tab Repository Import and click on the button Execute. The new Odin Views are now imported to the system. Rebranding The following file names have been changed: Old Name ModusClient.exe ModusClient.exe.config ModusStudio.exe ModusStudio.exe.config ModusSuite.Runtime.ConsoleHost.exe ModusSuite.Runtime.ConsoleHost.exe.config ModusSuite.Runtime.WindowsServiceHost.exe ModusSuite.Runtime.WindowsServiceHost.exe.config ModusSuite.WCF.Console.exe.config modusconfig.exe ModusXmlFileImporter.exe mot.exe mot.exe.config modus.lic New Name PDC.Client.exe PDC.Client.exe.config PDC.Studio.exe PDC.Studio.exe.config PDC.ConsoleHost.exe PDC.ConsoleHost.exe.config PDC.WindowsServiceHost.exe PDC.WindowsServiceHost.exe.config PDC.WCF.Console.exe.config PDC.ConfigurationEditor.exe PDC.XmlFileImporter.exe PDC.Tool.exe PDC.Tool.exe.config PDC.lic 6

11 Backward Compatibility Please note: Objects in 5.3 systems are not compatible with earlier versions. For this reason, it is not possible to transfer objects from a Version 5.3 repository to systems based on older repository versions such as 5.1, 5.2 or 5.0.4, for example..net Setup General Perceptive Document Composition requires the Net Framework 3.5 Service Pack 1. This can be downloaded from the Microsoft Download Center. Document Composition Setup Windows Operating System Operating System Windows Server 2008 / Windows Server 2012 / Windows 7 /Windows 8 / Windows Vista Use the file PDC.Setup_Win7_SRV2008.msi Other Operating systems Use the file PDC.Setup_XP_SRV2003.msi Start the Installation Start the installation by double clicking the file PDC.Setup_XP_SRV2003.msi or PDC.Setup_Win7_SRV2008.msi. Setup first checks whether.net Framework 3.5 is installed. If it is not installed, a corresponding message is displayed and setup is terminated. Run.Net Setup first. Installation Procedure 1. Choose the components In this step, you will choose the components you want to install. You can choose from the following components: Component PDC Basic System Contents This component is always required and cannot be removed from the installation. 7

12 PDC Studio PDC Client PDC Server Contains the complete design environment that is needed by administrators. These components enable employees to create, forward and print documents. Installs the server components. Click the Browse button to change the default installation directory. Important: Avoid installing in a directory that contains brackets (e.g. 'C:\Program Files (x86)'). Several versions of the Oracle client do not correctly parse directories that contain parentheses. The following error message is displayed: ORA 'TNS:could not resolve service name'. See also: Oracle error # or Oracle Note Start the Installation In the next step, you will start the installation by clicking the button Install. 3. Status display The status provides information about the installation's progress. 4. Completing the Installation The last window confirms the successful installation. Permission Configuration On the computer that is running the Document Composition server services, the following security settings need to be made for the program directory: The user group Users must be assigned Full control. No special permissions are required for computers on which only Client and/or Studio is installed. No manual changes have to be made. Restart Windows Restart Windows so the environment variable %PDCdir% that was created by the installation is available in Windows services. You need to restart the system because changes to environment variables are not visible until Windows is restarted. See also: Microsoft Support, Article ID:

13 Odin/MWS Database Setup Oracle Database user The Oracle user must have the following roles and permissions: Roles Connect Resource System permissions Create table Create view Create procedure Create sequence A corresponding Oracle user can be created by running the script Ora_Odin_CreateUser.sql. The script can generate error messages such as ORA Table or View does not exist ORA Sequence does not exist These messages can be ignored. They occur because the SQL scripts contain DROP instructions for objects that do not exist in the database. Database schema The directory \Admin\Oracle contains the files Ora_Odin5.sql and Ora_Mws.sql, which are used to create the Odin and MWS schemes. MS SQL Server Database schema The directory \Admin\MS-SQL contains the files MSSql_Odin5.sql and MSSql_Mws.sql which are used to create the Odin and MWS schemas. Important: Run both of the scripts from the SA administrator account. You may have to create SQL Server databases to run the scripts. You can give the databases any name you want. Write down the name. You will need it later during the configuration. 9

14 Database user A database user with the following rights must be created for each database used. This user enables subsequent access to the schemas mentioned above. Object Tables Views Stored Procedures Rights INSERT, SELECT, UPDATE, DELETE SELECT EXECUTE The directory \Admin\MS-SQL contains an SQL script template MSSql_CreateUser.sql. This script can be tailored to create a user and SQL Server login for a database on an SQL Server. For ease of use, simply run the script in SQL Server Management Studio (SSMS). All the information needed on how to perform this action is contained in the script header. The script must be used to create a login for every database catalog used. Only one login is required if both schemas are created in the same database catalog. User Language Choose the User Language The user interface of the Studio and Client is currently available in the following languages: German (default) English (US) French Italian Dutch Portuguese (BR) Spanish Follow the below steps to choose a language other than German: 1. Download files Download the required language pack from the Perceptive Customer Portal ( download area. PDC_5.30 Language Pack EN-US.zip for English (US) PDC_5.30 Language Pack FR.zip for French PDC_5.30 Language Pack NL.zip for Dutch 10

15 PDC_5.30 Language Pack IT.zipfor Italian PDC_5.30 Language Pack ES.zip for Spanish PDC_5.30 Language Pack PT-BR.zip for Portuguese (BR) 2. Create subdirectories In the Studio or Client installation directory, create the directory: en for English (US) fr for French it for Italian nl for Dutch pt-br for Portuguese (BR) es for Spanish Example: Perceptive Document Composition was installed in the directory c:\program files\pdc and the English language resources are to be used. c:\program files\pdc\en 3. Extract files from the zip file Extract the contents of the zip file contained in the language pack to the directory you created in Step 2. In this folder, select the file PDC.Studio.chm. Right-click on the file and select the Properties menu item. Click the Unblock button. In this folder, select the file PDC.Client.chm. Right-click on the file and select the Properties menu item. Click the Unblock button. 4. Set the language for the Odin views Go to the table ODIN_SETTING and change the value in the field OD_ISO_LANG_CODE to: en-us for English (US) fr for French it for Italian nl for Dutch pt-br for Portuguese (BR) es for Spanish Please note that the codes are case-sensitive, e.g. US in en-us must be written in uppercase. 5. Start programs 11

16 If you wish to use in a different language to the one defined in the Windows system settings, you must start Studio and Client with a command line switch. If you wish to use a different language to the one defined in the Windows system settings, you must start Studio and Client with a command line switch. Sample files can be found in the respective language pack: DE_PDC.Client.cmd / DE_PDC.Studio.cmd EN_PDC.Client.cmd / EN_PDC.Studio.cmd ES_PDC.Client.cmd / ES_PDC.Studio.cmd FR_PDC.Client.cmd / FR_PDC.Studio.cmd IT_PDC.Client.cmd / IT_PDC.Studio.cmd NL_PDC.Client.cmd / NL_PDC.Studio.cmd PT-BR_PDC.Client.cmd / PT-BR_PDC.Studio.cmd Help Files The help files are available in the following languages: German English (US) French Dutch These can be downloaded from the download area on the Perceptive Customer Portal ( Repository Setup General The repository setup installs a first Document Composition system on a database. Oracle and MS SQL Server are currently supported. Important: This application must be run on the computer on which the Document Composition server services will be run. Run the repository setup from a user account that has write permission for the Document Composition installation directory. Before running the repository setup, the following must be in place: License If you do not have a valid license, please send an to support: support@perceptivesoftware.com 12

17 and ask for the license file for your environment. Copy the license file to the Document Composition installation directory and make sure the file name is PDC.lic. MS SQL Server An empty database for the repository DB schema. The SQL Servers authentication mode must be active. The SA users password is used to run setup. Oracle Run the Ora_Rep_CreateUser.sql script to create an Oracle user for the database in which the Document Composition DB schema is to be installed. The script is in the Admin\Oracle\ directory. You must have SYSDBA permissions to run the script. Start the Installation To start the repository setup, run the RepositorySetup file in the installation directory. Installation Procedure 1. Select the database First define whether the Document Composition repository is to be installed on an SQL Server or an Oracle database. 1.1 SQL Server The following information is needed to install the repository on an SQL Server: Server: Database: User: Password: Name of the SQL Server instance Name of the SQL Server database in which the repository database schema is to be installed Database user that is used to create the database schema. Please log in as SA user! Database users password Click Test Database Connection to test whether a connection to the database can be established using the entered data. 1.2 Oracle To install the repository on an Oracle database, enter the required information in this window. 13

18 Server: User: Password: SqlPlus Path: Name of the Oracle server instance. Database user that is used to create the database schema. Please use a user that was created by the script Ora_Rep_CreateUser.sql because the user must have specific permissions. Password of the database user Enter the path to the Oracle application SqlPlus.exe. The setup routine will automatically look for this path. SqlPlus.exe is needed to execute the Oracle SQL scripts. Click Test Database Connection to test whether a connection to the database can be established using the entered data. 2. Create a New System In the next step, specify the name and the ID of the Document Composition system to be created. Enter a unique ID for the new system and write it down. You will need it later during the configuration. 3. Start the Installation Start the installation in the last window by clicking on the Start Installation button. The information in the log file window informs you about the installations progress. If you are running the installation on an Oracle database, the SqlPlus output is written to the Ora_Rep_Create_Schema.log Ora_Rep_CreatePackage.log Ora_Rep_lookup.log Ora_Check_FTSComponents.log files. These files are in the Document Composition installation directory and should be checked for error messages. Modify Configuration General After the repository setup has successfully completed, the System Object ID that was entered during the repository setup has to be entered in a number of configuration files. 14

19 Special Settings for Windows Server 2008/2012 and Windows 7/8 Please note that the program ConfigurationEditor must be run with explicit administrator permissions in order to be able to save any changes made. To do this, perform the following steps: 1. Open the Explorer and change to the Document Composition installation folder. 2. Select the file PDC.ConfigurationEditor.exe and then select the context menu item Run as administrator. The application now has explicit administrator permissions and therefore is able to execute write access on the installation folder. User Account Control in Windows 7 / Windows 8 If User Account Control, UAC is activated under Windows 7 respectively Windows 8, programs are always run using the permissions of a standard user, even if the user is an administrator. This is why a user does not have the rights assigned to the Administrator role when Studio is started. To grant the user the rights of the Administrator role, Studio must explicitly be started with run as Administrator or UAC must be deactivated. Modify UserRepository.config 1. Start PDC.ConfigurationEditor from the installation directory. 2. Select the menu item File - Open configuration to open the UserRepository.config file. 3. In the upper table, choose System Object ID and enter the system object ID you entered during setup. 4. Select the menu item File - Save configuration to save your changes. Modify Modus_MWS.exe.config 1. Start PDC.ConfigurationEditor from the installation directory. 2. Select the menu item File - Open configuration to open the modus_mws.exe.config file. 3. In the upper table, choose System Object ID and enter the system object ID you entered during setup. 4. Select the menu item File - Save configuration to save your changes. Specify Normal.dotm Copy Normal.dotm to the installation directory that you created in the step Choose components. Modify PDC.Client.exe.config 1. Start PDC.ConfigurationEditor from the installation directory. 2. Select the menu item File - Open configuration to open the PDC.Client.exe.config file. 3. In the upper table, choose Odin View System Object ID and enter the system object ID you entered during setup. 15

20 4. The corresponding URL will have to be changed based on whether a service is running on a different computer. Choose the desired service and enter the changed URL. The change usually consists of replacing the local IP address (or localhost) with the IP address (or name) of the server on which the service is run. Specifically, the URLs localhost entry needs to be changed on the specific server host name/ip address for the following entries: - Data Provider Service - License Service - Login Service - Modus User Service - Modus Web Service - Modus Web Service Repository - Odin Web Service - Security Token Service Example: If the Document Composition Server service is on the PDCServer host, the Security Token Services URL has to be changed from to 5. Select the menu item File - Save configuration to save your changes. Modify PDC.Studio.exe.config 1. Start PDC.ConfigurationEditor from the program directory. 2. Select the menu item File - Open configuration to open the PDC.Studio.exe.config file. 3. The corresponding URL will have to be changed based on whether a service is running on a different computer. Choose the desired service and enter the changed URL. The change usually consists of replacing the local IP address (or localhost) with the IP address (or name) of the server on which the service is run. Specifically, the URLs localhost entry needs to be changed on the specific server host name/ip address for the following entries: - Data Provider Service - License Service - Login Service - Modus Web Service Repository - Odin Web Service - Repository Service - Security Token Service Example: If the Document Composition Server service is on the PDCServer host, the Security Token Services URL has to be changed from 16

21 to 4. Select the menu item File - Save configuration to save your changes. Start the Core Service The configuration has been changed such that the Core service can start. Open Windows Services and start the Modus_Core service. Start Studio If the service started successfully, Studio can be started: Start -> All Programs -> Perceptive Document Composition -> Perceptive Composition Studio Tip: If Composition Studio is being started for the first time, important controls, such as the Navigator, are not visible. The Navigator and other controls are displayed by clicking on the respective buttons in the Studio - Windows ribbon. The Navigator is displayed by clicking on the globe: Enter Connection Data for the Odin/Mws Database in the Configuration In Studio, click the System Selection button at the top left to select the active system. This displays the System Selection dialog in which you can enter your selection. In Studio, go to the Administration tab and click the DB Alias Administration icon. The DB aliases Mws and Odin are displayed in the DB alias administrator interface. The Mws or Odin database connection is configured as follows: 1. Double-click Mws or Odin. The dialog for the DB connection settings opens. 2. Select the appropriate DB product in the Data Provider field: - Native SQL for MS SQL Server or - Microsoft Oracle for an Oracle database 3. In the SQL Template field, click the Default Value button the default value is read from the configuration and entered. 4. In the SQL Field Template field, click the Default Value button the default value is read from the configuration and entered. 5. In the Connection String area, click the button with the ellipsis. The product-specific connection dialog opens. 6. Enter the connection information for the DB user previously created for the respective schema using the script Ora_Odin_CreateUser.sql or MSSql_CreateUser.sql. 17

22 7. Make sure the option Allow saving password is checked. 8. Click OK to confirm your entry. 9. Make the described change for the Odin and Mws DB alias. 10. Save your changes in the DB alias administrator. Start the Services Open Windows Services and start the following services: Modus_Core Modus_Mws Modus_Ows 18

23 Index Backward Compatibility... 7 Choose Config... 15, 16 Configuration Core Service Enter Connection Data General... 7, 12, 14 Help Files Installation... 7, 13 Installation Procedure... 7, 13 MS SQL Server... 9 Mws Database Odin Oracle... 9 Permission Configuration... 8 Rebranding... 6 Restart Windows... 8 Services Special Settings Start... 7, 13, 17, 18 Start Studio Technical Specifications... 1 User Language Windows... 7, 15 Windows Operating System... 7 Windows Server