Eforms Install
Eforms Install
Eforms Install
Version 4.0.2
GC19-2724-01
Version 4.0.2
GC19-2724-01
Note Before using this information and the product it supports, read the information in Notices on page 55.
This edition applies to version 4.0.2 of IBM FileNet eForms for P8(product number 5724-R85) and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright International Business Machines Corporation 2006, 2008. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Table of Contents
Table of Contents
About this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Intended audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Typographical conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 About IBM FileNet documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Copy Web documents into the help system and make them searchable . . . . . . . . . . . . . . . . . . . Links to additional information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Gather reference documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation reference documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Other available documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Access IBM FileNet documentation, compatibility matrices, and fix packs . . . . . . . . . . . . . . . . . Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 10 11 11 12 14 14
Installation tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Task 1: Install FileNet eForms for P8 documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Task 2: (Optional) Adjust Process Engine workflow settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Task 3: Install IBM FileNet eForms for P8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Configuration/startup Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Task 4: Configure the eForms step processors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Task 5: Set the eForms site preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Task 6: (Optional) Customize settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Table of Contents
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Intended audience
This document is intended for software professionals who will install the FileNet P8 applications. Installation by an IBM FileNet Certified Professional (FCP) is recommended. For more information about the FCP program, contact your IBM service representative.
Typographical conventions
Typographical conventions
This document uses the following typographical conventions: Convention Bold Usage Platform-specific headings Example Start the application server. WebSphere Refer to IBM WebSphere documentation for more information. WebLogic Refer to BEA WebLogic documentation for more information. Gray bold Clickable items, such buttons, and tabs. Menu paths or breadcrumb trails. Italics Variables that require usersupplied values Document titles
Monospace
Click OK. Select Start > Settings > Control Panels > Display > Screen Saver. The calculation is: number of object stores * 16 + number of concurrent users. You are reading the IBM FileNet P8 Platform Installation and Upgrade Guide. Copy the file by entering the following command:
COPY filename
Code samples
Display text, such as prompts and error messages Elements such as filenames, properties, classes and so on, whose meaning might get confused in regular text.
Are you sure you want to delete this object? You do not have permission to delete this object.
Open the filed file. Enter a value for the new property. Select the senior class.
Acronyms
Usage User-interface fields that do not use initial capitalization and document headings referenced within a document Case-sensitive text, where uppercase text is required.
Example See the Part number field for the part number. For more information, see Typographical conventions on page 8. Copy the file by entering the following command:
COPY filename
UPPERCASE
Acronyms
This document uses the following IBM FileNet product names and acronyms. Product Name Application Engine Business Process Manager Content Engine Process Engine Acronyms AE BPM CE PE
About IBM FileNet documentation Copy Web documents into the help system and make them searchable
10
Copy Web documents into the help system and make them searchable
The IBM FileNet P8 help system is designed so that you can download updated copies of this document and copies of other IBM FileNet documents into the IBM FileNet P8 help system and index them so that they can be retrieved by a search in the help system. However, to search the IBM FileNet P8 help system, it must be installed as a Web site on a Web server that supports Java applications. For more information, see: Gather reference documentation on page 11 The IBM FileNet P8 Installation and Upgrade Guide topic Install IBM FileNet P8 Platform documentation about how to install IBM FileNet P8 Platform documentation and update the documentation search index.
Because this document is included in the default FileNet P8 help system, the links to the FileNet P8 help topics work only when you view this document from within the help system. If you view this document from outside of the help system, the links to FileNet P8 help topics do not work.
11
IBM FileNet P8 Non-English Support Guide IBM FileNet P8 High Availability Technical Notice IBM FileNet P8 Performance Tuning Guide
12
Document or help topic name... IBM FileNet P8 help topic: Administration > Enterprise-wide Administration > FileNet P8 Security > Users and Groups IBM FileNet P8 help topic: Administration > Enterprise-wide Administration > Shutdown and Startup
Refer to this document... For a complete list of the user and group roles, accounts, and responsibilities required to install, configure, and maintain a FileNet P8 system. For information about how to shut down and start up FileNet P8 and any expansion products.
IBM FileNet P8 Security Help Extract IBM FileNet P8 Rendition Engine Installation and Upgrade document IBM FileNet eForms for P8 Installation and Upgrade Guide IBM FileNet Connector for SharePoint Web Parts Installation and Upgrade Guide IBM FileNet Connector for SharePoint Document Libraries Installation and Upgrade Guide IBM FileNet P8 Portlets for WebSphere Installation and Upgrade Guide
13
Document name IBM FileNet Process Analyzer Installation and Upgrade Guide IBM FileNet Process Simulator Installation and Upgrade Guide IBM FileNet Records Manager Installation and Upgrade Guide IBM FileNet Business Activity Monitor Installation and Configuration Guide IBM FileNet Content Federation Services Installation and Upgrade Guide IBM FileNet Content Federation Services for Image Services Planning and Configuration Guide IBM FileNet Content Federation Services for Content Manager OnDemand Planning and Configuration Guide IBM FileNet Content Management Widgets Installation Guide
Refer to this document... For information about how to install and upgrade Process Analyzer in a FileNet P8 environment. For information about how to install and upgrade Process Simulator in a FileNet P8 environment. For information about how to install and upgrade Records Manager in a FileNet P8 environment. For information about how to install and configure Business Activity Monitor in a FileNet P8 environment. For information about how to install and upgrade Content Federation Services in a FileNet P8 environment. For information about how to configure Image Services for document federation. For information about how to configure Content Manager for OnDemand for document federation.
For information about how to install Content Management Widgets in a FileNet P8 environment.
About IBM FileNet documentation Access IBM FileNet documentation, compatibility matrices, and fix packs
14
Customer support
For information about contacting customer support: 1. Navigate to the FileNet Product Family support page: (http://www.ibm.com/software/data/content-management/filenet-product-family/support.html). 2. Click IBM FileNet Support Communications, or search for a particular support topic under Enter search terms.
Feedback
Your feedback helps us to provide quality information. Send your comments about this publication or any other IBM FileNet documentation by e-mail to comments@us.ibm.com. Be sure to include the name of the product, the version number of the product, and the name and part number of the book (if applicable). If you are commenting on specific text, include the location of the text (for example, a chapter and section title, a table number, a page number, or a help topic title).
15
16
17
18
Definitions of roles
The planning and preparation tasks in this IBM FileNet eForms for P8 Installation and Upgrade Guide guide as well as the Plan and Prepare Your Environment for IBM FileNet P8 guide are organized by administrative roles. Your organization may have different roles, and some of the responsibilities of listed roles will vary from those assigned by default in this documentation. It is a best practice to examine the installation and upgrade worksheet, included as part of the IBM FileNet P8 Platform Installation and Upgrade Guide, and confirm or change the default role assignments.
19
Use the installation and upgrade worksheet Application server administrator (ASA)
20
Installation tasks
21
Installation tasks
Complete the following tasks to install IBM FileNet eForms for P8: Task 1: Install FileNet eForms for P8 documentation on page 22. Task 2: (Optional) Adjust Process Engine workflow settings on page 23. Task 3: Install IBM FileNet eForms for P8 on page 24.
Task 1: Install FileNet eForms for P8 documentation To install FileNet eForms for P8 documentation
22
Task 2: (Optional) Adjust Process Engine workflow settings To install FileNet eForms for P8 documentation
23
Task 3: Install IBM FileNet eForms for P8 To Install eForms for P8 on Windows
24
For example:
P8eF-4.0.2.0-AE-AIX.bin -is:javahome /opt/filenet/AE/_jvm
In order for your application server to access to your data, you must download and install the appropriate JDBC driver for your database. Refer to your application server documentation for instructions on configuring drivers. Do not save the drivers in the either the root path or the WebSphere application server directory structure. Once eForms for P8 has been installed, it can be used in standalone web applications (for example, a public-facing portal that is part of your overall P8 application). For information, see the FileNet eForms for P8 Developers Guide in the IBM Filenet P8 help system.
To Install eForms for P8 on Windows 1. Access the host machine and log on using an account that has administrator privileges. 2. Stop the Workplace or Workplace XT Web Application. 3. Stop the application server and undeploy Workplace or Workplace XT. 4. Install the eForms for P8 software, using the appropriate values from your worksheet. HINT With the Data > Filter > AutoFilter command enabled, as it is by default in the shipping worksheet file (p8_worksheet.xls), perform the following steps to quickly see only the installation properties you must specify for the eForms for P8 installer: Click the AutoFilter drop-down arrow in the Installation or Configuration Program" column header and select eForms installer. Click the AutoFilter drop-down arrow in the "Setup Type" column header, select Custom, and specify: Setup Type contains "Installation."
Task 3: Install IBM FileNet eForms for P8 To install eForms for P8 on UNIX
25
To install interactively i. Access the IBM FileNet eForms for P8 installation package and execute the appropriate installer for your configuration: Application Engine P8eF-4.0.2.0-AE-WIN.exe Workplace XT P8eF-4.0.2.0-XT-WIN.exe
To install silently i. ii. Access the IBM FileNet eForms for P8 installation package and edit the silent.txt file to reflect the appropriate responses for your installation. Launch the appropriate eForms for P8 installer for your configuration by executing one of the following commands: Application Engine
P8eF-4.0.2.0-AE-WIN.exe -options silent.txt -silent
Workplace XT
P8eF-4.0.2.0-XT-WIN.exe -options silent.txt -silent
5. Start the application server and redeploy Workplace or Workplace XT. To install eForms for P8 on UNIX NOTE For proper deployment of AIX on WebSphere, the Java SE Development Kit (JDK) must be pre-installed. 1. Access the host machine and log on as a user with administrator privileges. 2. Stop the Workplace or Workplace XT Web Application and undeploy. 3. Stop the application server. 4. Install the eForms for P8 software, using the appropriate values from your worksheet. HINT With the Data > Filter > AutoFilter command enabled, as it is by default in the shipping worksheet file (p8_worksheet.xls), perform the following steps to quickly see only the installation properties you must specify for the eForms for P8 installer: Click the AutoFilter drop-down arrow in the Installation or Configuration Program" column header and select eForms installer. Click the AutoFilter drop-down arrow in the "Setup Type" column header, select Custom, and specify: Setup Type contains "Installation."
Task 3: Install IBM FileNet eForms for P8 To install eForms for P8 on UNIX
26
To install interactively (X terminal must be installed) i. Access the IBM FileNet eForms for P8 installation package and execute the appropriate installer for your configuration: Application Engine P8eF-4.0.2.0-AE-UNIX type.bin Workplace XT P8eF-4.0.2.0-AE-XT-UNIX type.bin
To install silently i. ii. Access the IBM FileNet eForms for P8 installation package and edit the silent.txt file to reflect the appropriate responses for your installation. Launch the appropriate eForms for P8 installer for your configuration by executing one of the following commands: Application Engine
P8eF-4.0.2.0-AE-UNIX type.bin -options silent.txt -silent
Workplace XT
P8eF-4.0.2.0-AE-UNIX type.bin -options silent.txt -silent
5. Start the application server and redeploy Workplace or Workplace XT. 6. Set the display configuration to render PDF and TIFF files using one of the following methods: a. Set the DISPLAY variable to match the functioning X Server. b. Set the JDK environment to run in headless mode. WebSphere i. ii. In the WAS Administration Console, access the Java Virtual Machine settings. Set Heap Size parameters as follows: Initial: Xms256m Max: Xmx512m iii. Add the following entry to the Generic JVM Arguments field:
Djava.awt.headless=true
Task 3: Install IBM FileNet eForms for P8 To install eForms for P8 on UNIX
27
JBOSS i. Set the following system option for the server Java VM:
Djava.awt.headless=true
ii.
Modify the JBOSS startup script JAVA_OPTS variable to include the follow entries:
Xms256m Xmx512m Djava.awt.headless=true
28
Configuration/startup Tasks
After you install FileNet eForms for P8, you must perform the following configuration and startup tasks. Task 4: Configure the eForms step processors on page 29. Task 5: Set the eForms site preferences on page 31. Task 6: (Optional) Customize settings on page 32.
Task 4: Configure the eForms step processors To configure the eForms step processors
29
6. Click Add to insert a new line. Enter the values below that are marked in bold for the eForms step processor: Type: Step Name: Form HTML (FileNet) Language: HTML Location: Double-click the Location field to display the Step Processor Locations dialog box. In the Location field next to FileNet Workplace, enter:
html/form/StepForm.jsp
Task 4: Configure the eForms step processors To configure the eForms step processors
30
7. Click OK. 8. Click Commit Changes on the toolbar to save the changes. Then close the Process Configuration Console.
Task 5: Set the eForms site preferences To set the eForms site preference
31
32
33
34
Upgrade overview
The upgrade described in this guide assumes that you will: Retain your basic platform configuration from the previous release. This guide does not address migrations to different operating systems, databases, or application servers during upgrade. To migrate components or third-party software from one platform to another (for example, migrating from SQL Server database engine to Oracle), you must contact your IBM FileNet representative. Make no changes to existing user or group definitions during the upgrade. Apply only the necessary supported third-party software updates, service packs, fix packs and patches, as noted in this guide and in the IBM FileNet P8 Hardware and Software Requirements. To download this guide from the IBM support page, see Access IBM FileNet documentation, compatibility matrices, and fix packs on page 14. Apply the required minimum level of IBM FileNet P8 Service Packs, fix packs, or interim fixes to the currently installed software before you upgrade. IBM FileNet Service Packs, fix packs and test fixes often include feature updates that are required to ensure a successful upgrade. Therefore, before you begin your upgrade to IBM FileNet eForms for P8 4.0.2, you must have applied the minimum level of Service Pack, fix pack, or test fix to your installed 4.0.x components. For more details, see Access IBM FileNet documentation, compatibility matrices, and fix packs on page 14.
35
Gather documentation
See the installation topic Gather reference documentation on page 11 for a list of guides and help topics that are relevant to an eForms for P8 upgrade. Upgrade the eForms for P8 documentation to the current version (if you haven't already done so as part of upgrading your overall IBM FileNet P8 documentation installation). For detailed instructions on how to upgrade the documentation for expansion products such as IBM FileNet eForms for P8, see the "Upgrade IBM FileNet P8 Documentation" topic in the IBM FileNet P8 Platform Installation and Upgrade Guide.
General requirements
The following are the minimal software levels required to upgrade eForms for P8: Content Engine 4.5.x Application Engine 4.0.2
For the latest information on requirements, see the current version of the IBM FileNet P8 Hardware and Software Requirements document. To download this guide from the IBM support page, see Access IBM FileNet documentation, compatibility matrices, and fix packs on page 14.
36
Task 1: Upgrade IBM FileNet eForms for P8 To upgrade eForms for P8 on Windows
37
For example:
P8eF-4.0.2.0-AE-AIX.bin -is:javahome /opt/filenet/AE/_jvm
In order for your application server to access to your data, you must download and install the appropriate JDBC driver for your database. Refer to your application server documentation for instructions on configuring drivers. Do not save the drivers in the either the root path or the WebSphere application server directory structure. Once eForms for P8 has been installed, it can be used in standalone web applications (for example, a public-facing portal that is part of your overall P8 application). For information, see the FileNet eForms for P8 Developers Guide in the IBM Filenet P8 help system.
To upgrade eForms for P8 on Windows 1. Access the host machine and log on using an account that has administrator privileges. 2. Stop the Workplace or Workplace XT Web Application and undeploy. 3. Stop the application server. 4. (Optional) Uninstall the previous version of FileNet eForms for P8 if you are upgrading from a version prior to 3.5.1. 5. Install the eForms for P8 software, using the appropriate values from your worksheet. HINT With the Data > Filter > AutoFilter command enabled, as it is by default in the shipping worksheet file (p8_worksheet.xls), perform the following steps to quickly see only the installation properties you must specify for the eForms for P8 installer: Click the AutoFilter drop-down arrow in the Installation or Configuration Program" column header and select eForms installer. Click the AutoFilter drop-down arrow in the "Setup Type" column header, select Custom, and specify: Setup Type contains "Installation."
Task 1: Upgrade IBM FileNet eForms for P8 To upgrade eForms for P8 on UNIX
38
To upgrade interactively i. Access the IBM FileNet eForms for P8 installation package and execute the appropriate installer for your configuration: Application Engine P8eF-4.0.2.0-AE-WIN.exe Workplace XT P8eF-4.0.2.0-XT-WIN.exe
To upgrade silently i. ii. Access the IBM FileNet eForms for P8 installation package and edit the silent.txt file to reflect the appropriate responses for your installation. Launch the appropriate eForms for P8 installer for your configuration by executing one of the following commands: Application Engine
P8eF-4.0.2.0-AE-WIN.exe -options silent.txt -silent
Workplace XT
P8eF-4.0.2.0-XT-WIN.exe -options silent.txt -silent
6. Download and install the latest software updates, fix packs, or interim fixes for the IBM FileNet eForms for P8 software to ensure optimal operation. 7. Start the application server and redeploy Application Engine or Workplace XT. To upgrade eForms for P8 on UNIX 1. Access the host machine and log on as a user with administrator privileges. 2. Stop the Workplace or Workplace XT Web Application and undeploy. 3. Stop the application server. 4. Install the eForms for P8 software, using the appropriate values from your worksheet. HINT With the Data > Filter > AutoFilter command enabled, as it is by default in the shipping worksheet file (p8_worksheet.xls), perform the following steps to quickly see only the installation properties you must specify for the eForms for P8 installer: Click the AutoFilter drop-down arrow in the Installation or Configuration Program" column header and select eForms installer. Click the AutoFilter drop-down arrow in the "Setup Type" column header, select Custom, and specify: Setup Type contains "Installation."
Task 1: Upgrade IBM FileNet eForms for P8 To upgrade eForms for P8 on UNIX
39
To upgrade interactively (X terminal must be installed) i. Access the IBM FileNet eForms for P8 installation package and execute the appropriate installer for your configuration: Application Engine P8eF-4.0.2.0-AE-UNIX type.bin Workplace XT P8eF-4.0.2.0-AE-XT-UNIX type.bin
To upgrade silently i. ii. Access the IBM FileNet eForms for P8 installation package and edit the silent.txt file to reflect the appropriate responses for your installation. Launch the appropriate eForms for P8 installer for your configuration by executing one of the following commands: Application Engine
P8eF-4.0.2.0-AE-UNIX type.bin -options silent.txt -silent
Workplace XT
P8eF-4.0.2.0-AE-UNIX type.bin -options silent.txt -silent
5. Download and install the latest software updates, fix packs, or interim fixes for the IBM FileNet eForms for P8 software to ensure optimal operation. 6. Start the application server and redeploy Workplace or Workplace XT. 7. Set the display configuration to render PDF and TIFF files using one of the following methods: a. Set the DISPLAY variable to match the functioning X Server. b. Set the JDK environment to run in headless mode. WebSphere i. ii. In the WAS Administration Console, access the Java Virtual Machine settings. Set Heap Size parameters as follows: Initial: Xms256m Max: Xmx512m iii. Add the following entry to the Generic JVM Arguments field:
Djava.awt.headless=true
Task 1: Upgrade IBM FileNet eForms for P8 To upgrade eForms for P8 on UNIX
40
JBOSS i. Set the following system option for the server Java VM:
Djava.awt.headless=true
ii.
Modify the JBOSS startup script JAVA_OPTS variable to include the follow entries:
Xms256m Xmx512m Djava.awt.headless=true
Task 2: (Optional) Migrate from eForms for P8 3.5.1 To migrate from eForms for P8 3.5.1
41
To migrate from eForms for P8 3.5.1 To migrate from IBM FileNet eForms for P8 version 3.5.1 to the current version of eForms for P8, implement the following solutions, as appropriate for your configuration. NOTE In some cases, you may need to migrate processes that are currently running (workflows that contain documents which are still processing) and, as such, modifications cannot be made to the associated form templates. These processes can be fixed by adding new preference settings to the eforms-preferences.xml file, outlined below, to ensure forms and related data process correctly in P8. 1. Remove embedded scripts, included within <script></script> tags, from all templates. Condition Embedded scripts are not supported in eForms for P8. Any scripts that were entered in the embedded script section of a form template in eForms for P8 3.5.1 were ignored. Scripting is now enabled and, as such, eForms for P8 will attempt to run any embedded scripts within your templates. When eForms for P8 encounters embedded scripts, errors are generated. Solution To rectify this potential situation, review your templates for embedded scripts and remove them. In-process solution Manually add the following preference setting to the eforms-preferences.xml file to correct potential issues, where appropriate, based on your specific IBM FileNet eForms for P8 3.5.1 configuration. For in-process templates, make any embedded scripts inactive by adding the removeScriptTag to the eforms-preferences.xml file and setting the parameter value to true. IBM FILENET EFORMS FOR P8 INSTALLATION AND UPGRADE GUIDE
Task 2: (Optional) Migrate from eForms for P8 3.5.1 To migrate from eForms for P8 3.5.1
42
All embedded scripts, included within <script></script> tags, will then be ignored in eForms for P8 4.0.2 or later. Example
<?xml version="1.0" encoding="utf-8" ?> <preferences> <customer removeScriptTag="true"> </customer> </preferences>
2. Modify templates to use the external URLEncode feature. Condition Use of the autoUrlEncoding feature to automatically encode all URLs is no longer supported in eForms for P8. Solution If you used the autoUrlEncoding=true preference in your eForms for P8 3.5.1 form.properties file, to maintain this functionality you must modify each form template in eForms for P8 4.0.2 and later to use the external URLEncode feature for each cell where URL encoding is required. In-process solution Manually add the following preference setting to the eforms-preferences.xml file to correct potential issues, where appropriate, based on your specific IBM FileNet eForms for P8 3.5.1 configuration. For in-process documents, you must add the following preference to the eformspreferences.xml file for each template containing a cell for which you want the value to be encoded:
<template uri="p8:{object store ID}.{template ID}> <autoUrlEncodingEnabled>true</autoUrlEncodingEnabled> </template>
You must add the template node entry multiple times, as appropriate, to specify multiple templates. To obtain the object store ID for Workplace or Workplace XT, right-click the object store name and select Properties. To obtain the template ID in Workplace: a. Right-click the template and select Properties. b. Click Show system properties. To obtain the template ID in Workplace XT: c. Right-click the template and select More Information > All Properties. d. Click Show system properties.
Task 2: (Optional) Migrate from eForms for P8 3.5.1 To migrate from eForms for P8 3.5.1
43
Example
<?xml version="1.0" encoding="utf-8" ?> <preferences> <customer> <templates> <template uri="p8:{object store ID1}.{template ID1}> <autoUrlEncodingEnabled>true</autoUrlEncodingEnabled> </template> <template uri="p8:{object store ID2}.{template ID2}> <autoUrlEncodingEnabled>true</autoUrlEncodingEnabled> </template> <template uri="p8:{object store ID3}.{template ID3}> <autoUrlEncodingEnabled>true</autoUrlEncodingEnabled> </template> </templates> </customer> </preferences>
NOTE Apply this setting only to correct in-process, problematic form templates. For all new form templates and policies, you must use the external URLEncode feature for each cell in which you want the value to be encoded. 3. Modify your form templates to include the Allow exporting data error handling setting in cases where you want the Launch and Complete actions in P8 to permit data to be exported, even though the form contains invalid data. Condition If you designed a form for eForms for P8 3.5.1 and enabled the Allow saving data option under Actions allowed with invalid data section of the Error Handling settings window, the Launch and Complete actions, when filling out the form in P8, allowed exporting of data in cases where the form contained invalid data. In eForms for P8 4.0.2 and later, the Allow saving data option in the error-handling section of eForms Designer no longer has an effect on the Launch and Complete actions for the form. This change resulted because Launch and Complete actions have been changed from an isSaveAction in eForms for P8 3.5.1 to an isExportAction. For more details, see the Class Command section of the eForms Java API Reference help. Solution In eForms for P8 4.0.2 and later, you must now set the Allow exporting data error-handling option in the Error Handling settings window to allow data to be exported from forms which contain invalid data. In-process solution Manually add the following preference setting to the eforms-preferences.xml file to correct potential issues, where appropriate, based on your specific IBM FileNet eForms for P8 3.5.1 configuration. For in-process documents, you must add the allowExportingIncompleteData entry to the eforms-preferences.xml file and set the value to true for each template in which you want error handling to allow the Launch and Complete action to export data when a form contains invalid data:
Task 2: (Optional) Migrate from eForms for P8 3.5.1 To migrate from eForms for P8 3.5.1
44
You must add the template node entry multiple times, as appropriate, to specify multiple templates. Example
<?xml version="1.0" encoding="utf-8" ?> <preferences> <customer> <templates> <template uri="p8:{object store ID1}.{template ID1}> <allowExportingIncompleteData>true</allowExportingIncompleteData> </template> <template uri="p8:{object store ID2}.{template ID2}> <allowExportingIncompleteData>true</allowExportingIncompleteData> </template> <template uri="p8:{object store ID3}.{template ID3}> <allowExportingIncompleteData>true</allowExportingIncompleteData> </template> </templates> </customer> </preferences>
4. Remove all parameter mechanism use for prefills from form templates and, instead, use the AEUI post or get mechanism. Use of the parameter mechanism is deprecated for eForms for P8 4.x and later. Condition In eForms for P8 3.5.1, no API was available to perform cell prefill activities for forms. Some clients implemented use of performing prefill activities such as through the parameter mechanism. In eForms for P8 4.0, Application Engine UI service command mechanisms ( post and get) were introduced to handle prefills. Calls that do not adhere to the AEUI post and get mechanism requirements are not supported and must be removed. Non-standard calls will typically produce an error such as, Unable to convert that value to a date. Solution Change all the prefill calls that use the parameter mechanism to instead use the AEUIS commands, post and get. For details on the use of these commands, refer to the Application Engine UI Service Command Reference section of the P8 Platform Help. NOTE Any data returned to eForms for P8 will be in canonical format. 5. If your eForms for P8 3.5.1 configuration maps null (empty string) values from workflow data fields to form fields, you must enter the new null value bootstrap setting parameter for IBM FileNet Application Engine and IBM FileNet Workplace XT. Workplace XT must be upgraded to version 1.1.4 or later for this parameter to be available.
Task 2: (Optional) Migrate from eForms for P8 3.5.1 To migrate from eForms for P8 3.5.1
45
Condition In eForms for P8 3.5.1, null values (empty strings) were treated as populated data fields. In eForms for P8 4.0 and later, null values are handled as unpopulated fields, which contain no data and, as such, null values are not mapped. Solution If your eForms for P8 3.5.1 configuration uses mapped null (empty string) values from workflow data fields to form fields, to ensure continued support of this functionality, you must add the following entry to the bootstrap.properties file and set the value to true:
eFormsDefaultMapNullValue=value
If the value is not set, eForms for P8 will default this value to false and will not map null values.
46
47
c. Click Change/Remove and follow the prompts. UNIX: a. Change directory to the Application Engine or Workplace XT root install folder and execute the eforms_uninstaller.bin file. 3. Redeploy the WAR file or EAR file. For details, refer to the IBM FileNet P8 Platform Installation and Upgrade Guide. 4. Reset the eForms site preference. a. From the Workplace Admin page, click Site Preferences. b. On the General Site Preferences page, under General Settings > Application > eForms Installed, select No from the drop-down list. c. Click Apply to save your changes.
48
The preferences file should include only the settings that need to be overridden. For example, the following code modifies only the maximum size of the template cache. All other features assume the default behavior.
<?xml version="1.0" encoding="utf-8"?> <preferences> <caching> <templateCache maxSize="512" /> </caching> </preferences>
To set preferences 1. Use a text editor to open the eForms-preferences.xml file in the AE or Workplace XT install directory. 2. Using XML tags, refer to the lists below and write the code for the settings you need.
49
Settings
Update Period Use this setting to specify the period in minutes at which the settings from the configuration file are updated in the cache. The default value is 10 minutes. Example
<?xml version="1.0" encoding="utf-8"?> <preferences updatePeriod=5 />
Heartbeat Period Use this setting to specify the period in seconds at which heartbeat requests are made to refresh cached content for open HTML eForms. The default value is 180 seconds (3 minutes). Example
<?xml version="1.0" encoding="utf-8"?> <preferences> <caching heartbeatPeriod=120 /> </preferences>
Heartbeat Restoration Period When a heartbeat request fails, a warning that the server connection is lost is presented to the user. Then the heartbeat period changes as specified by this setting. When the server connection is restored, the user is notified and the heartbeat returns to its original period. Typically, the heartbeat restoration period is short to provide more immediate feedback when the connection is restored. However, this can result in more network traffic if, for example, the server is shut down. Use this setting to specify the period in seconds at which heartbeat requests are made while in this state. The default value is 10 seconds. Example
<?xml version="1.0" encoding="utf-8"?> <preferences> <caching heartbeatRestorationPeriod="30" /> </preferences>
50
Template Cache Purge Period Use this setting to specify the period in seconds at which stale templates are purged from the template cache. The default value is 60 seconds. Example
<?xml version="1.0" encoding="utf-8"?> <preferences> <caching> <templateCache purgePeriod="30" /> </caching> </preferences>
Template Cache Expiration Interval Use this setting to specify the interval in minutes after which a cached template becomes stale. The default value is 60 minutes. Example
<?xml version="1.0" encoding="utf-8"?> <preferences> <caching> <templateCache expirationInterval="240" /> </caching> </preferences>
Template Cache Maximum Size Use this setting to specify the maximum size in megabytes of the template cache. The default value is 128 megabytes. Example
<?xml version="1.0" encoding="utf-8"?> <preferences> <caching> <templateCache maxSize="512" /> </caching> </preferences>
51
Data Cache Purge Period Use this setting to specify the period in seconds at which stale data items such as pictures and attachments are purged from the data cache. The default value is 60 seconds. Example
<?xml version="1.0" encoding="utf-8"?> <preferences> <caching> <dataCache purgePeriod="30" /> </dataCache> </caching> </preferences>
Data Cache Expiration Interval Use this setting to specify the period in minutes after which stale data items such as pictures and attachments in the data cache become stale. The default value is 15 minutes. Example
<?xml version="1.0" encoding="utf-8"?> <preferences> <caching> <dataCache expirationInterval="10" /> </caching> </preferences>
Login to Delete When you install FileNet eForms for P8, the value for the Secure Login to Delete Signatures attribute is set to false. With this setting, users who sign a form using the I-Sign (P8) signature service are prompted for a username and password before they can sign; however, any user can later delete the signature from the form. If you change the value for the Secure Login to Delete Signatures attribute to true and a user signs a form, only that user can delete the signature. Example
<?xml version="1.0" encoding="utf-8"?> <preferences> <iSign loginToDelete="true" /> </preferences>
52
SQL Connections
Use these settings to associate ODBC-style DSN names with JDBC connection settings. These settings allow you to configure an ODBC auto-increment, lookup, or submit in eForms Designer which can be supported via JDBC in eForms for P8. The driver and url (connection string) settings are required. The user and password settings are optional. Example
<?xml version="1.0" encoding="utf-8"?> <preferences> <sql> <connection dsn="ED-SQL2000" driver="com.microsoft.jdbc.sqlserver.SQLServerDriver" user="sa" password="Passw0rd" url="jdbc:microsoft:sqlserver://edSQL2000;DatabaseName=SQLAutomation"> </connection> </sql> </preferences>
Font Mapping
Use these settings to associate font names specified in the eForms template to system font names. These system fonts are used in place of the font specified in the template when printing or when rendering a PDF or TIFF image. If desired, multiple system font names can be specified. The first system font found will be used. If a mapping is not specified or if a mapped system font cannot be found, a suitable default system font is used. NOTE After you install new fonts, you must restart your web server. Windows Print and graphics rendering services are available out-of-the box for Java web servers running on Windows. These services include rendering graphics and images in PDF or TIFF format or printing to a network printer. All True Type Unicode fonts that represent printable characters in the range U+0000 to U+FFFF and installed on the host computer are supported. Copy any fonts used in your eForms templates into the system\Fonts folder. UNIX Print and graphics rendering services are available on supported non-Windows platforms. The out-of-the-box availability on these platforms includes rendering graphics and images in PDF or TIFF format or printing to a network printer. Only Java native fonts (Lucida family) are supported out-of-the-box. All True Type Unicode fonts that represent printable characters in the range U+0000 to U+FFFF and installed on the host computer are supported after the Java environment is configured. Install all True Type fonts to $JAVA_HOME/jre/lib/fonts.
53
The FileNet eForms for P8 software will attempt to locate the UNIX font directory, but as the location can vary for each UNIX installation, you can manually enter the location in the preferences to ensure it is found. To set the fonts directory location, add the path attribute to the fonts element as shown below. Example
<?xml version="1.0" encoding="utf-8"?> <preferences> <fonts path=/usr/X/lib/X11/fonts> <font name="Helvetica" systemName="Arial,Sans Serif" /> </fonts> </preferences>
NOTE If the specified font cannot be located, Helvetica will be substituted for all fonts. If the font cannot handle a character in a string, that portion of the string is left blank.
Printing
Use these settings to associate printer names with network printers and to specify a default printer. The printer name may be any string value and the network printer must be referenced by its system name. For example:
Win32 Printer : \\server\printername Unix Printer : printername
If not configured, the default printer is the first printer in the list. Example
<?xml version="1.0" encoding="utf-8"?> <preferences> <printing defaultPrinter="Engineering"> <printer name="Engineering" systemName="Unix Printer : Engineering" /> <printer name="Marketing" systemName="Unix Printer : Marketing" /> </printing> </preferences>
Index
54
Index
A
About 7 About this document 7 Acronyms 9
S
service packs and interim fixes 7
T
Typographical conventions 8
C
Configuration/startup Tasks 28
U
UNIX settings, render PDF and TIFF 26 Upgrade earlier versions 34 eforms for P8 37 prepare 33 UNIX interactively 39 UNIX silently 39 Windows interactively 38 Windows silently 38
D
documentation install 22
E
eForms site preferences, set 31 eForms step processors, configure 29
I
Install UNIX interactively 26 UNIX silently 26 Windows interactively 25 Windows silently 25 Install IBM FileNet eForms for P8 24 Installation planning 16 prerequisites 17 Installation and upgrade worksheet 20
P
preferences configuration file 48 expirationInterval 50, 51 font mapping 52 heartbeatPeriod 49 heartbeatRestorationPeriod 49 loginToDelete 51 maxSize 50 printing 53 purgePeriod 50, 51 reference 48, 49 set 48 SQL Connections 52 updatePeriod 49 Process Engine, adjust settings 23 Process Routers, connect to 29
R
remove eForms software 47 IBM FILENET EFORMS FOR P8 INSTALLATION AND UPGRADE GUIDE
Notices
55
Notices
Notices
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the users responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106-0032, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.
Notices
56
Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation J46A/G4 555 Bailey Avenue San Jose, CA 95141-1003 blank U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBMs future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs.
Trademarks
57
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. If these and other IBM trademarked terms are marked on their first occurrence in this information with a trademark symbol ( or ), these symbols indicate U.S. registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web at Copyright and trademark information at www.ibm.com/legal/copytrade.shtml.
Trademarks
FileNet is a registered trademark of FileNet Corporation, in the United States, other countries, or both. Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Windows, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Other company, product, and service names may be trademarks or service marks of others.
58
59
60
Printed in USA
GC19-2724-01