Guideline SAPERION Update Version 7.1

Transcription

1 Guideline SAPERION Update Version 7.1

2 Copyright 201 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International, Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Lexmark.

3 Table of Contents 1 Introduction General Preliminaries Backup Core Server Standard Directory of Installation Update of Version 5.7 to Version Prerequisites Document Access via HTML-String resp. URL MS SQL/ Oracle Server Workflow Tasks after Installation... 3 Update Version to Version Prerequisites Memory Consumption Profiles in the User Management Forms (.QBE) "xnmain" Menu and Ribbon Navigation Rights Migration of Existing Applications Replacing Toolbars by Ribbons Form Toolbar Main Toolbar Viewer Toolbar..... Structure Window Toolbar Ribbon Extensions by Event Script..... User Management Profile: Individual Ribbon Updating Forms Using existing DDCs Java Core Server Workflow Compability Mode Update Version /7.1.1 to Update of the Web Client Update of Java Java SDK... 10

4 7.2 Java SE FAQ FAQ Bit Version... 11

5 2.1 Backup Guideline SAPERION Update Version Introduction This document serves as a guideline for administrators who intend to execute an update of SAPERION version to version 7.1 resp. version 5.7 to version 7.1. i Please always use the current SAPERION version. In cases errors occurs in the attachment, request the current patch level. ISOs can be downloaded from the FTP server. 2 General Preliminaries In general, you should first execute resp. ensure the following points before updating. i On SAPERION partner portal you will find the current compatibility list. Please check before updating whether you have hardware or software in use that are possibly not supported. 2.1 Backup Make the following backup: all server components SAPERION directory 2.2 Core Server backup of MS SQL database backup of DBS directory of the Broker backup off all database definitions (*.DDC), all forms (*.QBE), workflow definitions (*.DFD) and COLD definitions (*.DRD) process all user trays check all caches for open write entries and process them backup of media databases and the cache of virtual media inspection of the disk space 1

6 3 Update of Version 5.7 to Version 7.1 process all mirroring jobs so that original and mirror have the identical state 2.3 Standard Directory of Installation If you are using a directory deviating from the SAPERION standard installation directory for used scenario files, such as definitions (.DDC) or forms (.QBE), be aware that the SAPERION setup will not consider it. By default, the following subfolders are created when updating where current system files are copied: defs (DDC files) macros (BAS files) masks (QBE files) workflow (DFD files). 3 Update of Version 5.7 to Version Prerequisites Basically we recommend the setting up of a test system in order to identify and clarify possible problems caused by the update in advance. By doing so you can for example, check whether certain functionalities work furtheron or whether changes result. This may also include: Evaluation of the takeover via MAPI connection Document separation via barcode when scanning 3.2 Document Access via HTML-String resp. URL In version 5.7, when documents that are archived in SAPERION are accessed via third-party applications an URL which is extracted from the mapping export into HTML is used. This URL calls up directly the document in the Web Gateway. Due to the reason that this Web Gateway and the mapping export does not exist anymore in SAPERION version 7.1 the question is, whether the stored URL will work in the future. With SAPERION version 7.1 web services are delivered which are able to understand simple HTML Gateway URLs. New URLs can be built according to a pattern (which are documented) so that documents can be called directly. This is then a document download. Using the SAPERION Web Client it is also possible to open SAPERION forms via an URL and to pre-complete search parameters. As it is not possible to create folders for a search result in the Web Client public folders under the application can be used for structuring. 2

7 3.3 MS SQL/ Oracle Server When the pure viewing of documents is required the URLs should directly be built in the SAPERION web service. 3.3 MS SQL/ Oracle Server Please make sure that an up-to-date version of MS SQL/ Oracle is installed (e.g. update MS SQL 2000 server to MS SQL 2008 Server). Set up a MS SQL-authentication and NOT a Windows authentication at the server. Activate the port, e.g Workflow Due to the reason that with version 7.1 process definitions with BPMN standard are rolled out, accompanied by technical modifications of the workflow engine, we recommend to complete workflow processes before updating. In cases the completion of all processes is not possible check in your test system whether ongoing processes are still working correctly after update. 3.5 Tasks after Installation After the installation all virtual media are set "Write-protected". You may create new media and configure the write buffer. Without these steps the initial folder structure cannot be generated for the user. Adapt the pools, possibly the adaption is necessary because of the newly created media. Update your Java version to at least version ! Please do not use Java version 1..29: the service of the Java Core Server sends a false signal when using JDK 1. update 29. Make sure that the JAVA_HOME variable is set. Install the appropriate VCRedist version. Remove all JCR-relevant DDCs and tables. The Java Core Server must be added subsequently via Control Panel > Programs and Features > SAPERION 7.1 > MODIFY. You will be asked for the database connection data and the [ApplicationServer] section in the ARCHIEF.INI will be filled correctly. If you want to use the Web Client for an existing DDC make sure, that the DDC is containing a SYSROWID system column. Please add this column via the DDC designer. Then fill the values in the table with the following SQL-statement: SQL UPDATE <DDC Name> SET SYSROWID = Replace(NEWID(),'-','')' ' WHERE SYSROWID IS NULL Oracle 3

8 Update Version to Version 7.1 UPDATE <TABLE> SET SYSROWID = SYS_GUID() ' ' WHERE SYSROWID IS NULL Update Version to Version Prerequisites Please check whether the following described steps are ensured before you start the update installation..1.1 Memory Consumption Check the memory consumption of the Core Server (Broker, Document Server). Use the tool Process Explorer of Microsoft and check the private bytes property of the SAPERION process/service. If you are near to or above 2 GB we need to install the Java Core Server as a bit process..1.2 Profiles in the User Management Check your profiles in the SAPERION user management for: Template Users The distribution of the ARCHIEF.INI is still working, but the applications and trays in the outlook bar are only created once if the user logs in for the first time. All forms available in the outlook bar are created in the folder personal folders. This snapshot is never again updated. So we recommend creating new applications including policies based on groups and ACLs (see also updating the navigation tree). This first snapshot cannot be prevented at the moment. Individual Menu Configuration The menu configuration has to be transformed to the new individual ribbons..1.3 Forms (.QBE) Check your forms (*.QBE): Toolbars have to be migrated to the ribbons.

9 .2 Navigation Rights Each complex form has to be tested in Version 7.1. especially, if macro-events are implemented..1. "xnmain" Decide where the data of the new navigation DDC "xnmain" should be stored and assign the DDC "xnmain" to a pool. Alter pool condition..1.5 Menu and Ribbon Your individual menu configuration has to be transformed to the new ribbon. Check your toolbars for macro extensions. They have to be transformed the ribbon. Check your menus for extensions. In the menu event you could append items to the SAPERION main menu. They have to be transformed to SAPERION ribbons. The context menu event still works but your extensions should be tested in version Navigation Rights When you update to SAPERION 7.1 you have to setup the navigation tree and decide who can add/delete global applications. Even in the personal folder only a user with configuration right can create new applications. This is the way how we ensure that access to special data pools can be prevented by the user interface. On the root level of the navigation only the user with the configuration right can create/delete folders and applications. Objects beneath the root w/o an ACL can only be altered by users with configuration right. Once a folder has been created beneath the root every user has the right to add/delete objects. This folder has to be controlled by an ACL. Another way to protect the navigation tree is to disable all folder menu items in the ribbon for a profile by defining an individual ribbon menu. The access to applications is now controlled by ACLs instead of copied template users. If you update your system analyze the existing applications and define global applications with group ACLs..3 Migration of Existing Applications If you decide not to use the snapshot of the user's outlook bar in the personal folders and have template users you can login as such a template user and move the applications to a public folder beneath the root (Drag&Drop the application). Then you can set ACLs for the applications according to your new access policies. After all applications are migrated you turn off the snapshot migration by setting the following.ini key in the PROGRAM.INI: [Setup] MigrateOutlookbar=FALSE 5

10 Update Version to Version 7.1 If you do not know the existing applications, you wait until all your users have logged in once and the current applications are created. Then you analyze the XML properties of the application folders in the database and define a new navigation tree based on this information.. Replacing Toolbars by Ribbons With SAPERION 7 all toolbars have been removed. All default icons have been moved to the new ribbon. Customized icons have to be migrated as ribbon extensions...1 Form Toolbar In index forms the icons of the form toolbar must be transformed to buttons. Using the Rich Client you can group buttons in the task panel control which can be flipped open if required. In query forms you can append the icons to the main ribbon using the menu event and the form set/ killfocus event. It is also possible to create buttons with the toolbar functions. We recommend the usage of embedded forms because in standalone query forms the ribbon cannot be evaluated and all functions must be added as buttons...2 Main Toolbar You can append the icons to the main ribbon using the menu...3 Viewer Toolbar In index forms customized icons of the viewer toolbar cannot be used in version 7.1. The default icons do not exist anymore and the function is integrated in the context menu of the viewer. In query form preview viewer or standalone viewers you can append the icons to the main ribbon using the menu event... Structure Window Toolbar The toolbar does not exist anymore and all functions are available in the context menu...5 Ribbon Extensions by Event Script The only way to expand the ribbon bar is using the Rich Client events. The icon ID must be above 5000 and we recommend using groups for your customized icons (see examples). Ribbon icons should be visible all the time. Use the menu event and add the icons each time the main ribbon is refreshed.

11 .5 Updating Forms Form related icons should only be visible if the appropriate form is active. Use the main menu event and the "InitDialog/ CloseDialog/ SetFocus/ KillFocus" event of the form to show/ hide the new icons. Document related icons should only be shown when an item in the result-list is selected. Use the "selchange" event of the result list... User Management Profile: Individual Ribbon It is possible to enable/disable all icons of the main menu.! The de-/ activation of the toolbar-icons in the viewer is not possible via a profile. Once you have enabled/ disabled one icon in the individual ribbon of a profile, you are fully responsible for all icons, since the individual ribbon overwrites the default ribbon rights. Generally, menu functions that are controlled by an ACL cannot be controlled via the profile of individual ribbons. Icons added by your macros cannot be enabled/ disabled in the individual ribbon of the profile, but have to be controlled by macros. To enable or disable icons you have to evaluate the current user and his group membership in your scripts.! There are a lot of new functions that could not be controlled by the profile administration until the release of 7.1 SP1 (e.g. Workflow start, viewer functions and many more)..5 Updating Forms Please test all your forms with version 7.1. Although all macro events for the new pane layout have been tested by SAPERION, it might be possible that the timing is slightly different. To make sure that a form works in SAPERION in version 7.1 you have to load and save the form. SAPERION converts the old layout to the new pane layout. You can check the layout in the forms designer and redesign the layout by adding/ removing panes. The controls can be moved to new panes by Drag&Drop. If you use more than one pane the "Scale elements" option will be off as expected, as the panes offer scroll bars and a wide functionality to arrange the user s workplace. In version it was possible to hide controls by placing them outside the visible area. In version 7.1 with panes it is much more sufficient to hide controls by adding them to a group with "Read condition = FALSE". 7

12 Update Version to Version 7.1 Please keep in mind that the calendar control is not available in index and query forms if the Rich Client is working under Windows XP.. Using existing DDCs If you want to use the Web Client for an existing DDC make sure, that the DDC is containing a SYSROWID system column. Please add this column via the DDC designer. Then fill the values in the table with the following SQL-statement: SQL UPDATE <DDC Name> SET SYSROWID = Replace(NEWID(),'-','')' ' WHERE SYSROWID IS NULL Oracle UPDATE <TABLE> SET SYSROWID = SYS_GUID() ' ' WHERE SYSROWID IS NULL.7 Java Core Server When upgrading a SAPERION version.x to version 7.1 the Java Core Server is not being installed. You can install it subsequently per Modify-setup. Because in this case you are not asked for the path to the "Java.exe", you have to state the path in the "wrapper.conf"-file. 1. Go to the directory "<Installdir>\scr\scr-javacoreserver\config\". 2. Open the "wrapper.conf" file. 3. Enter the path to the "Java.exe" in the following section. Example #******************************************************************** # Wrapper Java Properties #******************************************************************** # Java Application # Locate the java binary on the system PATH: wrapper.java.command=c:\program FILES\JAVA\JDK1..0_20\BIN\java # Specify a specific java binary: #set.java_home=/java/path #wrapper.java.command=%java_home%/bin/java.8 Workflow Due to the reason that with version 7.1 process definitions with BPMN standard are rolled out, accompanied by technical modifications of the workflow engine, we recommend to complete workflow 8

13 .9 Compability Mode processes before updating. In cases the completion of all processes is not possible check in your test system whether ongoing processes are still working correctly after update..9 Compability Mode In cases a SAPERION Rich Client of version is used in compability mode and in conjunction with the SAPERION Core Server of version 7, problems may appear when annotations are applied. i We recommend as a general rule always using Core Server and Rich Client of the same version after an update to SAPERION Update Version /7.1.1 to In the file "ClientServerVirtualViewer.conf" of scr-webclient (" \Tomcat <version>\webapps\scr-webclient\web-inf\configuration") a parameter has been changed.! The document cache size has been defined in bytes until now. From service pack 2 on the cache size is specified in MB. If you have already defined a cache size, you have to adapt the value to MB otherwise the cache size may be to large. <description>configures the document-cache size in MB.</description> <param-name>documentcachesize</param-name> <param-value>100</param-value> Update of the Web Client Please consider the following hints regarding the Web Client update: After an update of the Web Client, problems with the viewer applet may appear, for example the viewer does not work or documents are not displayed correctly. The logfile provides then messages which point out incompatible classes. In this case you have to remove the cache of the local Java VM via the system control of Java on the clients. The working directory should be removed after each Web Client update. Using the Apache Tomcat it is the "work" folder which can be found in the directory: ""...\Apache Software Foundation\Tomcat <version>". 9

14 7 7 Update of Java 7.1 Java SDK Update of Java If you have updated Java SDK 1. to Java SDK 1.7 the Oracle JDBC driver (in the "...scr/scr-javacoreserver/lib" directory) has also to be updated: current: ojdbc1-1.jar update to: ojdbc.jar 7.2 Java SE Updating to Java SE Update 32 or 33 causes problems with the Web Client when using Internet Explorer, as the Viewer applet is not fully compatible with these versions of Java. We therefore strongly recommend against updating to these versions of Java. 8 FAQ How should I distribute my Client Installations? Due to the fact, that Windows 7 has an enhanced security concept, we recommend to use the MSI with/without silent installation. If you are using the CLIENT.INI installation you need administrative rights for the first start of the SAPERION Rich Client because the used OCX have to be registered. How can I back up my navigation tree? Copy the database table and the media with the data. Execute an -Scenario ex-/ import with SAPERION. Can I move the xnmain to another data pool? After the installation the "xnmain" objects are stored in the default media. Can I move the "xnmain" to another data pool? As long as no new applications have been created you can redirect "xnmain" to another pool, restart the server. The "xnmain" objects are created automatically. Do I still need my "Template users"? "Template users" are only used when you intend to distribute further adapted options via the ARCHIEF.INI. Can I create/ delete/ alter applications in the navigation tree by COM/ UBI/ Java API? There are no methods defined in the API so far. Folders and personal data folders can be created. Can I hide/ rename the default folders of the navigation tree (tasks, personal folders, etc.)? Yes, with the "localize.ddc". Just enter the ID of the path and define the new name for the wanted language 10

15 8.1 FAQ Bit Version Folder/ Application ID Folder/ Application ID Private Folder 1022 Favorites 1038 Tasks 1105 efiles 1108 Personal Files 1109 If the string is DISABLE the folder is hidden. You can also hide the "Tasks" folder by removing the "xwfinbox.qbe" from the Java Core Server masks-directory. Can I use my old workflow inbox form? Yes, just replace your inbox by the "xwfinbox" form. If you still want to use an old workflow inbox outliner you have to turn on the automatic folder creation in the PROGRAM.INI and ARCHIF.INI of the server: [Docflow] FolderOptions=95 The outliner cannot be used in the web client. In this case you should remove the "xwfinbox.qbe" form and create a global application with the old workflow inbox including outliner. If you do not remove the "xwfinbox.qbe" you will have two trees showing the inbox structure with inbox, group inboxes, reminders, etc. Can I create personal folders in the task leaf as in version? No, it is not possible to create personal folders. In the Rich Client the new task folder offers a lot of new possibilities to structure the tasks. If you want the old functionality please use the old workflow index form. Personal files (a personal collection of files) only show the description and the date. Can I use a query form for personal files? No, but a solution for this can be a global application with subfolders for each user. Each subfolder is controlled by an ACL containing only the user. Now each user has his folder where he can build document collections for one special DDC. If you allow the user to alter the ACL he can grant access to other users. Can I delete the personal folder in the "xnmain" table? Yes, if you know the user ID of the user you can execute a delete statement that deletes all rows in the personal folder. 8.1 FAQ Bit Version Can I run a 32 bit Java Core Server on a bit Windows OS? Yes, on Windows 2008 R2. I have broker macro tasks. If I install a bit Java Core Server, can I still use the tasks? No, in the bit Java Core Server no macros will be executed. But you can install and start a 32 bit R/ Link and define the broker tasks there. I have workflows with server side macros. Can I use this workflow on a bit Java Core Server? 11

16 8 No, you have to migrate your scripts to Java and create new script tasks (in Java) and the Business Rules Server. Run a legacy workflow server. Resource = xdfdocvector Can I run a 32 bit Java Core Server and a bit Java Core Server on the same OS? You can run either the 32-bit Java Core Server or the -bit Java Core Server on a Windows Server 2008 R2 (-bit). However you must decide on a flavor of the Java Core Server per OS installation; it is not possible to run both in parallel. Can I still start my old Core Server Service? Since many new functions are only available with the new Java Core Server (e.g. HCP, efiles), we recommend using the Java Core Server. All Rich Client functionality will still be available. Can I update my 32 bit SAPERION V to bit SAPERION V7? No, SAPERION 7 is a new service and needs a new installation. No event script macro is executed on a bit server (Workflow, Broker tasks). 12 FAQ