Front-Office Server 2.7

(1)

Configuration Guide for IBM Content Manager

KOFAX

Front-Office Server

2.7 8.2 and 8.3

(2)

Third-party software is copyrighted and licensed from Kofax’s suppliers. For information on third-party software included in this product, see “KFSTHIRDPARTYLICENSEREADME.txt.”

This product is protected by U.S. Patent No. 6,370,277.

THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF KOFAX, INC. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF KOFAX, INC.

Kofax, the Kofax logo, VirtualReScan, the “VRS VirtualReScan” logo, and VRS are trademarks or registered trademarks of Kofax, Inc. in the U.S. and other countries. All other trademarks are the trademarks or registered trademarks of their respective owners.

U.S. Government Rights Commercial software. Government users are subject to the Kofax, Inc. standard license agreement and applicable provisions of the FAR and its supplements.

You agree that you do not intend to and will not, directly or indirectly, export or transmit the Software or related documentation and technical data to any country to which such export or transmission is restricted by any applicable U.S. regulation or statute, without the prior written consent, if required, of the Bureau of Export Administration of the U.S. Department of Commerce, or such other governmental entity as may have jurisdiction over such export or transmission. You represent and warrant that you are not located in, under the control of, or a national or resident of any such country.

DOCUMENTATION IS PROVIDED “AS IS” AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF

(3)

Introduction

This guide shows how to configure IBM DB2 Content Manager 8.2 and 8.3 and Kofax Front-Office Server. Item types in IBM Content Manager appear as destinations in Kofax Front-Office Server, and you can select attributes that appear as index fields. In IBM Content Manager System Administration Client, you create item types and attributes and then grant permissions to the necessary users by creating user groups and access control lists. You can add Kofax Front-Office Server users to IBM Content Manager or use Kofax Front-Office Server Web Client to associate Kofax Front-Office Server users with IBM Content Manager users. In the IBM Content Manager client, you create folders that match the item types.

Additional Documentation

This guide should be read with the following documentation:

Kofax Front-Office Server Installation Guide Kofax Front-Office Server Administrator’s Guide

Kofax Front-Office Server Administration Console Help Kofax Front-Office Server Web Client Help

For information about IBM Content Manager, refer to the documentation that came with the product or contact IBM for support.

Tip For additional information about Kofax products, visit the Kofax Web site and go to the

Technical Support pages. These pages provide product-specific information, such as supported versions of the destination type, current revision levels, the latest drivers and software patches, technical tips, and a searchable knowledgebase. In addition, updates to product documentation (if any) are available from these pages.

System Requirements

Before configuring IBM Content Manager, install the following. These should be on separate servers:

Kofax Front-Office Server IBM Content Manager Server

Required IBM Content Manager Files on Kofax Front-Office Server

On the server where Kofax Front-Office Server is installed, you must also install the following IBM Content Manager files:

DB2 run-time files

Information Integrator for Content (II4C) connector

You may also install the IBM DB2 Content Manager Client for Windows for convenient access to files in Content Manager.

(6)

Note the following:

Because these IBM Content Manager 8.2 and 8.3 files are not supported on 64-bit Windows

system, the IBM Content Manager connector cannot be used when Kofax Front-Office Server is installed on a 64-bit Windows system.

When installing the II4C connector, be sure to use the correct connection ID, which may be

different from the administrator’s ID. If the wrong connection ID is specified, users will not be able to connect through Kofax Front-Office Server.

Configuring IBM Content Manager

This section provides basic procedures for using IBM Content Manager System Administration Client to set up IBM Content Manager to use with Kofax Front-Office Server. Refer to the IBM Content Manager documentation for complete instructions.

Setting Up User Accounts

Kofax Front-Office Server and IBM Content Manager use separate security systems. To send documents to IBM Content Manager, you need to log on with a valid IBM Content Manager user account as follows:

Users sending documents through Kofax Front-Office Server Web Client are prompted to

enter an IBM Content Manager user name and account when they expand the list of destinations. Once they have logged on successfully, the credentials are saved.

Administrators setting up global and group shortcuts can save an IBM Content Manager

user name and password for the IBM Content Manager destination type. The credentials are used as defaults when creating shortcuts for IBM Content Manager destinations. Administrators can override the defaults by assigning different user accounts to individual shortcuts.

After the credentials have been saved, users or administrators are not prompted for an IBM Content Manager user name and password unless they were changed.

Refer to the Help for Kofax Front-Office Server Web Client and Kofax Front-Office Server Administration Console for instructions.

Creating Kofax Front-Office Server User Accounts in IBM Content Manager

Use IBM Content Manager System Administration Client to create users and grant them the necessary privileges. The following procedure provides a basic example of creating IBM Content Manager users who will use Kofax Front-Office Server. This consists of the following general steps:

Create a privilege set with the appropriate rights for a Kofax Front-Office Server

destination.

Create a user group for Kofax Front-Office Server users. Create the user accounts for Kofax Front-Office Server.

Create an access control list for users of an item type. You can create different access

(7)

X To create a privilege set for Kofax Front-Office Server Users

1 Start IBM Content Manager System Administration Client. Log on to the server for IBM

Content Manager and use an administrator’s user ID and password.

2 In the DB2 Content Manager panel on the left side of the IBM Content Manager System

Administration Client, expand the listing for Authorization. There should be four items underneath it: Privileges, Privilege Groups, Privilege Sets, and Access Control Lists.

3 Right-click Privilege Sets. From the menu that appears, select New | Advanced. The New

Privilege Set Definition (Advanced) window appears.

4 In the Name field, type the name of the privilege set.

5 Under Privileges, select only the following. The privileges appear under “Selected

privileges” as you select each check box.

ItemAdd ItemAddLink ItemAddPart ItemLinkTo ItemLinked ItemQuery ItemSQLSelect ItemSetUserAttr ItemTypeQuery

6 Click OK. The New Privilege Set Definition (Advanced) window closes, and the new

privilege set appears in the IBM Content Manager System Administration Client window. X To create user groups for Kofax Front-Office Server Users

1 If you are not in IBM Content Manager System Administration Client, log on.

Administration Client, expand the listing for Authentication. There should be two items underneath it: Users and User Groups.

3 Right-click User Groups. From the menu that appears, select New. The New User Group

window appears.

4 In the Name field, type a name for the user group. Leave the other fields empty.

5 Click OK. The New User Group window closes, and the new user group appears in the

IBM Content Manager System Administration Client window. X To create user accounts for Kofax Front-Office Server Users

Administration Client, expand the listing for Authentication, if it is not already.

3 Right-click Users. From the menu that appears, select New. The New User window

appears.

4 On the Define Users tab, complete the following fields that are required for use with

Kofax Front-Office Server. The other fields are optional. Refer to the IBM Content Manager documentation for more information.

(8)

when you expand the IBM Content Manager listing in Kofax Front-Office Server Web Client.

Password: Type the password. This can match the password of the Kofax Front-Office

Server user account, or you can enter this password when you expand the IBM Content Manager listing in Kofax Front-Office Server Web Client.

Confirm password: Type the same password you entered in the Password field. Password expiration: Select the option that meets your password policy. For the Kofax

Front-Office Server administrator and default user accounts, we recommend that you select “Never expires” so that you do not need to change the passwords in Kofax Front-Office Server Web Client later.

Note If you select “At next logon,” make sure that the user obtains a new password

before connecting to IBM Content Manager through Kofax Front-Office Server Web Client.

Maximum privilege set: Select the privilege set you created.

5 Click the Assign to Groups tab. Under “Assign the users to one or more groups,” select

the user group you created earlier. If the user belongs to more than one user group, select them. To select several groups, press Ctrl as you click each one. To select a range of groups, press Shift as you click the first and last groups of the range.

6 Click the Set Defaults tab. Complete the tab as follows:

a Set the “Default resource manager” and “Default collection” fields to the appropriate

settings for your IBM Content Management system. Normally, these settings will be the defaults.

b If you have not already created an access control list, select PublicReadACL in the

“Default item access control list” field. You will add the user to an access control list for your item type later. If you have already created an access control list, select it.

7 Click OK to create the user account. The New User window closes, and the user name

appears in the IBM Content Manager System Administration Client window. X To create an access control list

Administration Client, expand the listing for Authorization.

3 Right-click Access Control Lists. From the menu that appears, select New. The New

Access Control List Definition window appears.

4 In the Name field, type the name of the access control list.

5 Under “Find groups/users,” type the name of the user group (not the individual user

accounts) you created and click Find. You can use the options and buttons in the “Find groups/users” section to find the user group. Refer to the IBM Content Manager System Administration Client Help for instructions.

6 When the group you want appears in the table below the Show options, select it. 7 Under Privilege Sets, select the privilege set you created for Kofax Front-Office Server.

The Add button should be enabled.

8 Click Add. The pairing of the user group and privilege set should appear in the table. 9 Click OK. The New Access Control List Definition window closes, and the access control

(9)

10 Apply the new access control list to the user accounts that were created before you

defined the access control list. Do the following:

a Click Users, which is under Authentication. A list of users appears on the right. b Right-click the user you want to change. From the menu that appears, select

Properties.

c Click the Set Defaults tab.

d Change the “Default item access control list” to the access control list you just created. e Click OK.

Setting Up Destinations

Use IBM Content Manager System Administration Client to create the item types that you will use as Kofax Front-Office Server destinations. The item type name appears in Kofax Front-Office Server Web Client. When you create the item type, select an attribute to identify the document name and any others that you want to appear as index fields in Kofax Front-Office Server. Use one of the following options for storing documents in IBM Content Manager System:

In a folder with the same name as the item type In a specified folder

Without linking to any specific folder

You specify which option to use in the rs.connector.ibmcm.properties as shown in Configuring Kofax Front-Office Server on page 10.

If you want to store documents in folders in IBM Content Manager System, you might need to create folders in Client for Windows. When defining a folder, select an existing item type, or create a new item type that has at least one attribute selected as“Represents item” and a privilege set with at least the following privileges:

ItemAdd ItemAddLink ItemLinkTo ItemQuery ItemSetUserAttr ItemSQLSelect ItemTypeQuery

This section provides a basic procedure for creating an item type and a folder for documents. The item type in this example uses the access control list you defined in the previous section. The access control list is associated with a privilege set that includes the necessary privileges. For complete information about creating item types and folders, refer to the IBM Content Manager documentation.

X To create an item type

(10)

4 On the Definition tab, type the name in the Name field. As you type the name, it also

appears in the “Display name” field.

Note Leave the “Display name” field at its default. It is not used by Kofax Front-Office

Server.

5 Click the Access Control tab. In the “Item type access control list” field, select the access

control list you created for users who will use this item type.

6 Click the Attributes tab. Add any attributes you want to use as index fields.

Note Do not use attribute groups. Attributes in attribute groups do not appear in Kofax

Front-Office Server destinations.

7 Click the Document Management tab. Complete the tab as follows:

a Click Add. The Define Document Management Relations window appears. b In the “Part type” field, select ICMBASE.

c In the “Access control list” field, select the access control list that you created. d Click OK. The Define Document Management Relations window closes, and the

settings appears as a row in the table.

8 Complete the other tabs, if desired.

9 Click OK. The New Item Type Definition window closes, and the access control list name

appears in the IBM Content Manager System Administration Client window. X To create a folder

1 Start Client for Windows. Log on to the server for IBM Content Manager and use an

administrator’s user ID and password.

2 Search for an existing document in any folder. If IBM Content Manager does not have any

documents, import one.

3 Right-click a document. From the menu that appears, select “Add to new Folder.” The

Add to New Folder window appears.

4 Complete the Add to New Folder window as follows: a Select “Open folder in new window.”

b In the Item Type field, select the item type that you want to use for the folder. The Item

Type must have at least one attribute selected as “Represents item.”

c In the field which was selected as “Represents item”, type the folder name. This name

must match the item type name for the document if you want to store documents in a folder named by its item type.

d Leave the other fields in their default settings.

e Click Create. A window opens for your new folder, and it contains the document you

selected. You can delete the document.

Configuring Kofax Front-Office Server

(11)

Note To help in copying the files, create a shared folder on one computer that is accessible to the

other. You can then copy the Content Manager files into the shared folder and then move them to the appropriate Kofax Front-Office Server folder.

X To configure Kofax Front-Office Server for IBM Content Manager

1 On the server where Kofax Front-Office Server is installed, locate the following files

where the DB2 run-time files and II4C connector is installed. The paths are based on a default installation. If you had installed IBM Content Manager in a different path, locate the files in the appropriate folder.

C:\Program Files\IBM\db2cmv8\cmgmt\connectors\cmbicmenv.ini C:\Program Files\IBM\db2cmv8\cmgmt\connectors\cmbicmsrvs.ini C:\Program Files\IBM\db2cmv8\lib\cmbcm81.jar

C:\Program Files\IBM\db2cmv8\lib\cmbicm81.jar C:\Program Files\IBM\SQLLIB\java\db2java.zip

2 Copy (do not move) the IBM Content Manager files to folders shown in Table 1. The paths

listed in the table are relative to the folder where Kofax Front-Office Server is installed (such as C:\Program Files\Kofax\Front-Office Server).

3 Copy the db2java.zip file to the \Avalin\jboss\server\avalin\lib folder where Kofax

Front-Office Server is installed.

4 Open rs.connector.ibmcm.properties in a text editor. Edit the following properties, and

then save and close the file:

folder.option default.folder

5 Copy rs.connector.ibmcm.properties from the \Resources\setup folder to the

\Avalin\jboss\server\avalin\conf folder where Kofax Front-Office Server is installed.

6 Stop and restart Kofax Front-Office Server.

7 Deploy RSModuleConnectorIBMCM.ear: Copy the file from the \Resources\setup folder

to the \Avalin\jboss\server\avalin\deploy folder where Kofax Front-Office Server is installed.

8 Use Kofax Front-Office Server Administration Console to enable the IBM Content

Manager destination type, and to associate the newly available IBM Content Manager module to the desired roles. Refer to the Kofax Front-Office Server Administration Console Help for instructions.

The IBM Content Manager destinations should display in Kofax Front-Office Server Web Client and Kofax Front-Office Server Administration Console. To display these IBM Content Manager

Table 1. IBM Content Manager Files and Paths for Application Servers

File Copy to Location

cmbicmenv.ini \Avalin\jboss\bin cmbicmsrvs.ini \Avalin\jboss\bin

(12)

Web Client and Kofax Front-Office Server Administration Console. Refer to the Help for these applications for information.

Note Stop and restart Kofax Front-Office Server whenever you change document types in IBM

Content Manager. Changes in document types do not appear until you restart, even if you refresh the list of destinations.

Frequently Asked Questions

If the software does not work correctly, or if you have questions about how the software operates, refer to the information in this section. You can find additional information and software updates on the Kofax Web site.

Why does IBM Content Manager not display as a destination type in Kofax Front-Office Server Web Client and Kofax Front-Office Server Administration Console?

Check the following:

Make sure you have performed the procedures shown in Configuring IBM Content Manager on page 6 and Configuring Kofax Front-Office Server on page 10.

Create users in IBM Content Manager to correspond with users in Kofax Front-Office

Server. Refer to Setting Up User Accounts on page 6.

Enable the IBM Content Manager destination type in Kofax Front-Office Server

Administration Console.

Refresh the browser window.

My document type does not appear under IBM Content Manager. What do I do?

Check the following:

You have added the IBM Content Manager user to a group or role and then assigned the

role to the document type and cabinet.

The name of the item type and folder match exactly.

If you changed document types, stop and restart Kofax Front-Office Server.

How do I send documents to a destination from the MFP?

Create shortcuts in Kofax Front-Office Server Administration Console and Kofax Front-Office Server Web Client. Shortcuts created with Kofax Front-Office Server Administration Console are available to all users of an MFP. Users can create their own shortcuts with Kofax Front-Office Server Web Client.

Why am I unable to send documents to IBM Content Manager from the MFP?

Make sure that you have established credentials for an IBM Content Manager user in Kofax Front-Office Server Administration Console. Refer to Setting Up User Accounts on page 6.

Why can I connect to IBM Content Manager through Windows, but not through Kofax Front-Office Server?

When installing the II4C connector on the computer where Kofax Front-Office Server is installed, be sure to use the correct connection ID, which may be different from the administrator’s ID.

How do users verify that their documents are being sent to a destination?

(13)

Technical Support

For additional technical information about Kofax products, visit the Kofax Web site at

www.kofax.com and select an appropriate option from the Support menu. The Kofax Support pages provide product-specific information, such as current revision levels, the latest drivers and software patches, online documentation and user manuals, updates to product release notes (if any), technical tips, and an extensive searchable knowledgebase.

The Kofax Web site also contains information that describes support options for Kofax products. Please review the site for details about the available support options.

If you need to contact Kofax Technical Support, please have the following information available:

Kofax Front-Office Server software version and build number Operating system and service pack version

MFP or scanner make and model Kofax Document Scan Server version

(14)

Front-Office Server 2.7

Configuration Guide for IBM Content Manager

KOFAX