IBM Content Collector for SAP Applications Version 3 Release 0. Configuring Content Collector for SAP for use with IBM FileNet P8: Best practices

Transcription

1 IBM Content Collector for SAP Applications Version 3 Release 0 Configuring Content Collector for SAP for use with IBM FileNet P8: Best practices

2

3 IBM Content Collector for SAP Applications Version 3 Release 0 Configuring Content Collector for SAP for use with IBM FileNet P8: Best practices

4 Note Before using this information and the product it supports, read the information in Notices on page 217. Second edition (July 2013) This edition applies to version 3, release 0, modification 0 of IBM Content Collector for SAP Applications (product number 5725-B46) and to all subsequent releases and modifications until otherwise indicated in new editions. Technical changes and major changes to the text since the previous edition are indicated by a vertical bar () to the left of each new or changed line of information. Copyright IBM Corporation 2010, US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

5 Contents About this information vii Intended audience vii Terminology and conventions used in this information vii Screen captures viii ibm.com and related resources viii Contacting IBM ix What's new in Version xi What's new in the third edition xi What s new in the second edition xi Chapter 1. General information Default location of installed files and of files created at run time Mapping the names of attributes or properties.. 2 Chapter 2. Preparing your environment Preparing your environment for Collector Server Preparing your environment for Collector Server on Linux or UNIX Preparing your environment for Collector Server on Windows Setting up a basic SAP system Creating a user with CPIC access Restricting the access of the CPIC user Creating a role and a profile for the CPIC user Assigning the role to the CPIC user Linking a logical system to the SAP client Defining a number range for SAP ArchiveLink Chapter 3. Configuring FileNet P8 for use with Content Collector for SAP Properties necessary to read, archive, update, and delete documents: Overview Chapter 4. Configuring Collector Server Configuring Collector Server for use with FileNet P Server configuration profile: General information and structure Creating a server configuration profile for FileNet P Configuring the connection between Collector Server and SAP Setting the number of Java RFC dispatchers Setting up the connection between Collector Server and SAP through HTTP Setting the number of HTTP dispatchers Creating an SAP ArchiveLink protocol for use by the HTTP connection Creating SAP ArchiveLink queues for use by the HTTP connection Creating a content repository for the HTTP connection Sending an SAP certificate to Collector Server Setting up the connection between Collector Server and SAP through Remote Function Call (RFC) Setting the number of RFC dispatchers Creating an RFC destination Creating an SAP ArchiveLink protocol for use by the Remote Function Call (RFC) connection Creating SAP ArchiveLink queues for use by the Remote Function Call (RFC) connection Creating a content repository for the Remote Function Call (RFC) connection Enabling Collector Server to connect to SAP Starting Collector Server for the first time Stopping Collector Server Chapter 5. Configuring Archiving Client Setting up Archiving Client Defining the connection to Collector Server Specifying the directory for the temporary files Loading the modules for the queues Specifying the number of bar codes in a batch job Sending the document format of the queues to SAP Enabling logging and tracing for Archiving Client Completing the setup of Archiving Client Managing the queues Creating queues Creating queues if the scanned documents are in the file system Providing details about the queue of type DirQueue Defining the connection to Collector Server Connecting the queue to a logical archive Providing details about the directory Completing the creation of the queue of type DirQueue Creating queues if the scanned documents are in the file system and a description file exists Copyright IBM Corp. 2010, 2012 iii

6 Making the document classes available for property mapping Providing details about the queue of type FileQueue Defining the connection to Collector Server Connecting the queue to a logical archive Providing details about the directory and the description file Specifying the attributes values to be stored in the logical archive or in SAP Completing the creation of the queue of type FileQueue Saving and reusing the queue information Viewing and changing the properties of a queue Viewing the connection between Archiving Client and the Collector Server instances Deleting a queue Adding or removing SAP document formats Enabling Collector Server to use Archiving Client Chapter 6. Configuring P8 Client Logging on to Workplace or Workplace XT as an administrator Configuring the Browse portlet Registering the Browse portlet and adding it to the My Workplace view Defining the connection to Collector Server Setting up My Workplace Selecting the object store and the folder Configuring the Queue portlet Registering the Queue portlet and adding it to the My Workplace view Defining the connection to Collector Server Setting up My Workplace Associating the Queue portlet with a P8 queue Chapter 7. Configuring P8 Client SAP Connector Registering P8 Client SAP Connector with SAP Creating an SAP ArchiveLink application for linking FileNet P8 objects Adapting the SAP ArchiveLink protocol for linking FileNet P8 objects Chapter 8. Configuring Utility Client Setting up an index transfer Specifying the document classes whose properties are to be mapped to SAP attributes Defining the connection to the SAP server Defining the connection to Collector Server Defining an archive Mapping the SAP attribute to be transferred to an archive attribute Creating an index transfer profile Creating an index transfer session Setting up a document-linking process Specifying the document classes whose properties are to be mapped to the SAP workflow attributes Defining the connection to the SAP server Defining the connection to Collector Server Defining an archive Creating a document-linking session Managing the configuration of Utility Client Changing the preferences of Utility Client 105 Chapter 9. Configuring Viewing Client Setting up Viewing Client Defining the connection to Collector Server Specifying the directory for temporary files Specifying a viewer application Enabling logging and tracing for Viewing Client Enabling the closing of applications Completing the setup of Viewing Client Enabling Collector Server to use Viewing Client 113 Chapter 10. Configuring your environment for basic tasks Configuring for archiving data Setting up the sample archiving object FI_BANKS Configuring the SAP ArchiveLink path Checking your data archiving configuration Creating test data for the sample archiving object Running an archiving session to test your archiving setup Configuring for archiving incoming documents Configuring for archiving incoming documents by creating work items in an SAP workflow Associating the document type of the incoming documents with an SAP workflow Registering Archiving Client with SAP Creating an SAP ArchiveLink application for archiving documents Adapting the SAP ArchiveLink protocol for archiving documents Configuring for archiving incoming documents by processing their bar codes Configuring for archiving outgoing documents Configuring for linking FileNet P8 objects to SAP Configuring for linking archived documents by using Utility Client Associating the document type of the archived documents with an SAP workflow Enabling Collector Server for linking archived documents by using Utility Client Configuring for linking FileNet P8 objects by using P8 Client iv Content Collector for SAP: Configuring for use with FileNet P8: Best practices

7 Enabling Collector Server to use P8 Client Creating P8 queues and workflows Configuring for archiving and viewing print lists Defining an archive device Associating the document type of the print lists with an SAP workflow Creating an SAP ArchiveLink batch job Enabling extended ALF viewing Enabling print-list viewing Configuring for viewing archived documents with the SAP GUI Configuring for viewing archived documents with an external viewer application Registering Viewing Client with SAP Creating an SAP ArchiveLink application for viewing documents Adapting the SAP ArchiveLink protocol for viewing documents Configuring an SAP ArchiveLink application for closing viewer applications Configuring for viewing FileNet P8 objects with the viewer application embedded in Workplace or Workplace XT Configuring for transferring index information 183 Chapter 11. Configuring your environment for more or advanced tasks Preventing the storage of web content in the browser cache Enabling caching of retrieved documents Setting timeout periods for the RFC or Java RFC dispatcher and the agents Setting the timeout period for the RFC or Java RFC dispatcher Setting the timeout period for the agents Creating several instances of Collector Server Creating more instance directories Configuring the server configuration profiles for the instances Assigning fixed ports to the client dispatchers Running Collector Server as a service Installing Collector Server as a service and uninstalling the service Starting and stopping the service Running several instances of Collector Server as services Hints and tips Configuring for viewing documents from several SAP systems Configuring for preprocessing outgoing documents The preprocessor user exit Requirements for running a preprocessor The input for the preprocessor The result from the preprocessor The format of the result file The format of the result object The preprocessor Including the preprocessors in the archiving process Enabling Collector Server to log on to an SAP logon group Linking documents to SAP by using the Cold program Linking documents that are not archived yet by using the Cold program Linking archived documents by using the Cold program Integrating IBM Datacap and Content Collector for SAP Deploying the archiving capability on Datacap Deploying the archiving capability on Datacap Version Deploying the archiving capability on Datacap Version Setting up a secure connection to Collector Server and adapting the client configuration profile Setting the custom actions ICCAccessExit ICCAccessInit ICCAccessInit ICCAddArchiveProperty ICCAddSAPProperty ICCArchiveCreateWI ICCArchiveFileName ICCArchiveID ICCArchiveSendBarcode ICCDocType ICCFileExtension ICCFilePath ICCSetDLLTraceFile ICCSetDLLTraceLevel Integrating Content Collector for SAP into the SAP Solution Manager Notices Privacy policy considerations Trademarks Glossary Index Contents v

8 vi Content Collector for SAP: Configuring for use with FileNet P8: Best practices

9 About this information Intended audience This book shows how to configure IBM Content Collector for SAP Applications for use with IBM FileNet P8. For better guidance, it includes screen captures of the Content Collector for SAP windows and the SAP windows. This book is intended for administrators who are responsible for configuring IBM Content Collector for SAP Applications. Administrators should have an in-depth knowledge of SAP and the archives that they intend to use. It is assumed that they are familiar with the three-tier architecture of SAP and that they have a basic understanding of document management and the archives. In addition, they should have a good working knowledge of the underlying operating system. This book also addresses programmers who must create customized archive clients, and who must therefore familiarize themselves with the concepts of IBM Content Collector for SAP Applications and SAP so that they can modify and extend sample code. Terminology and conventions used in this information To facilitate reading, product names are abbreviated in this information, where applicable. In addition, you might have changed the names of specific files and paths when you installed IBM Content Collector for SAP Applications Version 3.0. The default names are shown in this section. v v IBM Content Collector for SAP Applications Version 3.0 is abbreviated to Content Collector for SAP. To improve readability, the following product names are often abbreviated as shown in the following table: Full name FileNet Application Connector for SAP R/3, J2EE Edition FileNet Application Engine FileNet Content Engine FileNet Image Services FileNet Process Engine FileNet Workplace FileNet Workplace XT Abbreviated name FileNet Application Connector for SAP Application Engine Content Engine Image Services Process Engine Workplace Workplace XT v The following path variables are used in this information, listed in alphabetical order: Windows env_var_appdata The full path to the directory that contains the application-specific files for a user. To determine the path, open a command prompt and enter the following command: Copyright IBM Corp. 2010, 2012 vii

10 echo %APPDATA% InstallHome The full path to the directory where Content Collector for SAP is installed. The default installation path is: Linux UNIX /opt/ibm/iccsap Windows C:\Program Files\IBM\ICCSAP v v v v v v Windows SystemRoot The full path to the directory that contains the files for the Windows operating system. To determine the path, open a command prompt and enter the following command: echo %SystemRoot% UserHome The full path to the directory that contains the files for a user. A FileNet P8 object is used as a generic term for archived documents, folders, stored searches, search templates, or a combination of them. Archiving is a process where data, documents, or print lists are stored in FileNet P8 and are linked to an SAP business object for future retrieval. Linking is a process where objects that are already stored in FileNet P8, are linked to an SAP business object for future retrieval. If you have FileNet Content Federation Services for FileNet Image Services installed, documents that are stored in Image Services can be accessed through FileNet P8. Phrases like documents that are stored in FileNet P8 then include the Image Services documents. P8 queues are the queues that hold the documents that are stored in FileNet P8 and that are to be processed. You might also know these queues as BPM queues. A basic environment consists of the SAP GUI, the Collector Server of Content Collector for SAP, and FileNet P8. Screen captures The explanation of the various configuration tasks is complemented by screen captures of Content Collector for SAP windows and SAP windows. The screen captures were taken on a Windows system. Most of the entries and selections in the screen captures are examples only that you can change according to your needs. The screen captures of SAP windows are based on SAP ERP Central Component (ECC) 6. If you use another version of SAP ECC, your windows might differ slightly. If possible, the entries and selections that are examples only reflect the settings in the sample configuration profile that Content Collector for SAP delivers for FileNet P8 on Windows. In the screen captures of SAP windows, the entries and selections are often surrounded by a rectangle so that they are easier to spot. ibm.com and related resources Product support and documentation are available from ibm.com. viii Content Collector for SAP: Configuring for use with FileNet P8: Best practices

11 Support and assistance From ibm.com, click Support & downloads and select the type of support that you need. From the Support Portal, you can search for product information, download fixes, open service requests, and access other tools and resources. IBM Knowledge Center See your online product information in IBM Knowledge Center at contentcollectorforsap_2.2.0.html. PDF publications See the following PDF publications for your product at docview.wss?rs=86&uid=swg Contacting IBM For general inquiries, call 800-IBM-4YOU ( ). To contact IBM customer service in the United States or Canada, call IBM-SERV ( ). For more information about how to contact IBM, including TTY service, see the Contact IBM website at About this information ix

12 x Content Collector for SAP: Configuring for use with FileNet P8: Best practices

13 What's new in Version 3.0 Content Collector for SAP Version 3.0 provides advanced archiving capabilities that help SAP users run their businesses more efficiently. Content Collector for SAP is designed to provide access to a wide range of business information, transfer older information to lower-cost storage with optional SAP retention enforcement, and improve system performance. This section summarizes the significant improvements or enhancements over Content Collector for SAP Version 2.2 and refers you to the relevant topics for more information. What's new in the third edition This edition includes the following updates: v The list of keywords that are necessary to enable Collector Server to log on to an SAP logon group has been corrected. For more information, see 4.2.4, Enabling Collector Server to connect to SAP, on page 48. v Utility Client can also be started from Linux and UNIX operating systems. For more information, see Chapter 8, Configuring Utility Client, on page 97. v If you want to view FileNet P8 objects with the viewer application embedded in Workplace or Workplace XT, you must also configure your environment for accepting user tokens. For more information, see technote # The following topic has been updated to include this information: 10.8, Configuring for viewing FileNet P8 objects with the viewer application embedded in Workplace or Workplace XT, on page 179. v The topic about fixed ports has been reworked. For more information, see , Assigning fixed ports to the client dispatchers, on page 188. v Fix Pack 1 If you use IBM Datacap Version 8.1, you must ensure that the IBM Global Secure ToolKit (GSKit) libraries of Content Collector for SAP are used by Datacap. For more information, see , Deploying the archiving capability on Datacap Version 8, on page 204. v Fix Pack 1 IBM Datacap V9 is now also supported. For more information, see 11.10, Integrating IBM Datacap and Content Collector for SAP, on page 202. v The client configuration profile must contain the keystore parameter. For more information, see , Setting up a secure connection to Collector Server and adapting the client configuration profile, on page 206. Technical changes and major changes to the text are indicated by a vertical bar () to the left of each new or changed line of information. What s new in the second edition This edition includes the following updates: Copyright IBM Corp. 2010, 2012 xi

14 v v v v v v v v v When you issue the archadmin, archcert, archpro, archservice, orarchstop command, you can omit the fully qualified file name of the server configuration profile if both of the following conditions are met: You enter the command from the directory that contains the server configuration profile. The server configuration profile has the default name archint.ini. When you specify a path in the server configuration profile, ensure that this path exists before you start Collector Server. Collector Server does not create any paths. The restriction that the value of the PE_USERID keyword must be in lowercase characters no longer applies. If you want to store documents with many components, you must increase the size of specific FileNet P8 documents. For more information, see Technote # The following topic has been updated to include this information: 3.1, Properties necessary to read, archive, update, and delete documents: Overview, on page 22. The R3NAME keyword must also be specified when you use Utility Client for linking FileNet P8 documents. For more information, see , Enabling Collector Server for linking archived documents by using Utility Client, on page 154. The name of the workflow that makes the documents available in the P8 queue must not exceed 31 characters. For more information, see Technote # The following topic has been updated to include this information: , Enabling Collector Server for linking archived documents by using Utility Client, on page 154. If a FileNet P8 object is not displayed by the viewer application that is embedded in Workplace or Workplace XT, check your configuration of the SAP GUI. For more information, see Technote # The following topic has been updated to include this information: 10.8, Configuring for viewing FileNet P8 objects with the viewer application embedded in Workplace or Workplace XT, on page 179. The integration of Datacap requires the installation of Microsoft.Net Version 2, or later, on the computer where Rulerunner of Datacap runs. For more information, see 11.10, Integrating IBM Datacap and Content Collector for SAP, on page 202. If you want to run Datacap as a service, you must move the CSClient.ini file to a specific directory. For more information, see , Setting up a secure connection to Collector Server and adapting the client configuration profile, on page 206. xii Content Collector for SAP: Configuring for use with FileNet P8: Best practices

15 Chapter 1. General information Which components of Content Collector for SAP and which products you must configure depends on the tasks that you want to perform with Content Collector for SAP. All tasks require a configured and running Collector Server. Thus, the following configuration steps are mandatory: 1. Chapter 2, Preparing your environment, on page 5 2. Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page 25 After you complete these steps, decide which task you want to perform with Content Collector for SAP and go to the appropriate configuration topic under Chapter 10, Configuring your environment for basic tasks, on page 115. Some tasks require additional configuration of Collector Server, the archives, or SAP. And some tasks require the configuration of one of the Content Collector for SAP clients. Restriction: Only SAP configuration tasks that are necessary for Content Collector for SAP to work successfully or for the communication between SAP and Content Collector for SAP are described in this information. For all other SAP configuration tasks, see the SAP documentation. 1.1 Default location of installed files and of files created at run time During configuration, you might have to copy or change files that were installed by Content Collector for SAP or that were created during run time. This topic gives an overview of the default location of the individual files. Table 1. Installed files File ACSystemSelection.properties Contains the Collector Servers to which the Browse portlet and the Queue portlet can connect. archint_sample_p8.ini Example of a server configuration profile. CSClient_sample.ini Example of a client configuration profile. Default location on Linux and UNIX systems WEB-INF/classes directory of your Workplace or Workplace XT installation InstallHome/server/bin Not applicable. Default location on Windows WEB-INF\classes directory of your Workplace or Workplace XT installation InstallHome\Server\ instances\instance01 env_var_appdata\ibm\iccsap env_var_appdata stands for the directory that contains the application-specific files for the user who installed Archiving Client or Viewing Client. Copyright IBM Corp. 2010,

16 Table 1. Installed files (continued) File csmimes.properties Maps the document format of the archived documents to MIME types so that SAP can display the document content correctly. ArchcheckApiSample.java Contains a sample program for calling the archcheck Java API. FileNet P8 WorkflowGeneration.pep Contains a sample workflow definition that is designed for processing bar codes. Default location on Linux and UNIX systems InstallHome/server/bin InstallHome InstallHome Default location on Windows InstallHome\Server\ instances\instance01 InstallHome InstallHome Table 2. Files that are created at run time File archint.cfg Default password file. It contains all passwords that a Collector Server instance needs to communicate with the Content Collector for SAP clients, SAP, and the archives. Default location on Linux and UNIX systems Instance path as set by the INSTANCEPATH keyword in your server configuration profile Default location on Windows Instance path as set by the INSTANCEPATH keyword in your server configuration profile It is created when you start Collector Server for the first time. 1.2 Mapping the names of attributes or properties Some of the document attributes or document properties must have specific names so that Content Collector for SAP can use these attributes or properties. If you do not specify the required names, you must map the names that you used instead, to the appropriate attributes or properties. For this purpose, you must create an attribute mapping file. You can use a different mapping file for each logical archive. Identical logical archives, however, must use the same mapping file. Two logical archives are considered identical if a specific keyword has the same value in both ARCHIVE sections. Collector Server checks the following keyword in this respect: STORAGETYPE P8 OBJECTSTORE Procedure: 1. Open a text editor. 2 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

17 2. Map your attributes or properties as follows: v On the left side of a mapping, specify the name of the Content Collector for SAP attribute or property in uppercase characters, which are preceded by the prefix INTERNAL_. v On the right side, specify the name of the attribute or the property that you assigned. For example: INTERNAL_BARCODE barcode1 3. Save the attribute mapping file with the extension txt, for example, mapping.txt. 4. Open the server configuration profile in a text editor. 5. To each ARCHIVE section that is to use the attribute mapping file, add the ATTRMAPPING_FILE keyword and specify the fully qualified path to the mapping file. For example: ARCHIVE A1... ATTRMAPPING_FILE C:\Users\iccsapadmin\AppData\Roaming\IBM\ICCSAP\ instance01\mapping.txt 6. Save the server configuration profile, and restart Collector Server for the changes to take effect. Chapter 1. General information 3

18 4 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

19 Chapter 2. Preparing your environment Content Collector for SAP requires at least one instance of Collector Server. Before you begin: You installed FileNet P8, Content Collector for SAP, and any additional programs. Procedure: , Preparing your environment for Collector Server , Setting up a basic SAP system, on page Preparing your environment for Collector Server Content Collector for SAP requires at least one instance of Collector Server. Before you begin: Plan for a secure Collector Server. For more information, see the corresponding topic in the Planning part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Preparing your environment for Collector Server on Linux or UNIX Create an instance user and an instance directory that is to contain all instance-related files. Procedure: 1. Create a user for a Collector Server instance. For example, create user iccsapadmin. 2. Log on as the Collector Server instance user. 3. Add the following call of the shell script to the.profile file, which is in the home directory of the instance user:. InstallHome/server/bin/csenv.sh Note the space between the period (.) and InstallHome. 4. Create an instance directory where all instance-related files are to be stored, in the UserHome directory. For example: /home/iccsapadmin/instance01 The instance user must have full permissions for this directory. Make a note of the path to this directory. You must specify this path for the INSTANCEPATH keyword in the server configuration profile when you configure Collector Server for use with FileNet P8. 5. In the instance directory, create a directory named SAPCertificates. The SAP certificates for the archives are stored in this directory. Important: The directory name is case-sensitive. 6. In the instance directory, create a directory named queue. Instead of creating the queue directory, you can add the QUEUEPATH keyword to the server configuration profile and specify a path to an existing directory for it. You can add the keyword when you configure Collector Server for use with FileNet P8. Copyright IBM Corp. 2010,

20 Hint: If you expect many queues, use the QUEUEPATH keyword. What to do next: 2.2, Setting up a basic SAP system Preparing your environment for Collector Server on Windows After you install Collector Server, a Collector Server instance is already set up in the InstallHome\Server\instances\instance01 directory. If you want to start Collector Server as a user without administrator rights, you must create an instance directory in a directory other than the Program Files directory. Complete the following steps to configure an instance: 1. Create the instance directory. It is good practice to create the instance directory in the env_var_appdata directory of the user who is allowed to start Collector Server. For example: C:\Users\iccsapadmin\AppData\Roaming\IBM\ICCSAP\instance01 2. Make a note of the path to the new instance directory. You must specify this path for the INSTANCEPATH keyword in the server configuration profile when you configure Collector Server for use with FileNet P8. 3. In the instance directory, create a directory named SAPCertificates. The SAP certificates for the archives are stored in this directory. 4. In the instance directory, create a directory named queue. Instead of creating the queue directory, you can add the QUEUEPATH keyword to the server configuration profile and specify a path to an existing directory for it. You can add the keyword when you configure Collector Server for use with FileNet P8. Hint: If you expect many queues, use the QUEUEPATH keyword. What to do next: 2.2, Setting up a basic SAP system 2.2 Setting up a basic SAP system To perform any of the Content Collector for SAP tasks, a basic SAP system must exist. Before you begin: 2.1, Preparing your environment for Collector Server, on page 5 Procedure: , Creating a user with CPIC access , Linking a logical system to the SAP client, on page , Defining a number range for SAP ArchiveLink, on page Creating a user with CPIC access Create a user in the SAP client that you want to use with Content Collector for SAP. This topic shows how to create the sample user CPICUSER1 in SAP client 800. Procedure: 1. In the SAP GUI, enter the transaction code SU01 to open the User Maintenance: Initial Screen window. 6 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

21 2. In the User field, specify a name for the CPIC user that you want to create. For example, type: CPICUSER1 Note: SAP translates lowercase characters or a mixture of lowercase and uppercase characters into uppercase characters. Figure 1 shows the User Maintenance: Initial Screen window containing the sample user name CPICUSER1. Figure 1. User Maintenance: Initial Screen window containing the sample user name CPICUSER1 You must specify the CPIC user name later when you configure Collector Server for use with FileNet P8. 3. Click the Create icon. The Maintain User window opens. 4. On the Address page, in the Last name field, type the surname of the user. For example, type: CPICUSER1_family Figure 2 on page 8 shows the Maintain User window containing CPICUSER1_family as sample surname for sample user CPICUSER1. Chapter 2. Preparing your environment 7

22 Figure 2. Address page of Maintain User window containing the sample surname CPICUSER1_family 5. Click the Logon data tab and specify the following information. a. From the User Type field, select Communications Data. b. In the Initial password field, type a password for the user. c. Repeat this password in the Repeat password field. d. Optional: In the Valid from and Valid through fields, specify the start date and end date of the period during which this user is valid. Figure 3 on page 9 shows what the Logon data page of the Maintain User window might look like after you completed step 5. 8 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

23 Figure 3. Logon data page of the Maintain User window containing the necessary settings 6. Decide whether you want to give the CPIC user access to the entire SAP system or whether you want to give the CPIC user only those authorizations that are needed to archive, link, and view data, print lists, and documents. v To give the CPIC user access to the entire SAP system, complete the following steps: a. Click the Profiles tab. b. In the first line of the Profile column, type: SAP_ALL c. In the second line of the Profile column, type: SAP_NEW Figure 4 on page 10 shows the Profiles page of the Maintain User window containing the necessary authorizations for sample user CPICUSER1. Chapter 2. Preparing your environment 9

24 Figure 4. Profiles page of the Maintain User window containing the necessary authorizations for sample user CPICUSER1 v d. Click the Save icon to save your settings. To restrict the access of the CPIC user, complete these steps: a. Click the Save icon to save your settings. b , Restricting the access of the CPIC user What to do next: Depending on your decision regarding the authorizations of the CPIC user, continue with either of the following tasks: v , Restricting the access of the CPIC user v 2.2.2, Linking a logical system to the SAP client, on page Restricting the access of the CPIC user Instead of giving the CPIC user access to the entire SAP system, you can give the CPIC user only those authorizations that are needed to archive, link, and view data, print lists, and documents Creating a role and a profile for the CPIC user: You must create a role for the CPIC user. In addition, you must create a profile where you specify the necessary authorizations. This topic shows how to create sample ICCSAP_USER. Procedure: 1. In the SAP GUI, enter the transaction code PFCG to open the Role Maintenance window. 2. In the Role field, type a name for the role. For example, type: ICCSAP_USER 10 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

25 Figure 5 shows the Role Maintenance window containing the sample role ICCSAP_USER. Figure 5. Role Maintenance window containing the sample role ICCSAP_USER 3. Click the Single Role icon. The Create Roles window opens. 4. In the Description field, type a description. Then, click the Save icon to save your settings. For example, type: Authorizations for Content Collector for SAP Figure 6 shows the Create Roles window containing the sample role description. Figure 6. Create Roles window containing the sample role description 5. Click the Authorizations tab. The title of the window changes to Change Roles. 6. Under Information About Authorization Profile, click the Propose Profile Names icon to the right of the Profile Name field. SAP generates a profile name and a description. Figure 7 on page 12 shows the Change Roles window containing the generated profile name and description. You can change the description. Chapter 2. Preparing your environment 11

26 However, leave the generated profile name. Figure 7. Change Roles window containing the generated profile name and description 7. Click the Save icon to save your settings. 8. Under Maintain Authorization Data and Generate Profiles, click the Change authorization data icon. See Figure In the Change role: Authorizations window, click the Do not select templates icon. 10. Click the Manually icon. 11. In the Manual selection of authorizations window, type the following authorizations in the right column, one authorization on each line: v S_WFAR_LOG v S_WFAR_LOP v S_WFAR_OBJ v S_WFAR_PRI v S_WFAR_RED v S_RFC Figure 8 on page 13 shows the Manual selection of authorizations window containing the necessary authorizations. 12 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

27 Figure 8. Manual selection of authorizations window showing the necessary authorizations 12. Click the Continue icon to save your specifications and to return to the Change role: Authorizations window. Figure 9 shows the Change role: Authorizations window containing the specified authorizations. Figure 9. Change role: Authorizations window showing the specified authorizations Chapter 2. Preparing your environment 13

28 13. Activate the individual authorizations: Expand all nodes and click each asterisk (*). The background color of the asterisks changes from blue to green. When all asterisks have a green background, the status of the nodes automatically changes from yellow to green. Figure 10 shows the Change role: Authorizations window where some authorizations are activated. Figure 11 on page 15 shows what the Change role: Authorizations window must look like after you activated all authorizations. Figure 10. Change role: Authorizations window showing some asterisks with a green background 14 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

29 Figure 11. Change role: Authorizations window after activating all authorizations 14. Click the Save icon to save your settings. 15. Click the Generate icon to create the role and thus the profile. What to do next: , Assigning the role to the CPIC user Assigning the role to the CPIC user: You must assign the role, including the profile, to the CPIC user. This topic shows how to assign sample role ICCSAP_USER to the sample user CPICUSER1. Procedure: 1. In the SAP GUI, enter the transaction code SU01 to open the User Maintenance: Initial Screen window. 2. In the User field, specify the name of the CPIC user to which you want to assign the role. For example, type CPICUSER1 3. Click the Change icon. 4. In the Maintain User window, click the Roles tab. 5. In the Role column of the Role Assignments table, specify the name of the role that you want to assign and press Enter. For example, type: ICCSAP_USER Figure 12 on page 16 shows the Roles page of the Maintain User window containing the specified role. Chapter 2. Preparing your environment 15

30 Figure 12. Roles page of the Maintain User window showing the specified role after you press Enter 6. Click the Profiles tab to check whether the profile is shown in the Assigned Authorization Profiles table. You should see the name and the description of the profile that you created. For example, you should see T-E and Profile for role ICCSAP_USER. Figure 13 shows what the Profiles page of the Maintain User window might look like. Figure 13. Profiles page of the Maintain User window showing the name and the description of the sample role 16 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

31 7. Click the Save icon to save your settings. The role and the profile are assigned to the CPIC user. You can now work with this user. What to do next: 2.2.2, Linking a logical system to the SAP client Linking a logical system to the SAP client Define a logical system and link it to the SAP client that you want to use with Content Collector for SAP. This topic shows how to create the sample logical system T90CLNT090 and how to link it to SAP client 800, for which you created user CPICUSER1. Before you begin: 2.2.1, Creating a user with CPIC access, on page 6 Procedure: 1. In the SAP GUI, enter the transaction code BD54 to open the Change View "Logical Systems": Overview window. If a window opens with the message Caution: The table is cross-client., press Enter. 2. If the table already contains logical systems, you can use one of them. If you want to use an existing logical system, continue with 4 on page 18. Note: Do not change the settings of an existing logical system. 3. If no logical system exists, create one by following these instructions. As an example, create the logical system T90CLNT090. a. In the Change View "Logical Systems": Overview window, click New Entries. The New Entries: Overview of Added Entries window opens. b. In the first free row of the Log. System column, type a name for the logical system. For example, type: T90CLNT090 You must specify this name later when you configure Collector Server for use with FileNet P8. c. Add a description in the Name column of the same row. For example, type: First logical system for SAP client 800 Figure 14 on page 18 shows what the New Entries: Overview of Added Entries window might look like after you completed step 3b and step 3c. Chapter 2. Preparing your environment 17

32 Figure 14. New Entries: Overview of Added Entries window containing a sample name for the logical system and a sample description d. Click the Save icon. e. In the Request field of the Prompt for Workbench request window, type the name of, or select, an existing request. If a request does not exist, create one by using the Create Request icon. 4. Link the logical system to the SAP client for which you created a user with CPIC access. To link the sample logical system T90CLNT090 to the sample SAP client 800, take these steps: a. Enter the transaction code SCC4 to open the Display View "Clients": Overview window. b. Click the Change icon. If a window opens with the message Caution: The table is cross-client., press Enter. c. Double-click the row in the Client column that contains the SAP client to which you want to link the logical system. For example, double-click the row in the Client column that contains the number 800. d. In the Change View "Clients": Details window, select the logical system from the Logical system list. For example, select T90CLNT090. Figure 15 on page 19 shows the Display View "Clients": Overview window containing your selection in step 4d. 18 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

33 Figure 15. Display View "Clients": Overview window containing the name of the sample logical system that you want to link 5. Click the Save icon to save your settings. What to do next: 2.2.3, Defining a number range for SAP ArchiveLink Defining a number range for SAP ArchiveLink Define a range for SAP ArchiveLink, if this interval does not exist yet. Before you begin: 2.2.2, Linking a logical system to the SAP client, on page 17 Procedure: 1. In the SAP GUI, enter the transaction code OANR to open the SAP ArchiveLink Number range window. 2. Click the Change Intervals icon. Figure 16 on page 20 shows the Maintain Number Range Intervals window containing the required interval. Chapter 2. Preparing your environment 19

34 Figure 16. Maintain Number Range Intervals window containing the required interval 3. If the required interval does not exist, take these steps: a. In the Maintain Number Range Intervals window, click the Insert Interval icon. b. In the Insert Interval window, specify the following settings: 1) In the No column, type: 01 2) In the From number column, type: ) In the To number column, type: Do not change the setting in the Current number column. c. Click the Insert icon to insert the specified interval. The Maintain Number Range Intervals window should look similar to Figure Click the Save icon to save your settings. What to do next: Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page Content Collector for SAP: Configuring for use with FileNet P8: Best practices

35 Chapter 3. Configuring FileNet P8 for use with Content Collector for SAP Create the objects that you need to store outgoing documents in FileNet P8. For incoming documents, ensure that the document classes have the necessary properties. Some of the objects might exist and can be used. For details about how to create the objects and how to assign the properties to the document classes, see the IBM FileNet P8 Information Center. Make a note of the names of all objects that you create. You must later specify them in the server configuration profile when you configure Collector Server for use with FileNet P8. To configure FileNet P8: 1. Create a user that Content Collector for SAP can use to connect to FileNet P8. 2. Create a domain that contains the object stores where the documents are stored or are to be stored. 3. Create one or more object stores to hold the documents. 4. Create the properties for the document classes. Which properties are necessary depends on whether you want to read or delete the archived documents, or whether you want to update the archived documents or to archive outgoing documents. For more information, see 3.1, Properties necessary to read, archive, update, and delete documents: Overview, on page Create the document classes, and assign the appropriate properties. Create at least one document class. Otherwise, no documents are stored. If you do not want to store all documents in one document class, create several document classes. You can create a document class for each MIME type. For each document class, add the user that you created in step 1, or the group to which this user belongs, to the Default Instance Security access control list (ACL) and specify Full Control as permission. With this permission, the user can view, create, modify, read, and delete the documents in the object stores. Note: If a user is #CREATOR-OWNER of all documents in this document class, this user does not have to be added to the ACL list 6. If the archived documents are to be organized in folders, create the folders that you need. For each folder, grant the Add to Folder security to the user that you created in step 1, or to the group to which this user belongs. In this way, you allow the user or the group to add documents to the folders. This security level includes the following necessary access rights: v File in folder v Unfile from folder v Read permissions What to do next: Chapter 4, Configuring Collector Server, on page 25 Copyright IBM Corp. 2010,

36 3.1 Properties necessary to read, archive, update, and delete documents: Overview The properties that you must create depend on whether you want to read and delete the archived documents, or whether you want to update the archived documents or archive outgoing documents. Table 3 gives an overview of the properties, in alphabetical order. The property names are case-sensitive and must not be changed. If they exist, you must create an attribute mapping file, in which you map these names to the names of your choice. For more information about how to create an attribute mapping file, see 1.2, Mapping the names of attributes or properties, on page 2. Table 3. Overview of the document class properties Property name Description Data type Minimum size Required or optional for reading and deleting documents Required or optional for archiving and updating documents ALFdpages The total number of ALF description pages, if the document is paginated. String 3 Optional Required ALFpages The total number of ALF pages, if the document is paginated. Barcode The bar code. String Maximum size: 40 PageSize SAPCompCharset SAPCompCreated SAPCompModified The page size of a paginated document. The character sets in which the content of the components is encoded. The date and time, in Coordinated Universal Time (UTC) format, when the components were created. The date and time, in UTC format, when the components were last modified. String 3 Optional Required Optional Required for documents with bar codes String 239 Optional Required String 239 Optional Optional String 239 Optional Required String 239 Optional Required SAPComps The component IDs. String 239 Optional Required SAPCompSize The component sizes. This property prevents the components from being retrieved to determine the component sizes. String 239 Optional Required SAPCompVersion The versions of the SAP applications that are used to create the components. String 239 Optional Optional 22 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

37 Table 3. Overview of the document class properties (continued) Property name Description Data type Minimum size Required or optional for reading and deleting documents Required or optional for archiving and updating documents SAPContType The MIME type, such as text/plain or image/tiff. This property is needed for viewing the document. String 239 Optional Required SAPDocDate SAPDocId SAPDocProt SAPType The date and time when the document was created. The time stamp is shown in UTC format. The SAP document ID. Specify this property as index property. The SAP document protection (create, read, update, delete). The SAP document class, such as TXT or TIF. This property is needed for processing the bar code. String 239 Optional Required String 40 Optional Required String 4 Optional Required String 3 Optional Required Important: v Store date and time information as data type string or integer if it is important that SAP and Workplace or Workplace XT show the same date and time for a document. Values of data type date are stored as data type timestamp in FileNet P8. The time stamp shows the date and time of the document in UTC format, with the hour, minutes, and seconds set to 0. When you later link a FileNet P8 document, Content Collector for SAP converts an attribute of data type date to UTC format and transfers the date in UTC format (without the time) to the SAP workflow. Thus, SAP cannot convert the date to the local time zone any more. In Workplace or Workplace XT, however, the time stamp is converted to the local time zone of the server where Workplace or Workplace XT is installed. Thus, the date and time of the document can differ by one day. v If you have documents with more than 16 components and documents with less than 16 components but very long component names, a size of 239 characters is not sufficient for the following properties: SAPCompCharset SAPCompCreated SAPCompModified SAPComps SAPCompSize SAPCompVersion For these properties, calculate the size by using the following formula: 15 x (maximum number of components in a document) This formula is based on the following facts: Chapter 3. Configuring FileNet P8 for use with Content Collector for SAP 23

38 Some of the affected properties hold time stamps. Time stamps have a fixed length of 14 characters and are usually longer than any other SAP metadata. The SAP metadata of all components are concatenated and separated by a colon. The maximum length of strings is determined by the underlying database and is characters. If you need longer strings to hold the SAP metadata for all components in a document, you must define the properties with the Use Long Column Width attribute. You can specify this attribute only when you create the properties. 24 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

39 Chapter 4. Configuring Collector Server Configure Collector Server in the sequence shown. Before you begin: 1. Install and configure SAP as required. 2. Install Collector Server from the server package. For more information, see the topic Installing the server package in console mode or GUI mode in the Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 2, Preparing your environment, on page Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page 21. Figure 17 shows which parts of the Content Collector for SAP environment belong to a Collector Server instance. Client dispatcher archwin ARCHWINS keyword RFC dispatcher archdp DISPATCHERS keyword Java RFC dispatcher cssap.jar DISPATCHERS keyword HTTP dispatcher archcls.jar WEBDPS keyword Engine archpro ARCHPRO_ PORT keyword P8 agent agent_p8.jar P8AGENTS keyword Collector Server instance Figure 17. Configuration of Collector Server Complete the following tasks to configure Collector Server: Procedure: , Configuring Collector Server for use with FileNet P , Configuring the connection between Collector Server and SAP, on page , Starting Collector Server for the first time, on page , Stopping Collector Server, on page Configuring Collector Server for use with FileNet P8 You configure Collector Server by changing the sample server configuration profile that Content Collector for SAP supplies for each archive. A server configuration profile contains the entire configuration information that Collector Server needs to communicate with SAP and to perform all the tasks that are supported by Content Collector for SAP. Copyright IBM Corp. 2010,

40 You can configure more than one instance of Collector Server. Each instance must have its own server configuration profile. Before you begin: v Plan for a secure Collector Server. v Plan for the master key and for secure passwords. For more information, see the topics Planning for a secure Collector Server and Planning for the master key and for secure passwords in the Planning part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH The sample server configuration profile is an ASCII file that contains keywords and their values. During installation of Collector Server, the sample files were stored in the following directory: v Linux UNIX InstallHome/server/bin v Windows InstallHome\Server\instances\instance01 For FileNet P8, the sample profile is archint_sample_p8.ini. There are many keywords that you can add to the profile to fine-tune the behavior of Collector Server. The following topics, however, show how to change the basic settings that are necessary to start and run Collector Server and to perform the most important tasks. For a complete list of the keywords that you can add and for an overview of the values that you can specify and of the default values, see the topic Keywords in the server configuration profile in the Reference part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Important: The length of a line in the server configuration profile must not exceed 2048 bytes Server configuration profile: General information and structure A server configuration profile is an ASCII file that can be changed with any ASCII editor. It consists of keywords and their values. A keyword can have one value, sometimes even a list of values that are separated by commas. Most of the keywords have a default value. If you omit such a keyword, the default value is used. When Collector Server is started, it checks the syntax of the server configuration profile. Collector Server starts successfully only if the keywords and their values are specified correctly and in the correct order. A server configuration profile contains the following sections: v A general section, where you specify the following information: The paths, such as the path to the Collector Server instance and the path to the temporary files The log and trace settings v The DESTINATION section, where you specify the connection to the related SAP system 26 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

41 v v One or more ARCHIVE sections, where each ARCHIVE section contains the settings for one logical archive The subprocess section where you define how many dispatchers and agents are to be started and where you specify the necessary ports The general section and the subprocess section contain global keywords, which apply to the entire Collector Server instance. Specify global keywords only once in a server configuration profile. Do not specify them in an ARCHIVE section or a DESTINATION section. The DESTINATION section must be defined once in the server configuration profile. Archive-specific keywords must be specified for each archive that you want to use. The following examples for the individual sections reflect the contents of the sample server configuration profile on a Windows system. Example of a general section: # # # The full path to the directory containing the program files of # Collector Server. # # BINPATH C:\Program Files\IBM\ICCSAP\Server\bin # # # The full path to the instance directory of Collector Server, # containing all instance-related files, such as trace files and # log files. # # INSTANCEPATH C:\Program Files\IBM\ICCSAP\Server\instances\instance01 # # # Enables or disables Collector Server to write additional information # to stdout, which is normally the console. # # #REPORT ON # # # Specifies how tracing is handled. # # #TRACE DYNAMIC_ON # # # The maximum size of the Collector Server trace file, in KB. # # #TRACEMAX 2000 # # # The fully qualified path to the Collector Server trace file. This # trace file contains the messages that are issued by the individual # Content Collector for SAP components after the connection to Collector # Server is established. # # #TRACEFILE env_var_appdata\ibm\iccsap\instance01\traces\icc_trace.trc # # # The full path to the directory where Collector Server is to store # the temporary files that are needed for processing. # # TEMPPATH C:\temp\ # # # Specifies whether Collector Server creates a log file on every day that # it is active. # # Chapter 4. Configuring Collector Server 27

42 #LOG ON # # # The full path to the exchange directory where your SAP applications # should store the files that are to be archived by Content Collector # for SAP. The path should be shared by all SAP Application Servers # by using NFS mount. # Note: This keyword is only required if RFC_DISPATCHERS > 0. # # #BASEPATH \\SAPSERVER\transfer\base\ # # # The full path to the directory where Collector Server and SAP can # retrieve the archived files. # Note: This keyword is only required if RFC_DISPATCHERS > 0. # # #ARCHPATH \\SAPSERVER\transfer\arch\ # # # The fully qualfied path to the master key file, which is to hold # the master key that encrypts the password file and the SAP certificates. # # MASTER_KEYFILE C:\Users\iccadm\instance01\masterkey.txt # # # The fully qualified file name of the server keystore. The server # keystore holds the self-signed certificate of Collector Server # and the certificates of all trusted installations of Archiving Client # and Viewing Client. # # DLL_KEYSTORE_FILE env_var_appdata\ibm\iccsap\instance01\server_clients\ server\server.kdb Example of a DESTINATION section: # # # Defines the connection between Collector Server and SAP. It is similar # to the SAP sideinfo configuration file. # You can specify several LOGICAL_SYSTEM sections. In this way, you can # connect one Collector Server instance to several SAP clients. # Note: It is good practice to use the ID of the SAP system as value. # # DESTINATION KD7 # # # Keywords used for an RFC connection and for document linking # by creating a work item. # # # PROGID KD7.ICCSAP # GWHOST /H/sapserver # GWSERV sapgw00 # LU sapserver # TP sapdp00 # # # Keywords used for logging on to an SAP logon group. # # # PROGID KD7.ICCSAP # GWHOST /H/sapserver # GWSERV sapgw00 # MSHOST sapmskd7 # GROUP mygroup R3NAME KD7 # # # Additional keywords for logging on to an SAP logon group and for 28 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

43 # document linking by using P8 Client. # # LOGICAL_SYSTEM T90CLNT090 CLIENT 800 USER CPICUser1 LOGICAL_SYSTEM T90CLNT091 CLIENT 801 USER CPICUser2 Notes: v The LOGICAL_SYSTEM keyword can be used in the DESTINATION section and in the ARCHIVE section. v In the DESTINATION section, the LOGICAL_SYSTEM keyword starts a section where you specify the SAP client that is linked to the logical system and where you specify the CPIC user that is used to log on to the SAP client. A LOGICAL_SYSTEM section can be specified several times. In this way, you can connect a Collector Server instance to several SAP clients. v If you want to archive or only link documents by processing their bar codes or by creating work items in the SAP, the ARCHIVE section must contain the LOGICAL_SYSTEM keyword. Example of an ARCHIVE section: # # # You need an ARCHIVE section for each FileNet P8 server and # for each object store. # # # # # Configuration for linking documents. # # ARCHIVE P1 STORAGETYPE P8 REMOTESERVERURL P8USER sampleuser1 P8DOMAIN P8_domain_name OBJECTSTORE object_store_name DEFAULT_P8DOCCLASS SAPDefault LOGICAL_SYSTEM T90CLNT090 # # # Additional keywords for bar code processing. # # PE_USERID sampleuser3 PE_CONNECTPOINT connectpointname PE_QUEUENAME queuename # # # Extended configuration for archiving outgoing documents # with different document types, with special configuration for # viewing, pagination, and filing. # # ARCHIVE P2 STORAGETYPE P8 REMOTESERVERURL WORKPLACEURL P8USER sampleuser1 WP_USERID sampleuser2 P8DOMAIN P8_domain_name OBJECTSTORE object_store_name DEFAULT_P8DOCCLASS SAPDefault DEFAULT_FOLDER /DefaultFolder DOCTYPE image/tiff P8DOCCLASS SAPTIF Chapter 4. Configuring Collector Server 29

44 CUSTOM_FOLDER /SAP_Documents/test PURETHIN yes DOCTYPE image/jpg PURETHIN yes DOCTYPE application/pdf P8DOCCLASS SAPPDF CUSTOM_FOLDER NONE DOCTYPE application/x-alf P8DOCCLASS SAPALF CUSTOM_FOLDER /SAP_Documents/printlists PAGESIZE 2000 # # # Additional keywords for index transfer. # # RETURN_ALL_ATTR YES REPINFOCLASSES SAPPDF, SAPTIF #TRUNCATE_ATTRIBUTE YES # # # The class path with all Content Engine Client JAR files and specific # Process Engine Client JAR files. The class path must always be # specified. # The following example applies to Content Engine Client V4.5.1 only. # Note that the path must be specified on one line. # # P8_CLASSPATH C:\Program Files\IBM\FileNet\WebClient\CE_API\lib\Jace.jar; C:\Program Files\IBM\FileNet\WebClient\CE_API\lib\log4j.jar; C:\Program Files\IBM\FileNet\WebClient\CE_API\lib\stax-api.jar; C:\Program Files\IBM\FileNet\WebClient\CE_API\lib\xlxpScanner.jar; C:\Program Files\IBM\FileNet\WebClient\CE_API\lib\xlxpScannerUtils.jar; C:\Program Files\IBM\FileNet\WebClient\WorkplaceXT\WEB-INF\lib\pe.jar; C:\Program Files\IBM\FileNet\WebClient\WorkplaceXT\WEB-INF\lib\peResources.jar # # # Additional options for the Java runtime environment if you use # Content Engine Client Version V4.0 or V # # #JAVA_OPTIONS -Dwasp.location=/opt/IBM/CE_API/wsi Note: P8_CLASSPATH and JAVA_OPTIONS are global keywords. Specify them after an ARCHIVE section. Example of a subprocess section: # # # The number of parallel instances of the Content Collector for SAP # child programs. # # RFC_DISPATCHERS 0 JRFC_DISPATCHERS 0 ADSMAGENTS 0 ODAGENTS 0 CMAGENTS 0 P8AGENTS 1 ARCHWINS 1 WEBDPS 1 # # # The TCP/IP port numbers that are used by Content Collector for SAP. # ARCHPRO_PORT is used by archstop and the dynamic-link library # csclient.dll. # WEBPORT is used by the HTTP dispatcher for the Internet access. # # ARCHPRO_PORT 5500 WEBPORT Content Collector for SAP: Configuring for use with FileNet P8: Best practices

45 # # # End of profile # # When you change a server configuration profile, keep in mind the following information: v A specified path must exist when you start Collector Server. Collector Server does not create any paths. v Every line is analyzed separately. The length of a line must not exceed 2048 bytes. v Keywords can start in any column of a line. v v v v v Do not specify any characters in front of a keyword. You can specify spaces, however. Specifying a keyword several times can produce unpredictable results. Values that contain blanks or paths can be, but do not have to be, enclosed in single quotation marks. The profile is scanned up to the END keyword or until the end of the file is reached. Use the number sign (#) to start a comment. Content Collector for SAP does not process comments. Unless you can specify several values for a keyword that are separated by commas, you can specify the comment in the same line as the keyword. For example, the following specification is allowed: DOCTYPE image/tiff # document type for TIFF images The following sample specification is not allowed: REPINFOCLASSES test1, test2 # index transfer classes Creating a server configuration profile for FileNet P8 Use the sample file archint_sample_p8.ini to create a server configuration profile for use with FileNet P8. Before you begin: Plan for secure archives and connections to the archives. For more information, see the corresponding topic in the Planning part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Procedure: 1. Copy the sample file archint_sample_p8.ini to a directory of your choice and rename it. For example, copy it to the instance directory and rename it to archint.ini, which is the default name. You determined the instance path when you prepared your environment for Collector Server. 2. Open the server configuration profile in a text editor and change the values of the following keywords to reflect your own setup. Note: For a complete list of the keywords that you can add and for an overview of the values that you can specify and of the default values, see the topic Keywords in the server configuration profile in the Reference part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 4. Configuring Collector Server 31

46 Keyword Description Remarks INSTANCEPATH Specify the full path to the Linux UNIX You directory where the must specify the path to the instance-related files, such as instance directory that you trace files and log files, are created when you prepared located. The instance user your environment for must have the full Collector Server. permissions for this directory. TEMPPATH MASTER_KEYFILE DLL_KEYSTORE_FILE DESTINATION R3NAME Specify the full path to the directory where Collector Server is to store the temporary files that are needed for processing. Specify the fully qualified name of the file that is to hold the master key to encrypt the password file (default name: archint.cfg) and the SAP certificates for the archives. For the initial setup, comment out this keyword with a number sign (#). Specify a name of your choice. This keyword groups all settings that are necessary for Collector Server to connect to SAP. Specify the ID of the SAP system to which Collector Server is to connect when linking documents to SAP. Windows This path is automatically assigned during the installation of Collector Server. If you created the instance directory in another directory, change the value for the INSTANCEPATH keyword accordingly. The master key is generated when you complete the steps that are required to start Collector Server for the first time. Ensure that the user who starts Collector Server has access permissions for the entire path. You need this keyword later when you set up secure client connections between Collector Server and Archiving Client or Viewing Client. For more information, see the topic Setting up secure client connections in the Security part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH You need this keyword if you want to link FileNet P8 documents or if you want to enable Collector Server to log on to a group of SAP Application Servers. 32 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

47 Keyword Description Remarks LOGICAL_SYSTEM Specify the name of the logical system that is connected to the SAP client. You specified this name when you defined the logical system in SAP. CLIENT Specify the name of the SAP client that is linked to the logical system. USER ARCHIVE REMOTESERVERURL P8USER P8DOMAIN OBJECTSTORE DEFAULT_P8DOCCLASS Specify the name of the user with CPIC access. The sample file contains two predefined profiles for logical archives: A1 contains the minimum settings for an archive. A2 contains the settings for archiving and linking various document types, including documents with bar codes, and for the index transfer. Specify the fully qualified path to the Content Engine Web Service Interface (WSI) endpoint. Specify the name of a Content Engine user with the following rights: v Create, modify, read, delete, and view documents v Import Image Services documents into FileNet P8. Specify the name of the domain that contains the object store where the documents are stored or are to be stored. Specify the name of the object store that contains, or is to contain, the documents. Specify the document class that is to be used if SAP does not supply the MIME type of a document or if the MIME type is not defined for the archive. You specified this name when you created the user with CPIC access in SAP. You must specify this ID again when you create the content repository in SAP. You need this keyword only for archiving outgoing documents. Ensure that the document class has all the properties that are required to archive and update the documents. See Table 3 on page 22. Chapter 4. Configuring Collector Server 33

48 Keyword Description Remarks P8_CLASSPATH JAVA_OPTIONS ARCHWINS ARCHPRO_PORT Specify the fully qualified paths to all JAR files of Content Engine Client and to specific JAR files of Process Engine Client. Specify the options for the Java runtime environment. For the initial setup, set the value of this keyword to 0. If another program does not use this port, leave the port that is specified in the sample profile, namely For more information, see the topic Installing FileNet P8 in the Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Important: This keyword is required. If you do not specify it, you cannot use FileNet P8 with Content Collector for SAP. This keyword is necessary only if you use Content Engine Client Version 4.0 or For more information, see the topic Installing FileNet P8 in the Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH If you specify a number greater than 0, you must also set the DLL_KEYSTORE_FILE keyword. For more information, see the topic Setting up secure client connections in the Security part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH This keyword specifies the TCP/IP registration port that is used by all Content Collector for SAP clients and all dynamic-link libraries (DLLs) to connect to Collector Server. 3. Add the QUEUEPATH keyword if you did not create a directory named queue in your instance directory. Specify the full path to the directory where the queues are to be stored. 4. Add as many ARCHIVE sections as you need in the same way. If you do not use any other archives, delete or comment out the remaining blocks that start with an ARCHIVE keyword. 34 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

49 5. Save your changes. What to do next: 4.2, Configuring the connection between Collector Server and SAP 4.2 Configuring the connection between Collector Server and SAP Task The connection that you must configure and the dispatchers that you must start depend on the task that you want to perform. Before you begin: v Plan for a secure connection between Collector Server and SAP. For more information, see the corresponding topic in the Planning part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH v Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page 21 The following table shows which connection you must set up for which task and which dispatchers must be started. HTTP connection, which uses the HTTP dispatcher RFC connection, which uses the RCF dispatcher Java RFC dispatcher Remarks Archiving data x x Either an HTTP connection or an RFC connection is required. Archiving documents x by creating work items in an SAP workflow Archiving documents by processing their bar codes Archiving outgoing documents Linking FileNet P8 documents by using Utility Client Linking FileNet P8 objects by using P8 Client Archiving and viewing print lists The bar code is sent directly to SAP. x x Either an HTTP connection or an RFC connection is required. x The Java RFC dispatcher is needed only if the documents are linked by creating work items. The OLE communication between P8 Client SAP Connector and SAP is used. x x Either an HTTP connection or an RFC connection is required. Chapter 4. Configuring Collector Server 35

50 Task Viewing archived documents with the SAP GUI Viewing archived documents with an external viewer Viewing FileNet P8 objects with the viewer application embedded in Workplace or Workplace XT Transferring index information HTTP connection, which uses the HTTP dispatcher RFC connection, which uses the RCF dispatcher Java RFC dispatcher Remarks x x An RFC connection can be used for print lists only. x x An RFC connection can be used for print lists only. x SAP communicates with Utility Client directly. Notes: v This table does not cover the client dispatcher (ARCHWINS keyword), which you need for the communication between Collector Server and Archiving Client or Viewing Client. You enable Collector Server to start a client dispatcher when you configure these clients. v The Object Linking and Embedding (OLE) communication is used for the communication between Archiving Client, P8 Client SAP Connector, or Viewing Client and the SAP GUI. You configure the OLE communication when you configure the tasks that need this type of communication Setting the number of Java RFC dispatchers A Java RFC dispatcher is required if you want to archive and link a document by creating a work item or if you want to search for and view documents by using the SAP Document Finder. Procedure: 1. Open the server configuration profile in a text editor. 2. Set the JRFC_DISPATCHERS keyword to a number greater than 0, for example: JRFC_DISPATCHERS 4 3. Save the server configuration profile, and restart Collector Server for the changes to take effect. What to do next: Continue with one of the following tasks: v 4.2.2, Setting up the connection between Collector Server and SAP through HTTP, on page 37 v 4.2.3, Setting up the connection between Collector Server and SAP through Remote Function Call (RFC), on page 42 v 4.2.4, Enabling Collector Server to connect to SAP, on page Content Collector for SAP: Configuring for use with FileNet P8: Best practices

51 4.2.2 Setting up the connection between Collector Server and SAP through HTTP You must configure the HTTP connection if you want to archive and retrieve documents by using SAP Content Server HTTP Interface. You use the SAP GUI to configure the connection. Before you begin: If you want to search for and view documents by using the SAP Document Finder, or if you want to archive or link a document by creating a work item in an SAP workflow: 4.2.1, Setting the number of Java RFC dispatchers, on page 36. Procedure: , Setting the number of HTTP dispatchers , Creating an SAP ArchiveLink protocol for use by the HTTP connection , Creating SAP ArchiveLink queues for use by the HTTP connection, on page , Creating a content repository for the HTTP connection, on page , Sending an SAP certificate to Collector Server, on page Setting the number of HTTP dispatchers To enable HTTP communication, at least one HTTP dispatcher must be started. In addition, you must specify the TCP/IP port through which the HTTP dispatcher gets its requests. You specify the number of HTTP dispatchers in the server configuration profile by using the WEBDPS keyword. In the sample server configuration profile, the value of the WEBDPS keyword is already set to 1. You might want to run several HTTP dispatcher sessions in parallel. The default value is 0. You specify the TCP/IP port in the server configuration profile by using the WEBPORT keyword. In the sample server configuration profile, the value of the WEBPORT keyword is set to You might want to specify a different port. To change the number of HTTP dispatchers and to change the TCP/IP port, take these steps: 1. Open the server configuration profile in a text editor. 2. Change the value of the WEBDPS keyword and the value of the WEBPORT keyword, as required. 3. Save the changed server configuration profile. What to do next: , Creating an SAP ArchiveLink protocol for use by the HTTP connection Creating an SAP ArchiveLink protocol for use by the HTTP connection Create a protocol for the general SAP ArchiveLink interface to the HTTP content server. This topic shows how to create the sample protocol HTTP1. Before you begin: , Setting the number of HTTP dispatchers Chapter 4. Configuring Collector Server 37

52 Procedure: 1. In the SAP GUI, enter the transaction code OAA3 to open the ArchiveLink: Communications Interface Administration window. 2. Click the New protocol icon. 3. In the Create New Protocol window, specify the following settings: Field Description Example Protocol Type a name for the protocol. Type: HTTP1 Version Description Specify the version of the SAP ArchiveLink HTTP Content Server Interface. Normally, 0045 is sufficient. However, if a cache server is used, specify Specify information about this protocol. Type: 0045 Type: Demo_HTTP Figure 18 shows the Create New Protocol window containing the sample specifications. Figure 18. Create New Protocol window containing the sample protocol name, the version, and a sample description 4. Press Enter and then click the Save icon to save your settings. The ArchiveLink: Communications Interface Administration window lists the new protocol. What to do next: , Creating SAP ArchiveLink queues for use by the HTTP connection Creating SAP ArchiveLink queues for use by the HTTP connection Complete the following steps to create SAP ArchiveLink queues. Before you begin: , Creating an SAP ArchiveLink protocol for use by the HTTP connection, on page 37 Procedure: 1. In the SAP GUI, enter the transaction code OAQI to open the SAP ArchiveLink: Create All Queues (CFBC, CARA, CGDA) window. 2. Make sure that all fields except for Queue Administrator contain an X. 3. In the Queue Administrator field, type the logon ID of an SAP user who should receive error notifications. By default, the current logon ID is inserted. For example, type: ADMIN 38 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

53 4. Click the Execute icon. Figure 19 shows the SAP ArchiveLink: Create All Queues (CFBC, CARA, CGDA) window containing the required settings. Figure 19. SAP ArchiveLink: Create All Queues (CFBC, CARA, CGDA) window containing the required settings What to do next: , Creating a content repository for the HTTP connection Creating a content repository for the HTTP connection For each logical archive that is defined in Content Collector for SAP, you must create a content repository in SAP. This topic describes how to create the sample content repository A2 for the sample SAP ArchiveLink protocol HTTP1. Before you begin: , Creating SAP ArchiveLink queues for use by the HTTP connection, on page 38 Procedure: 1. In the SAP GUI, enter the transaction code OAC0 to open the Display Content Repositories: Overview window. 2. Click the Change icon. 3. In the Change Content Repositories: Overview window, click the Create icon. 4. In the Change Content Repositories: Detail window, click Full administration. 5. Specify the following information: Field Description Example Content Rep. Description Document area Storage type Type the logical archive ID that you specified for the ARCHIVE keyword in the server configuration profile. Type a short description for the repository or archive. Select ArchiveLink. Select HTTP content server. Type: A2 Type: Sample archive A2 Chapter 4. Configuring Collector Server 39

54 Field Description Example Protocol Select the SAP ArchiveLink Select HTTP1. protocol that you created. Version no. Select the version of the SAP ArchiveLink HTTP Content Server Interface, which you specified when you created the SAP ArchiveLink protocol. Select HTTP server Port Number Type the host name or IP address of Collector Server. Type the port number of the TCP/IP port through which the HTTP dispatcher of Collector Server gets its requests. Type: myhost.yourserver.com Type: 5580 HTTP Script Basic Path Archive Path OutputDevice No signature The port number must match the value that you specified for the WEBPORT keyword when you set the number of HTTP dispatchers. Type: cs Type the full path to the exchange directory where your SAP applications is to store the files that are to be archived by Content Collector for SAP. The path must end with a delimiter, which is \ on Windows and / on Linux and UNIX systems. Make sure that both servers can access this directory. Type the full path to the directory where Collector Server and SAP can retrieve the archived files. The path must end with a delimiter, which is \ on Windows and / on Linux and UNIX systems. It is usually the same path as for the Basic Path field. Select ARCH. If selected, no signature is used. Generally, use it for test purposes only. Type: D:\SAPSERVER\transfer\base\ Type: D:\SAPSERVER\transfer\arch\ Figure 20 on page 41 shows the Change Content Repositories: Detail window containing your specifications. 40 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

55 Figure 20. Change Content Repositories: Detail window containing your specifications 6. Click the Save icon to save your settings. What to do next: , Sending an SAP certificate to Collector Server Sending an SAP certificate to Collector Server For each content repository that you define in SAP and that is accessed by Collector Server, you need an SAP certificate to use an encrypted HTTP connection. Encryption is enabled by default. Before you begin: , Creating a content repository for the HTTP connection, on page 39 You can send the certificate in either of the following ways: v After you click Save icon in the Change Content Repositories: Detail window, click the Send certificate icon. v Complete the following steps: 1. In the SAP GUI, enter the transaction code OAHT to open the Send certificates to HTTP content server window. 2. Double-click the content repository for which an SAP certificate is needed. For example, double-click A2. The corresponding Collector Server receives the SAP certificate and saves it in the SAPCertificates directory. For example, the SAP certificate for the content repository or logical archive A2 would be stored as A2.pse.fingerprint.TO_BE_CONFIRMED. fingerprint stands for the hash value that uniquely identifies the SAP certificate. 3. To accept the SAP certificate, complete these steps: Chapter 4. Configuring Collector Server 41

56 a. Open a command line and change to the directory where the appropriate server configuration profile is stored. The server configuration profile must contains the logical archive that corresponds to the content repository. b. Enter the following command: archcert -a archive_id archive_id stands for the content repository ID, which is equal to the logical archive ID. For example, A2. For more information about this command and the parameters that you can specify, see the topic archcert in the Reference part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH c. The content of the SAP certificate is displayed. Review it. d. If you decide to accept the SAP certificate, enter YES. Collector Server saves the SAP certificate in the SAPCertificates directory as archive_id.pse.fingerprint, for example, A2.pse.fingerprint. You can verify the SAP certificate in SAP by comparing the fingerprint to the one in the Trust Manager (transaction code STRUST). What to do next: 4.2.4, Enabling Collector Server to connect to SAP, on page Setting up the connection between Collector Server and SAP through Remote Function Call (RFC) You use the SAP GUI to configure the RFC connection. Before you begin: If you want to search for and view documents by using the SAP Document Finder, or if you want to archive or link a document by creating a work item in an SAP workflow: 4.2.1, Setting the number of Java RFC dispatchers, on page 36. Procedure: , Setting the number of RFC dispatchers , Creating an RFC destination, on page , Creating an SAP ArchiveLink protocol for use by the Remote Function Call (RFC) connection, on page , Creating SAP ArchiveLink queues for use by the Remote Function Call (RFC) connection, on page , Creating a content repository for the Remote Function Call (RFC) connection, on page Setting the number of RFC dispatchers You must start at least one RFC dispatcher. In addition, you must specify where the files that are to be exchanged between SAP and Content Collector for SAP are to be stored. You set the number of RFC dispatchers and specify the paths in the server configuration profile. Procedure: 1. Open the server configuration profile in a text editor. 2. Set the RFC_DISPATCHERS keyword to a number greater than 0, for example: RFC_DISPATCHERS 4 3. Add the following keywords to specify the paths for the temporary storage of the files: 42 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

57 BASEPATH ARCHPATH basepath archpath basepath Specify the full path to the exchange directory where your SAP applications are to store the files that are to be archived by Content Collector for SAP. You created the exchange directory when you installed Collector Server. archpath Specify the full path to the directory where Collector Server and SAP can retrieve the archived files. You can use the same path as for the BASEPATH keyword. 4. Save the server configuration profile, and restart Collector Server for the changes to take effect. What to do next: , Creating an RFC destination Creating an RFC destination Complete the following steps to create an RFC destination. This topic shows how to create the sample RFC destination KD7.ICCSAP. Before you begin: , Setting the number of RFC dispatchers, on page 42 Procedure: 1. In the SAP GUI, enter the transaction code SM59 to open the Configuration of RFC Connections window. 2. In the RFC Connections column, click TCP/IP connections and then click Create icon. 3. In the RFC Destination field of the RFC Destination window, type a name for the RFC destination. You can use a name of your choice. However, you might want to use the same name as in the Program ID field, which you specify in step 7. For example, type: KD7.ICCSAP 4. Under Description, type a description in one or more of the Description fields. For example, type: RFC Connection 1 5. Click the Technical Settings tab. 6. Under Activation Type, click Registered Server Program. 7. In the Program ID field, type the program ID under which the dispatcher is registered on the SAP Gateway. When you enable Collector Server for connecting to SAP, you must specify this name for the PROGID keyword in the server configuration profile. Important: If the RFC destination is to be used by SAP Document Finder, append the number 1 to the ID. For example, if the program ID is KD7.ICCSAP, type KD7.ICCSAP1 in the Program ID field. For example, type: KD7.ICCSAP1 8. Click the Save icon to save your settings. Chapter 4. Configuring Collector Server 43

58 Figure 21 shows what the RFC Destination window might look like after you completed step 3 on page 43 through step 7 on page 43. Figure 21. RFC Destination window containing the sample name of the RFC destination, the connection type, the sample description for the connection, the activation type, and the sample program ID What to do next: , Creating an SAP ArchiveLink protocol for use by the Remote Function Call (RFC) connection Creating an SAP ArchiveLink protocol for use by the Remote Function Call (RFC) connection Create a protocol for the general SAP ArchiveLink interface to the RFC content server. This topic shows how to create the sample protocol RFC1. Before you begin: , Creating an RFC destination, on page 43 Procedure: 1. In the SAP GUI, enter the transaction code OAA3 to open the ArchiveLink: Communications Interface Administration window. 2. Click the New protocol icon. 3. In the Create New Protocol window, specify the following settings: Field Description Example Protocol Type a name for the protocol. Type: RFC1 44 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

59 Field Description Example Version Description Specify the version of the SAP ArchiveLink Interface, namely Specify information about this protocol. Type: Demo_RFC Figure 22 shows what the Create New Protocol window might look like after you typed the necessary information. Figure 22. Create New Protocol window containing the protocol name, the version, and a sample description 4. Click the Save icon to save your settings. What to do next: , Creating SAP ArchiveLink queues for use by the Remote Function Call (RFC) connection Creating SAP ArchiveLink queues for use by the Remote Function Call (RFC) connection Complete the following steps to create SAP ArchiveLink queues. Before you begin: , Creating an SAP ArchiveLink protocol for use by the Remote Function Call (RFC) connection, on page 44 Procedure: 1. In the SAP GUI, enter the transaction code OAQI to open the SAP ArchiveLink: Create All Queues (CFBC, CARA, CGDA) window. 2. Make sure that all fields except for Queue Administrator contain an X. 3. In the Queue Administrator field, type the logon ID of an SAP user who should receive error notifications. By default, the current logon ID is inserted. For example, type: ADMIN 4. Click the Execute icon. Figure 23 on page 46 shows the SAP ArchiveLink: Create All Queues (CFBC, CARA, CGDA) window containing the required settings. Chapter 4. Configuring Collector Server 45

60 Figure 23. SAP ArchiveLink: Create All Queues (CFBC, CARA, CGDA) window containing the required settings What to do next: , Creating a content repository for the Remote Function Call (RFC) connection Creating a content repository for the Remote Function Call (RFC) connection For each logical archive that is defined in Content Collector for SAP, you must create a content repository in SAP. This topic describes how to create the sample content repository A1 for the sample SAP ArchiveLink protocol RFC1. Before you begin: , Creating SAP ArchiveLink queues for use by the Remote Function Call (RFC) connection, on page 45 Procedure: 1. In the SAP GUI, enter the transaction code OAC0 to open the Display Content Repositories: Overview window. 2. Click the Change icon. 3. In the Change Content Repositories: Overview window, click the Create icon. 4. In the Change Content Repositories: Detail window, click Full administration. 5. Specify the following information: Field Description Example Content Rep. Description Document area Storage type Protocol Type the logical archive ID that you specified for the ARCHIVE keyword in the server configuration profile. Type a short description for the repository or archive. Select ArchiveLink. Select RFC archive. Version no. Select Select the SAP ArchiveLink protocol that you created. Type: A1 Type: Sample archive A1 Select RFC1. 46 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

61 Field Description Example RFC destination Select the RFC destination Select KD7.ICCSAP. that you previously created. Basic Path Type the full path to the exchange directory where your SAP applications are to store the files that are to be archived by Content Collector for SAP. Type: D:\SAPSERVER\transfer\base\ The path must end with a delimiter, which is \ on Windows and / on Linux and UNIX systems. Use the path that you specified for the BASEPATH keyword in the server configuration profile. Archive Path OutputDevice Make sure that both servers can access this directory. Type the full path to the directory where Collector Server and SAP can retrieve the archived files. The path must end with a delimiter, which is \ on Windows and / on Linux and UNIX systems. Use the path that you specified for the ARCHPATH keyword in the server configuration profile. It is usually the same path as for the BASEPATH keyword. Select ARCH. Type: D:\SAPSERVER\transfer\arch\ Figure 24 on page 48 shows the Change Content Repositories: Detail window containing your specifications. Chapter 4. Configuring Collector Server 47

62 Figure 24. Change Content Repositories: Detail window containing your specifications 6. Click the Save icon to save your settings. What to do next: 4.2.4, Enabling Collector Server to connect to SAP Enabling Collector Server to connect to SAP The Remote Function Call (RFC) protocol requires specific connection settings. In addition, some Content Collector for SAP tasks require specific connection settings, regardless of whether the connection is established through HTTP or RFC. The connection settings must be specified in the DESTINATION section in the server configuration profile. Before you begin: You completed one of the following tasks: v 4.2.1, Setting the number of Java RFC dispatchers, on page 36 v 4.2.2, Setting up the connection between Collector Server and SAP through HTTP, on page 37 v 4.2.3, Setting up the connection between Collector Server and SAP through Remote Function Call (RFC), on page 42 The DESTINATION section defines the connection between one Collector Server instance and one SAP system. Within this section, however, you can define the connection to several SAP clients. Procedure: 1. Open the server configuration profile in a text editor. 2. You already specified the DESTINATION section and some of the keywords in this section when you configured Collector Server for use with the archives. The following table shows which keywords are required for which connection types and tasks. Add the missing keywords. 48 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

63 DESTINATION section with mandatory Connection or task keywords and example values Synchronous RFC calls and commands where DESTINATION KD7 the number of RFC dispatchers is greater PROGID KD7.ICCSAP than 0. GWHOST /H/sapserver GWSERV sapgw00 LU sapserver TP sapdp00 Asynchronous RFC calls and commands DESTINATION KD7 where the number of RFC dispatchers greater PROGID KD7.ICCSAP than 0. GWHOST /H/sapserver GWSERV sapgw00 LU sapserver TP sapdp00 LOGICAL_SYSTEM T90CLNT090 CLIENT 800 USER CPICUser1 Enabling Collector Server to log on to an DESTINATION KD7 SAP logon group. MSHOST sapmskd7 GROUP mygroup R3NAME KD7 Archiving and linking documents by DESTINATION KD7 processing their bar codes. The number of GWHOST /H/sapserver RFC dispatchers and Java RFC dispatchers is GWSERV sapgw00 0. LU sapserver TP sapdp00 LOGICAL_SYSTEM T90CLNT090 CLIENT 800 USER CPICUser1 Archiving and linking of documents where, DESTINATION KD7 for each document, a work item is created in PROGID KD7.ICCSAP the SAP workflow. The number of Java RFC GWHOST /H/sapserver dispatchers must be greater than 0. GWSERV sapgw00 LU sapserver TP sapdp00 LOGICAL_SYSTEM T90CLNT090 CLIENT 800 USER CPICUser1 Linking of FileNet P8 objects. DESTINATION KD7 Note: In the example to the right, the number of RFC dispatchers and Java RFC dispatchers is 0. If it is greater than 0, more keywords must be specified in the DESTINATION section. R3NAME KD7 Explanation of the keywords in alphabetical order: CLIENT The name of the SAP client. You specified this client when you defined the logical system in SAP. GROUP The name of the SAP logon group. GWHOST The host name or the IP address of the SAP Gateway that you want to use. GWSERV The service or the port number of the SAP Gateway that you want to use. Chapter 4. Configuring Collector Server 49

64 LOGICAL_SYSTEM The name of the logical system that is connected to an SAP client. You specified this name when you defined the logical system in SAP. You can specify several LOGICAL_SYSTEM sections within the DESTINATION section. Each LOGICAL_SYSTEM section defines the connection to a SAP client. LU The host name or the IP address of the SAP Application Server. MSHOST The host name of the SAP Message Server. PROGID The program ID under which the RFC dispatcher is registered on the SAP Gateway or that is used by SAP Document Finder. You specified this program ID when you created the RFC destination in SAP. Note: If the RFC destination is to be used by SAP Document Finder, the program ID that you specified in SAP is appended with the number 1. Do not specify this number as part of the PROGID keyword. For example, if you specified DOCF.GIN.OD1 in SAP, specify DOCF.GIN.OD for the PROGID keyword. R3NAME Either of the following IDs: v v The ID of the SAP system that contains the group of SAP Application Servers. The ID of the SAP system to which Collector Server is to connect when it links FileNet P8 objects to SAP. TP The service or the port number of the message dispatcher of your SAP Application Server. USER The name of the user that has CPIC access. You specified this name when you created a user with CPIC access in SAP. 3. Save the server configuration profile. What to do next: 4.3, Starting Collector Server for the first time 4.3 Starting Collector Server for the first time To start Collector Server for the first time, you use the archpro command. Before you begin: 1. Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page , Configuring the connection between Collector Server and SAP, on page Ensure that all paths that you specified in the server configuration profile exist. Collector Server does not create any paths. 4. If you installed Content Engine Client Version 4.0 or on a Linux or UNIX system, ensure that the user who starts Collector Server has write permission for the wsi/app_classpath directory of your Content Engine Client installation. The archpro command to start Collector Server can be issued from any directory because you can specify the fully qualified file name of the server configuration 50 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

65 profile as parameter. To omit the fully qualified file name of the server configuration profile, both of the following conditions must be met: v v You enter the command from the directory that contains the server configuration profile. The server configuration profile has the default name archint.ini. The procedures that are shown in this information are based on the following assumptions: v The server configuration profile is in the instance directory. v The server configuration profile has the default name archint.ini. v You enter the archpro command from the instance directory. Procedure: 1. Open a command line and change to the instance directory. 2. Enter the following command to generate the master key, which encrypts the password file (default name: archint.cfg) and the SAP certificates for the archives: archpro -f masterkey You must specify this command once when you want to start Collector Server for the first time. You must have read and write access for the fully qualified path to the master key file, which contains the master key. Ideally, you are the owner of this file and no other user has access to this file. Linux and UNIX systems check the permissions for this file. Content Collector for SAP creates a master key and saves it in the file that you specified for the MASTER_KEYFILE keyword. 3. Enter the following command to enable Collector Server to access your archives: archpro -f serverpasswd You must specify this command once when you want to start Collector Server for the first time. 4. Enter the password of the FileNet P8 user name. If this password changes, also change the logon password for Collector Server. You might also be prompted for the names of a logon server and a node. 5. Enter either of the following commands to log on to SAP: v If you want to log on to a specific SAP client, enter the following command: v archpro -f r3passwd user_name user_name stands for the name of the CPIC user that Collector Server uses to log on to the SAP client. You are prompted for the password of the specified CPIC user. If you want to log on to all SAP clients that are listed in your server configuration profile, enter the following command: archpro -f r3passwd You are prompted for the password of each CPIC user. Notes: v Type the password exactly as you specified it for the CPIC user. v You must enter this command each time you want to change the SAP password. 6. Enter archpro to start Collector Server. Chapter 4. Configuring Collector Server 51

66 4.4 Stopping Collector Server For more information about this command and the parameters that you can specify, see the topic archpro in the Reference part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH All passwords that you specified are stored in the password file. Collector Server uses them the next time it is started. What to do next: Chapter 10, Configuring your environment for basic tasks, on page 115 At any time, you can stop Collector Server. Collector Server waits until all jobs are finished and then shuts down. Procedure: 1. Open a command line and change to the instance directory. 2. Enter the following command: archstop When the archpro program receives the archstop command, it first stops all child processes and then it stops itself. For more information about this command and the parameters that you can specify, see the topic archstop in the Reference part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Content Collector for SAP: Configuring for use with FileNet P8: Best practices

67 Chapter 5. Configuring Archiving Client Configure Archiving Client if you want to archive incoming documents. Before you begin: 1. Install Archiving Client from the client package. For more information, see the topic Installing the client package in console mode or GUI mode in the Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page Set up secure client connections. For more information, see the corresponding topic in the Security part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Start Archiving Client by clicking start > All Programs > IBM Content Collector for SAP Applications > Archiving Client. When you start Archiving Client for the first time, the Setup window opens. Otherwise, the IBM Content Collector for SAP Applications - Archiving Client window opens. Figure 25 shows what the IBM Content Collector for SAP Applications - Archiving Client window looks like before you configure it. In the lower right corner of the window, you see a red cross because the connection to Collector Server is not defined yet. Figure 25. IBM Content Collector for SAP Applications - Archiving Client window before configuration Procedure: Copyright IBM Corp. 2010,

68 1. 5.1, Setting up Archiving Client , Managing the queues, on page , Enabling Collector Server to use Archiving Client, on page Setting up Archiving Client When you start Archiving Client for the first time, you must change the settings according to your environment and your preferences. An initial setup is mandatory. In the IBM Content Collector for SAP Applications - Archiving Client window, click Setup > Run Setup. The Setup window opens. Figure 26 shows what the Setup window might look like after you completed the topics 5.1.1, Defining the connection to Collector Server, on page 55 through 5.1.6, Enabling logging and tracing for Archiving Client, on page 58. Figure 26. Setup window containing sample specifications Procedure: , Defining the connection to Collector Server, on page , Specifying the directory for the temporary files, on page , Loading the modules for the queues, on page , Specifying the number of bar codes in a batch job, on page , Sending the document format of the queues to SAP, on page Optional: 5.1.6, Enabling logging and tracing for Archiving Client, on page , Completing the setup of Archiving Client, on page Content Collector for SAP: Configuring for use with FileNet P8: Best practices

69 5.1.1 Defining the connection to Collector Server You must connect Archiving Client to the Collector Server that you want to use for archiving your documents. If you enabled automatic processing, disable it by clicking Autom. Processing > Stop in the IBM Content Collector for SAP Applications - Archiving Client window. Under Preferred Server Connection in the Setup window, specify the following information: 1. In the Archive Host/IP address field, type the host name or the IP address of Collector Server. If Collector Server and Archiving Client are not installed on the same computer and you want to specify the host name, use the fully qualified host name, such as myhost.yourserver.com, or the IP address of the remote host. The default value is for Internet Protocol version 4 (IPv4) or ::1 for Internet Protocol version 6 (IPv6), which designates the local host. For example, leave the default value for the local host. 2. In the Port field, type the TCP/IP registration port that is used by all Content Collector for SAP clients to connect to Collector Server. Use the port number that you specified for the ARCHPRO_PORT keyword in the server configuration profile. For example, type: Click Test to check whether a connection between Archiving Client and the specified Collector Server can be established. The test result is displayed to the right of the button. If an error occurs, an error description is displayed in a separate window. If Archiving Client can connect to the specified Collector Server, the connection status is set to OK and a green bullet is shown. In addition, the WebPort field shows the port that is set as value for the WEBPORT keyword in the server configuration profile. If a connection cannot be established, the connection status is set to FAILED and a red cross is shown. Figure 27 shows what the Preferred Server Connection area of the Setup window might look like after you completed step 1 through step 3. Figure 27. Preferred Server Connection area of the Setup window containing the default IP address and the ports as specified in the sample configuration profile What to do next: v If you had to stop automatic processing, enable it again by clicking Autom. Processing > Enable in the IBM Content Collector for SAP Applications - Archiving Client window. v 5.1.2, Specifying the directory for the temporary files, on page 56. Chapter 5. Configuring Archiving Client 55

70 5.1.2 Specifying the directory for the temporary files By default, Archiving Client stores the temporary files in the env_var_appdata\ibm\ ICCSAP\ArchivingClient directory of the user who started Archiving Client. You can specify another directory. Under Work path in the Setup window, specify the following information: Specify the full path to the directory where Archiving Client should store its temporary files. For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\ Figure 28 shows the Work path area of the Setup window containing the sample path. Figure 28. Work path area of the Setup window containing the sample path What to do next: 5.1.3, Loading the modules for the queues Loading the modules for the queues Archiving Client collects the scanned documents that are to be archived, from a queue. The type of queue that you can use depends on your scanning application. For each type of queue, you must load a software module. Under Modules in the Setup window, specify the following information: v Select the DirQueue check box if your scanning application stores the scanned documents in the file system. v Select the FileQueue check box if your scanning application stores the scanned documents in the file system and creates a description file. Figure 29 shows the Modules area of the Setup window containing your selections Figure 29. Modules area of the Setup window containing your sample selections What to do next: 5.1.4, Specifying the number of bar codes in a batch job Specifying the number of bar codes in a batch job If the documents are to be linked by processing their bar codes, you can increase the performance by sending up to 50 bar codes in one batch job instead of sending the bar codes one by one. 56 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

71 Note: If one of the documents that are processed in a batch job are not linked, you get one return code for the entire batch job. You do not get a return code for each document processed. Under Barcode in the Setup window, specify the following information: In the Number of Barcodes to be sent in a batch field, click the arrows to select the number of bar codes that are to be sent together. You can also type the number, which can be For example, type: 50 Figure 30 shows the Barcode area of the Setup window containing your sample specification. Figure 30. Barcode area of the Setup window containing the sample number of bar codes What to do next: 5.1.5, Sending the document format of the queues to SAP Sending the document format of the queues to SAP If you want to view archived documents in the format in which they are archived, you must enable Collector Server to send the document format to SAP. Otherwise, a document is displayed in the FAX format. You specify the document format when you create a queue for the documents. Under Document format sent to SAP in the Setup window, specify the following information: Select the As configured in queue setup (if unchecked FAX is sent) check box if you want to archive your documents in a format other than FAX. In this case, the document format that you specify when you create the queues is sent to SAP. If you select this check box, ensure that SAP can use a viewer application that recognizes the document format of the archived documents. For this example, select the check box. Figure 31 shows the Document format sent to SAP area of the Setup window containing your selection Figure 31. Document format sent to SAP area of the Setup window containing your selection What to do next: 5.1.6, Enabling logging and tracing for Archiving Client, on page 58 Chapter 5. Configuring Archiving Client 57

72 5.1.6 Enabling logging and tracing for Archiving Client You can enable Archiving Client to log its activities in log files and trace files. You can enable logging in a general log file, in a log file that contains information about the communication between Archiving Client and Collector Server, and in a trace file for error recovery. In addition, you can specify where the log files and trace files are to be stored. Note, however, that logging and tracing affects the performance of Content Collector for SAP. If possible, use the path where you store the temporary files, as path for all log files and trace files. Under Logging and Tracing in the Setup window, specify the following information: Procedure: v To enable general logging, complete these steps: 1. Select the Enable check box next to the Log file field. 2. In the Log file field, specify the fully qualified path to the log file. You can specify a path of your choice. For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\ ICCSAP_AC.log v To record information about the communication between Archiving Client and Collector Server, complete these steps: 1. Select the Enable check box next to the API trace file field. 2. In the API trace file field, specify the fully qualified path the trace file. You can specify a path of your choice. For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\ ICCSAP_ClientAPI.trc v To collect more details about the activities of Archiving Client, complete these steps: 1. Select the Enable check box next to the Client trace file field. 2. In the Client trace file field, specify the fully qualified path to the trace file. You can specify a path of your choice. For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\ ICCSAP_AC.trc 3. In the Maximum file size field, click the arrows to select the maximum size of the trace file, in KB. You can specify a number up to, and including, KB. If the trace file exceeds the limit, the oldest information is overwritten. For example, type: Select the Clear trace file check box if you want to delete the existing trace file each time you start Archiving Client. Note: If you select this check box, you might lose valuable information for error recovery if the same error recurs. For this example, leave this check box clear. 58 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

73 Figure 32 shows the Logging and Tracing area of the Setup window with the entire logging and tracing enabled. What to do next: 5.1.7, Completing the setup of Archiving Client Completing the setup of Archiving Client Click OK to verify your configuration. If your settings are correct, they are saved. 5.2 Managing the queues Figure 32. Logging and Tracing area of the Setup window containing the sample specifications You are returned to the IBM Content Collector for SAP Applications - Archiving Client. In the right corner of the status bar, a green bullet indicates that a connection to Collector Server is established. What to do next: v At any time, you can change the setup again by clicking Setup > Run Setup in the IBM Content Collector for SAP Applications - Archiving Client window. If you enabled automatic processing and decide to change the server connection, remember to disable automatic processing first by clicking Autom. Processing > Stop in the IBM Content Collector for SAP Applications - Archiving Client window. v 5.2.1, Creating queues, on page 60. A queue is a container for scanned documents with common properties. Archiving Client collects the scanned documents from a queue and stores them in an archive or in SAP. For example, you might want to create a queue for documents with a certain content, such as invoices, or for documents in a certain format, such as a GIF, or for documents that you want to store in the same archive. The scanning application that you use determines the queue type. You can create queues, view and change the properties of the queues, import scanned documents into the queues, and remove documents from the queues. You perform these tasks in Archiving Client. To start Archiving Client: Procedure: Chapter 5. Configuring Archiving Client 59

74 Click Start > All Programs > IBM Content Collector for SAP Applications > Archiving Client. The IBM Content Collector for SAP Applications - Archiving Client window opens Creating queues Create queues for documents with common properties. Before you begin: v If you enabled automatic processing, disable it by clicking Autom. Processing > Stop in the IBM Content Collector for SAP Applications - Archiving Client window. v 5.1, Setting up Archiving Client, on page 54. v Plan for secure connections to Archiving Client and Viewing Client. For more information, see the corresponding topic in the Security part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH In the IBM Content Collector for SAP Applications - Archiving Client window, click Queue > New Queue. The Queue window opens. Create at least one queue: v , Creating queues if the scanned documents are in the file system v , Creating queues if the scanned documents are in the file system and a description file exists, on page Creating queues if the scanned documents are in the file system Create queues of type DirQueue if your scanning application stores the scanned documents in the file system. Archiving Client collects the scanned documents from the file system. It can use the file names of the scanned documents as bar codes. Procedure: , Providing details about the queue of type DirQueue , Defining the connection to Collector Server, on page , Connecting the queue to a logical archive, on page , Providing details about the directory, on page , Completing the creation of the queue of type DirQueue, on page Providing details about the queue of type DirQueue: You must provide some details about the queue that you want to create. In the Queue window, provide the following information: Procedure: 1. From the Queue Type list, select DirQueue. 2. In the Queue Name field, type a name for the queue. For example, type: my_dirqueue 3. From the Document Format list, select an SAP document format. For example, select FAX. 60 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

75 The document formats that you can select are listed in the file csdoctypes.ini, which is in the directory of your Archiving Client installation. If the file does not contain the document format that you need, you must add it to the csdoctypes.ini file. For more information, see 5.2.6, Adding or removing SAP document formats, on page 76. If you select a document format other than FAX, ensure that the As configured in queue setup (if unchecked FAX is sent) check box is selected in the Setup window. Only if this check box is selected, the document format that you specify here is sent to SAP when the documents are archived. Otherwise, the document format FAX is sent to SAP. SAP uses the document format to open a suitable viewer application for the archived documents. 4. If you plan to archive your documents by creating work items in an SAP workflow, specify a document type in the Document type field. The document type categorizes the documents that are to be imported into the queue. When you later configure your environment for archiving incoming documents, you must enable this document for an SAP workflow so that the documents can be linked to a specific SAP business object. For example, type: FIIINVOICE 5. Click Next to connect the queue with a Collector Server. Figure 33 shows what the Queue window might look like after you completed step 1 on page 60 through step 4. Figure 33. Queue window showing the sample details for a queue of type DirQueue What to do next: , Defining the connection to Collector Server, on page 62 Chapter 5. Configuring Archiving Client 61

76 Defining the connection to Collector Server: By default, a queue is connected to the Collector Server that you specified in the Setup window as the preferred Collector Server. The queue can, however, be connected to a different Collector Server. Before you begin: , Providing details about the queue of type DirQueue, on page 60 In the Connection Properties window, provide the following information: Procedure: 1. You can use an existing server connection or create one: v To use an existing server connection, click it under Available connections. The details of the server connection are shown in the Archive Host/IP address, Port, and WebPort fields. v To create a server connection, complete these steps: a. In the Archive Host/IP address field, type the host name or the IP address of Collector Server. If Collector Server and Archiving Client are not installed on the same computer and you want to specify the host name, use the fully qualified host name, such as myhost.yourserver.com, or the IP address of the remote host. The default value is for Internet Protocol version 4 (IPv4) or ::1 for Internet Protocol version 6 (IPv6), which designates the local host. For this example, leave the default value. b. In the Port field, type the TCP/IP registration port that is used by all Content Collector for SAP clients. Use the port number that you specified for the ARCHPRO_PORT keyword in the server configuration profile. For example, type: 5500 c. In the WebPort field, specify the TCP/IP port through which the HTTP dispatcher gets its requests. The port must match the value of the WEBPORT keyword in the server configuration profile. For example, type: Click Next to connect the queue to a logical archive. Figure 34 on page 63 shows the Connection Properties window containing the sample Collector Server that you specified in the Setup window as the preferred Collector Server. 62 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

77 Figure 34. Connection Properties window showing the sample Collector Server that you specified in the Setup window as the preferred Collector Server What to do next: , Connecting the queue to a logical archive Connecting the queue to a logical archive: You must connect the queue to a logical archive that is already defined in the server configuration profile and in SAP. Before you begin: , Defining the connection to Collector Server, on page 62 In the Logical archive window, specify the following information: Procedure: 1. In the SAP Archive field, specify the logical archive ID. Use the ID that you specified for the ARCHIVE keyword in the server configuration profile and that you specified when you created a content repository or logical archive in SAP. For example, select A1. 2. If, during archiving, Content Collector for SAP should check whether the archive ID that is submitted by an Object Linking and Embedding (OLE) request matches the specified logical archive ID, select the Check archive matching check box. For this example, select the check box. 3. Click Next to provide information about the selected queue type. Figure 35 on page 64 shows the Logical archive window containing the sample specifications. Chapter 5. Configuring Archiving Client 63

78 Figure 35. Logical archive window showing the sample specifications What to do next: , Providing details about the directory Providing details about the directory: You must specify the directory in which the scanning application stores the scanned documents. In the Directory Queue window, specify the following information: Procedure: 1. In the Path name field, specify the full path to the directory that contains the scanned documents. For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\queues\ dir 2. Make sure that the Use filename as barcode check box is selected. During archiving, Content Collector for SAP sends the file names of the scanned documents as bar codes to SAP. If you leave the check box clear, you receive an error message because the archived documents cannot be linked to the SAP business objects. 3. Click Next. Figure 36 on page 65 shows the Directory Queue window containing the sample path to the directory where the scanned documents are stored. 64 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

79 Figure 36. Directory Queue window showing the sample path to the directory where the scanned documents are stored What to do next: , Completing the creation of the queue of type DirQueue Completing the creation of the queue of type DirQueue: Click Finish to create the queue. You are returned to the IBM Content Collector for SAP Applications - Archiving Client window. The queue is listed in the navigation pane and is ready for use. What to do next: v If you had to stop automatic processing, enable it again by clicking Autom. Processing > Enable in the IBM Content Collector for SAP Applications - Archiving Client window. v 5.2.2, Saving and reusing the queue information, on page Creating queues if the scanned documents are in the file system and a description file exists Create queues of type FileQueue if your scanning application stores the scanned documents in the file system and creates a description file. The description file contains an entry for each scanned document. Archiving Client stores only the documents for which an entry in the description file exists. Each entry must contain the file name of the scanned document. If the bar code of the document is to be processed, the entry must also contain the bar code. If the entries contain additional attribute values for the documents, Archiving Client can store them with the documents. Procedure: Chapter 5. Configuring Archiving Client 65

80 , Making the document classes available for property mapping , Providing details about the queue of type FileQueue , Defining the connection to Collector Server, on page , Connecting the queue to a logical archive, on page , Providing details about the directory and the description file, on page , Specifying the attributes values to be stored in the logical archive or in SAP, on page , Completing the creation of the queue of type FileQueue, on page Making the document classes available for property mapping: More than one document class can be defined for an object store. If your scanning application creates a description file, the values in this file can be stored with the documents. For this purpose, the custom properties of the document classes must be mapped to the values in the description file. Specify the documents classes whose custom properties are to be available for mapping. You specify the document classes in the server configuration profile. 1. Open the server configuration profile of the Collector Server that you want to use, in a text editor. 2. Add the following keyword to the appropriate ARCHIVE sections: REPINFOCLASSES class1,class2,... class1,class2,... stands for the document classes that are to receive the values. Only those properties can receive values that are common to all specified document classes. 3. The document classes that are listed for REPINFOCLASSES might not have the same set of properties. If you want to ensure that all properties of all specified document classes can receive values, add the following keyword: RETURN_ALL_ATTR YES Note: In this case, however, you receive an error when Collector Server tries to archive property values in a document class for which the properties are not defined. 4. Save the server configuration profile, and restart Collector Server for the changes to take effect. What to do next: , Providing details about the queue of type FileQueue Providing details about the queue of type FileQueue: You must provide some details about the queue that you want to create. Before you begin: , Making the document classes available for property mapping In the Queue window, provide the following information: Procedure: 1. From the Queue Type list, select FileQueue. 2. In the Queue Name field, type a name for the queue. 66 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

81 For example, type: my_filequeue 3. From the Document Format list, select an SAP document format. For example, select FAX. The document formats that you can select are listed in the file csdoctypes.ini, which is in the directory of your Archiving Client installation. If the file does not contain the document format that you need, you must add it to the csdoctypes.ini file. For more information, see 5.2.6, Adding or removing SAP document formats, on page 76. If you select a document format other than FAX, ensure that the As configured in queue setup (if unchecked FAX is sent) check box is selected in the Setup window. Only if this check box is selected, the document format that you specify here is sent to SAP when the documents are archived. Otherwise, the document format FAX is sent to SAP. SAP uses the document format to open a suitable viewer application for the archived documents. 4. If you plan to archive your documents by creating work items in an SAP workflow, specify a document type in the Document type field. The document type categorizes the documents that are to be imported into the queue. When you later configure your environment for archiving incoming documents, you must enable this document for an SAP workflow so that the documents can be linked to a specific SAP business object. For example, type: FIIINVOICE 5. Click Next to connect the queue with a Collector Server. Figure 37 shows what the Queue window might look like after you completed step 1 on page 66 through step 4. Figure 37. Queue window showing the sample details for a queue of type FileQueue What to do next: , Defining the connection to Collector Server, on page 68 Chapter 5. Configuring Archiving Client 67

82 Defining the connection to Collector Server: By default, a queue is connected to the Collector Server that you specified in the Setup window as the preferred Collector Server. The queue can, however, be connected to a different Collector Server. Before you begin: , Providing details about the queue of type FileQueue, on page 66 In the Connection Properties window, provide the following information: Procedure: 1. You can use an existing server connection or create one: v To use an existing server connection, click it under Available connections. The details of the server connection are shown in the Archive Host/IP address, Port, and WebPort fields. v To create a server connection, complete these steps: a. In the Archive Host/IP address field, type the host name or the IP address of Collector Server. If Collector Server and Archiving Client are not installed on the same computer and you want to specify the host name, use the fully qualified host name, such as myhost.yourserver.com, or the IP address of the remote host. The default value is for Internet Protocol version 4 (IPv4) or ::1 for Internet Protocol version 6 (IPv6), which designates the local host. For this example, leave the default value. b. In the Port field, type the TCP/IP registration port that is used by all Content Collector for SAP clients. Use the port number that you specified for the ARCHPRO_PORT keyword in the server configuration profile. For example, type: 5500 c. In the WebPort field, specify the TCP/IP port through which the HTTP dispatcher gets its requests. The port must match the value of the WEBPORT keyword in the server configuration profile. For example, type: Click Next to connect the queue to a logical archive. Figure 38 on page 69 shows the Connection Properties window containing the sample Collector Server that you specified in the Setup window as the preferred Collector Server. 68 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

83 Figure 38. Connection Properties window showing the sample Collector Server that you specified in the Setup window as the preferred Collector Server What to do next: , Connecting the queue to a logical archive Connecting the queue to a logical archive: You must connect the queue to a logical archive that is already defined in the server configuration profile and in SAP. Before you begin: , Defining the connection to Collector Server, on page 68 In the Logical archive window, specify the following information: Procedure: 1. In the SAP Archive field, specify the logical archive ID. Use the ID that you specified for the ARCHIVE keyword in the server configuration profile and that you specified when you created a content repository or logical archive in SAP. For example, select A1. 2. If, during archiving, Content Collector for SAP should check whether the archive ID that is submitted by an Object Linking and Embedding (OLE) request matches the specified logical archive ID, select the Check archive matching check box. For this example, select the check box. 3. Click Next to provide information about the selected queue type. Figure 39 on page 70 shows the Logical archive window containing the sample specifications. Chapter 5. Configuring Archiving Client 69

84 Figure 39. Logical archive window showing the sample specifications What to do next: , Providing details about the directory and the description file Providing details about the directory and the description file: You must specify the directory in which the scanning application places the scanned documents. In addition, you must specify details about the description file that the scanning application creates. Before you begin: , Connecting the queue to a logical archive, on page 69 A description file contains an entry for each scanned document. An entry that can be used by Archiving Client to link a document to an SAP business object, can look like in the following example: "OCR capture","barcode","246148","c:\users\iccsapuser1\appdata\roaming\ibm\iccsap\ ArchivingClient\queues\file\order.tiff","myclient","12345","order","11/07/31","2012" Each attribute value of a document is enclosed in double quotation marks to mark its beginning and its end is an example for a bar code, and C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\queues\ file\order.tiff is an example for a fully qualified file name of a scanned document. Both attribute values are mandatory. Other attribute values, such as myclient or order, are optional. You can store optional attribute values with the documents so that the documents are easier to find. In the File Queue window, specify the following information: Procedure: 1. In the Path name for description files field, specify the full path to the directory that contains the description file. 70 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

85 For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\FileData 2. In the Extension of description files field, type the extension of the description file. For example, type: txt 3. In the File column field, type the number of the column in the description file that contains the file name of each scanned document. In the description file example, the file name is in the fourth column. Thus, you would enter 4 in the File column field. 4. In the Barcode column field, type the number of the column in the description file that contains the bar code of each scanned document. In the description file example, the bar code is in the third column. Thus, you would enter 3 in the Barcode column field. 5. Click Next to select the attributes that are listed in the description file for each document and that are to be stored with a document. Figure 40 shows what the File Queue window might look like after you completed step 1 on page 70 through step 4. Figure 40. File Queue window showing the sample specifications What to do next: If you want to store more information about the documents in the logical archive or in SAP, continue with , Specifying the attributes values to be stored in the logical archive or in SAP Specifying the attributes values to be stored in the logical archive or in SAP: You can specify which attributes values are to be transferred to SAP. If you use Content Manager Enterprise Edition, Content Manager OnDemand, or FileNet P8 Chapter 5. Configuring Archiving Client 71

86 as archive, the attribute values can also be stored in the logical archive. You can use the attribute values to search for the archived documents. Before you begin: v The scanning application creates a description file. v The attributes exist in the logical archive or in SAP, or they must be added before you start archiving. The description file that is created by your scanning application contains the attribute values of the scanned documents. To enable the storage of these values, you must specify the attributes for the queue and you must specify the position of each attribute value in the description file. The Custom attributes window lists the properties that are already defined for the document classes. Figure 41 shows the Custom attributes window with sample custom attributes. Figure 41. Custom attributes window showing sample custom attributes The Column column shows the position of the attribute value in the description file. If there are several values for an attribute, they are separated by a comma. The Target column shows Archive or SAP, depending on where the attribute is to be stored. The list of attributes does not include the Content Collector for SAP system attributes. System attributes are automatically filled by Collector Server. v To specify the position of the attribute value in the description file, complete these steps: 1. In the Custom attributes window, click an attribute and then click Edit. The Edit custom attribute window opens. 72 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

87 v v 2. In the Column field, type the position of the attribute value in the description file. If an attribute has more than one value, separate the positions by a comma. 3. Click OK to return to the Custom attributes window. To add an attribute, complete these steps: 1. In the Custom attributes window, click Add. The Add custom attribute window opens. 2. In the Name field, type a name for the attribute. 3. In the Column field, type the position of the attribute value in the description file. If an attribute has more than one value, separate the positions by a comma. 4. In the Target field, select Archive or SAP depending on whether this attribute is to be stored in the specified document classes or is to be sent to SAP. 5. Click OK to return to the Custom attributes window. To specify that, for a particular attribute, no values are to be stored, complete these steps: 1. In the Custom attributes window, click an attribute and then click Edit. The Edit custom attribute window opens. 2. In the Column field, type 0. Alternatively, you can also select none in the Target field. 3. Click OK to return to the Custom attributes window. What to do next: , Completing the creation of the queue of type FileQueue Completing the creation of the queue of type FileQueue: Click Finish to create the queue. You are returned to the IBM Content Collector for SAP Applications - Archiving Client window. The queue is listed in the navigation pane and is ready for use. If you created a queue of type FileQueue, the attributes are listed in the content pane. What to do next: v If you had to stop automatic processing, enable it again by clicking Autom. Processing > Enable in the IBM Content Collector for SAP Applications - Archiving Client window. v 5.2.2, Saving and reusing the queue information Saving and reusing the queue information At any time, you can save the queue information to a file. When you start Archiving Client the next time, you can open and reuse the queue information. You can save various statuses of the queue information under different file names. For example, you might want to create one queue and then save the information under a specific file name. After you create another queue, you might want to save the information about both queues under a different file name. You save, change, and reopen the queue information in the IBM Content Collector for SAP Applications - Archiving Client window. Chapter 5. Configuring Archiving Client 73

88 Procedure: v If you created one or more queues and want to save the queue information, complete these steps: 1. Click File > Save. 2. In the window that opens, specify a fully qualified file name without a file extension. The file is saved with the extension csw. v If you changed the queue information and want to save it under the same name, click File > Save. v If you changed the queue information and want to save it under a different name, complete these steps: 1. Click File > Save As. 2. In the window that opens, specify a fully qualified file name without a file extension. The file is saved with the extension csw. v To use the queue information again that you saved in a csw file, complete these steps: 1. Click File > Open. 2. In the window that opens, select the file that contains the queue information that you want to use again. What to do next: 5.3, Enabling Collector Server to use Archiving Client, on page Viewing and changing the properties of a queue You can view the properties of a queue and you can change some of the queue properties. Before you begin: If automatic processing is enabled and you want to change any properties, disable automatic processing by clicking Autom. Processing > Stop in the IBM Content Collector for SAP Applications - Archiving Client window. Procedure: 1. In the navigation pane of the IBM Content Collector for SAP Applications - Archiving Client window, select the queue that you want to change, and click Queue > Properties. The Properties of queue window opens. 2. In the Properties of queue window, you can change specific settings on various pages. Note: For queues of type CMQueue, you cannot change the server connection because these queues always use the Collector Server that you specified when you created the queue. 3. Click OK to save your changes and to return to the IBM Content Collector for SAP Applications - Archiving Client window. Figure 42 on page 75 shows the Queue page of the Properties of queue window containing the details about a sample queue of type DirQueue. 74 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

89 Figure 42. Queue page of the Properties of queue window showing the details about the sample queue my_dirqueue If you had to stop automatic processing, enable it again by clicking Autom. Processing > Enable in the IBM Content Collector for SAP Applications - Archiving Client window Viewing the connection between Archiving Client and the Collector Server instances You can view details about the connections between Archiving Client and the Collector Server instances. Before you begin: If you enabled automatic processing, disable it by clicking Autom. Processing > Stop in the IBM Content Collector for SAP Applications - Archiving Client window. Procedure: 1. In the navigation pane of the IBM Content Collector for SAP Applications - Archiving Client window, click a queue, and click Queue > Connections Info. In the Connections Information window, you can view the details about all configured connections, which are sorted by queue name. The information includes the connections status and details about the SAP system to which Collector Server is connected. 2. Click Refresh to view the latest information. You might want to refresh if a new connection was configured after you opened the Connections Information window. 3. Click Close to close the window. Figure 43 on page 76 shows the Connections Information window with two sample connections. Chapter 5. Configuring Archiving Client 75

90 Figure 43. Connections Information window showing the connection information that you defined for two sample queues If you had to stop automatic processing, enable it again by clicking Autom. Processing > Enable in the IBM Content Collector for SAP Applications - Archiving Client window Deleting a queue You can delete a queue even if it still contains scanned documents. You can delete the scanned documents together with the queue. Procedure: 1. In the navigation pane of the IBM Content Collector for SAP Applications - Archiving Client window, select a queue, and click Queue > Delete. Ifthe queue contains scanned documents, the following message is displayed: DIALOG19: When deleting the selected queue, do you want the scanned original documents to be deleted as well? 2. Make your selection. If you click Yes, the scanned documents are deleted together with the queue. If you click No, only the queue is removed Adding or removing SAP document formats When you create a queue, you must select a document format so that SAP can open a suitable application for viewing the archived documents. When you archive a document, the selected format is stored with it. The document formats from which you can choose are in the file csdoctypes.ini. You can add more document formats to this file or remove document formats. Procedure: 1. Open the csdoctypes.ini file in a text editor. This file is in the directory of your Archiving Client installation. The content of the file looks as follows: ;FAX is a mandatory doctype. It has to be in the list of doctypes. [CSClientDocTypes] doctypes=fax,tif,pdf,alf,txt,jpg,gif,doc,rtf,xls,ppt,lwp,123,mpg The lines that start with a semicolon are comments. 2. Add the missing SAP document formats after the doctypes= tag. Separate the entries by a comma. Type all formats on one line. 76 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

91 3. You can remove any document formats that you do not need. However, do not remove the mandatory document format FAX. 4. Save and close the file. 5.3 Enabling Collector Server to use Archiving Client You must enable Collector Server to start at least one client dispatcher. Procedure: 1. Open the server configuration profile of the Collector Server that you want to use, in a text editor. 2. Set the ARCHWINS keyword to a value greater than Save the server configuration profile, and restart Collector Server for the changes to take effect. What to do next: If you are configuring your environment for archiving your documents by creating work items in an SAP workflow, return to , Configuring for archiving incoming documents by creating work items in an SAP workflow, on page 129. Chapter 5. Configuring Archiving Client 77

92 78 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

93 Chapter 6. Configuring P8 Client Configure P8 Client if you want to link archived documents and other archived objects to SAP. P8 consists of the following Workplace portlets: the Browse portlet and the Queue portlet. If you want to link documents, specific versions of the documents, stored searches, search templates, or entire folders, you must configure the Browse portlet. If you want to link documents that are available in a P8 queue, you must configure the Queue portlet. You configure both portlets in Workplace or in Workplace XT. Before you begin: 1. Install P8 Client from the server package or the client package and install P8 Client SAP Connector from the client package. For more information, see the topic Installing the server package in console mode or GUI mode or Installing the client package in console mode or GUI mode in the Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Plan for secure connections to P8 Client. For more information, see the corresponding topic in the Planning part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 2, Preparing your environment, on page Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page , Configuring Collector Server for use with FileNet P8, on page , Starting Collector Server for the first time, on page 50. You can configure the portlets for your user account only (user preferences) or for all user accounts of a Workplace or Workplace XT application (site preferences). The following procedure shows how to set the site preferences. 6.1 Logging on to Workplace or Workplace XT as an administrator To change the site preferences, you must log on to Workplace or Workplace XT as an administrator. Procedure: 1. Start Workplace or Workplace XT by using either of the following web addresses: v v 2. Log on to Workplace or Workplace XT with the name of a user who is a member of the Application Engine Administrators group and with the password of this user. 3. Depending on whether you have Workplace or Workplace XT, proceed as follows: v In Workplace, click the Admin tab. On the Admin page, click Site Preferences. Copyright IBM Corp. 2010,

94 v In Workplace XT, click Tools > Administration. What to do next: Continue with either of the following tasks: v 6.2, Configuring the Browse portlet v 6.3, Configuring the Queue portlet, on page Configuring the Browse portlet Configure the Browse portlet if you want to create work items in SAP for selected documents that are organized in folders and if you want to create work items for entire folders. Before you begin: 6.1, Logging on to Workplace or Workplace XT as an administrator, on page 79 Procedure: , Registering the Browse portlet and adding it to the My Workplace view , Defining the connection to Collector Server, on page , Setting up My Workplace, on page , Selecting the object store and the folder, on page Registering the Browse portlet and adding it to the My Workplace view You must register the Browse portlet with Workplace or Workplace XT and add it to the My Workplace view. Procedure: 1. In the navigation pane of the Site Preferences page, expand My Workplace > Registered Portlets to view the default Workplace or Workplace XT portlets. 2. Under Registered Portlets, click Add New to register the Browse portlet. 3. In the Portlet Settings area, type the following information: Field Title Portlet Servlet Portlet Image URL Description Value ACBrowsePortlet ACBrowsePortlet ACBrowsePortlet/image.gif With ACBrowsePortlet, you can browse folders, documents, stored searches, and search templates and you can link these objects to SAP by using an inbound linking process. Note: Type ACBrowsePortlet as shown. It is case-sensitive. 4. Click Accept to save your specifications. The Registered Portlets page shows the Browse portlet that you registered. 5. In the navigation pane of the Site Preferences page, expand My Workplace > Pages. 6. Under My Workplace, click Add New to add a page. The Design Page opens. 80 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

95 7. In the Page Name field under the Design Page Layout, type a name for the new page, for example: Content Collector for SAP Browse Portlet 8. Click Design Page to define the content and the layout of the new page. The Design Page Layout page opens. 9. In the Available Portlets area, under ACBrowsePortlet, click Add to Layout. 10. On the Create Title page, type an alias for the portlet in the Alias field. Click Accept. The selected Browse portlet is added, under its alias, to the left box at the bottom of the Design Page Layout page. 11. Click Accept. You are returned to the Design Page. 12. In the Design Page Layout area, click Select access roles to define which users should have access to the new page. 13. On the Select Access Roles page, select the user groups that should have access to the new My Workplace page. Then, click Accept. 14. On the Design Page, click Accept. The My Workplace area on the Site Preferences page shows the new page. 15. Click Apply or OK to permanently add your new page to the My Workplace view. What to do next: 6.2.2, Defining the connection to Collector Server Defining the connection to Collector Server To ensure that the documents in a specific archive are linked to the appropriate SAP system, Workplace or Workplace XT must be able to access the server configuration profile of the appropriate Collector Server. The connection to Collector Server is defined in a properties file that was installed in the directory of your Workplace or Workplace XT installation when P8 Client was installed. The properties file contains examples of entries that you can change according to your needs. Before you begin: 6.2.1, Registering the Browse portlet and adding it to the My Workplace view, on page 80 The properties file ACSystemSelection.properties is installed in the following path of your Workplace or Workplace XT installation: v Linux UNIX WEB-INF/classes v Windows WEB-INF\classes Procedure: 1. Open the properties file in a text editor. The file contains two examples of entries, where each entry is in the following format: <entry key="value"> 2. Change the entries as follows: v Replace the key value with a name that helps you recognize the Collector Server whose server configuration profile Workplace or Workplace XT should access. The name that you specify is displayed on the Preview and Setup page of Workplace or Workplace XT. Chapter 6. Configuring P8 Client 81

96 v In the web address, replace server_name with the IP address, the host name, or the fully qualified host name of Collector Server. In addition, replace port with the value of the ARCHPRO_PORT keyword, which specifies the port number of Collector Server. Note: Some characters must not be used in an entry. The following table gives an overview of these characters and shows which XML character escapes are to be used instead. Characters not to be used: Use the following character escapes instead: & & < < > > " " ' &#39; 3. Save the changes to the properties file. 4. Deploy Workplace or Workplace XT again on your Application Server. What to do next: 6.2.3, Setting up My Workplace Setting up My Workplace You must set display preferences and specify the Collector Server with which Workplace or Workplace XT is to communicate. Before you begin: 6.2.2, Defining the connection to Collector Server, on page 81 Procedure: 1. Depending on whether you have Workplace or Workplace XT, start as follows: v In Workplace, click the Admin tab. On the Admin page, click Site Preferences. v In Workplace XT, click Tools > Administration. 2. In the navigation pane of the Site Preferences page of Workplace or Workplace XT, expand My Workplace > Pages. Under My Workplace, the page that you previously added is shown. 3. Under the name of the new page, click Preview and setup. 4. In the window that opens, click the Always trust content from this publisher check box and then click Run to permanently accept the security certificate for the signed applet. The procedure depends on whether you work with Workplace or Workplace XT. 5. Click the Edit icon to the right of the page to change the current settings of the portlet. 6. In the Maximum Rows field, type a number to specify how many documents and folders are to be displayed in the portlet at a time. 7. From the SAP System list, select a connection to a Collector Server. The connection is defined in the ACSystemSelection.properties file. By using this connection, the portlet retrieves the server configuration profile to determine the archive from which documents are linked and to determine the SAP system to which the documents are to be linked. 82 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

97 Your selection is stored permanently. If you change the web address of the connection in the ACSystemSelection.properties file, the selected entry disappears from the SAP System list and you must select another connection. 8. Click Apply to save your changes. What to do next: 6.2.4, Selecting the object store and the folder Selecting the object store and the folder You must select the object store and the folder that contains the documents that are to be linked. Before you begin: 6.2.3, Setting up My Workplace, on page 82 Procedure: 1. On the Preview and Setup page for the Browse portlet, click the Edit icon to the right of the page to change the current settings of the portlet. 2. Click Path to define the path to the object store and the folder. 3. On the Select Item page, under Object Stores, click one of the displayed object stores. 4. Under Folders and Searches, click one of the folders. Your selection is displayed under Path. 5. If the selected folder contains subfolders, you can continue to select a subfolder until the folder of your choice is displayed under Path. Note: If you select a folder with subfolders, you later get a list of all documents in the folder and in its subfolders. In addition, you get a list entry for each subfolder because you can link an entire subfolder to SAP. If you plan to link an entire subfolder to SAP, ensure that all documents in the subfolder can be assigned to one SAP document type. 6. Under Path, click Select folder_name, where folder_name stands for the name of the selected folder. The Path field shows the selected object store and the selected folder. 7. Click Apply to save your changes and to view a list of all documents in the selected folder. If the folder has subfolders, each subfolder is listed as one entry. 8. Click Close to return to the My Workplace view. What to do next: If you are configuring your environment for linking FileNet P8 objects by using P8 Client, continue with Chapter 7, Configuring P8 Client SAP Connector, on page Configuring the Queue portlet Configure the Queue portlet if you want to link documents to SAP that are available as work items in a P8 queue. Before you begin: 6.1, Logging on to Workplace or Workplace XT as an administrator, on page 79 Procedure: , Registering the Queue portlet and adding it to the My Workplace view, on page , Defining the connection to Collector Server, on page 85 Chapter 6. Configuring P8 Client 83

98 , Setting up My Workplace, on page , Associating the Queue portlet with a P8 queue, on page Registering the Queue portlet and adding it to the My Workplace view You must register the Queue portlet with Workplace or Workplace XT and add it to the My Workplace view. Procedure: 1. In the navigation pane of the Site Preferences page, expand My Workplace > Registered Portlets to view the default Workplace or Workplace XT portlets. 2. Under Registered Portlets, click Add New to register the Queue portlet. 3. In the Portlet Settings area, type the following information: Field Title Portlet Servlet Portlet Image URL Description Value ACQCimPortlet ACQCimPortlet ACQCimPortlet/image.gif With ACQCimPortlet, you can view work items and you can link work items in a P8 queue to SAP by using an inbound linking process. Note: Type ACQCimPortlet as shown. It is case-sensitive. 4. Click Accept to save your specifications. The Registered Portlets page shows the Queue portlet that you registered. 5. In the navigation pane of the Site Preferences page, expand My Workplace > Pages. 6. Under My Workplace, click Add New to add a page. The Design Page opens. 7. In the Page Name field under the Design Page Layout, type a name for the new page, for example, Content Collector for SAP Queue Portlet 8. Click Design Page to define the content and the layout of the new page. The Design Page Layout page opens. 9. In the Available Portlets area, under ACQCimPortlet, click Add to Layout. 10. On the Create Title page, type an alias for the portlet in the Alias field. Click Accept. The selected Queue portlet is added, under its alias, to the left box at the bottom of the Design Page Layout page. 11. Click Accept. You are returned to the Design Page. 12. In the Design Page Layout area, click Select access roles to define which users have access to the new page. 13. On the Select Access Roles page, select the user groups that should have access to the new My Workplace page. Then, click Accept. 14. On the Design Page, click Accept. The My Workplace area on the Site Preferences page shows the new page. 15. Click Apply or OK to permanently add your new page to the My Workplace view. 84 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

99 What to do next: 6.3.2, Defining the connection to Collector Server Defining the connection to Collector Server To ensure that the documents in a specific archive are linked to the appropriate SAP system, Workplace or Workplace XT must be able to access the server configuration profile of the appropriate Collector Server. The connection to Collector Server is defined in a properties file that was installed in the directory of your Workplace or Workplace XT installation when P8 Client was installed. The properties file contains examples of entries that you can change according to your needs. Before you begin: 6.3.1, Registering the Queue portlet and adding it to the My Workplace view, on page 84 The properties file ACSystemSelection.properties is installed in the following path of your Workplace or Workplace XT installation: v Linux UNIX WEB-INF/classes v Windows WEB-INF\classes Procedure: 1. Open the properties file in a text editor. The file contains two examples of entries, where each entry is in the following format: <entry key="value"> 2. Change the entries as follows: v Replace the key value with a name that helps you recognize the Collector Server whose server configuration profile Workplace or Workplace XT should access. The name that you specify is displayed on the Preview and Setup page of Workplace or Workplace XT. v In the web address, replace server_name with the IP address, the host name, or the fully qualified host name of Collector Server. In addition, replace port with the value of the ARCHPRO_PORT keyword, which specifies the port number of Collector Server. Note: Some characters must not be used in an entry. The following table gives an overview of these characters and shows which XML character escapes are to be used instead. Characters not to be used: Use the following character escapes instead: & & < < > > " " ' &#39; 3. Save the changes to the properties file. 4. Deploy Workplace or Workplace XT again on your Application Server. What to do next: 6.3.3, Setting up My Workplace, on page 86 Chapter 6. Configuring P8 Client 85

100 6.3.3 Setting up My Workplace You must set display preferences and specify the Collector Server with which Workplace or Workplace XT is to communicate. Before you begin: 6.3.2, Defining the connection to Collector Server, on page 85 Procedure: 1. Depending on whether you have Workplace or Workplace XT, start as follows: v In Workplace, click the Admin tab. On the Admin page, click Site Preferences. v In Workplace XT, click Tools > Administration. 2. In the navigation pane of the Site Preferences page of Workplace or Workplace XT, expand My Workplace > Pages. Under My Workplace, the page that you previously added is shown. 3. Under the name of the new page, click Preview and setup. 4. In the window that opens, click the Always trust content from this publisher check box and then click Run to permanently accept the security certificate for the signed applet. The procedure depends on whether you work with Workplace or Workplace XT. 5. Click the Edit icon to the right of the page to change the current settings of the portlet. 6. In the Maximum Rows field, type a number to specify how many documents and folders are to be displayed in the portlet at a time. 7. From the SAP System list, select a connection to a Collector Server. The connection is defined in the ACSystemSelection.properties file. By using this connection, the portlet retrieves the server configuration profile to determine the archive from which documents are linked and to determine the SAP system to which the documents are to be linked. Your selection is stored permanently. If you change the web address of the connection in the ACSystemSelection.properties file, the selected entry disappears from the SAP System list and you must select another connection. 8. Click Apply to save your changes. What to do next: 6.3.4, Associating the Queue portlet with a P8 queue Associating the Queue portlet with a P8 queue You must select the P8 queue that contains the work items that are to be linked. Before you begin: 6.3.3, Setting up My Workplace If a P8 queue, the workflow that makes the documents available in the P8 queues, or both, do not exist yet, you can adapt the sample workflow definition that is supplied with Content Collector for SAP, to your needs. The sample workflow definition is designed for processing bar codes. It is available in the file WorkflowGeneration.pep, which you find in InstallHome. For details, see , Creating P8 queues and workflows, on page 158. Procedure: 1. On the Preview and Setup page for the Queue portlet, click the Edit icon to the right of the page to change the current settings of the portlet. 2. Click Public Inbox to select a P8 queue. 86 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

101 3. Under Inboxes, click one of the displayed P8 queues. Under Public Inboxes, Select queue is displayed, where queue stands for the name of the selected P8 queue. In addition, all work items in the selected P8 queue are listed. 4. Under Public Inboxes, click Select queue. The Public Inbox field shows the selected P8 queue. 5. Click Apply to save your changes and to view all documents in the selected workflow. 6. Click Close to return to the My Workplace view. What to do next: If you are configuring your environment for linking FileNet P8 objects by using P8 Client, continue with Chapter 7, Configuring P8 Client SAP Connector, on page 89. Chapter 6. Configuring P8 Client 87

102 88 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

103 Chapter 7. Configuring P8 Client SAP Connector Configure P8 Client SAP Connector on SAP if you want to use P8 Client to link archived documents and other archived objects to SAP. P8 Client SAP Connector is used for receiving OLE requests from the SAP GUI and sending them to P8 Client. Before you begin: 1. Install P8 Client SAP Connector from the client package. For more information, see the topic Installing the client package in console mode or GUI mode in the Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 2, Preparing your environment, on page Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page , Configuring Collector Server for use with FileNet P8, on page If you did not configure an HTTP connection or a Remote Function Call (RFC) connection because you do not need such a connection, create an SAP ArchiveLink protocol and a content repository or logical archive in SAP: a , Creating an SAP ArchiveLink protocol for use by the HTTP connection, on page 37 b , Creating a content repository for the HTTP connection, on page , Starting Collector Server for the first time, on page 50. Procedure: , Registering P8 Client SAP Connector with SAP , Creating an SAP ArchiveLink application for linking FileNet P8 objects, on page , Adapting the SAP ArchiveLink protocol for linking FileNet P8 objects, on page Registering P8 Client SAP Connector with SAP Register P8 Client SAP Connector with SAP to establish a connection between the SAP GUI and P8 Client. Procedure: 1. In the SAP GUI, enter the transaction code SOLE to open the Display View Maintenance view for OLE applications : Overview window. 2. Click the Display > Change icon. If a window opens with the message Caution: The table is cross-client., press Enter. 3. Click New Entries. 4. In the New Entries: Details of Added Entries window, specify the following information: Copyright IBM Corp. 2010,

104 Field name Description Example OLE application Version number CLSID OLE object name Type Info key Type a name of your choice. You must specify this name again when you configure an SAP ArchiveLink application for use with P8 Client SAP Connector. Type the version of the OLE application. Type: ACCeDesktop.Bean Note: Type the ID in mixed case, as shown. Type: ACCEDESKTOP.BEAN Type: NO_TYPELIB Type: ICCSAP_CE Type: 2.2 Leave all other fields blank. Figure 44 shows what the New Entries: Details of Added Entries window might look like. Figure 44. New Entries: Details of Added Entries window containing the necessary settings 5. Click the Save icon to save your settings. What to do next: 7.2, Creating an SAP ArchiveLink application for linking FileNet P8 objects, on page Content Collector for SAP: Configuring for use with FileNet P8: Best practices

105 7.2 Creating an SAP ArchiveLink application for linking FileNet P8 objects Create an SAP ArchiveLink application and configure it for use with P8 Client SAP Connector. Before you begin: 7.1, Registering P8 Client SAP Connector with SAP, on page 89 Procedure: 1. In the SAP GUI, enter the transaction code OAA4 to open the ArchiveLink: Application Maintenance window. 2. Click the Create icon. 3. In the ArchiveLink: Application Maintenance window, type a name of your choice for the SAP ArchiveLink application. For example, type: P8LINK Figure 45 shows what the ArchiveLink: Application Maintenance window might look like. Figure 45. ArchiveLink: Application Maintenance window containing the sample application name 4. Press Enter. You are returned to the ArchiveLink: Application Maintenance window. 5. Double-click the SAP ArchiveLink application that you created. For example, double-click P8LINK. 6. On the Windows SAPGUI OLE automation page, double-click Archive from Frontend. 7. In the window that opens, specify the following information: a. In the Application field, type the OLE application name that you specified when you registered P8 Client SAP Connector with SAP. For example, type: ICCSAP_CE b. Click a radio button and type a command as shown in the following table. Start your specification in the first line. Chapter 7. Configuring P8 Client SAP Connector 91

106 Radio button M G G @EID=LastError Type the commands exactly as they are shown in the table. Do not add any spaces. Several values are separated by a comma only. Do not add a space after a comma. sap_system stands for the value of the R3NAME keyword as specified in the server configuration profile. For example: KD7 Figure 46 shows what the SAP window might look like after you completed step 7 on page 91. Figure 46. Information to be specified for the SAP ArchiveLink application for linking FileNet P8 objects The following table shows the specifications for additional SAP functions. SAP function Radio button Command Display stored M document Display stored document Retrieval for M frontend Retrieval for frontend Display local file M 92 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

107 SAP function Radio button Command Display local file Store file from M frontend Store file from frontend Store file from frontend 8. Click Back. 9. Click the Save icon to save your settings. The status next to Archive from Frontend changes to Maintained. Figure 47 shows what the Windows SAPGUI OLE automation page might look like. Figure 47. Windows SAPGUI OLE automation page showing status Maintained for Archive from Frontend What to do next: 7.3, Adapting the SAP ArchiveLink protocol for linking FileNet P8 objects 7.3 Adapting the SAP ArchiveLink protocol for linking FileNet P8 objects You must adapt the SAP ArchiveLink protocol for use with P8 Client SAP Connector. This topic shows how to adapt the example protocol HTTP1. Before you begin: 7.2, Creating an SAP ArchiveLink application for linking FileNet P8 objects, on page 91 Procedure: Chapter 7. Configuring P8 Client SAP Connector 93

108 1. In the SAP GUI, enter the transaction code OAA3 to open the ArchiveLink: Communications Interface Administration window. 2. Double-click the SAP ArchiveLink protocol. For example, double-click HTTP1. 3. In the ArchiveLink Protocols: Overview of Protocol window, double-click Archive from frontend. Figure 48 shows which item to double-click in the ArchiveLink Protocols: Overview of Protocol window. Figure 48. ArchiveLink Protocols: Overview of Protocol window showing which item to double-click 4. Under Document classes, click the radio button next to a SAP document class, and click the Change icon. The document class must represent the MIME type of the documents that you want to link. Note: If the necessary document class is not displayed in the window, click the Next page icon until you see the document class that you want to use. For example, click the Next page icon until you see TIF, and click TIF. Figure 49 on page 95 shows which radio button and icon to click in the ArchiveLink Protocols: Overview of Protocol window. 94 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

109 Figure 49. ArchiveLink Protocols: Overview of Protocol window showing which radio button and which icon to click 5. In the Communication Type field of the small window that opens, specify OPEN. Then click the Continue icon. Figure 50 shows what the ArchiveLink Protocols: Overview of Protocol window might look like after you specify the communication type. Figure 50. ArchiveLink Protocols: Overview of Protocol window showing the necessary communication type 6. In the Application field, specify the name of the SAP ArchiveLink application that you previously created. For example, select P8LINK. Figure 51 on page 96 shows what the ArchiveLink Protocols: Overview of Protocol window might look like after you specify the sample application. Chapter 7. Configuring P8 Client SAP Connector 95

110 Figure 51. ArchiveLink Protocols: Overview of Protocol window showing the sample SAP ArchiveLink application P8LINK 7. Repeat Steps 4 on page 94 through 6 on page 95 for each SAP document class to which FileNet P8 objects are to be linked. 8. Click the Continue icon to confirm your specifications and to close the window. 9. Click the Save icon to save your settings. What to do next: If you are configuring your environment for linking FileNet P8 objects by using P8 Client, continue with , Enabling Collector Server to use P8 Client, on page Content Collector for SAP: Configuring for use with FileNet P8: Best practices

111 Chapter 8. Configuring Utility Client Configure Utility Client if you want to transfer index information to the archived documents. You can then search for the archived documents. In addition, configure Utility Client if you want to link the archived documents to SAP. Before you begin: 1. Plan for secure connections to Utility Client. For more information, see the corresponding topic in the Planning part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Install Utility Client from the server package or the client package. For more information, see the topic Installing the server package in console mode or GUI mode or Installing the client package in console mode or GUI mode in the Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page 25. For both the index transfer and the document-linking process, you must create objects that contain the information that Utility Client needs about your environment, such as information about the archive, about Collector Server, and about SAP. To create the individual objects, start Utility Client: v Linux UNIX Open a command line and change to the InstallHome/utilityclient directory. Enter the following command: csclientgui.sh v Windows Click All Programs > IBM Content Collector for SAP Applications > Utility Client. The IBM Content Collector for SAP Applications - Utility Client window opens. Figure 52 on page 98 shows what the IBM Content Collector for SAP Applications - Archiving Client window looks like after you start it for the first time. Copyright IBM Corp. 2010,

112 Figure 52. IBM Content Collector for SAP Applications - Utility Client window after the client is started for the first time 8.1 Setting up an index transfer You can transfer index information from the SAP business objects to the archived documents. You can then search for the archived documents. Before you begin: Install the index transfer enablement package for Utility Client Procedure: , Specifying the document classes whose properties are to be mapped to SAP attributes , Defining the connection to the SAP server, on page , Defining the connection to Collector Server, on page , Defining an archive, on page , Mapping the SAP attribute to be transferred to an archive attribute, on page , Creating an index transfer profile, on page , Creating an index transfer session, on page Specifying the document classes whose properties are to be mapped to SAP attributes More than one document class can be defined for an object store. You must specify the document classes that are to receive the index information. Only the custom properties of the specified document classes can then be mapped to the SAP attributes that supply the index information. You specify the document classes in the server configuration profile. 98 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

113 1. Open the server configuration profile of the Collector Server that you want to use, in a text editor. 2. Add the following keyword to the appropriate ARCHIVE sections: REPINFOCLASSES class1,class2,... class1, class2,... stands for the document classes of which the custom properties are to be mapped. Only those custom properties can be mapped that are common to all listed document classes. Note: System properties, such as SAPDocId or SAPCompSize, cannot be mapped. 3. The document classes that are listed for REPINFOCLASSES might not have the same set of properties. If you want to ensure that all properties of all specified document classes can be mapped, add the following keyword: RETURN_ALL_ATTR YES Note: In this case, however, take special care when you set up your index transfer. Assume, for example, that you specify REPINFOCLASSES CLASS1, CLASS2, CLASS3. Also, assume that the listed document classes have the following properties: Document class CLASS1 CLASS2 CLASS3 Properties p1, p2, p3, p4 p2, p4, p5 p1, p2, p5, p7 If you did not specify RETURN_ALL_ATTR or if you specified RETURN_ALL_ATTR NO, only the value of p2 would be available for mapping. If you specified RETURN_ALL_ATTR YES, you would receive an error during the index transfer because the classes do not have the same properties. However, you can set up your index transfer such, for example, that only p2 and p4 of CLASS1 and CLASS2 are mapped. 4. Save the server configuration profile, and restart Collector Server for the changes to take effect. What to do next: 8.1.3, Defining the connection to Collector Server, on page Defining the connection to the SAP server Create an object that defines the connection to the SAP system that you want to use for the index transfer. Before you begin: v Plan for secure connections to Utility Client. For more information, see the corresponding topic in the Planning part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH v 8.1.1, Specifying the document classes whose properties are to be mapped to SAP attributes, on page 98. Procedure: Chapter 8. Configuring Utility Client 99

114 In the IBM Content Collector for SAP Applications - Utility Client window, click Define SAP Server. The New SAP Server wizard opens. Refer to the help pane of the New SAP Server wizard for information about how to define the SAP server. What to do next: 8.1.3, Defining the connection to Collector Server Defining the connection to Collector Server Create an object that defines the connection to the Collector Server that you want to use for the index transfer. Before you begin: 8.1.2, Defining the connection to the SAP server, on page 99 Procedure: In the IBM Content Collector for SAP Applications - Utility Client window, click Define Collector Server. The New Collector Server wizard opens. Refer to the help pane of the New Collector Server wizard for information about how to define Collector Server. What to do next: 8.1.4, Defining an archive Defining an archive Create an object that defines the archive in which the documents are stored. The archive must already be specified in SAP. Before you begin: 8.1.3, Defining the connection to Collector Server Important: During document linking or during the index transfer, only one Utility Client can access an archive at a time. Procedure: In the IBM Content Collector for SAP Applications - Utility Client window, click Select Archive. The New Archive wizard opens. Refer to the help pane of the New Archive wizard for information about how to define the archive. What to do next: 8.1.5, Mapping the SAP attribute to be transferred to an archive attribute Mapping the SAP attribute to be transferred to an archive attribute Create an object that defines the attribute whose value is to be transferred and stored with a document as index information. Before you begin: 8.1.4, Defining an archive Procedure: In the IBM Content Collector for SAP Applications - Utility Client window, click Define Attribute Mapping. The New Attribute Mapping wizard opens. Refer to the help pane of the New Attribute Mapping wizard for information about how to map the attributes. 100 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

115 What to do next: 8.1.6, Creating an index transfer profile Creating an index transfer profile An index transfer profile defines the index information that is to be transferred. You can use an index transfer profile for more than one index transfer. The information that relates to a specific index transfer is specified in an index transfer session. Before you begin: 8.1.5, Mapping the SAP attribute to be transferred to an archive attribute, on page 100 Procedure: In the IBM Content Collector for SAP Applications - Utility Client window under Set up an index transfer, click Define Profile. The New Index Transfer Profile wizard opens. Refer to the help pane of the New Index Transfer Profile wizard for information about how to create the profile. What to do next: 8.1.7, Creating an index transfer session Creating an index transfer session An index transfer session contains the information for a single index transfer. Because this information is subject to change, you normally use a session only once. For repeated use, in particular when you use the command-line interface of Utility Client, create a batch session that specifies that index information is added only to those documents that are archived after the previous session runs. Before you begin: 8.1.6, Creating an index transfer profile Procedure: In the IBM Content Collector for SAP Applications - Utility Client window under Set up an index transfer, click Define Session. The New Session wizard opens. Refer to the help pane of the New Session wizard for information about how to create the session. What to do next: 8.3, Managing the configuration of Utility Client, on page Setting up a document-linking process You can link the archived documents to SAP. Procedure: , Specifying the document classes whose properties are to be mapped to the SAP workflow attributes, on page , Defining the connection to the SAP server, on page , Defining the connection to Collector Server, on page , Defining an archive, on page , Creating a document-linking session, on page 103 Chapter 8. Configuring Utility Client 101

116 8.2.1 Specifying the document classes whose properties are to be mapped to the SAP workflow attributes If you plan to link your documents by creating work items in an SAP workflow, you can add the values of custom properties to the SAP workflow. You must specify the document classes that are to supply the property values. Only the custom properties of the specified document classes can then be mapped to the SAP workflow attributes. You specify the document classes in the server configuration profile. 1. Open the server configuration profile of the Collector Server that you want to use, in a text editor. 2. Add the following keyword to the appropriate ARCHIVE sections: REPINFOCLASSES class1,class2,... class1, class2,... stands for the document classes of which the custom properties are to be mapped. Only those custom properties can be mapped that are common to all listed document classes. Note: System properties, such as SAPDocId or SAPCompSize, cannot be mapped. 3. The document classes that are listed for REPINFOCLASSES might not have the same set of properties. If you want to ensure that all properties of all specified document classes can be mapped, add the following keyword: RETURN_ALL_ATTR YES Assume, for example, that you specify REPINFOCLASSES CLASS1, CLASS2, CLASS3. Also, assume that the listed document classes have the following properties: Document class CLASS1 CLASS2 CLASS3 Properties p1, p2, p3, p4 p2, p4, p5 p1, p2, p5, p7 If you did not specify RETURN_ALL_ATTR or if you specified RETURN_ALL_ATTR NO, only the value of p2 would be available for mapping. If you specified RETURN_ALL_ATTR YES, you would receive an error during the linking because the classes do not have the same properties. However, you can set up your document-linking process such, for example, that only p2 and p4 of CLASS1 and CLASS2 are mapped. 4. Save the server configuration profile, and restart Collector Server for the changes to take effect. What to do next: 8.2.2, Defining the connection to the SAP server Defining the connection to the SAP server Create an object that defines the connection to the SAP system that you want to use for the document-linking process. Before you begin: v Plan for secure connections to Utility Client. For more information, see the corresponding topic in the Planning part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Content Collector for SAP: Configuring for use with FileNet P8: Best practices

117 v 8.2.1, Specifying the document classes whose properties are to be mapped to the SAP workflow attributes, on page 102 Procedure: In the IBM Content Collector for SAP Applications - Utility Client window, click Define SAP Server. The New SAP Server wizard opens. Refer to the help pane of the New SAP Server wizard for information about how to define the SAP server. What to do next: 8.2.3, Defining the connection to Collector Server Defining the connection to Collector Server Create an object that defines the connection to the Collector Server that you want to use for the document-linking process. Before you begin: 8.2.2, Defining the connection to the SAP server, on page 102 Procedure: In the IBM Content Collector for SAP Applications - Utility Client window, click Define Collector Server. The New Collector Server wizard opens. Refer to the help pane of the New Collector Server wizard for information about how to define Collector Server. What to do next: 8.2.4, Defining an archive Defining an archive Create an object that defines the archive in which the documents are stored. The archive must already be specified in SAP. Before you begin: 8.2.3, Defining the connection to Collector Server Important: During document linking or during the index transfer, only one Utility Client can access an archive at a time. Procedure: In the IBM Content Collector for SAP Applications - Utility Client window, click Select Archive. The New Archive wizard opens. Refer to the help pane of the New Archive wizard for information about how to define the archive. What to do next: 8.2.5, Creating a document-linking session Creating a document-linking session A document-linking session contains the information for a single document-linking process. Because this information is subject to change, you normally use a session only once. For repeated use, in particular when you use the command-line interface of Utility Client, create a batch session because it does not store information about a previous document-linking process. Before you begin: 8.2.4, Defining an archive Chapter 8. Configuring Utility Client 103

118 Procedure: In the IBM Content Collector for SAP Applications - Utility Client window under Set up a document-linking process, click Define Session. The New Session wizard opens. Refer to the help pane of the New Session wizard for information about how to create the session. Note: You can link the documents by processing their bar codes or by creating work items in an SAP workflow. If you want to link Content Manager documents that are stored in an item type that cannot be accessed by SAP, select Create bar codes in the New Session wizard. What to do next: 8.3, Managing the configuration of Utility Client 8.3 Managing the configuration of Utility Client You can change the settings for specific objects. You can also create several configurations of Utility Client and save these configurations under different names. v If you configured Utility Client for the first time or without using a previous configuration and you want to save the configuration, complete these steps: 1. Click File > Save. 2. In the window that opens, specify a fully qualified file name without a file extension. The file is saved with the extension cs. v v v v Important: When you defined the connection to the SAP server, you might have decided to save the password of the SAP user in the project file. In this case, ensure that the configuration file is stored in a secure location with restricted access. If you changed the configuration and want to save it under the same name, click File > Save. If you changed the configuration and want to save it under a different name, complete these steps: 1. Click File > Save As. 2. In the window that opens, specify a fully qualified file name without a file extension. The file is saved with the extension cs. To open a saved configuration, complete these steps: 1. Click File > Open. 2. In the window that opens, select the file that contains the configuration that you want to use. To change the properties of an object: 1. In the navigation pane of the IBM Content Collector for SAP Applications - Utility Client window, expand All Objects > object_type > object_name. object_type stands for the type of object, such as SAP Servers or Profiles. object_name stands for the name of the object that you want to change. 2. In the content pane in the middle, clear the Read-only check box. 3. Make your changes. 4. Select the Read-only check box to save your changes. 104 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

119 If the Read-only check box is unavailable, you cannot change the properties. However, you can copy the settings of an existing object by selecting the object in the navigation pane and then clicking Edit > Copy Changing the preferences of Utility Client You can specify which trace files and log files are to be created for Utility Client and when the connection to the servers is to time out. In addition, you can change the visual style and the language of the Utility Client GUI. Procedure: 1. In the IBM Content Collector for SAP Applications - Utility Client window, click File > Preferences. 2. On the Logging/Tracing page, you can make the following specifications: a. In the Log-file path field, specify the directory where the daily log files (file name csyyyymmdd.log) are to be created. For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\UtilityClient\ b. In the Trace-file path field, specify the directory where the daily trace files (file name csyyyymmdd.trace) are to be created. For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\UtilityClient\ c. Under Traces, select Trace off or select the trace and the log that are to be created for Utility Client. For example, click Trace all components. d. In the Maximum number of log entries displayed field, specify the number of log entries that are to be displayed at the bottom of the IBM Content Collector for SAP Applications - Utility Client window. You see the log entries after you click Show Log in that window. For example, type: 50 Figure 53 on page 106 shows what the Logging/Tracing page of the Preferences window might look like after you completed step 2a through step 2d. Chapter 8. Configuring Utility Client 105

120 Figure 53. Logging/Tracing page of the Preferences window containing your specifications 3. On the Connection page, specify the period, in milliseconds, after which Utility Client is to display an error if the connection to a server cannot be established. For example, type: On the Appearance page, select a visual style of the Utility Client GUI from the Look and feel list. For example, select Windows. Note: The visual style of the Utility Client GUI is affected only by this selection. It is independent of the settings for your operating system. 5. On the Languages page, select the language of the Utility Client GUI from the Current language list. The default language is English (United States). For example, leave English. 6. Click OK. 7. Restart Utility Client if you changed the following preferences: v v You changed the visual style of the Utility Client GUI on the Appearance page. You set the language to Hebrew. 106 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

121 Chapter 9. Configuring Viewing Client 9.1 Setting up Viewing Client Configure Viewing Client if you want to view the archived documents with an external viewer application, such as a web browser. Before you begin: 1. Install Viewing Client from the client package.for more information, see the topic Installing the client package in console mode or GUI mode in the Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page Set up secure client connections. For more information, see the corresponding topic in the Security part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH When you start Viewing Client, the IBM Content Collector for SAP Applications - Viewing Client Setup window opens. When you start Viewing Client for the first time, you must change the settings according to your environment and your preferences. Start Viewing Client by clicking Start > All Programs > IBM Content Collector for SAP Applications > Viewing Client. The IBM Content Collector for SAP Applications - Viewing Client Setup window opens. Figure 54 on page 108 shows what the Viewing Client Setup window might look like after you completed the topics 9.1.1, Defining the connection to Collector Server, on page 108 through 9.1.4, Enabling logging and tracing for Viewing Client, on page 111. Copyright IBM Corp. 2010,

122 Figure 54. Viewing Client Setup window containing sample specifications Procedure: , Defining the connection to Collector Server , Specifying the directory for temporary files, on page , Specifying a viewer application, on page , Enabling the closing of applications, on page Optional: 9.1.4, Enabling logging and tracing for Viewing Client, on page , Completing the setup of Viewing Client, on page Defining the connection to Collector Server You must connect Viewing Client to the Collector Server that has access to the archived documents that you want to view. Under Server Connection in the IBM Content Collector for SAP Applications - Viewing Client Setup window, specify the following information: 1. In the Archive Host/IP address field, type the host name or the IP address of the Collector Server. If Collector Server and Viewing Client are not installed on the same computer and you want to specify the host name, use the fully qualified host name, such as myhost.yourserver.com. The default value is for Internet Protocol version 4 (IPv4) and ::1 for Internet Protocol version 6 (IPv6), which designates the local host. 108 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

123 For example, leave the default value for the local host. 2. In the Port field, type the TCP/IP registration port that is used by all Content Collector for SAP clients to connect to Collector Server. Use the port number that you specified for the ARCHPRO_PORT keyword in the server configuration profile. For example, type: Click Test to check whether a connection between Viewing Client and the specified Collector Server could be established. The test result is displayed to the right of the button. If an error occurs, an error description is displayed in a separate window. If Viewing Client can connect to the specified Collector Server, the connection status is set to OK and a green circle is shown. If a connection cannot be established, the connection status is set to FAILED and a red cross is shown. Figure 55 shows what the Preferred Server Connection area of the Setup window might look like after you completed step 1 on page 108 through step 3. Figure 55. Server Connection area of the Viewing Client Setup window containing the default IP address and containing the port as specified in the sample configuration profile What to do next: 9.1.2, Specifying the directory for temporary files Specifying the directory for temporary files By default, Viewing Client stores the temporary files in the env_var_appdata\ibm\ ICCSAP\ViewingClient directory of the user who started Viewing Client. You can specify another directory. Before you begin: Plan for secure connections to Archiving Client and Viewing Client. For more information, see the corresponding topic in the Security part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Under Work path in the IBM Content Collector for SAP Applications - Viewing Client Setup window, specify the following information: Specify the full path to the directory where Viewing Client should store its temporary files. For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ViewingClient\ Figure 56 on page 110 shows the Work path area of the Viewing Client Setup window containing the sample path. Chapter 9. Configuring Viewing Client 109

124 Figure 56. Work path area of the Viewing Client Setup window containing the sample path What to do next: 9.1.3, Specifying a viewer application Specifying a viewer application You can view archived documents by using a web browser or another viewer application. You can specify the viewer application of your choice. Before you begin: 4.2.2, Setting up the connection between Collector Server and SAP through HTTP, on page 37. If you use a web browser, you can append notes to the archived documents by using the process note applet or you can attach these documents to an by using the mailing applet. The mailing applet ensures that the notes are included in the attachment. Under Viewing in the IBM Content Collector for SAP Applications - Viewing Client Setup window, specify the following information: v To use a web browser, click Browser viewing, and specify the following details: 1. In the WebPort field, specify the TCP/IP port through which the HTTP dispatcher gets its requests. Use the port that you specified for the WEBPORT keyword in the server configuration profile. For example, type: Select the Enhanced functionality check box if the functions Process note and Send are to be displayed in the browser. With Process note, you can add text notes to an archived document. With Send , you can attach the displayed document, including any notes, to an . For this example, do not select the check box. 3. In the Web viewer field, specify the fully qualified file name of a browser program. For example, select the fully qualified file name of Internet Explorer. v To use another viewer application, select Native viewing, and specify the fully qualified path to a viewer application in the Native viewer field. For example, select the path to Internet Explorer. Figure 57 on page 111 shows what the Viewing area of the Viewing Client Setup window might look like after you completed step 1 through step Content Collector for SAP: Configuring for use with FileNet P8: Best practices

125 Figure 57. Viewing area of the Viewing Client Setup window containing the sample specifications What to do next: 9.1.4, Enabling logging and tracing for Viewing Client Enabling logging and tracing for Viewing Client You can enable Viewing Client to log its activities in log files and trace files. You can enable a general log file, a log file that contains information about the communication between Viewing Client and Collector Server, and a trace for error analysis. In addition, you can specify where the log files and the trace files are to be stored. Note, however, that logging and tracing affects the performance of Content Collector for SAP. If possible, use the path where you store the temporary files as path for all log files and trace files. Under Logging and Tracing in the IBM Content Collector for SAP Applications - Viewing Client Setup window, specify the following information: v To enable general logging, complete these steps: 1. Select the Enable check box next to the Log file field. 2. In the Log file field, specify the fully qualified path to the log file. You can specify a path of your choice. For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ViewingClient\ ICCSAP_VC.log v v To record information about the communication between Viewing Client and Collector Server, complete these steps: 1. Select the Enable check box next to the API trace file field. 2. In the API trace file field, specify the fully qualified path to the trace file. You can specify a path of your choice. For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ViewingClient\ ICCSAP_ClientAPI.trc To collect more details about the activities of Viewing Client, complete these steps: 1. Select the Enable check box next to the Trace file field. Chapter 9. Configuring Viewing Client 111

126 2. In the Trace file field, specify the fully qualified path to the trace file. You can specify a path of your choice. For example, type: C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ViewingClient\ ICCSAP_VC.trc 3. In the Maximum file size field, click the arrows to select the maximum size of the trace file, in KB. You can specify a number up to, and including, KB. If the trace file exceeds the limit, the oldest information is overwritten. For example, type: Select the Clear trace file check box if you want to delete the existing trace file each time you start Viewing Client. Note: If you select the check box, you might lose valuable information for error recovery if the same error recurs. For this example, leave this check box clear. Figure 58 shows the Logging and Tracing area of the Setup window with the entire logging and tracing enabled. Figure 58. Logging and Tracing area of the Viewing Client Setup window containing the sample specifications What to do next: 9.1.5, Enabling the closing of applications Enabling the closing of applications You can enable Viewing Client to respond to doclosewindow requests from SAP. Viewing Client then closes all applications that it started and deletes all temporary files. Under File and Viewer Management in the IBM Content Collector for SAP Applications - Viewing Client Setup window, select the Viewing Client deletes the temporary files and closes all open viewer applications check box. Figure 59 on page 113 shows the File and Viewer Management area of the Viewing Client Setup window containing your selection. 112 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

127 Figure 59. File and Viewer Management area of the Viewing Client Setup window containing your selection What to do next: 9.1.6, Completing the setup of Viewing Client Completing the setup of Viewing Client Click OK to validate your configuration. If your settings are correct, the configuration is saved in the client configuration profile. What to do next: 9.2, Enabling Collector Server to use Viewing Client 9.2 Enabling Collector Server to use Viewing Client You must enable Collector Server to start at least one client dispatcher. Procedure: 1. Open the server configuration profile of the Collector Server that you want to use, in a text editor. 2. Set the ARCHWINS keyword to a value greater than Save the server configuration profile, and restart Collector Server for the changes to take effect. What to do next: If you are configuring your environment for viewing archived documents, continue with , Registering Viewing Client with SAP, on page 171. Chapter 9. Configuring Viewing Client 113

128 114 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

129 Chapter 10. Configuring your environment for basic tasks Archiving and viewing data and print lists and archiving, linking, and viewing documents are the basic tasks that you probably perform most frequently. As a basic environment, you need the SAP GUI, Collector Server, and one or more archives. For some tasks, you need an additional Content Collector for SAP component. The following sections explain how to configure your environment for the basic tasks and which additional components you need. This information does not cover the tasks that you configure in SAP only. It covers only those tasks where the configuration of one or more components of Content Collector for SAP is required Configuring for archiving data Content Collector for SAP supports various data archiving solutions. For example, it supports the archiving of data on different media, such as hard disks, tapes, or WORMs. In addition, it supports automatic moving of data from one medium to another. To archive data, you need the basic environment. Before you begin: 1. Chapter 2, Preparing your environment, on page Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page , Configuring Collector Server for use with FileNet P8, on page , Configuring the connection between Collector Server and SAP, on page 35. Configure either an HTTP connection or a Remote Function Call (RFC) connection , Starting Collector Server for the first time, on page 50. Figure 60 on page 116 shows which parts of the Content Collector for SAP environment must be configured so that you can archive data. Copyright IBM Corp. 2010,

130 SAP GUI 4 SAP ERP P8 agent P8 Content Engine Image Services ArchiveLink 1 RFC dispatcher Engine 3 HTTP dispatcher Collector Server instance 1 = RFC communication = SAP = archives = Content Collector for SAP = connection information 3 = HTTP communication Figure 60. Configuration of your Content Collector for SAP environment for archiving data = FileNet Content Federation Services for Images Services (CFS-IS) By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v The archives where the data is to be stored v Collector Server v An HTTP connection or an RFC connection between Collector Server and SAP The remaining tasks that are necessary to configure your environment for archiving data are explained by using the sample archive object FI_BANKS, which refers to bank master data. Bank master data is usually not archived. Therefore, you can use the sample archive object in an SAP production system. Procedure: , Setting up the sample archiving object FI_BANKS , Configuring the SAP ArchiveLink path, on page , Checking your data archiving configuration, on page , Creating test data for the sample archiving object, on page , Running an archiving session to test your archiving setup, on page Setting up the sample archiving object FI_BANKS Configure SAP for the use of the sample archiving object FI_BANKS. Procedure: 1. In the SAP GUI, enter the transaction code SARA to open the Archive Administration: Initial Screen window. 2. In the Object Name field, specify: FI_BANKS Figure 61 on page 117 shows the Archive Administration: Initial Screen containing the sample archiving object name Content Collector for SAP: Configuring for use with FileNet P8: Best practices

131 Figure 61. Archive Administration: Initial Screen window containing the name of the sample archiving object FI_BANKS 3. Click Customizing to open the Data Archiving Customizing window. 4. Under Archiving Object-Specific Customizing, double-click Technical Settings. Figure 62 shows which item to double-click in the Data Archiving Customizing window. Figure 62. Data Archiving Customizing window showing which item to double-click 5. In the Change View "Customizing View for Archiving": Details window, specify the following settings unless they are already specified: a. Under Delete Jobs, select Start Automatically. b. Under Place File in Storage System: 1) In the Content Repository field, specify the archive where you want to archive the data. Use the logical archive ID that you specified for the ARCHIVE keyword in the server configuration profile. For example, type: A1 2) Select the Start Automatically check box. This setting ensures that, when the archiving session is run, a request is automatically sent to Content Collector for SAP to archive the file that was generated with SAP. 3) Under Sequence, select Store Before Deleting. Chapter 10. Configuring your environment for basic tasks 117

132 Figure 63 shows what the Change View "Customizing View for Archiving": Details window might look like after you completed step 5a on page 117 and step 5b on page 117. Figure 63. Change View "Customizing View for Archiving": Details window containing your settings 6. Click the Save icon to save your settings. 7. In the Prompt for Workbench request window, select a request in the Request field. If a request does not exist yet, click the Create icon to create a request. 8. Click the Continue icon to return to the Change View "Customizing View for Archiving": Details window. What to do next: , Configuring the SAP ArchiveLink path Configuring the SAP ArchiveLink path Complete these steps to configure the SAP ArchiveLink path. Before you begin: , Setting up the sample archiving object FI_BANKS, on page 116 Procedure: 1. In the SAP GUI, enter the transaction code FILE to open the Change View "Logical File Path Definition": Overview window. If a window opens with the message Caution: The table is cross-client., press Enter. 2. In the table, select ARCHIVE_GLOBAL_PATH by clicking in the first cell of the row that contains this entry. 118 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

133 3. Double-click Assignment of Physical Paths to Logical Path in the Dialog Structure pane on the left. Figure 64 shows which items you must select in the Change View "Logical File Path Definition": Overview window. Figure 64. Change View "Logical File Path Definition": Overview window reflecting your selections in Step 2 and Step 3 The Change View "Assignment of Physical Paths to Logical Path": Overview window opens. 4. In the Syntax grp column of the table, double-click the entry for your operating system. For example, double-click UNIX. Figure 65 on page 120 shows what your selection might look like. Chapter 10. Configuring your environment for basic tasks 119

134 Figure 65. Change View "Assignment of Physical Paths to Logical Path": Overview window containing your sample selection UNIX 5. As Physical path, specify the full path to the exchange directory where your SAP applications must store the files that are to be archived by Content Collector for SAP. Use the path that you specified for the BASEPATH keyword in the server configuration profile. For example, type: /home/sap/transfer/base/ Figure 66 shows what your specification might look like. Figure 66. Change View "Assignment of Physical Paths to Logical Path": Overview window containing the sample physical path 6. In the Dialog Structure pane on the left, double-click Logical File Name Definition, Cross-Client. 120 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

135 7. In the Change View "Logical File Name Definition, Cross-Client": Overview window, double-click ARCHIVE_DATA_FILE_WITH_ARCHIVE_LINK. Figure 67 shows which item you must double-click. Figure 67. Change View "Logical File Name Definition, Cross-Client": Overview window showing which item to double-click 8. Check whether the Logical path field shows ARCHIVE_GLOBAL_PATH. Correct the path, if necessary. Figure 68 shows which field you must check. Figure 68. Change View "Logical File Name Definition, Cross-Client": Details window showing which field to check 9. Click the Save icon to save your settings. Then click the Back icon. 10. In the Change View "Logical File Name Definition, Cross-Client": Overview window, double-click the ARCHIVE_DATA_FILE table entry. See Figure 67, which also lists the ARCHIVE_DATA_FILE table entry. Chapter 10. Configuring your environment for basic tasks 121

136 11. Check whether the Logical path field shows ARCHIVE_GLOBAL_PATH. Correct the path, if necessary. Figure 69 shows which field you must check. Figure 69. Change View "Logical File Name Definition, Cross-Client": Details window showing which field to check 12. Click the Save icon to save your settings. What to do next: , Checking your data archiving configuration Checking your data archiving configuration Check the configuration for your sample archiving object FI_BANKS. Before you begin: , Configuring the SAP ArchiveLink path, on page 118 Procedure: 1. In the SAP GUI, enter the transaction code SARA to open the Archive Administration: Initial Screen window. 2. In the Object Name field, specify: FI_BANKS Figure 61 on page 117 shows the Archive Administration: Initial Screen containing the sample archiving object name. 3. Click Customizing to open the Data Archiving Customizing window. 4. Under Archiving Object-Specific Customizing, double-click Technical Settings. Figure 62 on page 117 shows which item to click in the Data Archiving Customizing window. 5. In the Change View "Customizing View for Archiving": Details window, check the following settings: a. Make sure that the Logical File Name field contains either of the following values: v ARCHIVE_DATA_FILE v ARCHIVE_DATA_FILE_WITH_ARCHIVE_LINK b. Under Settings for Delete Program, check whether the Test Mode Variant contains a test variant, for example: SAP&TEST 122 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

137 c. Check whether the Production Mode Variant field contains a production variant, for example: SAP&PROD d. Under Delete Jobs, check whether Start Automatically is selected. e. Under Place File in Storage System, check whether the correct archive is specified in the Content Repository field. For example, check if A1 is specified. f. Check whether the Start Automatically check box is selected. This setting ensures that, when the archiving session is run, a request is automatically sent to Content Collector for SAP to archive the file that was generated with SAP. g. Under Sequence, check whether Store Before Deleting is selected. Figure 70 shows what the Change View "Customizing View for Archiving": Details window might look like with the information that you checked in step 5a on page 122 through step 5g. Figure 70. Change View "Customizing View for Archiving": Details window containing the necessary settings 6. Click the Save icon to save your settings. 7. In the Prompt for Workbench request window, select a request in the Request field. If a request does not exist yet, click the Create icon to create a request. Chapter 10. Configuring your environment for basic tasks 123

138 8. Click the Continue icon to return to the Change View "Customizing View for Archiving": Details window. Your settings are saved. What to do next: , Creating test data for the sample archiving object Creating test data for the sample archiving object Complete these steps to create test data for the sample archiving object FI_BANKS. Before you begin: , Checking your data archiving configuration, on page 122 Procedure: 1. In the SAP GUI, enter the transaction code FI01 to open the Create Bank: Initial Screen window. 2. In the Bank Country field, type: AD 3. In the Bank Key field, type: Figure 71 shows what the Create Bank: Initial Screen window might look like after you completed step 2 and step 3. Figure 71. Create Bank: Initial Screen window containing your specifications 4. Press Enter. 5. In the Create Bank: Detail Screen window, type Archiving test in the Bank name field. Figure 72 on page 125 shows the Create Bank: Detail Screen window containing the bank name. 124 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

139 Figure 72. Create Bank: Detail Screen window containing the bank name 6. Click the Save icon to save your settings. What to do next: , Running an archiving session to test your archiving setup Running an archiving session to test your archiving setup Test your setup by archiving the test data for archiving object FI_BANKS. Before you begin: , Creating test data for the sample archiving object, on page 124 Procedure: 1. In the SAP GUI, enter the transaction code SARA to open the Archive Administration: Initial Screen window. 2. In the Object Name field, specify: FI_BANKS 3. Optional: If necessary, click Customizing to check and correct your configuration settings. 4. Click Write. 5. In the Archive Administration: Create Archive Files window, specify a variant in the Variant field For example, type: test_variant Figure 73 on page 126 shows the Archive Administration: Create Archive Files window containing the sample variant test_variant. Chapter 10. Configuring your environment for basic tasks 125

140 Figure 73. Archive Administration: Create Archive Files window containing the sample variant test_variant 6. Click Maintain. 7. In the Variants: Change Screen Assignment window, select For All Selection Screens and then click the icon. 8. Click Maintain again. 9. In the Maintain Variant window, specify the following information: a. Under Bank Master Data, type AD in the Bank Country field. b. Under Restrictions, clear the Only With Deletion Indicator check box. c. In the Min.No.of Days in the System field, type: 0 d. Under Processing Options, click Production Mode. e. From the Detail Log list, select Complete. f. From the Log Output list, select List. g. In the Archiving Session Note field, type a description. For example, type: Content Collector for SAP Test Figure 74 on page 127 shows what the Maintain Variant window might look like after you completed step Content Collector for SAP: Configuring for use with FileNet P8: Best practices

141 Figure 74. Maintain Variant window containing the necessary settings 10. Click the Save icon to save your settings. 11. Click the Back icon. 12. To specify when the archiving session is to run, take these steps: a. In the Archive Administration: Create Archive Files window, click Start Date. b. In the Start Time window, click Immediate. c. Click the Save icon at the bottom of the window. Figure 75 on page 128 shows which button to click in the Start Time window. Chapter 10. Configuring your environment for basic tasks 127

142 Figure 75. Start Time window showing which button to click 13. To specify the output device, take these steps: a. In the Archive Administration: Create Archive Files window, click Spool Params. b. In the Background Print Parameters window, specify a suitable printer in the Output Device field. For example, type: LP01 c. Click the Continue icon. Figure 76 shows the Background Print Parameters window containing the sample printer. Figure 76. Background Print Parameters window containing the sample printer LP Content Collector for SAP: Configuring for use with FileNet P8: Best practices

143 14. In the Archive Administration: Create Archive Files window, click the Execute icon to run the archiving session. 15. Click the Job Overview icon. In the Job Overview window, you see the different jobs that are started for this archiving session, where no stands for the number that is assigned to the job. ARV_FI_BANKS_SUBno ARV_FI_BANKS_WRIno ARV_FI_BANKS_DELno ARV_FI_BANKS_STOno submit write delete store After the STO job finishes and if the Start Automatically check box is selected in the Change View "Customizing View for Archiving": Details window under Place File in Storage System, a request is automatically sent to Content Collector for SAP to archive the file that was generated with SAP. See Figure 70 on page Configuring for archiving incoming documents You can archive documents by creating work items in an SAP workflow, by processing their bar codes, or by using simultaneous archiving. For information about how to configure SAP for simultaneous archiving, see the SAP documentation. To archive documents by creating work items in an SAP workflow or by processing their bar codes, you need Archiving Client in addition to your basic environment Configuring for archiving incoming documents by creating work items in an SAP workflow The archiving process can be started from the SAP GUI, which uses Object Linking and Embedding (OLE) for this purpose, or from Archiving Client. The documents must be available in the file system. Before you begin: 1. Install Archiving Client from the client package.for more information, see the topic Installing the client package in console mode or GUI mode in the Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Install Archiving Client and the scanning application on the same computer as the SAP GUI. 2. Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page , Configuring Collector Server for use with FileNet P8, on page , Setting the number of Java RFC dispatchers, on page If you want to start the archiving process from the SAP GUI and if you did not configure an HTTP connection or a Remote Function Call (RFC) connection because you do not need such a connection, create an SAP ArchiveLink protocol and a content repository or logical archive in SAP: a , Creating an SAP ArchiveLink protocol for use by the HTTP connection, on page 37. b , Creating a content repository for the HTTP connection, on page 39. Chapter 10. Configuring your environment for basic tasks 129

144 6. 4.3, Starting Collector Server for the first time, on page 50. Figure 77 shows which parts of the Content Collector for SAP environment must be configured so that you can archive documents by creating work items in the SAP workflow. The SAP GUI is needed only if you want to start the archiving process from there. OLE communication Content Collector for SAP clients Archiving Client SAP GUI csclient.dll SAP ERP Client dispatcher P8 agent P8 Content Engine 4 Image Services ArchiveLink 2 SAP JCo 3 Java RFC dispatcher Engine Collector Server instance = SAP = archives = Content Collector for SAP = connection information By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v The archives where the documents are to be stored v Collector Server v v 2 = create work item 4 = FileNet Content Federation Services for Images Services (CFS-IS) Figure 77. Configuration of your Content Collector for SAP environment for archiving incoming documents by creating work items in an SAP workflow At least one Java RFC dispatcher for the communication between Collector Server and SAP To start the archiving process from the SAP GUI, an HTTP connection, a Remote Function Call (RFC) connection, or an SAP ArchiveLink protocol and a content repository or logical archive in SAP Take these steps to complete the configuration of your environment for archiving your documents by creating work items in an SAP workflow: 1. Configure Archiving Client: a. 5.1, Setting up Archiving Client, on page 54 b , Creating queues if the scanned documents are in the file system, on page 60 or , Creating queues if the scanned documents are in the file system and a description file exists, on page Content Collector for SAP: Configuring for use with FileNet P8: Best practices

145 c , Saving and reusing the queue information, on page 73 d. 5.3, Enabling Collector Server to use Archiving Client, on page , Associating the document type of the incoming documents with an SAP workflow , Registering Archiving Client with SAP, on page If you want to start the archiving process from the SAP GUI, complete the following additional steps: a , Creating an SAP ArchiveLink application for archiving documents, on page 141 b , Adapting the SAP ArchiveLink protocol for archiving documents, on page Associating the document type of the incoming documents with an SAP workflow Only those documents are linked to SAP business objects that can be associated with a specific SAP workflow. You associate the documents with a specific SAP workflow by specifying their document type in the queue from which the documents are collected and by enabling this document type for the SAP workflow. Before you begin: Chapter 5, Configuring Archiving Client, on page 53 You added the document type to the queue when you created the queue in Archiving Client. You enable the document type for an SAP workflow by taking these steps: Procedure: 1. In the SAP GUI, enter the transaction code OAD5 to open the ArchiveLink: Document Type Customizing Wizard. Figure 78 on page 132 shows what the Start page of the ArchiveLink: Document Type Customizing Wizard might look like. Chapter 10. Configuring your environment for basic tasks 131

146 Figure 78. Start page of the ArchiveLink: Document Type Customizing Wizard 2. Click Continue. 3. On the Document type page, specify the following information: a. In the Doc.type field, type the document type that you specified for the queue when you created the queue in Archiving Client. To look up the document type, take these steps: 1) Start Archiving Client. 2) In the navigation pane of the IBM Content Collector for SAP Applications - Archiving Client window, select the appropriate queue, and click Queue > Properties. 3) In the Properties of queue window, click the Queue tab. The Document type field contains the information that you need. For example, type: FIIINVOICE b. In the Name field, specify a description. For example, type: Incoming invoice w/o verification Figure 79 on page 133 shows what the Document type page of the ArchiveLink: Document Type Customizing Wizard might look like with the sample entries. 132 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

147 Figure 79. Document type page of the ArchiveLink: Document Type Customizing Wizard containing the sample document type and the sample description c. Click Continue. 4. On the Document type template page, proceed as follows: v If you want to use an existing document type as a template, specify this document type in the Doc.type field. Then, click Continue. v If you do not want to use a template, click Continue. For this example, do not specify a template. Figure 80 on page 134 shows what the Document type template page of the ArchiveLink: Document Type Customizing Wizard might look like. Chapter 10. Configuring your environment for basic tasks 133

148 Figure 80. Document type template page of the ArchiveLink: Document Type Customizing Wizard containing no template 5. On the Workflow document type page, select the Workflow document type check box so that the SAP workflow can use the document type. Then, click Continue. Figure 81 shows what the Workflow document type page of the ArchiveLink: Document Type Customizing Wizard might look like. Figure 81. Workflow document type page of the ArchiveLink: Document Type Customizing Wizard with selected item 134 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

149 6. On the Document class page, specify the document class in the Doc. class field, and click Continue. Use the document class that you specified when you created the queue in Archiving Client. Check the Document Format field on the Queue page of the Properties of queue window for the value. For information about how to open this window, see 3a on page 132. For example, type: FAX 7. On the Object, method and tasks page, associate the document type with an SAP business object type and assign a method and a workflow task to the document type. Then, click Continue. You can use the standard tasks or the workflow templates. The default values for documents of document type FIIINVOICE are as follows: Property Object type Method Task (for entry) Task (for assignment) Value BKPF CREATE TS TS For more details, see the SAP documentation. Figure 82 shows what the Object, method and tasks page of the ArchiveLink: Document Type Customizing Wizard might look like with the default values for documents. Figure 82. Object, method and tasks page of the ArchiveLink: Document Type Customizing Wizard containing the default settings for documents of document type FIIINVOICE 8. On the Workflow parameter page, you have the following options: v If you specified an existing document type as a template, leave the offered transaction code as it is and click Continue. v If you did not specify a template, specify a transaction code. For example, specify FB10 for a financial booking. Then, click Continue. Chapter 10. Configuring your environment for basic tasks 135

150 Figure 83 shows what the Workflow parameter page of the ArchiveLink: Document Type Customizing Wizard might look like with the sample transaction code. Figure 83. Workflow parameter page of the ArchiveLink: Document Type Customizing Wizard containing the sample transaction code FB10 9. On the Storage system and link table page, specify the following information: a. In the Cont.Rep.ID field, specify the ID of the repository that contains the documents to be archived. Use the ID that you specified for the ARCHIVE keyword in the server configuration profile of Collector Server. For example, type: A2 b. In the Link field, specify a link table. For example, select TOA01. Figure 84 on page 137 shows what the Storage system and link table page of the ArchiveLink: Document Type Customizing Wizard might look like with the sample values. 136 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

151 Figure 84. Storage system and link table page of the ArchiveLink: Document Type Customizing Wizard containing the sample content repository A1 and the sample link table TOA01 c. Click Continue. 10. On the Selection from available presettings page, you have the following options: v If you want to add the document type to one or more existing presettings, click the button in front of available presettings, and click Continue. v If you want to create a presetting only, click Continue. For this example, do not select a presetting. Figure 85 on page 138 shows what the Selection from available presettings page of the ArchiveLink: Document Type Customizing Wizard might look like. Chapter 10. Configuring your environment for basic tasks 137

152 Figure 85. Selection from available presettings page of the ArchiveLink: Document Type Customizing Wizard without the selection of a presetting 11. On the Create new presettings page, you have the following options: v If you want to create a presetting, specify a 4-digit ID and a name for the presetting. Then, click Continue. v If you do not want to create a presetting, click Continue. To create a sample presetting, type A101 in the first line of the ID column and type Financial booking for A1 in the first line of the Name column. Figure 86 on page 139 shows what the Create new presettings page of the ArchiveLink: Document Type Customizing Wizard might look like with a sample presetting. 138 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

153 Figure 86. Create new presettings page of the ArchiveLink: Document Type Customizing Wizard containing a sample presetting 12. In the Details of presettings page, take these steps: a. Go to the existing presetting that you selected or go to the new presetting by clicking the Next default setting icon. b. In the Obj. Type column, type US for User. c. In the ID column, type the name of the user who owns the Inbox where the work item is to be placed. For example, type: DEMO_US d. Select one or more of the available check boxes. For example, select: v Storing for subsequent entry v Store and enter v Assign then store Figure 87 on page 140 shows the Details of presettings page of the ArchiveLink: Document Type Customizing Wizard containing the necessary settings. Chapter 10. Configuring your environment for basic tasks 139

154 Figure 87. Details of presettings page of the ArchiveLink: Document Type Customizing Wizard containing the necessary settings e. Click Continue. 13. Click Complete. 14. In the Prompt for Workbench request window, select a request in the Request field. If a request does not exist yet, click the Create icon to create a request. 15. Click the Continue icon. What to do next: , Registering Archiving Client with SAP Registering Archiving Client with SAP You enable the SAP GUI to start Archiving Client by registering an Object Linking and Embedding (OLE) application with Archiving Client. Before you begin: , Associating the document type of the incoming documents with an SAP workflow, on page 131 Procedure: 1. In the SAP GUI, enter the transaction code SOLE to open the Display View Maintenance view for OLE applications : Overview window. 2. Click the Display > Change icon. If a window opens with the message Caution: The table is cross-client., press Enter. 3. Click New Entries. 4. In the New Entries: Details of Added Entries window, specify the following information: 140 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

155 Field name OLE application Description Type: CSCLIENT.DOCUMENT You must specify this name again when you configure an SAP ArchiveLink application for use with Archiving Client. CLSID Type Info key Type: {C8452EF3-19FE-11D1-A16E-0004AC62FCBA} Type: NO_TYPELIB Leave all other fields blank. Figure 88 shows the New Entries: Details of Added Entries window containing the necessary settings. Figure 88. New Entries: Details of Added Entries window containing the necessary settings 5. Click the Save icon to save your settings. What to do next: If the archiving process is to be started from the SAP GUI, continue with , Creating an SAP ArchiveLink application for archiving documents Creating an SAP ArchiveLink application for archiving documents If the archiving process is to be started from the SAP GUI, you must create an SAP ArchiveLink application and configure it for use with Archiving Client. This topic shows how to create the sample SAP ArchiveLink application CSARCH. Before you begin: , Registering Archiving Client with SAP, on page 140 Procedure: 1. In the SAP GUI, enter the transaction code OAA4 to open the ArchiveLink: Application Maintenance window. 2. Click the Create icon. Chapter 10. Configuring your environment for basic tasks 141

156 3. In the ArchiveLink: Application Maintenance window, type a name of your choice for the SAP ArchiveLink application. For example, type: CSARCH Figure 89 shows the ArchiveLink: Application Maintenance window with the sample application name. Figure 89. ArchiveLink: Application Maintenance window containing the sample application name CSARCH 4. Press Enter. You are returned to the ArchiveLink: Application Maintenance window. 5. Double-click the SAP ArchiveLink application that you created. For example, double-click CSARCH. 6. On the Windows SAPGUI OLE automation page, double-click Archive from Frontend. 7. In the window that opens, specify the following information: a. In the Application field, type the OLE application name that you specified when you registered Archiving Client with SAP. Type: CSCLIENT.DOCUMENT b. Click a radio button and type a command as shown in the following table. Start your specification in the first line. Radio button M Command The specified command is used as a method. M doqueuearchive =@DID The specified command is used to set an attribute in Archiving Client. =EID The specified command is used to get the value of an attribute from Archiving Client. Note: Type the commands exactly as they are shown in the table. 142 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

157 Figure 90 shows what the SAP window might look like after you completed step 7 on page 142. Figure 90. Information to be specified for the SAP ArchiveLink application for archiving documents 8. Click Back. 9. Click the Save icon to save your settings. The status next to Archive from Frontend changes to Maintained. Figure 91 on page 144 shows the Windows SAPGUI OLE automation page with status Maintained for Archive from Frontend. Chapter 10. Configuring your environment for basic tasks 143

158 Figure 91. Windows SAPGUI OLE automation page showing status Maintained for Archive from Frontend What to do next: , Adapting the SAP ArchiveLink protocol for archiving documents Adapting the SAP ArchiveLink protocol for archiving documents You must adapt the SAP ArchiveLink protocol for use with Archiving Client. This topic shows how to adapt the sample protocol HTTP1. Before you begin: , Creating an SAP ArchiveLink application for archiving documents, on page 141 Procedure: 1. In the SAP GUI, enter the transaction code OAA3 to open the ArchiveLink: Communications Interface Administration window. 2. Double-click the SAP ArchiveLink protocol. For example, double-click HTTP1. 3. In the ArchiveLink Protocols: Overview of Protocol window, double-click Archive from frontend. Figure 92 on page 145 shows which item to double-click in the ArchiveLink Protocols: Overview of Protocol window. 144 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

159 Figure 92. ArchiveLink Protocols: Overview of Protocol window showing which item to double-click 4. Under Document classes, click the radio button next to a SAP document class, and click the Change icon. The document class must represent the MIME type of the documents that you want to archive. For example, click FAX. Note: The document classes are sorted alphabetically. The document class that you want to select might be displayed on another page. Click the Next page icon to move to the next page. Figure 93 on page 146 shows which radio button and which icon to click in the ArchiveLink Protocols: Overview of Protocol window. Chapter 10. Configuring your environment for basic tasks 145

160 Figure 93. ArchiveLink Protocols: Overview of Protocol window showing which radio button and which icon to click 5. In the Communication Type field of the small window that opens, specify OPEN and then click the Continue icon. Figure 94 shows the ArchiveLink Protocols: Overview of Protocol window containing the necessary communication type. Figure 94. ArchiveLink Protocols: Overview of Protocol window showing the necessary communication type 6. In the Application field, specify the name of the SAP ArchiveLink application that you previously created. For example, select CSARCH. Figure 95 on page 147 shows the ArchiveLink Protocols: Overview of Protocol window containing the sample application name. 146 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

161 Figure 95. ArchiveLink Protocols: Overview of Protocol window showing the sample SAP ArchiveLink application name CSARCH 7. Click the Continue icon to confirm your specifications and to close the window. 8. Click the Save icon to save your settings Configuring for archiving incoming documents by processing their bar codes To archive incoming documents and link them to SAP business objects by processing the bar codes of the documents, you must complete additional configuration steps on the SAP Application Server. The documents must be available in the file system. Before you begin: 1. Install Archiving Client from the client package. For more information, see the topic Installing the client package in console mode or GUI mode in the Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page , Configuring Collector Server for use with FileNet P8, on page , Starting Collector Server for the first time, on page 50. Figure 96 on page 148 shows which parts of the Content Collector for SAP environment must be configured so that you can archive documents by processing their bar codes. Chapter 10. Configuring your environment for basic tasks 147

162 OLE communication Content Collector for SAP clients Archiving Client SAP GUI csclient.dll SAP ERP send bar code Client dispatcher P8 agent P8 Content Engine 4 Image Services ArchiveLink Engine Collector Server instance = SAP = archives = Content Collector for SAP = connection information 4 = FileNet Content Federation Services for Images Services (CFS-IS) Figure 96. Configuration of your Content Collector for SAP environment for archiving incoming documents by processing their bar codes By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v The archives where the documents are to be stored v Collector Server Collector Server sends the bar code directly to SAP. You do not need an HTTP connection or a Remote Function Call (RFC) connection. Take these steps to complete the configuration of your environment for archiving documents by processing their bar codes: 1. Configure Archiving Client: a. 5.1, Setting up Archiving Client, on page 54 b , Creating queues if the scanned documents are in the file system, on page 60 or , Creating queues if the scanned documents are in the file system and a description file exists, on page 65 c , Saving and reusing the queue information, on page 73 d. 5.3, Enabling Collector Server to use Archiving Client, on page In the SAP GUI, complete the following steps: a. Assign the various types of bar codes that the documents use, to the individual SAP business objects. Use the transaction code OAC5 for this step. b. Check the settings for the specified bar-code types. Use the transaction code OAD4 for this step. c. Enable SAP for archiving documents by processing their bar codes. 148 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

163 For more information about how to complete these steps, refer to the SAP documentation Configuring for archiving outgoing documents To archive outgoing documents, you need the basic environment. Before you begin: 1. Chapter 2, Preparing your environment, on page 5 2. Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page , Configuring Collector Server for use with FileNet P8, on page , Configuring the connection between Collector Server and SAP, on page 35. Tip: Set up an HTTP connection, which supports MIME types. If you use a Remote Function Call (RFC) connection, not all data types are supported , Starting Collector Server for the first time, on page 50 Figure 97 shows which parts of the Content Collector for SAP environment must be configured so that you can archive outgoing documents. SAP GUI SAP ERP P8 agent P8 Content Engine 4 Image Services ArchiveLink 1 RFC dispatcher Engine 3 HTTP dispatcher Collector Server instance 1 = RFC communication = SAP = archives = Content Collector for SAP = connection information 3 = HTTP communication = FileNet Content Federation Services for Images Services (CFS-IS) Figure 97. Configuration of your Content Collector for SAP environment for archiving outgoing documents By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v The archives where the data is to be stored. v Collector Server. v An HTTP connection or an RFC connection between Collector Server and SAP. Your current configuration is sufficient if you want to store all outgoing documents in one document class. 4 Chapter 10. Configuring your environment for basic tasks 149

164 If, however, you want to store your documents in different document classes or organize them in at least one folder, you must complete additional configuration steps. Note: You might want to store documents in folders to find them more easily. Workplace and Workplace XT can list only a limited amount of documents in a folder. So, if you expect large amounts of documents of the same MIME type, do not store them in folders. You can find the documents by using the search function. Assume, for example, that you want to store your documents as follows: v Documents of MIME type image/tiff should be stored in document class TIFF and folder production/tiff. v Documents of MIME type application/pdf should be stored in document class PDF but should not be stored in any folder. v Documents of all other MIME types should be stored in the default document class ALLDOCS and the default folder production/all_docs. Also, assume that you already created the example document classes and folders. Procedure: 1. You created the default document class when you configured FileNet P8 for use with Content Collector for SAP, and you specified this document class in the server configuration profile when you configured Collector Server for FileNet P8. For this example, assume that you specified the default document class, where all documents that are not of MIME type image/tiff or application/pdf are stored, as follows: DEFAULT_P8DOCCLASS ALLDOCS 2. Open the server configuration profile of the Collector Server that you want to use, in a text editor. 3. Add the following keywords to the ARCHIVE section of the appropriate FileNet P8 archive. The values that are shown reflect the example: Keywords to be added DEFAULT_FOLDER /production/all_docs DOCTYPE image/tiff P8DOCCLASS TIFF CUSTOM_FOLDER /production/tiff DOCTYPE application/pdf P8DOCCLASS PDF Explanation Specifies the default folder where all documents are stored that are not of MIME type image/tiff or application/pdf. Groups the configuration for documents of MIME type image/tiff. Specifies the document class where the documents of MIME type image/tiff are stored. Specifies the folder where the documents of MIME type image/tiff are stored. Groups the configuration for documents of MIME type application/pdf. Specifies the document class where the documents of MIME type application/pdf are stored. 150 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

165 Keywords to be added CUSTOM_FOLDER NONE Explanation Specifies that the documents of MIME type application/pdf are not to be stored in any folder. Notes: v For the DOCTYPE keyword, you can specify the MIME type of a document. You cannot specify the MIME type of a document component. For example, the specification of the MIME type application/x-alf-descr, which refers to the description file of a print list, is not allowed. v The document class that you specify for a P8DOCCLASS keyword must have all the properties that are required to archive and update the documents. See Table 3 on page 22. v The folder path must always start with a slash (/). 4. Save the server configuration profile, and restart Collector Server for the changes to take effect Configuring for linking FileNet P8 objects to SAP Documents that were stored in FileNet P8 without Archiving Client are not linked to SAP. To link such documents, you need Utility Client or P8 Client in addition to your basic environment. Use Utility Client if you want to link a large amount of documents, if the bar codes are to be used to create the links, or if you want to schedule linking as a batch job. Utility Client always links the released version of a document. Use P8 Client if you want to link selected documents, if you want to link selected versions of your documents, and if you want to link folders, stored searches, and search templates Configuring for linking archived documents by using Utility Client To link all archived documents that are in the P8 queue, you use the document-linking process of Utility Client. This process links the documents by creating a work item for each document in an SAP workflow or by uploading the bar codes of the documents to the Open Barcode table of SAP. If a work item is created, additional attributes can be transferred as index information. Before you begin: 1. Install Utility Client from the server package or the client package. For more information, see the topic Installing the server package in console mode or GUI mode or Installing the client package in console mode or GUI mode in the Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 2, Preparing your environment, on page Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page , Configuring Collector Server for use with FileNet P8, on page 25. Chapter 10. Configuring your environment for basic tasks 151

166 , Setting the number of Java RFC dispatchers, on page 36 if you want to link the documents by creating work items , Starting Collector Server for the first time, on page 50. Figure 98 shows which parts of the Content Collector for SAP environment must be configured so that you can link the archived documents by creating work items in the SAP workflow. Content Collector for SAP clients Utility Client SAP GUI SAP JCo 3 SAP ERP P8 agent P8 Content Engine 4 Image Services ArchiveLink 2 SAP JCo 3 Java RFC dispatcher Engine Collector Server instance = SAP = archives = Content Collector for SAP = connection information By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v FileNet P8, which contains the documents that are to be linked v Collector Server v 2 = create work item 4 = FileNet Content Federation Services for Images Services (CFS-IS) Figure 98. Configuration of your Content Collector for SAP environment for linking archived documents by creating work items to the SAP workflow At least one Java RFC dispatcher for the communication between Collector Server and SAP ArchiveLink Figure 99 on page 153 shows which parts of the Content Collector for SAP environment must be configured so that you can link the archived documents by processing their bar codes. 152 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

167 Content Collector for SAP clients Utility Client SAP GUI SAP JCo 3 SAP ERP send bar code P8 agent P8 Content Engine 4 Image Services ArchiveLink Engine Collector Server instance = SAP = archives = Content Collector for SAP = connection information 4 = FileNet Content Federation Services for Images Services (CFS-IS) Figure 99. Configuration of your Content Collector for SAP environment for linking archived documents by processing their bar codes By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v FileNet P8, which contains the documents that are to be linked v Collector Server Collector Server sends the bar code directly to SAP. You do not need an HTTP connection or a Remote Function Call (RFC) connection. Take these steps to complete the configuration of your environment for linking FileNet P8 documents by using Utility Client: 1. Configure Utility Client: a. 8.2, Setting up a document-linking process, on page 101 b. 8.3, Managing the configuration of Utility Client, on page , Associating the document type of the archived documents with an SAP workflow , Enabling Collector Server for linking archived documents by using Utility Client, on page , Creating P8 queues and workflows, on page Associating the document type of the archived documents with an SAP workflow Only those documents are linked to SAP business objects that can be associated with a specific workflow. You associate documents with a specific workflow by specifying their document type in a document-linking session and by enabling this document type for an SAP workflow. Chapter 10. Configuring your environment for basic tasks 153

168 Before you begin: Chapter 8, Configuring Utility Client, on page 97 You specified the document type in the document-linking session when you set up a document-linking process in Utility Client. You enable the document type for an SAP workflow by completing the steps that are described in , Associating the document type of the incoming documents with an SAP workflow, on page 131. To look up the information that you specified in the document-linking session, take these steps: 1. Start Utility Client. 2. In the navigation pane of the IBM Content Collector for SAP Applications - Utility Client window, expand Document Linking > Sessions and then click the appropriate document-linking session. The content pane in the middle contains the information that you need. What to do next: , Enabling Collector Server for linking archived documents by using Utility Client Enabling Collector Server for linking archived documents by using Utility Client If you want to link archived documents, you must ensure that specific keywords are properly set in the server configuration profile. Before you begin: , Associating the document type of the archived documents with an SAP workflow, on page 153 Procedure: 1. Open the server configuration profile of the Collector Server that you want to use, in a text editor. 2. The following keywords must be set: DESTINATION R3NAME dest_name sap_system dest_name Specify a name of your choice. sap_system Specify the ID of the SAP system to which Collector Server is to connect when linking documents to SAP. Notes: v The R3NAME keyword must be specified in the DESTINATION section. v If you specify the RFC_DISPATCHERS keyword, the JRFC_DISPATCHERS keyword, or both keywords, in the server configuration profile and set them to a value greater than 0, you must provide more information by specifying additional keywords in the DESTINATION section. 3. The ARCHIVE section of the appropriate FileNet P8 archive must contain the following keywords: PE_QUEUENAME p8_queue_name PE_CONNECTPOINT pe_connectpoint PE_USERID pe_user_name p8_queue_name Specify the name of the P8 queue that is to contain the documents that are to be linked. Keep the name as brief as possible. The name of the workflow 154 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

169 that makes the documents available in the P8 queue consists of the SAP system ID, the logical archive ID, and the P8 queue name and must not exceed 31 characters. pe_connectpoint Specify the connection point to the workflow system. pe_user_name Specify the name of the user who can read P8 queues and who can process the workflow that is used to make the documents available as work items in the P8 queue. 4. Save the server configuration profile, and stop Collector Server. 5. Start Collector Server again by completing these steps: a. Open a command line and change to the instance directory. b. Enter the following command: archpro -f serverpasswd_pe server_id pe_user_name pe_password The variables are optional. If you do not specify them, you are prompted for them. server_id Specify the values of the OBJECTSTORE, the REMOTESERVERURL, and the P8DOMAIN keywords that you defined in the server configuration profile, in the following format: [objectstore][remoteserverurl][p8domain] If any of the values contain a blank, enclose the entire server ID in quotation marks, such as: "[objectstore][remoteserverurl][p8domain]" Note: On Windows, you must use double quotation marks. On Linux and UNIX systems, you can use single quotation marks or double quotation marks. pe_user_name Specify the value of the PE_USERID keyword. pe_password Specify the password of the user. The password is stored in the password file. c. Enter archpro to start Collector Server. What to do next: , Creating P8 queues and workflows, on page Configuring for linking FileNet P8 objects by using P8 Client To link selected archived documents, folders, stored searches, and search templates by using either of the portlets of P8 Client, you must configure P8 Client. In addition, and you must enable Collector Server to use the portlets. Before you begin: 1. Install P8 Client from the server package or the client package and install P8 Client SAP Connector from the client package. For more information, see the topic Installing the server package in console mode or GUI mode or Installing the client package in console mode or GUI mode in the Installing part of IBM Chapter 10. Configuring your environment for basic tasks 155

170 Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 2, Preparing your environment, on page Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page , Configuring Collector Server for use with FileNet P8, on page , Starting Collector Server for the first time, on page Planning for viewing FileNet P8 documents with the viewer application embedded in Workplace or Workplace XT. For more information, see the corresponding topic in the Planning part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Figure 100 shows which parts of the Content Collector for SAP environment must be configured so that you can link FileNet P8 objects by using P8 Client. OLE communication SAP GUI Content Collector for SAP clients P8 Application Engine Workplace/ workplace XT P8 Client Browse portlet Queue portlet P8 Client SAP Connector (OLE Server) SAP ERP ArchiveLink P8 Content Engine 4 Image Services Engine Collector Server instance = SAP = archives = Content Collector for SAP = connection information = FileNet Content Federation Services for Images Services (CFS-IS) Figure 100. Configuration of your Content Collector for SAP environment for linking FileNet P8 objects by using P8 Client By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v FileNet P8, which contains the objects that are to be linked v Collector Server Content Collector for SAP: Configuring for use with FileNet P8: Best practices

171 P8 Client SAP Connector is the interface between P8 Client and the SAP GUI. It communicates with the SAP GUI by using Object Linking and Embedding (OLE). Therefore, you do not need an HTTP connection or a Remote Function Call (RFC) connection. Folders, stored searches, and search templates can be viewed only with the viewer application that is embedded in Workplace or Workplace XT. If you cannot use Workplace or Workplace XT, do not link these objects. For more information, see the topic Planning for viewing FileNet P8 documents with the viewer application embedded in Workplace or Workplace XT in the Planning part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Take these steps to complete the configuration of your environment for linking FileNet P8 objects by using P8 Client: 1. Configure P8 Client: a. 6.1, Logging on to Workplace or Workplace XT as an administrator, on page 79 b. Depending on which portlet you want to use or on whether you want to use both portlets, complete either or both of the following tasks: v 6.2, Configuring the Browse portlet, on page 80 v 6.3, Configuring the Queue portlet, on page Chapter 7, Configuring P8 Client SAP Connector, on page , Enabling Collector Server to use P8 Client 4. If you want to use the Queue portlet: , Creating P8 queues and workflows, on page Enabling Collector Server to use P8 Client You must enable Collector Server to use the portlets of P8 Client. For this purpose, ensure that specific keywords are properly set in the server configuration profile. Before you begin: 1. Chapter 6, Configuring P8 Client, on page Chapter 7, Configuring P8 Client SAP Connector, on page 89 Procedure: 1. Open the server configuration profile of the Collector Server that you want to use, in a text editor. 2. The following keywords must be set: DESTINATION R3NAME dest_name sap_system dest_name Specify a name of your choice. sap_system Specify the ID of the SAP system to which Collector Server is to connect when linking documents to SAP. Notes: v The R3NAME keyword must be specified in the DESTINATION section. Chapter 10. Configuring your environment for basic tasks 157

172 v If you specify the RFC_DISPATCHERS keyword, the JRFC_DISPATCHERS keyword, or both keywords, in the server configuration profile and set them to a value greater than 0, you must provide more information by specifying additional keywords in the DESTINATION section. 3. Save the server configuration profile, and restart Collector Server for the changes to take effect. What to do next: If you want to use the Queue portlet: , Creating P8 queues and workflows Creating P8 queues and workflows The documents that are to be linked must be available as work items in a P8 queue. You must create the P8 queues, and you must create the workflows that make these documents available in the P8 queues. Before you begin: v You completed either of the following tasks: , Configuring for linking archived documents by using Utility Client, on page , Configuring for linking FileNet P8 objects by using P8 Client, on page 155. You configured your environment for using the Queue portlet. v Documents with bar codes must have the property named Barcode, which is of data type string with a maximum length of 40 characters. To enable Collector Server to perform certain tasks, such as processing the bar codes of the documents, the workflow and the P8 queues must meet the following requirements: v Because a queue can contain documents from several workflows, the name of the workflow must have the following format: <sap_system>_<archive_id>_<p8_queue_name> <sap_system> Specify the ID of the SAP system to which the documents are to be linked, as defined by the R3NAME keyword in the server configuration profile. <archive_id> Specify the logical archive ID of the FileNet P8 archive that contains the documents that are to be linked, as defined by the ARCHIVE keyword in the server configuration profile. <p8_queue_name> Specify the name of the P8 queue that is to receive the documents that are to be linked, as defined by the PE_QUEUENAME keyword in the server configuration profile or as defined in the configuration of the Queue portlet. v Important: If you use Utility Client, ensure that the workflow name has a maximum length of 31 characters. Example for a workflow name: EC5_Y5_BarcodeQueue The workflow must have the following properties: If the documents are to be linked by using Utility Client, a field of data type string, named DWRemark. This field is used to store error messages that might occur during bar-code processing. Documents are only linked if this field is empty. 158 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

173 v The length of the field must be specified in bytes. The field must be long enough to hold 100 English ASCII characters. If you use a multibyte character set, characters do not equal bytes. Check the code page of your database to determine the number of bytes per character and to calculate the minimum length of the DWRemark field in bytes. An attachment of a data type other than array, named DocumentNumber. This attachment contains the document ID of the document that is to be linked. If the documents are to be linked by using Utility Client, expose the fields F_CLASS and DWRemark in the P8 queue. These fields are used in an internal search. Expose the fields by using Process Configuration Console of Workplace or Workplace XT. For more information, see the IBM FileNet P8 Information Center. Note: The names Barcode and DWRemark are case-sensitive and must not be changed. If these names exist in your environment, you must create an attribute mapping file, in which you map these names to the names of your choice. For example, if you want to use bar_code instead of Barcode and remarks instead of DWRemark, specify the following entries in the attribute mapping file: INTERNAL_BARCODE bar_code INTERNAL_DWREMARK remarks For more information about how to create an attribute mapping file, see 1.2, Mapping the names of attributes or properties, on page 2. Content Collector for SAP provides a sample workflow definition that is designed for processing bar codes. This workflow definition is available in the file WorkflowGeneration.pep, which you find in InstallHome. Integrate this sample into your Workplace or Workplace XT and change it according to your needs. For more information about how to create P8 queues and workflows, see the IBM FileNet P8 Information Center. The following procedure shows how to integrate the sample workflow definition into your Workplace XT: 1. Start Workplace XT by using the following web address: 2. Log on to Workplace XT as an administrator. 3. Click Tools > Advanced Tools > Process Designer. 4. Accept any security certificates for signed applets that are displayed to you. 5. In the Process Designer window, click File > Open, gotoinstallhome and then select the file WorkflowGeneration.pep. The sample workflow definition is imported, the name of the workflow is displayed on the tab, and an icon is added to the Workflow area. 6. Click the new icon to view and change the workflow properties, which are shown on the right Configuring for archiving and viewing print lists To archive and view print lists, you need the basic environment. Before you begin: 1. Chapter 2, Preparing your environment, on page Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page 21. Chapter 10. Configuring your environment for basic tasks 159

174 3. Chapter 4, Configuring Collector Server, on page 25. Configure either an HTTP connection or a Remote Function Call (RFC) connection. Figure 101 shows which parts of the Content Collector for SAP environment must be configured so that you can archive and view print lists. SAP GUI SAP ERP P8 agent P8 Content Engine 4 Image Services ArchiveLink 1 RFC dispatcher Engine 3 HTTP dispatcher Collector Server instance 1 = RFC communication = SAP = archives = Content Collector for SAP = connection information 3 = HTTP communication By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v The archives where the data is to be stored v Collector Server v An HTTP connection or an RFC connection between Collector Server and SAP Perform these tasks to complete the configuration of your environment for archiving and viewing print lists: , Defining an archive device , Associating the document type of the incoming documents with an SAP workflow, on page , Creating an SAP ArchiveLink batch job, on page , Enabling extended ALF viewing, on page , Enabling print-list viewing, on page Defining an archive device Define an archive device where the print lists can be archived. = FileNet Content Federation Services for Images Services (CFS-IS) Figure 101. Configuration of your Content Collector for SAP environment for archiving and viewing print lists Procedure: 1. In the SAP GUI, enter the transaction code SPAD to open the Spool Administration: Initial Screen window. 2. Click Display next to Output devices Content Collector for SAP: Configuring for use with FileNet P8: Best practices

175 3. In the Spool Administration: List of Output Devices window, double-click ARCH. 4. In the Spool Administration: Output Device (Display) window, click the Change icon. 5. On the DeviceAttributes page of the Spool Administration: Output Device (Change) window, select ARCHLINK: SAP ArchiveLink Archiver from the Device Type list. 6. From the Device Class list, select Archiving program. Figure 102 shows what the DeviceAttributes page of the Spool Administration: Output Device (Change) window might look like after you completed step 5 and step 6. Figure 102. DeviceAttributes page of the Spool Administration: Output Device (Change) window containing the necessary settings 7. Click the Access Method tab. 8. From the Host Spool Access Method list, select I: Archiving Device. Figure 103 on page 162 shows the DeviceAttributes page of the Spool Administration: Output Device (Change) window containing your selection. Chapter 10. Configuring your environment for basic tasks 161

176 Figure 103. DeviceAttributes page of the Spool Administration: Output Device (Change) window containing your selection 9. Click the Save icon to save your settings. What to do next: , Associating the document type of the print lists with an SAP workflow Associating the document type of the print lists with an SAP workflow Print lists must be linked to an SAP business object of type DRAW. Only those print lists are linked to this particular SAP business object that can be associated with a specific workflow. Before you begin: , Defining an archive device, on page 160 You associate print lists with a specific SAP workflow by enabling their document type for the SAP workflow. You enable the document type for an SAP workflow by completing the steps that are described in , Associating the document type of the incoming documents with an SAP workflow, on page 131. The following values are mandatory: Field in ArchiveLink: Document Type Customizing Wizard Doc.class Object type Value ALF DRAW What to do next: , Creating an SAP ArchiveLink batch job Creating an SAP ArchiveLink batch job Create an SAP ArchiveLink batch job to archive spooled print lists automatically. Before you begin: , Associating the document type of the print lists with an SAP workflow Procedure: 162 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

177 1. In the SAP GUI, enter the transaction code SM36 to open the Define Background Job window. 2. In the Job name field, type a name of your choice. For example, type: ARCHIVELINK 3. In the Job class field, leave C as value. Figure 104 shows what the Define Background Job window might look like after you completed step 2 and step 3. Figure 104. Define Background Job window containing your specifications 4. Click the Start condition icon. 5. In the Start Time window, click Date/Time. 6. In the fields that become available, specify a schedule, and then click the Save icon at the bottom of the window. Figure 105 on page 164 shows the Start Time window containing a sample schedule specification. Chapter 10. Configuring your environment for basic tasks 163

178 Figure 105. Start Time window containing a sample schedule You are returned to the Define Background Job window, which shows the specified schedule under Job start. 7. Click the Step icon. 8. In the Create Step 1 window, click ABAP program. 9. Under ABAP program, inthename field, type the name of the ABAP program. For example, type: ILQBATCH Figure 106 on page 165 shows the Create Step 1 window containing a sample ABAP program name. 164 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

179 Figure 106. Create Step 1 window containing the sample ABAP program name ILQBATCH 10. Click the Save icon at the bottom of the window. The Step List Overview window opens. It contains the ABAP program that you specified. What to do next: , Enabling extended ALF viewing Enabling extended ALF viewing Complete these steps to enable extended ALF viewing. Before you begin: , Creating an SAP ArchiveLink batch job, on page 162 Procedure: 1. In the SAP GUI, enter the transaction code RZ10 to open the Edit Profiles window. 2. In the Profile field, specify the name of an existing profile. For example, select DEFAULT. 3. Under Edit Profile, click Extended maintenance and then click the Change icon. Figure 107 on page 166 shows what the Edit Profiles window might look like after you completed step 2 and step 3. Chapter 10. Configuring your environment for basic tasks 165

180 Figure 107. Edit Profiles window containing your specifications 4. In the Maintain Profile window, click the Create icon. 5. In the Parameter name field, type: rspo/archive_format 6. In the Parameter val. field, type: 2 Figure 108 shows what the Edit Profiles window might look like after you completed step 5 and step 6. Figure 108. Maintain Profile window containing your specifications 7. Click the Exit icon. 8. When the message The parameter was changed. Do you want to save the changes? is displayed, click Yes. 9. In the Edit Profiles window, click the Save icon. 10. When you are asked whether you want to activate the profile, click Yes. What to do next: , Enabling print-list viewing, on page Content Collector for SAP: Configuring for use with FileNet P8: Best practices

181 Enabling print-list viewing To enable the viewing of print lists, you must adapt SAP ArchiveLink protocol. This topic shows how to adapt the sample protocol HTTP1. Before you begin: , Enabling extended ALF viewing, on page 165 Procedure: 1. In the SAP GUI, enter the transaction code OAA3 to open the ArchiveLink: Communications Interface Administration window. 2. Double-click the SAP ArchiveLink protocol. For example, double-click HTTP1. 3. In the ArchiveLink Protocols: Overview of Protocol window, double-click Display Stored Document. Figure 109 shows which item to double-click in the ArchiveLink Protocols: Overview of Protocol window. Figure 109. ArchiveLink Protocols: Overview of Protocol window showing which item to double-click 4. Under Document classes, click the radio button next to ALF and click the Change icon. Figure 110 on page 168 shows which radio button and which icon to click in the ArchiveLink Protocols: Overview of Protocol window. Chapter 10. Configuring your environment for basic tasks 167

182 Figure 110. ArchiveLink Protocols: Overview of Protocol window showing which radio button and which icon to click 5. In the Communication Type field of the small window that opens, specify R/3 and then click the Continue icon. Figure 111 shows what the ArchiveLink Protocols: Overview of Protocol window might look like after you specify the communication type. Figure 111. ArchiveLink Protocols: Overview of Protocol window showing the necessary communication type 6. Click the Continue icon to confirm your specifications and to close the window. 7. Click the Save icon to save your settings Configuring for viewing archived documents with the SAP GUI To view archived documents with the SAP GUI, you need only the basic environment. Before you begin: 1. Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page 25. Configure an HTTP connection. For print lists, you can configure an HTTP connection or a Remote Function Call (RFC) connection. Figure 112 on page 169 shows which parts of the Content Collector for SAP environment must be configured so that you can view archived documents with 168 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

183 the SAP GUI. SAP GUI SAP ERP P8 agent P8 Content Engine 4 Image Services ArchiveLink 1 RFC dispatcher Engine 3 HTTP dispatcher Collector Server instance 1 = RFC communication = SAP = archives = Content Collector for SAP = connection information 3 = HTTP communication = FileNet Content Federation Services for Images Services (CFS-IS) Figure 112. Configuration of your Content Collector for SAP environment for viewing archived documents with the SAP GUI By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v The archives where the documents to be viewed are stored v Collector Server v An HTTP connection or an RFC connection between Collector Server and SAP For information about how to set up the document viewer in SAP, see the SAP help document Customizing for the Document Viewer. Important: You can add an SAP note to a FileNet P8 document when you view the document with the SAP GUI or you can add an annotation when you view it with the viewer application that is embedded in Workplace or Workplace XT. When you add an SAP note, a new version of the document is created and the note becomes a component of the document. When you add an annotation, this annotation is stored in the annotation database of FileNet P8. By creating an SAP note, you break any links to the annotation database. Therefore, either create SAP notes for a document or create annotations. Do not use both methods Configuring for viewing archived documents with an external viewer application To view archived documents with an external viewer application, you need Viewing Client in addition to the basic environment. You start Viewing Client from the SAP GUI by using OLE. Viewing Client starts the viewer application. Before you begin: 1. Install Viewing Client from the client package. For more information, see the topic Installing the client package in console mode or GUI mode in the 4 Chapter 10. Configuring your environment for basic tasks 169

184 Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page 25. Configure an HTTP) connection. For print lists, you can configure an HTTP connection or a Remote Function Call (RFC) connection. Figure 113 shows which parts of the Content Collector for SAP environment must be configured so that you can view archived documents with an external viewer application. OLE communication Viewing Client Content Collector for SAP clients External viewer application SAP GUI csclient.dll Browser SAP ERP Client dispatcher P8 agent P8 Content Engine 4 Image Services ArchiveLink 1 RFC dispatcher Engine 3 HTTP dispatcher Collector Server instance 1 = RFC communication = SAP = archives = Content Collector for SAP = connection information 3 = HTTP communication = FileNet Content Federation Services for Images Services (CFS-IS) Figure 113. Configuration of your Content Collector for SAP environment for viewing archived documents with an external viewer application By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v The archives where the documents to be viewed are stored v Collector Server v An HTTP connection or an RFC connection between Collector Server and SAP Take these steps to complete the configuration of your environment for viewing archived documents with an external viewer application: 1. Configure Viewing Client: a. 9.1, Setting up Viewing Client, on page 107 b. 9.2, Enabling Collector Server to use Viewing Client, on page , Registering Viewing Client with SAP, on page Content Collector for SAP: Configuring for use with FileNet P8: Best practices

185 , Creating an SAP ArchiveLink application for viewing documents, on page , Adapting the SAP ArchiveLink protocol for viewing documents, on page , Configuring an SAP ArchiveLink application for closing viewer applications, on page Registering Viewing Client with SAP You enable the SAP GUI to start Viewing Client by registering an Object Linking and Embedding (OLE) application with Viewing Client. Before you begin: Chapter 9, Configuring Viewing Client, on page 107 Procedure: 1. In the SAP GUI, enter the transaction code SOLE to open the Display View Maintenance view for OLE applications : Overview window. 2. Click the Display > Change icon. If a window opens with the message Caution: The table is cross-client., press Enter. 3. Click New Entries. 4. In the New Entries: Details of Added Entries window, specify the following information: Field name OLE application Description Type: OLEDISPA.DOCUMENT You must specify this name again when you configure an SAP ArchiveLink application for use with Viewing Client. CLSID Type Info key Type: {45526A21-AA41-11CF-B90A-0004ACED415F} Type: NO_TYPELIB Leave all other fields blank. Figure 114 on page 172 shows the New Entries: Details of Added Entries window containing the required settings. Chapter 10. Configuring your environment for basic tasks 171

186 Figure 114. New Entries: Details of Added Entries window containing the required settings 5. Click the Save icon to save your settings. What to do next: , Creating an SAP ArchiveLink application for viewing documents Creating an SAP ArchiveLink application for viewing documents You must create an SAP ArchiveLink application and configure it for use with Viewing Client. Before you begin: , Registering Viewing Client with SAP, on page 171 Procedure: 1. In the SAP GUI, enter the transaction code OAA4 to open the ArchiveLink: Application Maintenance window. 2. Click the Create icon. 3. In the ArchiveLink: Application Maintenance window, type a name of your choice for the SAP ArchiveLink application. For example, type: CSVIEW Figure 115 on page 173 shows the ArchiveLink: Application Maintenance window containing the sample application name. 172 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

187 Figure 115. ArchiveLink: Application Maintenance window containing the sample application name CSVIEW 4. Press Enter. You are returned to the ArchiveLink: Application Maintenance window. 5. Double-click the SAP ArchiveLink application that you created. For example, double-click CSVIEW. 6. On the Windows SAPGUI OLE automation page, double-click Display Stored Document. 7. In the window that opens, specify the following information: a. In the Application field, type the OLE application name that you specified when you registered Viewing Client with SAP. Type: OLEDISPA.DOCUMENT b. Click a radio button and type a command as shown in the following table. Start your specification in the first line. Radio button M M Command Note: This step is necessary only if you want to save the user ID when you process notes. The specified command is used as a method. M The specified command is used as a method. =EID The specified command is used to get the value of an attribute from Viewing Client. Note: Type the commands exactly as they are shown in the table. Figure 116 on page 174 shows what the SAP window might look like after you completed step 7. Chapter 10. Configuring your environment for basic tasks 173

188 Figure 116. Information to be specified for the SAP ArchiveLink application for linking FileNet P8 objects 8. Click Back. 9. Click the Save icon to save your settings. The status next to Display Stored Document changes to Maintained. Figure 117 shows the Windows SAPGUI OLE automation page with status Maintained for Display Stored Document. Figure 117. Windows SAPGUI OLE automation page showing status Maintained for Display Stored Document What to do next: , Adapting the SAP ArchiveLink protocol for viewing documents, on page Content Collector for SAP: Configuring for use with FileNet P8: Best practices

189 Adapting the SAP ArchiveLink protocol for viewing documents You must adapt the SAP ArchiveLink protocol for use with Viewing Client. This topic shows how to adapt the sample protocol HTTP1. Before you begin: , Creating an SAP ArchiveLink application for viewing documents, on page 172 Procedure: 1. In the SAP GUI, enter the transaction code OAA3 to open the ArchiveLink: Communications Interface Administration window. 2. Double-click the SAP ArchiveLink protocol. For example, double-click HTTP1. 3. In the ArchiveLink Protocols: Overview of Protocol window, double-click Display Stored Document. Figure 118 shows which item to double-click in the ArchiveLink Protocols: Overview of Protocol window. Figure 118. ArchiveLink Protocols: Overview of Protocol window showing which item to double-click 4. Under Document classes, click the radio button next to a SAP document class, and click the Change icon. The document class must represent the MIME type of the documents that you want to view. For example, click FAX. Note: The document classes are sorted alphabetically. The document class that you want to select might be displayed on another page. Click the Next page icon to move to the next page. Figure 119 on page 176 shows which radio button and which icon to click in the ArchiveLink Protocols: Overview of Protocol window. Chapter 10. Configuring your environment for basic tasks 175

190 Figure 119. ArchiveLink Protocols: Overview of Protocol window showing which radio button and which icon to click 5. In the Communication Type field of the small window that opens, specify OPEN and then click the Continue icon. Figure 120 shows the ArchiveLink Protocols: Overview of Protocol window containing the necessary communication type. Figure 120. ArchiveLink Protocols: Overview of Protocol window showing the necessary communication type 6. In the Application field, specify the name of the SAP ArchiveLink application that you previously created. For example, select CSVIEW. Figure 121 on page 177 shows the ArchiveLink Protocols: Overview of Protocol window containing the sample application name. 176 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

191 Figure 121. ArchiveLink Protocols: Overview of Protocol window showing the sample SAP ArchiveLink application name CSVIEW 7. Click the Continue icon to confirm your specifications and to close the window. 8. Click the Save icon to save your settings. What to do next: , Configuring an SAP ArchiveLink application for closing viewer applications Configuring an SAP ArchiveLink application for closing viewer applications SAP ArchiveLink can call Object Linking and Embedding (OLE) functions in the SAP ArchiveLink application that close external viewer applications. In this way, you can save resources on your computer. Before you begin: , Adapting the SAP ArchiveLink protocol for viewing documents, on page 175 When Viewing Client receives a doclosewindow call, it closes the current instance of the viewer application. Take these steps to configure an SAP ArchiveLink application for this purpose: Procedure: 1. In the SAP GUI, enter the transaction code OAA4 to open the ArchiveLink: Application Maintenance window. 2. Double-click the SAP ArchiveLink application that you configured for viewing documents. For example, double-click CSVIEW. 3. On the Windows SAPGUI OLE automation page, double-click Close window. 4. In the window that opens, specify the following information: a. In the Application field, type the OLE application name that you specified when you registered Viewing Client with SAP. Type: OLEDISPA.DOCUMENT b. In the first line, click a radio button and type a command as shown in the following table: Radio button M Command doclosewindow Note: The specified command is used as a method. Chapter 10. Configuring your environment for basic tasks 177

192 Note: Type the command exactly as it is shown in the table. Figure 122 shows what the SAP window might look like after you completed step 4a on page 177 and step 4b on page 177 Figure 122. Information to be specified for the SAP ArchiveLink application for closing viewer applications 5. Click Back. 6. Click the Save icon to save your settings. The status next to Close window changes to Maintained. Figure 123 on page 179 shows the Windows SAPGUI OLE automation page with status Maintained for Close window. 178 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

193 Figure 123. Windows SAPGUI OLE automation page showing status Maintained for Close window 10.8 Configuring for viewing FileNet P8 objects with the viewer application embedded in Workplace or Workplace XT To view archived objects with the viewer application that is embedded in Workplace or Workplace XT, you must change the server configuration profile. Before you begin: 1. Chapter 2, Preparing your environment, on page 5 2. Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page , Configuring Collector Server for use with FileNet P8, on page , Setting up the connection between Collector Server and SAP through HTTP, on page , Starting Collector Server for the first time, on page Plan for viewing FileNet P8 documents with the viewer application embedded in Workplace or Workplace XT. For more information, see the corresponding topic in the Planning part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Figure 124 on page 180 shows which parts of the Content Collector for SAP environment must be configured so that you can view FileNet P8 objects with the embedded viewer application. Chapter 10. Configuring your environment for basic tasks 179

194 SAP GUI Content Collector for SAP clients P8 Application Engine Workplace/ workplace XT embedded viewer Queue application portlet SAP ERP P8 agent P8 Content Engine 4 Image Services ArchiveLink Engine 3 HTTP dispatcher Collector Server instance = SAP = archives = Content Collector for SAP = connection information 3 = HTTP communication = FileNet Content Federation Services for Images Services (CFS-IS) Figure 124. Configuration of your Content Collector for SAP environment for viewing FileNet P8 objects with the viewer application that is embedded in Workplace or Workplace XT By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v FileNet P8, where the objects to be viewed are stored v Collector Server v An HTTP connection between Collector Server and SAP 4 Take these steps to complete the configuration of your environment for viewing FileNet P8 objects with the embedded viewer application: 1. Configure your application server to support user tokens. 2. In Workplace or Workplace XT, change the bootstrap site preferences such that user tokens are accepted. For details, see the FileNet P8 product documentation. 3. Open the server configuration profile of the Collector Server that you want to use, in a text editor. 4. Add the following keyword to the ARCHIVE section of each FileNet P8 archive: WORKPLACEURL url url stands for the web address of Workplace or Workplace XT, namely or Folders, searches, and search templates are then opened in Workplace or Workplace XT. Documents are still displayed in a viewer application that is determined by SAP. 180 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

195 5. You can decide for each MIME type whether the documents are to be viewed with the embedded viewer application. To use the embedded viewer application, add the following keyword to the DOCTYPE section that groups the settings for a MIME type: PURETHIN YES If a DOCTYPE section does not exist yet for a MIME type, add it and specify PURETHIN as the only subkeyword. A DOCTYPE section does not exist, for example, if you decided to store all outgoing documents in the default document class or if the documents are incoming documents. Example: ARCHIVE P81... DOCTYPE image/jpg P8DOCCLASS JPG PURETHIN YES DOCTYPE image/tiff PURETHIN YES As a result of this specification example, the documents of MIME type image/tiff and image/jpg are displayed in Image Viewer of FileNet P8. 6. To view an archived object, you must log on to Workplace or Workplace XT. You can continue to view objects without further authentication until you close the browser. To avoid authentication, you can define a user name under which all objects in an archive are displayed. Ensure in this case that only those users have access to an archive who are allowed to view the archived objects. v v If you decide that each user who wants to view an archived object must log on to Workplace or Workplace XT, save the server configuration profile, and restart Collector Server for your changes to take effect. If you decide that all archived objects should be displayed under one user name, take these steps: a. Add the following keyword to the ARCHIVE section of each FileNet P8 archive where the objects should be displayed under one user name: WP_USERID user_name user_name stands for the name of the user that is used to log on to Workplace or Workplace XT. b. Save the server configuration profile, and stop Collector Server. c. Open a command line and change to the instance directory. d. Enter the following command: archpro -f serverpasswd_wp server_id wp_user_name wp_password The variables are optional. If you do not specify them, you are prompted for them. server_id Specify the values of the OBJECTSTORE, the REMOTESERVERURL, and the P8DOMAIN keywords, which are defined in the server configuration profile, in the following format: [objectstore][remoteserverurl][p8domain] If any of the values contain a blank, enclose the entire server ID in quotation marks, namely "[objectstore][remoteserverurl][p8domain]" Chapter 10. Configuring your environment for basic tasks 181

196 Note: On Windows, you must use double quotation marks. On Linux and UNIX systems, you can use single quotation marks or double quotation marks. wp_user_name Specify the value of the WP_USERID keyword. wp_password Specify the password of the Workplace user or of the Workplace XT user. The password is stored in the password file. e. Enter archpro to restart Collector Server. What to do next: Ensure that your SAP GUI is configured for displaying archived documents by running as a browser plug-in or by using a web browser. Use the transaction OAG1 to check whether either of the following options is selected in the ArchiveLink: Basic Settings window under Windows Viewer Settings: v Use HTML Control v Call Internet Browser 182 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

197 Important: You can add an SAP note to a FileNet P8 document when you view the document with the SAP GUI or you can add an annotation when you view it with the viewer application that is embedded in Workplace or Workplace XT. When you add an SAP note, a new version of the document is created and the note becomes a component of the document. When you add an annotation, this annotation is stored in the annotation database of FileNet P8. By creating an SAP note, you break any links to the annotation database. Therefore, either create SAP notes for a document or create annotations. Do not use both methods Configuring for transferring index information Archived documents contain only a specific set of attributes, such as the SAP document ID or the content type. They do not contain attributes that you usually use to search for a document in a browser. You can transfer the index information that is contained in SAP business objects, to the metadata of these archived documents. The documents that the index information can be transferred to, must already be linked to SAP Before you begin: 1. Installing the index transfer enablement package for Utility Client 2. Chapter 2, Preparing your environment, on page 5 3. Chapter 3, Configuring FileNet P8 for use with Content Collector for SAP, on page , Configuring Collector Server for use with FileNet P8, on page , Starting Collector Server for the first time, on page You completed one of the following tasks: v 10.2, Configuring for archiving incoming documents, on page 129 v 10.3, Configuring for archiving outgoing documents, on page 149 v 10.4, Configuring for linking FileNet P8 objects to SAP, on page 151 Figure 125 on page 184 shows which parts of the Content Collector for SAP environment must be configured so that you can transfer index information. Chapter 10. Configuring your environment for basic tasks 183

198 Content Collector for SAP clients Utility Client SAP JCo 3 SAP ERP Index transfer enablement package P8 agent P8 Content Engine 4 Image Services ArchiveLink Engine Collector Server instance = SAP = archives = Content Collector for SAP = connection information = FileNet Content Federation Services for Images Services (CFS-IS) Figure 125. Configuration of your Content Collector for SAP environment for transferring index information By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v The archives to which the index information is to be transferred v Collector Server Collector Server directly communicates with SAP. You do not need an HTTP connection or a Remote Function Call (RFC) connection. Take these steps to complete the configuration of your environment for transferring index information: Configure Utility Client: , Setting up an index transfer, on page , Managing the configuration of Utility Client, on page Content Collector for SAP: Configuring for use with FileNet P8: Best practices

199 Chapter 11. Configuring your environment for more or advanced tasks To use specific functions, to automate the start of Collector Server, or to increase the performance, you must further configure your environment Preventing the storage of web content in the browser cache Browsers maintain a cache memory of the entire web content and downloaded content. You can control the cache properties of the web content but you cannot control the cache properties of the downloaded content. This lack of control might be a problem if sensitive material is viewed in a web browser because cache directories are not secure. You can prevent the web content from being stored in the cache memory of your web browser by configuring the server configuration profile. Before you begin: v Chapter 4, Configuring Collector Server, on page 25. v You need a browser that complies with HTTP 1.1. In addition, you must configure your browser to use HTTP 1.1. Procedure: 1. Open the server configuration profile in a text editor. 2. Add the BROWSERCACHING keyword and set its value to NO, as follows: BROWSERCACHING NO The default value for this keyword is YES. Documents and plug-ins are downloaded to the folder where the web browser temporarily stores the displayed content. To ensure that this folder is emptied, close your web browser after you finish Enabling caching of retrieved documents Unless you view documents in a web browser, the retrieved documents and the query information can be stored in the local cache. The dynamic-link library csclient.dll supports the local caching of retrieved documents. Before you begin: Chapter 4, Configuring Collector Server, on page 25 The local cache is filled with documents that were viewed until the maximum size is reached, which is specified by the CacheMax parameter. When the maximum size is reached, the cache is flushed, and caching starts again. To enable caching, add the following keywords to the [ARCHPRO_CONNECTIONPARAMETER] section of the client configuration profile: CachePath Specifies the fully qualified path to the cache. The directory must exist but should not be used by any other function because all files are deleted when the maximum cache size is exceeded. Copyright IBM Corp. 2010,

200 CacheMax Specifies the maximum size of the cache, in KB. The default value is Example: [ARCHPRO_CONNECTIONPARAMETER]... CachePath=E:\CSClient\cache CacheMax= Setting timeout periods for the RFC or Java RFC dispatcher and the agents You can ensure that, after a specified period of inactivity, the RFC dispatcher or the Java RFC dispatcher and the agents close and reopen network connections to the SAP Gateway or to the archives. By setting timeout periods, the connections between the involved components remain intact. Timeout settings have the following advantages: v If you have several SAP systems and the connection to one SAP system fails, the RFC dispatcher or the Java RFC dispatcher automatically establishes a working connection to another SAP system. You do not need to restart Collector Server. v If you use Content Manager Enterprise Edition or Content Manager OnDemand, you can shut down and restart your archive servers independently of Collector Server. While Collector Server is up and running, the agents automatically establish new connections when the archive servers become available again. v If you use Tivoli Storage Manager, you can make sure that the connection to the archive remains active for the specified timeout period. In this way, you can avoid mounting and unmounting tape drives, in particular if you know that numerous requests address the same tape drive. Without a timeout setting, Tivoli Storage Manager closes the network connection after each request. As a result, the tape drive is mounted and unmounted for each request. You set the timeout in the server configuration profile by using the TIMEOUT keyword. You can specify different timeouts for the RFC dispatcher or the Java RFC dispatcher and for the agents. If you do not set timeout values, Collector Server uses the default settings for the RFC dispatcher or Java RFC dispatcher and the agents. The default settings are shown in the following table: Component Value in seconds TSM agent 0 CM agent (1 day) P8 agent (1 day) OD agent (1 day) RFC dispatcher or Java RFC dispatcher (1 day) Setting the timeout period for the RFC or Java RFC dispatcher To specify a timeout period for the RFC dispatcher or the Java RFC dispatcher, add the TIMEOUT keyword to the DESTINATION section in your server configuration profile. 186 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

201 Set the keyword to an integer value that is equal to, or greater than, 0. The value represents seconds. Example: DESTINATION KD7 PROGID KD7.ICCSAP GWHOST /H/sapserver GWSERV sapgw00 LU sapserver TP sapdp00 TIMEOUT 15 # 15 seconds LOGICAL_SYSTEM T90CLNT090 CLIENT 800 USER CPICUser1 After you save the changed server configuration profile, restart Collector Server for the changes to take effect Setting the timeout period for the agents To specify a timeout period for an agent, add the TIMEOUT keyword to the ARCHIVE section of each archive in the server configuration profile for which you want to specify a timeout period. Set the keyword to an integer value that is equal to, or greater than, 0. The value represents seconds. Example: ARCHIVE UA STORAGETYPE TSM SERVER iceberg MGMT_CLASS docs ADSMNODE docs LOGICAL_SYSTEM T90CLNT090 TIMEOUT 10 # 10 seconds After you save the changed server configuration profile, restart Collector Server for the changes to take effect Creating several instances of Collector Server You might need more than one instance of Collector Server. The instances can run on the same computer or on different computers. Before you begin: Chapter 4, Configuring Collector Server, on page 25 Each instance must have its own instance directory and its own server configuration profile. Procedure: , Creating more instance directories , Configuring the server configuration profiles for the instances, on page , Assigning fixed ports to the client dispatchers, on page Creating more instance directories Each instance of Collector Server requires its own instance directory. Procedure: Chapter 11. Configuring your environment for more or advanced tasks 187

202 1. Create a folder for each additional instance. 2. Copy the content of the instance folder to each new instance folder. Note: If you copy the password file and the SAPCertificates folder, ensure that you also copy the master key file. Several Collector Server instances can use the same master key but they must not share a master key file. What to do next: , Configuring the server configuration profiles for the instances Configuring the server configuration profiles for the instances Each instance requires a separate server configuration profile. You must adapt specific settings in the profile. Before you begin: , Creating more instance directories, on page 187 Procedure: v If you leave the server configuration profiles in the instance directories, they can all have the same name. If, however, you want to group them in a separate directory, give each server configuration profile a different name. v Change each server configuration profile as follows: Change the following paths: - Set the INSTANCEPATH keyword to the new instance directory. - Set the QUEUEPATH keyword, if available, to the directory where the queues are to be stored. - Specify a new path for the TEMPPATH keyword. Each instance should have its own directory for its temporary files. - You can use the same exchange directories (BASEPATH and ARCHPATH keywords) for all instances. If you want to use different exchange directories, they must be defined in SAP. - Adapt the paths of the log files. - Set the MASTER_KEYFILE keyword to the new location of the file. - Set the DLL_KEYSTORE_FILE keyword to the location of the server keystore for the new instance. Change the TCP/IP ports that are used for communication with the remote Content Collector for SAP components: - WEBPORT, ifthewebdps keyword exists and has a value other than 0 - ARCHPRO_PORT, if you want to assign fixed ports to each instance - SSL_WEBPORT, if HTTPS is used for server authentication What to do next: 1. After you change the server configuration profile, restart Collector Server , Assigning fixed ports to the client dispatchers Assigning fixed ports to the client dispatchers When the API of Content Collector for SAP is to communicate with a Collector Server instance, you can start several client dispatchers to run parallel connections. In the instance configuration, you can specify the Collector Server port. However, 188 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

203 the ports for the client dispatchers are assigned dynamically. A dynamic assignment can pose a problem, for example, if the API is behind a firewall. To solve this problem, you can assign fixed port numbers to the client dispatchers. The client dispatchers are then assigned a fixed range of consecutive port numbers that immediately follows the port numbers that are used by a Collector Server instance. You must ensure, however, that this fixed range of port numbers is not used by any other process. Assume, for example, that you specified 5500 as Collector Server port number in the instance configuration, that you started three client dispatchers, and that you want to assign fixed ports to the client dispatchers. In this example, Collector Server would use the ports 5500 and 5501 and the client dispatchers would be assigned the ports 5502, 5503, and You must ensure that the port numbers are not used by any other process. To use fixed ports, you must change the server configuration profile. Take these steps: 1. Open the server configuration profile in a text editor. 2. Add the CLIENT_ALL_PORTS_FIXED keyword and set it to YES. 3. Save the server configuration profile and restart the instance Running Collector Server as a service On Windows, you can run Collector Server as a service. As a service, Collector Server runs continuously even if all users are logged off. This is useful, for example, if you want to use monitoring tools Installing Collector Server as a service and uninstalling the service You use the archservice program to install and uninstall Collector Server as a service. Procedure: 1. Open a command prompt as an administrator, and enter the following command: archservice install -i profile profile stands for the fully qualified file name of the server configuration profile. If you enter the command from the directory that contains the server configuration profile and if the server configuration profile has the default name archint.ini, -i profile is optional. You can give the service a different name by adding -n name to the command. The service is installed, and the Windows Services window lists the Content Collector for SAP service under its original name or under the name that you assigned. 2. To uninstall the service, enter the following command: archservice remove -i profile Starting and stopping the service You can start and stop Collector Server as a service in various ways. 1. To start the service, use either of the following ways on the computer where Collector Server is installed: Chapter 11. Configuring your environment for more or advanced tasks 189

204 v In the command prompt that you opened as administrator, enter the following command: archservice start profile stands for the fully qualified file name of the server configuration profile. If you enter the command from the directory that contains the server configuration profile and if the server configuration profile has the default name archint.ini, -i profile is optional. v Right-click the Collector Server service in the Services window, and click the menu item to start the service. The Collector Server service is started. In addition, the archpro program is started, which in turn starts other related programs. The Collector Server service checks every few seconds if the archpro program is still running. If the service detects that this program stopped, it waits for 1 minute and then tries to restart it. 2. To obtain status information about the Collector Server service, enter the following command: archservice status 3. To stop the service, use either of the following ways on the computer where Collector Server is installed: v In the command prompt that you opened as administrator, enter the following command: archservice stop v Select the Collector Server service in the Services window and then click Action > All Tasks > Stop. The Collector Server service is stopped, together with the archpro program and the programs that were started by the archpro program Running several instances of Collector Server as services You can run several instances of Collector Server as services on a single operating system, for example, to improve the performance. To install several instances as services: 1. Open a command prompt as administrator. 2. Enter the following command: archservice install -i profile -n name profile stands for the fully qualified file name of the server configuration profile. If you enter the command from the directory that contains the server configuration profile and if the server configuration profile has the default name archint.ini, -i profile is optional. name stands for the name of the service. For more information, see the topic archservice in the Reference part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH The service is installed, and the Windows Services window lists the Content Collector for SAP service under the name that you assigned. 3. Repeat step 2 for each instance of Collector Server that you want to install as a service , Assigning fixed ports to the client dispatchers, on page Content Collector for SAP: Configuring for use with FileNet P8: Best practices

205 5. Each service requires a service initialization file of its own. Place each initialization file in a different directory and make sure that the SERVICE_TRACEFILE keyword has a different value in each file. 6. To uninstall a specific service, enter the following command: archservice remove -i profile -n name Hints and tips If a problem occurs when you run Collector Server as a service, the following hints and tips might help you solve the problem. v v v Install Collector Server as a service only after Collector Server is successfully configured and started for the first time, and if you do not get any error messages or warnings. In the server configuration profile, set the TRACE keyword to DYNAMIC_ON so that the startup of Collector Server is traced. Tracing stops automatically after Collector Server is fully initialized. You can start tracing again by using the archadmin program. However, tracing affects the performance of Content Collector for SAP. Therefore, disable tracing again when you do not need it any more. For more information, see the topic archadmin in the Reference part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH If the number of RFC dispatchers is greater than 0, the paths that are defined by the keywords BASEPATH and ARCHPATH are probably unavailable when you run Collector Server as a service. However, for Collector Server to start, all paths must be available. If the Collector Server cannot verify that the paths are available, it does not start Configuring for viewing documents from several SAP systems Normally, you can view a document from one SAP system only because the dynamic-link library csclient.dll can connect to only one instance of Collector Server. To view documents from several SAP systems, you must configure the client configuration profile. Before you begin: Chapter 4, Configuring Collector Server, on page 25 To define that the csclient.dll library can connect to three instances of the Collector Server, take these steps: 1. Open the client configuration profile in a text editor. 2. Add the following keywords to the [ARCHPRO_CONNECTIONPARAMETER] section in the client configuration profile: Server The name or the IP address of an instance of Collector Server. Port The port of this instance. Server_2 The name or IP address of another instance of Collector Server. Port_2 The port of this other instance. Server_3 The name or IP address of a third instance of Collector Server. Chapter 11. Configuring your environment for more or advanced tasks 191

206 Port_3 The port of this third instance. Example: [ARCHPRO_CONNECTIONPARAMETER] Server = w Port = 5500 Server_2 = w Port_2 = 5502 Server_3 = archifix Port_3 = 8017 Important: Keep the order of the keywords and do not skip a number. For example, if you specify Server and Port, and then Server_2 and Port_2, and then Server_4 and Port_4, the csclient.dll library stops reading after Server_2 and Port_2. 3. Suppress the messages that are displayed when the csclient.dll library cannot connect to a Collector Server. Specify the following keyword in the [ARCHPRO_CONNECTIONPARAMETER] section: Interactive=0 The default is Interactive=1. The csclient.dll library contacts the specified set of Collector Server instances. The first instance that can successfully handle the request to retrieve a document becomes the active instance. The following request is then always sent to the active instance first. If this instance cannot retrieve the requested document, the next instance is contacted until the request is handled successfully or until all of the specified instances are contacted. If the request finishes successfully, the document is displayed. Otherwise, an error message is sent to SAP Configuring for preprocessing outgoing documents Content Collector for SAP provides a preprocessor user exit. By using this user exit, you can change outgoing documents with a preprocessor before the documents are archived. To include preprocessors in the archiving process, you must change the server configuration profile The preprocessor user exit The preprocessor user exit supports one preprocessor per MIME type. The preprocessor user exit checks the MIME type of a document that is sent by SAP and that was created by using create or mcreate operations. If a document consists of more than one component, the preprocessor user exit checks the MIME type of only the first component. After the user exit reads all components of a document, it calls the preprocessor that is defined for this MIME type in the server configuration profile. The preprocessor can run as an executable file or as a Java class. The preprocessor user exit of Content Collector for SAP currently supports the following types of preprocessing: v Changing the format of a document, for example, from TIFF to PDF. v Merging a document that consists of several single-page components into a document with a multi-page component. In this way, you can merge, for example, single-page documents in TIFF format into one multi-page TIFF document. 192 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

207 The preprocessor user exit does not support the following tasks: v Linking files to a processed document v Changing or deleting the document ID or the component ID v Processing a document with several preprocessors Requirements for running a preprocessor You can run the preprocessor as an executable file or as a Java class. To run the preprocessor as an executable file, the command to start the preprocessor must look as follows: preprocessor_command> <input_file> <result_file To run the preprocessor as a Java class, you must provide a Java class that implements the following interface: public interface ACPreprocessor { public ResultSection execute(string archivefilename); } The input for the preprocessor is created by Content Collector for SAP. You are responsible for creating the preprocessor that produces a result that Content Collector for SAP can evaluate The input for the preprocessor Content Collector for SAP creates the following input for your preprocessor: an input file and an extended input file. The name of the input file is the temporary file name of the outgoing document. If the document consists of more than one component, the name of the input file is the temporary file name of the first component. The extended input file contains the temporary files of all components of the document, including the name of the input file. The temporary file names ensure that the individual components are uniquely identified during preprocessing even if several SAP requests are processed in parallel. The extended input file can contain the following sections: [Data] Contains the temporary file names of all components that are not annotations or descriptions. If you want to transform several single-page documents into one multi-page document, this section contains the temporary file names of all pages. [Note] Contains the temporary file name of an annotation. [Desc] Contains the temporary file name of a description. This section is specified only for documents of MIME type application/x-alf. If a specific component type does not exist, the corresponding section is omitted. For example, if there is no annotation, the extended input file does not contain the [NOTE] section. Notes: v Except for the file name extension, the file name of the input file is identical with the file name of the extended input file. The extended input file has always the extension.input. v The name of the input file is included as the first file name in the [Data] section of the extended input file. Chapter 11. Configuring your environment for more or advanced tasks 193

208 v v The extended input file lists the file names in the order in which the components are to be preprocessed. The name of the input file is passed to the preprocessor. The name of the extended input file is not passed to the preprocessor. Preprocessors that can handle an extended input file must check for its existence The result from the preprocessor Depending on whether you run your preprocessor as an executable file or as a Java class, the preprocessor produces a result file or a result object. This result file or result object must have specific characteristics and a specific format. The result file or result object must meet the following requirements: v The result file or result object contains one file name only, that is, the name of the output file. This means that the preprocessor returns only one component and deletes any additional components. In this way, a document with several components is merged into a document with one component. v The result file or result object and the input file can contain different MIME types. In this way, you can change a TIFF document to a PDF document. The MIME type must be specified in the result file or result object if it differs from the MIME type in the input file. v The result file or result object can contain additional indexes. The index fields and their values must be added to the attribute list in the result file or result object. Content Collector for SAP does not check the document after it is changed by the preprocessor. Ensure that the document can be accessed and used by SAP The format of the result file: If the preprocessor runs as an executable file, a result file is produced. The format of the result file is similar to the format of a server configuration profile. The order of the individual sections and the order of the parameters within each section is arbitrary. The result file must contain a GLOBAL section. It can also contain an INDEX section. The following example shows the various sections and the parameters that you can specify: [GLOBAL] File=output_file_name DocType=new_mimetype [INDEX] index_field1=index_value1 index_field2=index_value2 Explanation of the parameters: Parameter Description Mandatory or optional File DocType The name of the output file that contains the document and that is created by the preprocessor. You can specify one file name only. The MIME type of the document after it is changed by the preprocessor. Mandatory Mandatory if different from the input file 194 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

209 Parameter Description Mandatory or optional [INDEX] section The list of attributes that are returned by the preprocessor in the format index_field=index_value Optional Notes: v The file name that you specify for the File parameter can be enclosed in quotation marks. The HTTP dispatcher removes the quotation marks. v Blanks are not allowed before or after the equal (=) sign. v Content Collector for SAP evaluates all parameters in the result file The format of the result object: If the preprocessor runs as a Java class, a result object is produced. The format of the result object must meet specific requirements. The result object that is to be returned by the preprocessor must look as follows: public class ResultSection { private GlobalEntries globalentries; private List linkentries; private Map indexvalues; } The GlobalEntries class must contain the following parameters: public class GlobalEntries { private List filenames; private String documentclass; private String documenttype; private String[] links; } The elements of List linkentries must be of class LinkEntries, which is defined as follows: public class LinkEntries { private String linkname; private String filename; private String documentclass; private String index; private HashMap indexvalues; } Content Collector for SAP evaluates the following parameters. Any additional parameters are ignored. Parameter Description Mandatory or optional filenames The name of the output file that contains the Mandatory document and that is created by the preprocessor. documenttype indexvalues You can specify one file name only. The MIME type of the document after it is changed by the preprocessor. The list of attributes that are returned by the preprocessor in the format attribute_name=attribute_value Mandatory if different from the input file Optional Chapter 11. Configuring your environment for more or advanced tasks 195

210 Note: The LinkEntries class is necessary to ensure compatibility with FileNet Application Connector for SAP. It is not used by Content Collector for SAP The preprocessor You are responsible for creating a preprocessor that can handle the input that Content Collector for SAP creates, that produces the result that can be used by Content Collector for SAP, and that changes the documents as supported by the preprocessor user exit of Content Collector for SAP. In addition to the input and result requirements, keep in mind the following information when you create a preprocessor: v The preprocessor must remove any temporary files that it creates. v The preprocessor does not have to remove the input after preprocessing is completed. The input file and all files that are listed in the extended input file are deleted by Content Collector for SAP. Important: The existence of the result file or result object is the only indicator that the preprocessor ran successfully. Therefore, ensure that the creation of the result file or result object is the last preprocessing step Including the preprocessors in the archiving process You must change the server configuration profile to include one or more preprocessors. You can specify one preprocessor per MIME type. Before you begin: 1. Chapter 2, Preparing your environment, on page , Configuring Collector Server for use with FileNet P8, on page , Setting up the connection between Collector Server and SAP through HTTP, on page , Starting Collector Server for the first time, on page 50 Procedure: 1. Open the server configuration profile in a text editor. 2. In the ARCHIVE section, add either of the following set of keywords: v If you want to run the preprocessor as an executable file, specify the following keywords in the sequence shown: PREPROC_MIMETYPE mime_type PREPROC_EXEC exec v mime_type The MIME type of the documents that are to be processed. exec The fully qualified path to the executable file that is to process the documents of the specified MIME type. Example: PREPROC_MIMETYPE image/tiff PREPROC_EXEC d:\preprocessors\preproc_tif.bat If you want to run the preprocessor as a Java class, specify the following keywords in the sequence shown: PREPROC_MIMETYPE mime_type PREPROC_CLASS java_classname PREPROC_CLASSPATH java_classpath 196 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

211 mime_type The MIME type of the documents that are to be processed. java_classname The fully qualified Java class name. java_classpath The fully qualified class path to the Java class. Example: PREPROC_MIMETYPE image/tiff PREPROC_CLASS Preprocessor.SamplePreprocTif PREPROC_CLASSPATH d:\preprocessors\preproc_java.jar Note: You can use the same preprocessor several times. You can also use a different preprocessor for each MIME type. If you want to use different processors, ensure that each preprocessor has a unique Java class name even if the Java classes are in different class paths. Java class paths are concatenated. If you use the same Java class name for more than one preprocessor, the preprocessor user exit calls the first preprocessor that it finds for this Java class name. 3. Save the server configuration profile, and restart Collector Server for the changes to take effect Enabling Collector Server to log on to an SAP logon group When you archive or link your documents by processing their bar codes or by creating work items in the SAP workflow, you might want to distribute the work to several SAP Application Servers. For this purpose, you must enable Collector Server to log on to an SAP logon group. The SAP logon group that you want to use must exist. Change the server configuration profile as follows: 1. Open the server configuration profile in a text editor. 2. Specify the following keywords in the DESTINATION section: MSHOST GROUP R3NAME hostname group_name sap_system hostname The host name of the SAP Message Server. group_name The name of the SAP logon group. sap_system The ID of the SAP system that contains the group of SAP Application Servers. Example: DESTINATION KD7 MSHOST sapmskd7 GROUP mygroup R3NAME KD7 LOGICAL_SYSTEM T90CLNT090 CLIENT 800 USER CPICUser1 LOGICAL_SYSTEM T90CLNT091 CLIENT 801 USER CPICUser2 Chapter 11. Configuring your environment for more or advanced tasks 197

212 3. Save the server configuration profile, and restart Collector Server for the changes to take effect Linking documents to SAP by using the Cold program With the Cold program, you can link documents that are not archived yet and you can link documents that are stored in FileNet P8. The bar code of a document is used to create the link. The Cold program is supplied with Content Collector for SAP. You can change it according to your needs. Before you begin: 1. Install the Cold program. 2. Chapter 4, Configuring Collector Server, on page Linking documents that are not archived yet by using the Cold program To link documents that are not archived yet to an existing SAP business object, the documents must be accessible by Archiving Client or by a scanning application that can scan and archive documents. Before you begin: v , Configuring for archiving incoming documents by processing their bar codes, on page 147. v The documents must include information that the Cold program can use to create the link. This information can be either in the file name or in a description file. The Cold program provides a user exit that you can use to implement a method for identifying SAP business objects. If no SAP business object is found to which the document can be linked, the document is imported as a print list. Procedure: 1. Archive the documents by using Archiving Client or by using a scanning application that can also archive documents. In either case, the document IDs are sent to SAP as bar codes and are stored in the Open Barcode table of SAP. 2. In the SAP GUI, enter the transaction code ZCSI to open the IBM Content Collector for SAP Applications - Document Import window. 3. In the ARCHIV field, specify the ID of the archive. You find the archive ID in the server configuration profile. The archive ID is needed for SAP ArchiveLink. For example, type: A1 4. In the SAPOBJ field, specify the SAP business object to which the documents are to be linked. The default value is DRAW to import the documents as print lists into the document management system (DMS) of SAP. 5. In the AR_OBJ field, specify the kind of document on which the SAP business object depends. The default value is DRW 6. In the DOCTYPE field, type the document type. The default document type is alf for print lists. 7. In the OBJECTID field, type an ID that is used as starting point for the automatic generation of print-list IDs. 198 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

213 The ID must have the following format: cn. c stands for one alphabetic character, and n stands for a 7-digit integer. The Cold program checks the existence of the same ID in the TOADL table and automatically increments numerically. A maximum of documents for each leading alphabetic character can be imported. The default starting ID is C In the INFO field, type the value that is to be displayed in DMS and thus serves as an index. The default value is IMP. 9. In the PRINTER field, type the ID of the printer. The ID is displayed in DMS and thus serves as an index. You can assign a value each time the Cold program runs. This parameter applies only to print lists. The default value is LP In the FORMULAR field, type the form. The form is displayed in DMS and thus serves as an index. You can assign a value each time the Cold program runs. This parameter applies only to print lists. The default value is CS_INDEX. 11. Select the DVS check box if you want to make print lists accessible through DMS. For this example, select the check box. 12. Click the Execute icon. The Cold program is started. It reads the entries in the Open Barcode table and links the document to an existing SAP business object or places it in the document management system of SAP (SAP DMS). The transmitted bar code is interpreted as either a business object ID or a print-list description. If the bar code cannot be interpreted as an SAP business object ID, you can use the user exit to implement a method for identifying SAP objects. On request, the user exit generates a hyperlink for the document in the import protocol. Figure 126 shows what the IBM Content Collector for SAP Applications - Document Import window might look like after you completed step 3 on page 198 through step 11. Figure 126. IBM Content Collector for SAP Applications - Document Import window showing the sample settings and the default settings Chapter 11. Configuring your environment for more or advanced tasks 199

214 Linking archived documents by using the Cold program The Cold program links archived documents by generating an entry, for each document, in the Open Barcode table of SAP and then creating a link for each document in the SAP print-list tables. In this way, the documents become accessible from the SAP GUI. Procedure: 1. Create an input file that contains all archived documents. For each document, this input file must contain the document ID, the archiving date, and the SAP object ID, separated by commas, for example: d, ,document abc, ,document2 1999zzzzzzzzzz, ,document3 The input file must be in UTF-8 format. You can also use an input file that is created by the scanning application that stored the documents. Make sure, however, that the input file contains the required entries, separated by commas. 2. Create an entry for each document that is listed in the input file in the Open Barcode table of SAP: a. In the SAP GUI, enter the transaction code ZCSL to open the IBM Content Collector for SAP Applications - List Importer window. b. In the ARCHIVID field, type a unique archive ID. You find the archive ID in the server configuration profile. The archive ID is inserted in the Open Barcode table. The default value is A1. c. In the DOCTYPE field, specify the document type. For incoming documents, the default value is fax. d. In the TIMEFROM and TIMETO fields, specify the period during which the documents must be archived in order to be linked. The default start date is The default end date is e. Select the TESTRUN check box to open the SAP report but to suppress the processing of the input file. If the check box is selected, no entries are generated in the Open Barcode table. For this example, select the check box. f. In the FNIMPORT field, type the physical location and the case-sensitive name of the input file. On Linux and UNIX systems, the default path is /usr/sap/put/transfer/base/import.txt. g. In the POS1 field, type the position of the ID of the archived document in the input file. The type is character and the maximum length is 40. The default value is 1. h. In the POS2 field, type the position of the archiving date in the input file. The type is character and the format is yyyymmdd. The default value is 2. i. In the POS3 field, type the position of the object ID in the input file. The type is character and the maximum length is 50. The default value is 3. j. Select the IGNORE check box if the first line in the input file is to be ignored. For this example, do not select the check box. k. Select the DELFLAG check box if the input file is to be deleted after it is processed. For this example, do not select the check box. 200 Content Collector for SAP: Configuring for use with FileNet P8: Best practices

215 l. In the FNERROR field, the fully qualified path to the error file. On Linux and UNIX systems, the default path is /usr/sap/put/transfer/base/ error.txt m. Select the APP check box if the existing error file is to be kept and further errors are to be appended to this file. For this example, do not select the check box. n. Click the Execute icon. Figure 127 shows what the IBM Content Collector for SAP Applications - Document Import window might look like after you completed step 2b on page 200 through step 2m. Figure 127. IBM Content Collector for SAP Applications - List Import window showing the sample settings and the default settings The Cold program reads the input file and, for each line in the file, generates an entry in the Open Barcode table of SAP. All documents within the specified date range are processed. Faulty entries are written to the error file that you specified in step 2l , Linking documents that are not archived yet by using the Cold program, on page 198. Create a link for each document in the SAP print-list tables by completing step 2 on page 198 through step 12 on page 199. The documents are now accessible from the SAP GUI. Chapter 11. Configuring your environment for more or advanced tasks 201