Configuring Content Collector for SAP for use with IBM Content Manager Enterprise Edition Version 8

Transcription

1 IBM Content Collector for SAP Applications Version 2 Release 2 Configuring Content Collector for SAP for use with IBM Content Manager Enterprise Edition Version 8

2

3 IBM Content Collector for SAP Applications Version 2 Release 2 Configuring Content Collector for SAP for use with IBM Content Manager Enterprise Edition Version 8

4 Note Before using this information and the product it supports, read the information in Notices on page 205. Sixth edition (January 2015) This edition applies to version 2, release 2, 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. Copyright IBM Corporation 2011, 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 sixth edition xi What s new in the fifth edition xi What s new in the fourth edition xi What s new in the third edition xii What s new in the second edition xii 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 Configuring your environment for Content Manager Configuring your environment for Content Manager on a Linux or UNIX system Configuring your environment for Content Manager 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 Content Manager for use with Content Collector for SAP Creating a user ID Creating attributes Creating document-part item types Creating document item types Creating item-type subsets Configuring a connection to a remote Content Manager server Chapter 4. Configuring Collector Server Configuring Collector Server for use with Content Manager Server configuration profile: General information and structure Creating a server configuration profile for Content Manager Configuring the connection between Collector Server and SAP Setting the number of 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) 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 Copyright IBM Corp. 2011, 2015 iii

6 Creating queues if the scanned documents are in a Content Manager work basket Providing details about the queue of type CMQueue Defining the connection to Collector Server Connecting the queue to a logical archive Providing details about the Content Manager work basket Completing the creation of the queue of type CMQueue 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 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 Distributing Archiving Client and its settings to other computers Chapter 6. Configuring Utility Client Setting up an index transfer 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 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 Creating an attribute filter Changing the preferences of Utility Client 87 Chapter 7. 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 Distributing Viewing Client and its settings to other computers Chapter 8. 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 archived documents to SAP Configuring for linking archived documents to SAP by creating work items in an SAP workflow Creating a workflow in Content Manager Enabling Collector Server for the target item type and the Content Manager workflow Associating the document type of the archived documents with an SAP workflow. 135 iv Content Collector for SAP: Configuring for use with Content Manager V8

7 8.4.2 Configuring for linking archived documents to SAP by processing their bar codes Configuring the source item types Creating a target item type for linking Content Manager documents by processing their bar codes Creating a workflow in Content Manager Enabling Collector Server for the target item type and the Content Manager workflow 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 archived documents with Content Manager eclient Configuring for searching for and viewing archived documents by using SAP Document Finder Configuring for transferring index information 165 Chapter 9. Configuring your environment for additional 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 Securing the connection between Collector Server and SAP Configuring the server authentication Configuring server authentication on Collector Server Creating an SSL keystore and a certificate for Collector Server Having the certificate signed by a certificate authority Enabling Collector Server for the server authentication Exporting the Collector Server certificate Configuring the server authentication in SAP Importing the Collector Server certificate into SAP Enabling SSL support for the content repositories Configuring the client authentication Exporting the SAP certificate Importing the SAP certificate into the SSL truststore Enabling Collector Server for the client authentication Enforcing the use of HTTPS Creating several instances of Collector Server Creating additional 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 Associating SAP document classes to MIME types Overview of the mappings of SAP document classes to MIME types Adding missing mappings of SAP document classes to MIME types Enabling a Content Manager archive for links between one document and several SAP business objects Integrating Content Collector for SAP into the SAP Solution Manager Contents v

8 9.14 Integrating Java applications into your archiving setup Notices Privacy policy considerations Trademarks Index vi Content Collector for SAP: Configuring for use with Content Manager V8

9 About this information Intended audience This book shows how to configure IBM Content Collector for SAP Applications for use with IBM Content Manager Enterprise Edition Version 8. 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 2.2. The default names are shown in this section. v v v v IBM Content Collector for SAP Applications Version 2.2 is abbreviated to Content Collector for SAP. To improve the readability, Content Manager Enterprise Edition is sometimes abbreviated to Content Manager. Content Manager Enterprise Edition or Content Manager reflects Version 8 of this product. If this information refers to Version 7 of this product, the version number is added, namely Content Manager Enterprise Edition Version 7 or Content Manager Version 7. 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: 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 Copyright IBM Corp. 2011, 2015 vii

10 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. Archiving is a process where data, documents, or print lists are stored in Content Manager Enterprise Edition Version 8 and are linked to an SAP business object for future retrieval. Linking is a process where objects that are already stored in Content Manager Enterprise Edition Version 8, are linked to an SAP business object for future retrieval. A basic environment consists of the SAP GUI, the Collector Server of Content Collector for SAP, and Content Manager Enterprise Edition Version 8. 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 Content Manager Enterprise Edition 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. 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 support/docview.wss?rs=86&uid=swg viii Content Collector for SAP: Configuring for use with Content Manager V8

11 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 Content Manager V8

13 What's new in Version 2.2 Content Collector for SAP Version 2.2 integrates CommonStore for SAP Version 8.4 and FileNet Application Connector for SAP R/3, J2EE Edition Version 2.1. What's new in the sixth 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 47. v Utility Client can also be started from Linux and UNIX operating systems. For more information, see Chapter 6, Configuring Utility Client, on page 81. v The information about securing the connection between Collector Server and SAP has been updated in various topics. For more information, see 9.4, Securing the connection between Collector Server and SAP, on page 171. v The topic about fixed ports has been reworked. For more information, see 9.5.3, Assigning fixed ports to the client dispatchers, on page 186. 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 fifth edition This edition includes the following updates: v 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. v When you create an SSL keystore and a certificate for Collector Server by using the Java Keytool, specify the algorithm that is to be used to sign the certificate. What s new in the fourth edition This edition includes the following updates: v When you issue the archadmin, 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. v The topic that contains the default location of specific files has been rewritten. For more information, see 1.1, Default location of installed files and of files created at run time, on page 1. v The information about how to configure HTTPS communication has been improved. Copyright IBM Corp. 2011, 2015 xi

14 v For more information, see 9.4, Securing the connection between Collector Server and SAP, on page 171. You can disable the processing of insecure HTTP requests. For more information, see Technote The following topic has been updated to include this information: 9.4.3, Enforcing the use of HTTPS, on page 184. What s new in the third edition This edition includes the following updates: v Linux UNIX The default value for InstallHome is /opt/ibm/iccsap v The description for archint.cfg has changed. For more information, see 1.1, Default location of installed files and of files created at run time, on page 1. v The description of how to configure your environment for integrating Java applications into your archiving setup has been updated to show when and how several URLs must be specified. For more information, see 9.14, Integrating Java applications into your archiving setup, on page 203. What s new in the second edition This edition includes the following Technote: : Archiving incoming documents by creating work items in an SAP workflow returns "Error calling application via OLE CSCLIENT.DOCUMENT". For more information, see , Creating an SAP ArchiveLink application for archiving documents, on page 123. xii Content Collector for SAP: Configuring for use with Content Manager V8

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 Content Manager for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page 27 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 8, Configuring your environment for basic tasks, on page 97. 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 archint_sample_cm8.ini Example of a server configuration profile. 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. Default location on Linux and UNIX systems InstallHome/server/bin InstallHome/server/bin InstallHome Default location on Windows InstallHome\Server\ instances\instance01 InstallHome\Server\ instances\instance01 InstallHome Copyright IBM Corp. 2011,

16 Table 2. Files that are created at run time File Default location on Linux and UNIX systems Default location on Windows archint.cfg Default password file. It contains all passwords that a Collector Server instance needs to communicate with SAP and the archives. Instance path as set by the INSTANCEPATH keyword in your server configuration profile 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. CSClient.ini Default client configuration profile. It contains the configuration of Viewing Client. It is created when you start Viewing Client for the first time. *.cs Contains the configuration of Utility Client. It is created when you save the configuration of Utility Client. Not applicable. XP SystemRoot You specified the fully qualified file name when you saved the configuration. Vista Windows 7 env_var_appdata\local\ VirtualStore\Windows You specified the fully qualified file name when you saved the configuration. 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 keywords in this respect: STORAGETYPE CM LIBSERVER ITEM_TYPE 1. Open a text editor. 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, 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 2 Content Collector for SAP: Configuring for use with Content Manager V8

17 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 file name of the mapping file. For example: ARCHIVE A1... ATTRMAPPING_FILE C:\ICCSAP\Server\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 Content Manager V8

19 Chapter 2. Preparing your environment Content Collector for SAP requires at least one instance of Collector Server. In addition, you must set specific environment variables and set up a basic SAP system. Before you begin: You installed Content Manager Enterprise Edition, Content Collector for SAP, and any additional programs , Preparing your environment for Collector Server , Configuring your environment for Content Manager, on page , 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 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. 1. Create a user for a Collector Server instance. 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. 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 Content Manager Enterprise Edition. 5. Create a directory named queue in your instance directory. Instead of creating a queue directory, you can add the QUEUEPATH keyword to the server configuration profile and specify the path to an existing directory. You can add the keyword when you configure Collector Server for use with Content Manager Enterprise Edition. Hint: If you expect many queues, use the QUEUEPATH keyword. What to do next: 2.2.1, Configuring your environment for Content Manager on a Linux or UNIX system, on page 6 Copyright IBM Corp. 2011,

20 2.1.2 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. You might want to move or rename the instance directory or create your own instance directory. Complete the following steps to configure an instance: 1. Create an instance directory in a directory of your choice. 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 Content Manager Enterprise Edition. 3. Create a directory named queue in the new instance directory. Instead of creating a queue directory, you can add the QUEUEPATH keyword to the server configuration profile and specify the path to an existing directory. You can add the keyword when you configure Collector Server for use with Content Manager Enterprise Edition. Hint: If you expect many queues, use the QUEUEPATH keyword. What to do next: 2.2.2, Configuring your environment for Content Manager on Windows, on page Configuring your environment for Content Manager You must configure the environment settings so that Content Collector for SAP can access Content Manager Enterprise Edition Configuring your environment for Content Manager on a Linux or UNIX system You must configure your DB2 environment. In addition, you must configure your environment for the use of the Content Manager Enterprise Edition connector. Before you begin: 2.1.1, Preparing your environment for Collector Server on Linux or UNIX, on page 5 1. Log on as the Content Collector for SAP instance user. 2. Configure the environment for the Content Manager Enterprise Edition connector: a. Run the cmbenv81.sh shell script. b. To ensure that this script automatically runs at each logon, add the following entry to the.profile file:. /opt/ibm/db2cmv8/bin/cmbenv81.sh Note: There is a space between the period (.) and the first slash (/). 3. For the changes to the logon profile to take effect, log off and then log on as an instance user again. What to do next: 2.3, Setting up a basic SAP system, on page 7 6 Content Collector for SAP: Configuring for use with Content Manager V8

21 2.2.2 Configuring your environment for Content Manager on Windows You must configure your environment for the use of the Content Manager Enterprise Edition connector. Before you begin: 2.1.2, Preparing your environment for Collector Server on Windows, on page 6 From a command prompt, run the batch program AgentEnv_CM8.bat, which is in the installation directory of Collector Server. This program sets the CM8_CLASSPATH environment variable. What to do next: 2.3, Setting up a basic SAP system 2.3 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.2.1, Configuring your environment for Content Manager on a Linux or UNIX system, on page , 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 In the SAP GUI, enter the transaction code SU01 to open the User Maintenance: Initial Screen window. 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 on page 8 shows the User Maintenance: Initial Screen window containing the sample user name CPICUSER1. Chapter 2. Preparing your environment 7

22 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 Content Manager Enterprise Edition. 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 shows the Maintain User window containing CPICUSER1_family as sample surname for sample user CPICUSER1. 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. 8 Content Collector for SAP: Configuring for use with Content Manager V8

23 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 shows what the Logon data page of the Maintain User window might look like after you completed step 5 on page 8. 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.3.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. 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 Content Manager V8

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 Content Manager V8

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 Content Manager V8

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. 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 Content Manager V8

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.3.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.3.1, Creating a user with CPIC access, on page 7 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 Content Manager Enterprise Edition. 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 Content Manager V8

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.3.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.3.2, Linking a logical system to the SAP client, on page 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 Content Manager for use with Content Collector for SAP, on page Content Collector for SAP: Configuring for use with Content Manager V8

35 Chapter 3. Configuring Content Manager for use with Content Collector for SAP 3.1 Creating a user ID 3.2 Creating attributes Configure Content Manager Enterprise Edition. If the Content Manager Enterprise Edition server and the Collector Server are not installed on the same computer, you must also configure a connection between the two servers. Before you begin: Chapter 2, Preparing your environment, on page , Creating a user ID , Creating attributes , Creating document-part item types, on page , Creating document item types, on page Optional: 3.5, Creating item-type subsets, on page , Configuring a connection to a remote Content Manager server, on page 25 Create a Content Manager Enterprise Edition user ID on the library server where the documents are to be archived. Collector Server uses this user ID to log on to Content Manager Enterprise Edition. For details about how to create a user ID and about the options and values that you can set, see the IBM DB2 Content Management product documentation. Note, however, the following information: v v Make a note of the user ID. You must later specify this user ID for the CMUSER keyword in the server configuration profile. You change the server configuration profile when you configure Collector Server for use with Content Manager Enterprise Edition. Make a note of the password. You need this information when you start Collector Server for the first time. What to do next: 3.2, Creating attributes SAP ArchiveLink needs certain attributes to maintain the link to each document and to control the access to each document. Before you begin: 3.1, Creating a user ID For details about how to create attributes and about the options and values that you can set, see the IBM DB2 Content Management product documentation. The following table shows the mandatory attributes, together with the necessary attribute specifications. The attribute names are case-sensitive. Copyright IBM Corp. 2011,

36 Attribute name DocId DocProtection CompId Charset Version Checksum ContentType Barcode (required only for incoming documents with bar codes) CSOBJKEY (needed as a second-level attribute of a child component if the archived documents are to be referenced from several SAP objects) Attribute type Variable character Variable character Variable character Variable character Variable character Variable character Variable character Variable character Variable character Character type Minimum character length Other 0 40 Other 0 10 Other Other 0 20 Other 0 10 Other 0 20 Other 0 80 Other 0 40 Other 0 65 Maximum character length Attribute values that are longer than the defined maximum length are not stored, and the documents that contain such values are not archived. However, you can reduce the length of the values to the defined maximum length: You add the TRUNCATE_ATTRIBUTE keyword to the server configuration profile, as shown in the following example: ARCHIVE A1 STORAGETYPE CM... TRUNCATE_ATTRIBUTE YES The values of all attributes in the archive are then truncated at the maximum length. You can add this keyword when you configure Collector Server for Content Manager Enterprise Edition. Note: This keyword applies to all attributes in the archive. You cannot apply it to individual attributes. What to do next: 3.3, Creating document-part item types 3.3 Creating document-part item types A document-part item type contains a specific part of a document. Content Collector for SAP cannot use the existing document-part item types because they cannot store the attributes that SAP needs to access a document. Therefore, you must create additional document-part item types. 22 Content Collector for SAP: Configuring for use with Content Manager V8

37 Before you begin: 3.2, Creating attributes, on page 21 Content Collector for SAP supports the following additional document-part item types: ICMBASECS To contain the non-textual type of content, such as images or audio. This document-part item type is required. ICMNOTELOGCS To contain a log of all SAP notes. This document-part item type is required. ICMBASETEXTCS To contain the text content of the document. You need this document-part item type only if you want to search the content of the archived documents. To enable text search, you must set the TEXT_SEARCHABLE keyword to YES in the server configuration profile. You change the server configuration profile when you configure Collector Server for use with Content Manager Enterprise Edition. For details about how to create document-part item types and about the options and values that you can set, see the topic about creating item types in the IBM DB2 Content Management product documentation. Note the following settings for a document-part item type for use by Content Collector for SAP: v On the Definition page of the New Item Type Definition window: 1. In the Name field, specify the name of the part item type, namely ICMBASECS, ICMNOTELOGCS, oricmbasetextcs. 2. From the Item type classification list, select Document part. 3. From the Media Object (XDO) Class list, select one of the following values: For ICMBASECS: DKLobICM For ICMNOTELOGCS and ICMBASETEXTCS: DKTextICM v On the Attributes page, add all of the following attributes, which you previously created, to the Selected attributes and components list: CompId Charset Version Checksum ContentType What to do next: 3.4, Creating document item types 3.4 Creating document item types Document item types group documents within a Content Manager Enterprise Edition archive. An item type is associated with a set of attributes. All documents that are grouped within an item type thus share the set of attributes. To enable SAP to access an item type, it must contain the document-part item types that you created and additional attributes. Before you begin: 3.3, Creating document-part item types, on page 22 Chapter 3. Configuring Content Manager for use with Content Collector for SAP 23

38 For details about how to create item types and about the options and values that you can set, see the IBM DB2 Content Management product documentation. Note the following settings for an item type for use by Content Collector for SAP: Proceed as follows: v On the Definition page of the New Item Type Definition window, take these steps: 1. Select Document from the Item type classification list. 2. Select the Text searchable check box to enable the item type for text search in documents. v On the Document Management page of the New Item Type Definition window, take these steps: 1. Click Add. 2. In the Define Document Management Relations window, select the document-part item types that you previously created, from the Part type list. Select one document-part item type at a time and then click OK to add it to the Document Management page. v On the Attributes page of the New Item Type Definition window, add all of the following attributes, which you previously created, to the Selected attributes and components list: DocId DocProtection v Make a note of the name of the document item type. If you plan not to create an item-type subset, you must later specify the name of this item type for the ITEM_TYPE keyword in the server configuration profile. You change the server configuration profile when you configure Collector Server for use with Content Manager Enterprise Edition. What to do next: 3.5, Creating item-type subsets 3.5 Creating item-type subsets With item-type subsets, you can restrict the access to the documents that are stored in the same item type and to the document attributes. Before you begin: 3.4, Creating document item types, on page 23 Assume, for example, that a service provider stores files for different customers in the same item type because the documents are similar. The provider wants to prevent customer A from accessing the documents of customer B, and vice versa. Therefore, the service provider creates different subsets for each customer, based on the same item type. For details about how to create item-type subsets and about the options and values that you can set, see the IBM DB2 Content Management product documentation. Proceed as follows: v Make a note of the name of the item-type subset. You must later specify it for the ITEM_TYPE keyword in the server configuration profile. You change the server configuration profile when you configure Collector Server for use with Content Manager Enterprise Edition. 24 Content Collector for SAP: Configuring for use with Content Manager V8

39 v To ensure that only documents with specific attribute values are archived in the item-type subset and are available for viewing, use the Attribute filter for view fields in the New Item Type Subset window. In addition, choose either of the following methods: Include the attributes for which a filter is set, in an attribute mapping file. Content Collector for SAP then checks whether the attribute values of the documents meet the filter criteria before it stores the documents in the item-type subset. If a filtered attribute does not exist in the documents and if it is not included in an attribute mapping file, Content Collector for SAP can add it automatically and assign a value that follows the filter definition. For this purpose, you must add the ADDVIEWFILTERATTR keyword to the server configuration profile, as shown in the following example: ARCHIVE A1 STORAGETYPE CM... ADDVIEWFILTERATTR YES You can add this keyword when you configure Collector Server for use with Content Manager Enterprise Edition. Note: If a filter is set for an attribute with several values, Content Collector for SAP does not check compliance with the filter criteria. In addition, Content Collector for SAP cannot add attributes that are defined as multivalue attributes in Content Manager Enterprise Edition. What to do next: 3.6, Configuring a connection to a remote Content Manager server 3.6 Configuring a connection to a remote Content Manager server If the Content Manager Enterprise Edition server that holds the item types is not installed on the same computer as Collector Server, you must configure a connection between the two servers. Before you begin: 3.5, Creating item-type subsets, on page If you use Content Manager Enterprise Edition Version 8.3, create a TCP/IP node in the DB2 that catalogs the remote host. In addition, specify a database alias for the database that is used by the Content Manager Enterprise Edition server. Content Manager Enterprise Edition Version 8.3 uses the JDBC connection for this purpose. 2. Optional: Install a Content Manager client on the computer where Collector Server is installed to verify the data that is archived on the remote server. 3. Verify your configuration in the cmbicmsrvs.ini file, which is in the IBMCMROOT/cmgmt/connectors directory. What to do next: Chapter 4, Configuring Collector Server, on page 27 Chapter 3. Configuring Content Manager for use with Content Collector for SAP 25

40 26 Content Collector for SAP: Configuring for use with Content Manager V8

41 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 Content Manager 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 CM agent agent_cm.jar CMAGENTS keyword Collector Server instance Figure 17. Configuration of Collector Server Complete the following tasks to configure Collector Server: , Configuring Collector Server for use with Content Manager , 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 Content Manager 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. 2011,

42 You can configure more than one instance of Collector Server. Each instance must have its own server configuration profile. 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 Content Manager Enterprise Edition, the sample profile is archint_sample_cm8.ini. You can add many keywords 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 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 you start Collector Server, Collector Server 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 v One or more ARCHIVE sections, where each ARCHIVE section contains the settings for one logical archive v 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 28 Content Collector for SAP: Configuring for use with Content Manager V8

43 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 file name of the trace that contains the entire # Collector Server trace information. # # #TRACEFILE C:\Program Files\IBM\ICCSAP\Server\instances\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. # # #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 DISPATCHERS > 0. # # #BASEPATH \\SAPSERVER\transfer\base\ Chapter 4. Configuring Collector Server 29

44 # # # The full path to the directory where Collector Server and SAP can # retrieve the archived files. # Note: This keyword is only required if DISPATCHERS > 0. # # #ARCHPATH \\SAPSERVER\transfer\arch\ 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 the support of # SAP Document Finder. # # # 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 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. v If you use SAP Document Finder, the DESTINATION section must contain a LOGICAL_SYSTEM section. In the ARCHIVE section, the LOGICAL_SYSTEM keyword does not have to be specified. 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 Content Manager server and # for each item type. # # 30 Content Collector for SAP: Configuring for use with Content Manager V8

45 # # # Minimum archive definition. # # ARCHIVE A1 STORAGETYPE CM LIBSERVER LIBSERV1 CMUSER sampleuser1 ITEM_TYPE itemtypea1 # # # Definition for linking documents that are in a work basket. # # ARCHIVE A2 STORAGETYPE CM LIBSERVER LIBSERV2 CMUSER sampleuser2 ITEM_TYPE itemtypea2 SCAN_PROCESS SapScanProcess WORKLIST_SCAN SapScanWL_A2 WORKLIST_ERROR SapErrorWL_A2 LOGICAL_SYSTEM T90CLNT090 Example of a subprocess section: # # # The number of parallel instances of the Content Collector for SAP # child programs. # # DISPATCHERS 0 ADSMAGENTS 0 ODAGENTS 0 CMAGENTS 1 P8AGENTS 0 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 5580 # # # 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 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. Chapter 4. Configuring Collector Server 31

46 v v 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 Content Manager Use the sample file archint_sample_cm8.ini to create a server configuration profile for use with Content Manager Enterprise Edition. 1. Copy the sample file archint_sample_cm8.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 Installation, Configuration, and User's Guide, SH 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 Specify the full path to the directory where Collector Server is to store the temporary files that are needed for processing. 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. 32 Content Collector for SAP: Configuring for use with Content Manager V8

47 Keyword Description Remarks DESTINATION Specify a name of your choice. This keyword groups all settings that are necessary for Collector Server to connect to SAP. LOGICAL_SYSTEM Specify the name of the logical system that is linked to the SAP client that you want to use with Content Collector for SAP. You specified this name when you defined the logical system in SAP. CLIENT USER ARCHIVE Specify the name of the SAP client that you want to use with Content Collector for SAP. Specify the name of the user who has access to the specified SAP client. 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 documents, including documents with bar codes. You specified this name when you created the user with CPIC access in the appropriate SAP client. You must specify this ID again when you create the content repository in SAP. LIBSERVER CMUSER ITEM_TYPE ARCHWINS You can adapt and keep both definitions, or you can remove the unnecessary one. The ID must be unique in the server configuration profile and in SAP. Specify the alias name of the Content Manager Enterprise Edition library server. Specify the user ID that you created when you configured Content Manager Enterprise Edition for use with Content Collector for SAP. Specify the name of the item type or the item-type subset that you created when you configured Content Manager Enterprise Edition for use with Content Collector for SAP. If do not want to use Archiving Client or Viewing Client, set the value of this keyword to 0. If you migrated Content Manager Enterprise Edition Version 7, the item-type name was generated by the migration program. In this case, specify the generated name. Chapter 4. Configuring Collector Server 33

48 Keyword Description Remarks ARCHPRO_PORT If another program does not use this port, leave the port that is specified in the sample profile, namely 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. 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: Chapter 3, Configuring Content Manager 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 (cssap.jar / DISPATCHERS keyword) 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 The bar code is sent directly to SAP. x x Either an HTTP connection or an RFC connection is required. 34 Content Collector for SAP: Configuring for use with Content Manager V8

49 Task Linking archived documents by creating work items in an SAP workflow Linking archived documents by processing their bar codes Archiving and viewing print lists Viewing archived documents with the SAP GUI Viewing archived documents with an external viewer Viewing archived documents with eclient Searching for and viewing archived documents with SAP Document Finder Transferring index information HTTP connection, which uses the HTTP dispatcher RFC connection, which uses the RCF dispatcher Java RFC dispatcher (cssap.jar / DISPATCHERS keyword) x Remarks The bar code is sent directly to SAP. x x Either an HTTP connection or an RFC connection is required. 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 x 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 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 RFC dispatchers The number of RFC dispatchers and the number of Java RFC dispatchers are both set with the DISPATCHERS keyword in the server configuration profile. You need an RFC dispatcher for a Remote Function Call (RFC) communication. You need the Java RFC dispatcher 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. Chapter 4. Configuring Collector Server 35

50 If you are configuring an RFC connection, you must also 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. 1. Open the server configuration profile in a text editor. 2. Set the DISPATCHERS keyword to a number greater than 0, for example: DISPATCHERS 4 3. If you are configuring an RFC connection, you must add the following keywords to specify the paths for the temporary storage of the files: BASEPATH basepath ARCHPATH 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. If you do not need an RFC connection, you can set the BASEPATH and ARCHPATH keywords to an existing temporary or to a dummy directory. 4. 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 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 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 RFC dispatchers, on page , Setting the number of HTTP dispatchers, on page , Creating an SAP ArchiveLink protocol for use by the HTTP connection, on page , Creating SAP ArchiveLink queues for use by the HTTP connection, on page Content Collector for SAP: Configuring for use with Content Manager V8

51 , 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 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 Chapter 4. Configuring Collector Server 37

52 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 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 19 on page 39 shows the SAP ArchiveLink: Create All Queues (CFBC, CARA, CGDA) window containing the required settings. 38 Content Collector for SAP: Configuring for use with Content Manager V8

53 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 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 HTTP content server. Select the SAP ArchiveLink protocol that you created. Type: A2 Type: Sample archive A2 Select HTTP1. Chapter 4. Configuring Collector Server 39

54 Field Description Example 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 are 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 Content Manager V8

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 or logical archive to which you want to send a certificate. For example, double-click A2. A certificate is sent to the corresponding Collector Server. The Collector Server saves this certificate and uses it when the content repository or the logical archive sends archiving requests or retrieval requests. What to do next: 4.2.4, Enabling Collector Server to connect to SAP, on page 47 Chapter 4. Configuring Collector Server 41

56 4.2.3 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: 4.2.1, Setting the number of RFC dispatchers, on page , Creating an RFC destination , 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 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. 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. 42 Content Collector for SAP: Configuring for use with Content Manager V8

57 Figure 21 shows what the RFC Destination window might look like after you completed step 3 on page 42 through step 7 on page 42. 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 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 Chapter 4. Configuring Collector Server 43

58 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 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 45 shows the SAP ArchiveLink: Create All Queues (CFBC, CARA, CGDA) window containing the required settings. 44 Content Collector for SAP: Configuring for use with Content Manager V8

59 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 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. Chapter 4. Configuring Collector Server 45

60 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 47 shows the Change Content Repositories: Detail window containing your specifications. 46 Content Collector for SAP: Configuring for use with Content Manager V8

61 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 RFC dispatchers, on page 35 v 4.2.2, Setting up the connection between Collector Server and SAP through HTTP, on page 36 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. 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 Content Manager Enterprise Edition. The following table shows which keywords are required for which connection types and tasks. Add the missing keywords. Chapter 4. Configuring Collector Server 47

62 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 is 0. GWSERV sapgw00 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 RFC GWHOST /H/sapserver dispatchers must be greater than 0. GWSERV sapgw00 LU sapserver TP sapdp00 LOGICAL_SYSTEM T90CLNT090 CLIENT 800 USER CPICUser1 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. 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. LU The host name or the IP address of the SAP Application Server. MSHOST The host name of the SAP Message Server. 48 Content Collector for SAP: Configuring for use with Content Manager V8

63 PROGID The program ID under which the dispatcher is registered on the SAP Gateway. 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 by 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 The ID of the SAP system that contains the group of SAP Application Servers. 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 must complete specific steps. Before you begin: 1. Chapter 3, Configuring Content Manager 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. 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 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. 1. Open a command line and change to the instance directory. 2. Enter the following command to enable Collector Server to access your archives: Chapter 4. Configuring Collector Server 49

64 archpro -f serverpasswd You must specify this command once when you want to start Collector Server for the first time. 3. Enter the password of the Content Manager Enterprise Edition user ID. 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. 4. 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 4.4 Stopping Collector Server 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. 5. Enter archpro to start 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 8, Configuring your environment for basic tasks, on page 97 At any time, you can stop Collector Server. Collector Server waits until all jobs are finished and then shuts down. 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 Content Manager V8

65 Chapter 5. Configuring Archiving Client Configure Archiving Client if you want to archive incoming documents. Also configure this client if you want to link scanned documents to SAP that are stored in Content Manager Enterprise Edition. 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 Content Manager for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page 27. 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 , Setting up Archiving Client, on page , Managing the queues, on page 57 Copyright IBM Corp. 2011,

66 3. Optional: 5.4, Distributing Archiving Client and its settings to other computers, on page 79 if you need Archiving Client on several computers with the same settings , 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 53 through 5.1.6, Enabling logging and tracing for Archiving Client, on page 56. Figure 26. Setup window containing sample specifications , 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 Content Collector for SAP: Configuring for use with Content Manager V8

67 , Completing the setup of Archiving Client, on page 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: Chapter 5. Configuring Archiving Client 53

68 v 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 , Specifying the directory for the temporary files Specifying the directory for the temporary files By default, Archiving Client stores the temporary files in the installation directory. 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:\Program Files\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 CMQueue check box if your scanning application stores the scanned documents in a Content Manager work basket. 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, on page Content Collector for SAP: Configuring for use with Content Manager V8

69 5.1.4 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. Note: If one of the documents that are processed in a batch job could not be 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 on page 56 shows the Document format sent to SAP area of the Setup window containing your selection Chapter 5. Configuring Archiving Client 55

70 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 Enabling logging and tracing for Archiving Client You can enable Archiving Client to log its activities in log files and traces. 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 for error recovery. In addition, you can specify where the log files and traces 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 traces. Under Logging and Tracing in the 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:\Program Files\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 file name of the trace. You can specify a path of your choice. For example, type: C:\Program Files\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 file name of the trace. You can specify a path of your choice. For example, type: C:\Program Files\IBM\ICCSAP\ArchivingClient\ICCSAP_AC.trc 3. In the Maximum file size field, click the arrows to select the maximum size of the trace, in KB. You can specify a number up to, and including, KB. If the trace exceeds the limit, the oldest information is overwritten. For example, type: Content Collector for SAP: Configuring for use with Content Manager V8

71 4. Select the Clear trace file check box if you want to delete the existing trace 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. 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 58. 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. Chapter 5. Configuring Archiving Client 57

72 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: 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 52. 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 a Content Manager work basket v , Creating queues if the scanned documents are in the file system, on page 63 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 a Content Manager work basket Create queues of type CMQueue if your scanning application stores the scanned documents in a Content Manager work basket. Archiving Client collects the scanned documents from this work basket. The bar codes are defined as document attributes. Before you begin: , Enabling Collector Server for the target item type and the Content Manager workflow, on page , Providing details about the queue of type CMQueue, on page , Defining the connection to Collector Server, on page , Connecting the queue to a logical archive, on page , Providing details about the Content Manager work basket, on page , Completing the creation of the queue of type CMQueue, on page Content Collector for SAP: Configuring for use with Content Manager V8

73 Providing details about the queue of type CMQueue: You must provide details about the queue that you want to create. In the Queue window, provide the following information: 1. From the Queue Type list, select CMQueue. 2. In the Queue Name field, type a name for the queue. For example, type: my_cmqueue 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 78. 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. 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 through step 3. Figure 33. Queue window showing the sample details for a queue of type CMQueue Chapter 5. Configuring Archiving Client 59

74 What to do next: , Defining the connection to Collector Server 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 CMQueue, on page 59 In the Connection Properties window, provide the following information: 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 61 shows the Connection Properties window containing the sample Collector Server that you specified in the Setup window as the preferred Collector Server. 60 Content Collector for SAP: Configuring for use with Content Manager V8

75 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 60 In the Logical archive window, specify the following information: 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 62 shows the Logical archive window containing the sample specifications. Chapter 5. Configuring Archiving Client 61

76 Figure 35. Logical archive window showing the sample specifications What to do next: , Providing details about the Content Manager work basket Providing details about the Content Manager work basket: You must specify details about the Content Manager work basket from which Archiving Client must collect the scanned documents. In the Content Manager Queue window, specify the following information: 1. The Workbasket field shows the work basket that is specified by the WORKLIST_SCAN keyword in the server configuration profile. To use another work basket, you must change the value of the WORKLIST_SCAN keyword. 2. In the Maximum number of items field, type the maximum number of documents that are to be imported from the work basket into the queue in a single operation. For example, type: Select the Retrieve attributes check box to import the information that is stored in the work-basket attributes. Content Collector for SAP then archives the attribute information as well. This option is useful, for example, because scan dates or bar codes are usually stored in the work-basket attributes. Note, however, that this option decreases the performance of Content Collector for SAP. 4. Click Next. Figure 36 on page 63 shows the Content Manager Queue window containing the sample details about the Content Manager work basket. 62 Content Collector for SAP: Configuring for use with Content Manager V8

77 Figure 36. Content Manager Queue window showing the sample details about the Content Manager work basket What to do next: , Completing the creation of the queue of type CMQueue Completing the creation of the queue of type CMQueue: 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 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 , Providing details about the queue of type DirQueue, on page , 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 68 Chapter 5. Configuring Archiving Client 63

78 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: 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. 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 78. 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 on page 65 shows what the Queue window might look like after you completed step 1 through step Content Collector for SAP: Configuring for use with Content Manager V8

79 Figure 37. Queue window showing the sample details for a queue of type DirQueue What to do next: , Defining the connection to Collector Server 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 64 In the Connection Properties window, provide the following information: 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. Chapter 5. Configuring Archiving Client 65

80 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 shows the Connection Properties window containing the sample Collector Server that you specified in the Setup window as the preferred Collector Server. 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 65 In the Logical archive window, specify the following information: 66 Content Collector for SAP: Configuring for use with Content Manager V8

81 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 shows the Logical archive window containing the sample specifications. Figure 39. 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: 1. In the Path name field, specify the full path to the directory that contains the scanned documents. For example, type: C:\Program Files\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 Chapter 5. Configuring Archiving Client 67

82 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 40 shows the Directory Queue window containing the sample path to the directory where the scanned documents are stored. Figure 40. 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 68 Content Collector for SAP: Configuring for use with Content Manager V8

83 bar code of the document is to be processed, the entry must also contain the bar code. If the entries contain additional attributes of the documents, Archiving Client can store them with the documents , 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 Providing details about the queue of type FileQueue: You must provide some details about the queue that you want to create. In the Queue window, provide the following information: 1. From the Queue Type list, select FileQueue. 2. In the Queue Name field, type a name for the queue. 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 78. 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 41 on page 70 shows what the Queue window might look like after you completed step 1 through step 4. Chapter 5. Configuring Archiving Client 69

84 Figure 41. Queue window showing the sample details for a queue of type FileQueue What to do next: , Defining the connection to Collector Server 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 69 In the Connection Properties window, provide the following information: 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. 70 Content Collector for SAP: Configuring for use with Content Manager V8

85 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 42 shows the Connection Properties window containing the sample Collector Server that you specified in the Setup window as the preferred Collector Server. Figure 42. 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 70 In the Logical archive window, specify the following information: Chapter 5. Configuring Archiving Client 71

86 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 43 shows the Logical archive window containing the sample specifications. Figure 43. 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 71 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" 72 Content Collector for SAP: Configuring for use with Content Manager V8

87 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: 1. In the Path name for description files field, specify the full path to the directory that contains the description file. 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 44 shows what the File Queue window might look like after you completed step 1 through step 4. Figure 44. File Queue window showing the sample specifications Chapter 5. Configuring Archiving Client 73

88 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 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 attributes that are already defined in the logical archive. Figure 45 shows the Custom attributes window with sample custom attributes. Figure 45. 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. 74 Content Collector for SAP: Configuring for use with Content Manager V8

89 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. 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. v 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 archive or is to be sent to SAP. 5. Click OK to return to the Custom attributes window. v 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 Chapter 5. Configuring Archiving Client 75

90 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. 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. 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 46 on page 77 shows the Queue page of the Properties of queue window containing the details about a sample queue of type DirQueue. 76 Content Collector for SAP: Configuring for use with Content Manager V8

91 Figure 46. 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. 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 47 on page 78 shows the Connections Information window with two sample connections. Chapter 5. Configuring Archiving Client 77

92 Figure 47. 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. 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. 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. 78 Content Collector for SAP: Configuring for use with Content Manager V8

93 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. 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 8.2.1, Configuring for archiving incoming documents by creating work items in an SAP workflow, on page Distributing Archiving Client and its settings to other computers You might need Archiving Client on several computers with the same settings. In this case, you can install and set up Archiving Client on one computer and then copy the installation and the settings to other computers. Before you begin: 5.1, Setting up Archiving Client, on page In the IBM Content Collector for SAP Applications - Archiving Client window, click Setup > Save settings to file to save the settings in the CSArch.ini file. The CSArch.ini file is in the directory of your Archiving Client installation. 2. Copy the installation directory of Archiving Client to the other computers. 3. Copy the file CSArch.ini, which you saved in step 1, to the directory of Archiving Client installation on the other computers. 4. Start Archiving Client on the other computers to copy the settings from the CSArch.ini file to the Windows registry. Chapter 5. Configuring Archiving Client 79

94 80 Content Collector for SAP: Configuring for use with Content Manager V8

95 Chapter 6. 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. 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 Content Manager for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page 27. 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: v csclientgui.sh Click All Programs > IBM Content Collector for SAP Applications > Utility Client. The IBM Content Collector for SAP Applications - Utility Client window opens. Figure 48 on page 82 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. 2011,

96 Figure 48. IBM Content Collector for SAP Applications - Utility Client window after the client is started for the first time 6.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 , Defining the connection to the SAP server , 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 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. 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. 82 Content Collector for SAP: Configuring for use with Content Manager V8

97 What to do next: 6.1.2, 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: 6.1.1, Defining the connection to the SAP server, on page 82 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: 6.1.3, 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: 6.1.2, 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. 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: 6.1.4, 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: 6.1.3, Defining an archive 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. What to do next: 6.1.5, Creating an index transfer profile, on page 84 Chapter 6. Configuring Utility Client 83

98 6.1.5 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: 6.1.4, Mapping the SAP attribute to be transferred to an archive attribute, on page 83 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: 6.1.6, 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: 6.1.5, Creating an index transfer profile 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: 6.3, Managing the configuration of Utility Client, on page Setting up a document-linking process You can link the archived documents to SAP , Defining the connection to the SAP server , Defining the connection to Collector Server, on page , Defining an archive, on page , Creating a document-linking session, 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 document-linking process. 84 Content Collector for SAP: Configuring for use with Content Manager V8

99 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: 6.2.2, 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: 6.2.1, Defining the connection to the SAP server, on page 84 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: 6.2.3, 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: 6.2.2, 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. 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: 6.2.4, 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: 6.2.3, Defining an archive In the IBM Content Collector for SAP Applications - Utility Client window under Set up a document-linking process, click Define Session. The New Session Chapter 6. Configuring Utility Client 85

100 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: 6.3, Managing the configuration of Utility Client 6.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. 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. 86 Content Collector for SAP: Configuring for use with Content Manager V8

101 What to do next: If you are configuring your environment for linking archived documents by using Utility Client, continue with , Associating the document type of the archived documents with an SAP workflow, on page Creating an attribute filter An attribute filter limits the SAP attributes whose values are transferred as index information. Thus, it defines a subset of the available index information that is to be transferred. You can create an attribute filter only for SAP link tables (TOAxx). You can create it for an index transfer profile and for an index transfer session. In the IBM Content Collector for SAP Applications - Utility Client window, click File > New > Attribute Filter. The New Attribute Filter wizard opens. Refer to the help pane of the New Attribute Filter wizard for information about how to create the filter Changing the preferences of Utility Client You can specify which traces and logs 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. 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:\Program Files\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:\Program Files\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 49 on page 88 shows what the Logging/Tracing page of the Preferences window might look like after you completed step 2a through step 2d. Chapter 6. Configuring Utility Client 87

102 Figure 49. 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 a 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. 88 Content Collector for SAP: Configuring for use with Content Manager V8

103 Chapter 7. Configuring Viewing Client 7.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 Content Manager for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page 27. 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 50 on page 90 shows what the Viewing Client Setup window might look like after you completed the topics 7.1.1, Defining the connection to Collector Server, on page 90 through 7.1.4, Enabling logging and tracing for Viewing Client, on page 93. Copyright IBM Corp. 2011,

104 Figure 50. Viewing Client Setup window containing sample specifications , 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: 7.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. 90 Content Collector for SAP: Configuring for use with Content Manager V8

105 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 51 shows what the Preferred Server Connection area of the Setup window might look like after you completed step 1 on page 90 through step 3. Figure 51. 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: 7.1.2, Specifying the directory for temporary files Specifying the directory for temporary files By default, Viewing Client stores the temporary files in the installation directory. You can specify another directory. 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:\Program Files\IBM\ICCSAP\ViewingClient\ Figure 52 shows the Work path area of the Viewing Client Setup window containing the sample path. Figure 52. Work path area of the Viewing Client Setup window containing the sample path Chapter 7. Configuring Viewing Client 91

106 What to do next: 7.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 36. 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 53 shows what the Viewing area of the Viewing Client Setup window might look like after you completed step 1 through step 3. Figure 53. Viewing area of the Viewing Client Setup window containing the sample specifications 92 Content Collector for SAP: Configuring for use with Content Manager V8

107 What to do next: 7.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 traces. 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 traces 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 traces. 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:\Program Files\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 file name of the trace. You can specify a path of your choice. For example, type: C:\Program Files\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. 2. In the Trace file field, specify the fully qualified file name of the trace. You can specify a path of your choice. For example, type: C:\Program Files\IBM\ICCSAP\ViewingClient\ICCSAP_VC.trc 3. In the Maximum file size field, click the arrows to select the maximum size of the trace, in KB. You can specify a number up to, and including, KB. If the trace 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 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. Chapter 7. Configuring Viewing Client 93

108 Figure 54 shows the Logging and Tracing area of the Setup window with the entire logging and tracing enabled. Figure 54. Logging and Tracing area of the Viewing Client Setup window containing the sample specifications What to do next: 7.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 55 shows the File and Viewer Management area of the Viewing Client Setup window containing your selection. Figure 55. File and Viewer Management area of the Viewing Client Setup window containing your selection What to do next: 7.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: 7.2, Enabling Collector Server to use Viewing Client, on page Content Collector for SAP: Configuring for use with Content Manager V8

109 7.2 Enabling Collector Server to use Viewing Client You must enable Collector Server to start at least one client dispatcher. 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 8.7.1, Registering Viewing Client with SAP, on page Distributing Viewing Client and its settings to other computers You might need Viewing Client on several computers with the same settings. In this case, you can install and set up Viewing Client on one computer and then copy the installation and the settings to other computers. Before you begin: 7.1, Setting up Viewing Client, on page Copy the installation directory of Viewing Client to the other computers. 2. Copy the dynamic-link library csclient.dll, which is in the installation directory of Viewing Client, to the directory of your Viewing Client installation on the other computers. 3. Copy the file CSClient.ini to either of the following directories: v Vista XP SystemRoot v Windows 7 env_var_appdata\ibm\iccsap\archivingclient Chapter 7. Configuring Viewing Client 95

110 96 Content Collector for SAP: Configuring for use with Content Manager V8

111 Chapter 8. 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. 8.1 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 Content Manager for use with Content Collector for SAP, on page , Configuring Collector Server for use with Content Manager, on page , Configuring the connection between Collector Server and SAP, on page 34. Configure either an HTTP connection or a Remote Function Call (RFC) connection , Starting Collector Server for the first time, on page 49. Figure 56 on page 98 shows which parts of the Content Collector for SAP environment must be configured so that you can archive data. Copyright IBM Corp. 2011,

112 SAP GUI SAP ERP ArchiveLink 1 RFC dispatcher Engine CM agent Content Manager 3 HTTP dispatcher Collector Server instance 1 = RFC communication = SAP = archives = Content Collector for SAP = connection information 3 = HTTP communication Figure 56. Configuration of your Content Collector for SAP environment for archiving data 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 , 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. 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 57 on page 99 shows the Archive Administration: Initial Screen containing the sample archiving object name. 98 Content Collector for SAP: Configuring for use with Content Manager V8

113 Figure 57. 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 58 shows which item to double-click in the Data Archiving Customizing window. Figure 58. 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 8. Configuring your environment for basic tasks 99

114 Figure 59 shows what the Change View "Customizing View for Archiving": Details window might look like after you completed step 5a on page 99 and step 5b on page 99. Figure 59. 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: 8.1.2, Configuring the SAP ArchiveLink path Configuring the SAP ArchiveLink path Complete these steps to configure the SAP ArchiveLink path. Before you begin: 8.1.1, Setting up the sample archiving object FI_BANKS, on page 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. 100 Content Collector for SAP: Configuring for use with Content Manager V8

115 3. Double-click Assignment of Physical Paths to Logical Path in the Dialog Structure pane on the left. Figure 60 shows which items you must select in the Change View "Logical File Path Definition": Overview window. Figure 60. 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 61 on page 102 shows what your selection might look like. Chapter 8. Configuring your environment for basic tasks 101

116 Figure 61. 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 62 shows what your specification might look like. Figure 62. 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. 7. In the Change View "Logical File Name Definition, Cross-Client": Overview window, double-click ARCHIVE_DATA_FILE_WITH_ARCHIVE_LINK. 102 Content Collector for SAP: Configuring for use with Content Manager V8

117 Figure 63 shows which item you must double-click. Figure 63. 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 64 shows which field you must check. Figure 64. 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 63, which also lists the ARCHIVE_DATA_FILE table entry. 11. Check whether the Logical path field shows ARCHIVE_GLOBAL_PATH. Correct the path, if necessary. Figure 65 on page 104 shows which field you must check. Chapter 8. Configuring your environment for basic tasks 103

118 Figure 65. 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: 8.1.3, Checking your data archiving configuration Checking your data archiving configuration Check the configuration for your sample archiving object FI_BANKS. Before you begin: 8.1.2, Configuring the SAP ArchiveLink path, on page 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 57 on page 99 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 58 on page 99 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 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. 104 Content Collector for SAP: Configuring for use with Content Manager V8

119 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 66 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 104 through step 5g. Figure 66. 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. 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: 8.1.4, Creating test data for the sample archiving object, on page 106 Chapter 8. Configuring your environment for basic tasks 105

120 8.1.4 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: 8.1.3, Checking your data archiving configuration, on page 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 67 shows what the Create Bank: Initial Screen window might look like after you completed step 2 and step 3. Figure 67. 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 68 on page 107 shows the Create Bank: Detail Screen window containing the bank name. 106 Content Collector for SAP: Configuring for use with Content Manager V8

121 Figure 68. Create Bank: Detail Screen window containing the bank name 6. Click the Save icon to save your settings. What to do next: 8.1.5, 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: 8.1.4, Creating test data for the sample archiving object, on page 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 69 on page 108 shows the Archive Administration: Create Archive Files window containing the sample variant test_variant. Chapter 8. Configuring your environment for basic tasks 107

122 Figure 69. 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 70 on page 109 shows what the Maintain Variant window might look like after you completed step Content Collector for SAP: Configuring for use with Content Manager V8

123 Figure 70. 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 71 on page 110 shows which button to click in the Start Time window. Chapter 8. Configuring your environment for basic tasks 109

124 Figure 71. 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 72 shows the Background Print Parameters window containing the sample printer. Figure 72. Background Print Parameters window containing the sample printer LP Content Collector for SAP: Configuring for use with Content Manager V8

125 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 66 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 Content Manager for use with Content Collector for SAP, on page , Configuring Collector Server for use with Content Manager, on page , Setting the number of 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 8. Configuring your environment for basic tasks 111

126 6. 4.3, Starting Collector Server for the first time, on page 49. Figure 73 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 ArchiveLink 2 SAP JCo 3 Java RFC dispatcher Engine CM agent Content Manager Collector Server instance = SAP = archives = Content Collector for SAP = connection information 2 = create work item Figure 73. Configuration of your Content Collector for SAP environment for archiving incoming documents by creating work items in an SAP workflow 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 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 Content Collector for SAP: Configuring for use with Content Manager V8

127 b , Creating queues if the scanned documents are in the file system, on page 63 or , Creating queues if the scanned documents are in the file system and a description file exists, on page 68 c , Saving and reusing the queue information, on page 75 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 123 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 51 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: 1. In the SAP GUI, enter the transaction code OAD5 to open the ArchiveLink: Document Type Customizing Wizard. Figure 74 on page 114 shows what the Start page of the ArchiveLink: Document Type Customizing Wizard might look like. Chapter 8. Configuring your environment for basic tasks 113

128 Figure 74. 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 75 on page 115 shows what the Document type page of the ArchiveLink: Document Type Customizing Wizard might look like with the sample entries. 114 Content Collector for SAP: Configuring for use with Content Manager V8

129 Figure 75. 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 76 on page 116 shows what the Document type template page of the ArchiveLink: Document Type Customizing Wizard might look like. Chapter 8. Configuring your environment for basic tasks 115

130 Figure 76. 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 77 shows what the Workflow document type page of the ArchiveLink: Document Type Customizing Wizard might look like. Figure 77. Workflow document type page of the ArchiveLink: Document Type Customizing Wizard with selected item 116 Content Collector for SAP: Configuring for use with Content Manager V8

131 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 114. 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 78 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 78. 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 8. Configuring your environment for basic tasks 117

132 Figure 79 shows what the Workflow parameter page of the ArchiveLink: Document Type Customizing Wizard might look like with the sample transaction code. Figure 79. 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 80 on page 119 shows what the Storage system and link table page of the ArchiveLink: Document Type Customizing Wizard might look like with the sample values. 118 Content Collector for SAP: Configuring for use with Content Manager V8

133 Figure 80. 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 81 on page 120 shows what the Selection from available presettings page of the ArchiveLink: Document Type Customizing Wizard might look like. Chapter 8. Configuring your environment for basic tasks 119

134 Figure 81. 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 82 on page 121 shows what the Create new presettings page of the ArchiveLink: Document Type Customizing Wizard might look like with a sample presetting. 120 Content Collector for SAP: Configuring for use with Content Manager V8

135 Figure 82. 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 83 on page 122 shows the Details of presettings page of the ArchiveLink: Document Type Customizing Wizard containing the necessary settings. Chapter 8. Configuring your environment for basic tasks 121

136 Figure 83. 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 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: 122 Content Collector for SAP: Configuring for use with Content Manager V8

137 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 84 shows the New Entries: Details of Added Entries window containing the necessary settings. Figure 84. 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 In the SAP GUI, enter the transaction code OAA4 to open the ArchiveLink: Application Maintenance window. 2. Click the Create icon. Chapter 8. Configuring your environment for basic tasks 123

138 3. In the ArchiveLink: Application Maintenance window, type a name of your choice for the SAP ArchiveLink application. For example, type: CSARCH Figure 85 shows the ArchiveLink: Application Maintenance window with the sample application name. Figure 85. 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. 124 Content Collector for SAP: Configuring for use with Content Manager V8

139 Figure 86 shows what the SAP window might look like after you completed step 7 on page 124. Figure 86. 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 87 on page 126 shows the Windows SAPGUI OLE automation page with status Maintained for Archive from Frontend. Chapter 8. Configuring your environment for basic tasks 125

140 Figure 87. 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 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 88 on page 127 shows which item to double-click in the ArchiveLink Protocols: Overview of Protocol window. 126 Content Collector for SAP: Configuring for use with Content Manager V8

141 Figure 88. 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 89 on page 128 shows which radio button and which icon to click in the ArchiveLink Protocols: Overview of Protocol window. Chapter 8. Configuring your environment for basic tasks 127

142 Figure 89. 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 90 shows the ArchiveLink Protocols: Overview of Protocol window containing the necessary communication type. Figure 90. 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 91 on page 129 shows the ArchiveLink Protocols: Overview of Protocol window containing the sample application name. 128 Content Collector for SAP: Configuring for use with Content Manager V8

143 Figure 91. 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 Content Manager for use with Content Collector for SAP, on page , Configuring Collector Server for use with Content Manager, on page , Starting Collector Server for the first time, on page 49. Figure 92 on page 130 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 8. Configuring your environment for basic tasks 129

144 OLE communication Content Collector for SAP clients Archiving Client SAP GUI csclient.dll SAP ERP send bar code Client dispatcher ArchiveLink Engine CM agent Content Manager Collector Server instance = SAP = archives = Content Collector for SAP = connection information Figure 92. 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 52 b , Creating queues if the scanned documents are in the file system, on page 63 or , Creating queues if the scanned documents are in the file system and a description file exists, on page 68 c , Saving and reusing the queue information, on page 75 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. 130 Content Collector for SAP: Configuring for use with Content Manager V8

145 For more information about how to complete these steps, refer to the SAP documentation. 8.3 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 Content Manager for use with Content Collector for SAP, on page , Configuring Collector Server for use with Content Manager, on page , Configuring the connection between Collector Server and SAP, on page , Starting Collector Server for the first time, on page 49 Figure 93 shows which parts of the Content Collector for SAP environment must be configured so that you can archive outgoing documents. SAP GUI SAP ERP ArchiveLink 1 RFC dispatcher Engine CM agent Content Manager 3 HTTP dispatcher Collector Server instance 1 = RFC communication = SAP = archives = Content Collector for SAP = connection information 3 = HTTP communication Figure 93. 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 all necessary parts, namely: 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. Chapter 8. Configuring your environment for basic tasks 131

146 8.4 Configuring for linking archived documents to SAP Documents that were scanned and archived by a scanning application that is directly connected to Content Manager Enterprise Edition, are not linked to SAP. You can link such documents by processing their bar codes or by creating work items in an SAP workflow. The linking procedure that you can use depends on whether the documents are already in an item type that can be accessed by SAP Configuring for linking archived documents to SAP by creating work items in an SAP workflow To link documents by creating work items in an SAP workflow, the documents must be stored in an item type that can be accessed by SAP. In addition to the basic environment, you need Utility Client. Before you begin: 1. Install Utility Client from the server package or the client package. For more information, see the topic Installing the client 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 Content Manager for use with Content Collector for SAP, on page , Configuring Collector Server for use with Content Manager, on page , Setting the number of RFC dispatchers, on page , Starting Collector Server for the first time, on page 49. Figure 94 on page 133 shows which parts of the Content Collector for SAP environment must be configured so that you can link archived documents by creating work items in the SAP workflow. 132 Content Collector for SAP: Configuring for use with Content Manager V8

147 Content Collector for SAP clients Utility Client SAP GUI SAP JCo 3 SAP ERP ArchiveLink 2 SAP JCo 3 Java RFC dispatcher Engine CM agent Content Manager Collector Server instance = SAP = archives = Content Collector for SAP = connection information 2 = create work item Figure 94. Configuration of your Content Collector for SAP environment for linking archived documents to SAP by creating work items in an SAP workflow By completing the prerequisite tasks that are listed at the beginning of this topic, you should have configured the following parts: v v v Content Manager Enterprise Edition, which contains the documents that are to be linked Collector Server At least one Java RFC dispatcher for the communication between Collector Server and SAP Take these steps to complete the configuration of your environment for linking archived documents by creating work items in the SAP workflow: , Creating a workflow in Content Manager , Enabling Collector Server for the target item type and the Content Manager workflow, on page Configure Utility Client: a. 6.2, Setting up a document-linking process, on page 84. Create a document-linking session where you specify Create a work item in an SAP workflow. b. 6.3, Managing the configuration of Utility Client, on page , Associating the document type of the archived documents with an SAP workflow, on page Creating a workflow in Content Manager Uploading bar codes and document IDs to SAP requires a workflow in Content Manager Enterprise Edition. This workflow is a document routing process or a part of such a process and requires a scan work node and an error work node. Chapter 8. Configuring your environment for basic tasks 133

148 The workflow works as follows: The work items in the scan work node are routed to the error work node. At the same time, the documents are moved from the source item types to the target item types. After the work items arrive in the error work node, the bar codes and the IDs of the documents are sent to SAP. If uploading is completed successfully, the workflow ends. As a result, the corresponding work items are removed from the error work node and passed on to the next work node in the process. If uploading fails, you can manually move the failed work items back from the error work node to the scan work node so that they can be processed again. The documents, however, remain in the target item types. They are not moved back to their source item types. You can define a routing process exclusively for this purpose, or integrate the workflow into a larger document routing process. Use the system administration client of Content Manager Enterprise Edition to create a workflow. 1. Define two work nodes as work baskets. The first node is the scan work node, and the second node is the error work node. 2. Create a work basket for each work node. Each work basket must contain only one work node. 3. Define the document routing process. The following table shows a process solely for uploading bar codes and document IDs. To integrate this work flow into a larger work flow, replace the START and END nodes accordingly. From node Selection To node START Continue scan work node scan work node Continue error work node error work node Escalate scan work node error work node Continue END scan work node is the name of the scan work node, and error work node is the name of the error work node. What to do next: , Enabling Collector Server for the target item type and the Content Manager workflow Enabling Collector Server for the target item type and the Content Manager workflow Specify the details of the target item type and of the workflow in the server configuration profile. Before you begin: , Creating a workflow in Content Manager, on page Open the server configuration profile of the Collector Server that you want to use, in a text editor. 2. Change the ARCHIVE section as shown: 134 Content Collector for SAP: Configuring for use with Content Manager V8

149 ARCHIVE STORAGETYPE LIBSERVER ITEM_TYPE SCAN_PROCESS WORKLIST_SCAN WORKLIST_ERROR CMUSER archive_id CM server_name target_item_type process_name workbasket_name workbasket_name user_id archive_id Specify the ID of the logical archive of your choice. server_name Specify the name of the library server where the target item type that contains the documents is defined. target_item_type Specify the name of the target item type in which the documents are stored. process_name Specify the name of the workflow that you created in Content Manager Enterprise Edition. workbasket_name Specify the name of the work basket that you created for the scan work node or for the error work node. user_id Specify the user ID that Collector Server uses to log on to Content Manager Enterprise Edition. You created the user ID when you configured Content Manager Enterprise Edition for use with Content Collector for SAP. 3. Save the server configuration profile, and restart Collector Server for the changes to take effect. What to do next: 6.2, Setting up a document-linking process, 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. Before you begin: Chapter 6, Configuring Utility Client, on page 81 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 113. 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. Chapter 8. Configuring your environment for basic tasks 135

150 8.4.2 Configuring for linking archived documents to SAP by processing their bar codes You can link the documents by processing their bar codes regardless of whether SAP can access the item type in which the documents are stored. If the item type is accessible by SAP, you can use Utility Client or Archiving Client in addition to the basic environment. If the item type is not accessible by SAP, you must use Utility Client. During the linking procedure, Utility Client moves the documents to an accessible item type. Before you begin: 1. Install Archiving Client from the client package or 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 Content Manager for use with Content Collector for SAP, on page , Configuring Collector Server for use with Content Manager, on page , Starting Collector Server for the first time, on page 49. Figure 95 on page 137 shows which parts of the Content Collector for SAP environment must be configured so that you can link archived documents by processing their bar codes. 136 Content Collector for SAP: Configuring for use with Content Manager V8

151 OLE communication Content Collector for SAP clients Archiving Client Utility Client SAP GUI csclient.dll SAP JCo 3 SAP ERP send bar code Client dispatcher ArchiveLink Engine CM agent Content Manager Collector Server instance = SAP = archives = Content Collector for SAP = connection information Figure 95. Configuration of your Content Collector for SAP environment for linking archived documents to SAP 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 v Content Manager Enterprise Edition, which contains the documents that are to be linked 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 archived documents by processing their bar codes: , Configuring the source item types, on page , Creating a target item type for linking Content Manager documents by processing their bar codes, on page , Creating a workflow in Content Manager, on page , Enabling Collector Server for the target item type and the Content Manager workflow, on page Continue with the steps for the client that you want to use: v If you want to use Utility Client: a. 6.2, Setting up a document-linking process, on page 84. Create a document-linking session where you specify Create bar codes. b. 6.3, Managing the configuration of Utility Client, on page 86 v If you want to use Archiving Client: a. 5.1, Setting up Archiving Client, on page 52 Chapter 8. Configuring your environment for basic tasks 137

152 b , Creating queues if the scanned documents are in a Content Manager work basket, on page 58 c , Saving and reusing the queue information, on page 75 d. 5.3, Enabling Collector Server to use Archiving Client, on page Configuring the source item types The scanning application places the scanned documents in Content Manager item types that are called source item types. To include a source item type in the workflow for uploading bar codes and document IDs, you must define the attribute Barcode for the item type. Otherwise, no entries are created for the individual documents in the Open Barcode table of SAP. What to do next: , Creating a target item type for linking Content Manager documents by processing their bar codes Creating a target item type for linking Content Manager documents by processing their bar codes The source item types do not contain the attributes that SAP needs to access archived documents. For this purpose, you must create a target item type that has all necessary attributes and to which the documents can be moved. For each logical archive, you can create one target item type. However, you can also create one target item type for all logical archives. Before you begin: , Configuring the source item types , Creating document item types, on page Make sure that this item type contains the following document-part item types: v The document-part item types ICMBASECS and ICMNOTELOGCS. v The document-part item types that are defined in the corresponding source item types. 3. Define the Barcode attribute for the target item type. What to do next: , Creating a workflow in Content Manager Creating a workflow in Content Manager Uploading bar codes and document IDs to SAP requires a workflow in Content Manager Enterprise Edition. This workflow is a document routing process or a part of such a process and requires a scan work node and an error work node. Before you begin: , Creating a target item type for linking Content Manager documents by processing their bar codes The workflow works as follows: The work items in the scan work node are routed to the error work node. At the same time, the documents are moved from the source item types to the target item types. After the work items arrive in the error work node, the bar codes and the IDs of the documents are sent to SAP. If uploading is completed successfully, the workflow ends. As a result, the corresponding work items are removed from the error work node and passed on to the next work node in the process. 138 Content Collector for SAP: Configuring for use with Content Manager V8

153 If uploading fails, you can manually move the failed work items back from the error work node to the scan work node so that they can be processed again. The documents, however, remain in the target item types. They are not moved back to their source item types. You can define a routing process exclusively for this purpose, or integrate the workflow into a larger document routing process. Use the system administration client of Content Manager Enterprise Edition to create a workflow. 1. Define two work nodes as work baskets. The first node is the scan work node, and the second node is the error work node. 2. Create a work basket for each work node. Each work basket must contain only one work node. 3. Define the document routing process. The following table shows a process solely for uploading bar codes and document IDs. To integrate this work flow into a larger work flow, replace the START and END nodes accordingly. From node Selection To node START Continue scan work node scan work node Continue error work node error work node Escalate scan work node error work node Continue END scan work node is the name of the scan work node, and error work node is the name of the error work node. What to do next: , Enabling Collector Server for the target item type and the Content Manager workflow Enabling Collector Server for the target item type and the Content Manager workflow Specify the details of the target item type and of the workflow in the server configuration profile. Before you begin: , Creating a workflow in Content Manager, on page Open the server configuration profile of the Collector Server that you want to use, in a text editor. 2. Change the ARCHIVE section as shown: ARCHIVE STORAGETYPE LIBSERVER ITEM_TYPE SCAN_PROCESS WORKLIST_SCAN WORKLIST_ERROR CMUSER archive_id CM server_name target_item_type process_name workbasket_name workbasket_name user_id archive_id Specify the ID of the logical archive of your choice. Chapter 8. Configuring your environment for basic tasks 139

154 server_name Specify the name of the library server where the target item type is defined. target_item_type Specify the name of the target item type that you created. process_name Specify the name of the workflow that you created in Content Manager Enterprise Edition. workbasket_name Specify the name of the work basket that you created for the scan work node or for the error work node. user_id Specify the user ID that Collector Server uses to log on to Content Manager Enterprise Edition. You created the user ID when you configured Content Manager Enterprise Edition for use with Content Collector for SAP. 3. Save the server configuration profile, and restart Collector Server for the changes to take effect. What to do next: Depending on whether you want to use Utility Client or Archiving Client, proceed with either of the following tasks: v 6.2, Setting up a document-linking process, on page 84 v 5.1, Setting up Archiving Client, on page 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 Content Manager for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page 27. Configure either an HTTP connection or a Remote Function Call (RFC) connection. Figure 96 on page 141 shows which parts of the Content Collector for SAP environment must be configured so that you can archive and view print lists. 140 Content Collector for SAP: Configuring for use with Content Manager V8

155 SAP GUI SAP ERP ArchiveLink 1 RFC dispatcher Engine CM agent Content Manager 3 HTTP dispatcher Collector Server instance 1 = RFC communication = SAP = archives = Content Collector for SAP = connection information 3 = HTTP communication Figure 96. Configuration of your Content Collector for SAP environment for archiving and viewing print lists 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. 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. 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. Chapter 8. Configuring your environment for basic tasks 141

156 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 97 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 97. 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 98 on page 143 shows the DeviceAttributes page of the Spool Administration: Output Device (Change) window containing your selection. 142 Content Collector for SAP: Configuring for use with Content Manager V8

157 Figure 98. 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: 8.5.2, 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: 8.5.1, Defining an archive device, on page 141 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 113. The following values are mandatory: Field in ArchiveLink: Document Type Customizing Wizard Doc.class Object type Value ALF DRAW What to do next: 8.5.3, 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: 8.5.2, Associating the document type of the print lists with an SAP workflow Chapter 8. Configuring your environment for basic tasks 143

158 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 99 shows what the Define Background Job window might look like after you completed step 2 and step 3. Figure 99. 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 100 on page 145 shows the Start Time window containing a sample schedule specification. 144 Content Collector for SAP: Configuring for use with Content Manager V8

159 Figure 100. 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 101 on page 146 shows the Create Step 1 window containing a sample ABAP program name. Chapter 8. Configuring your environment for basic tasks 145

160 Figure 101. 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: 8.5.4, Enabling extended ALF viewing Enabling extended ALF viewing Complete these steps to enable extended ALF viewing. Before you begin: 8.5.3, Creating an SAP ArchiveLink batch job, on page 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 102 on page 147 shows what the Edit Profiles window might look like after you completed step 2 and step Content Collector for SAP: Configuring for use with Content Manager V8

161 Figure 102. 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 103 shows what the Edit Profiles window might look like after you completed step 5 and step 6. Figure 103. 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: 8.5.5, Enabling print-list viewing, on page 148 Chapter 8. Configuring your environment for basic tasks 147

162 8.5.5 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: 8.5.4, Enabling extended ALF viewing, on page 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 104 shows which item to double-click in the ArchiveLink Protocols: Overview of Protocol window. Figure 104. 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 105 on page 149 shows which radio button and which icon to click in the ArchiveLink Protocols: Overview of Protocol window. 148 Content Collector for SAP: Configuring for use with Content Manager V8

163 Figure 105. 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 106 shows what the ArchiveLink Protocols: Overview of Protocol window might look like after you specify the communication type. Figure 106. 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. 8.6 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 Content Manager for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page 27. Configure an HTTP connection. For print lists, you can configure an HTTP connection or a Remote Function Call (RFC) connection. Figure 107 on page 150 shows which parts of the Content Collector for SAP environment must be configured so that you can view archived documents with Chapter 8. Configuring your environment for basic tasks 149

164 the SAP GUI. SAP GUI SAP ERP ArchiveLink 1 RFC dispatcher Engine CM agent Content Manager 3 HTTP dispatcher Collector Server instance 1 = RFC communication = SAP = archives = Content Collector for SAP = connection information 3 = HTTP communication Figure 107. 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. 8.7 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 Installing part of IBM Knowledge Center or of IBM Content Collector for SAP Applications: Installation, Configuration, and User's Guide, SH Chapter 3, Configuring Content Manager for use with Content Collector for SAP, on page Chapter 4, Configuring Collector Server, on page 27. Configure an HTTP) connection. For print lists, you can configure an HTTP connection or a Remote Function Call (RFC) connection. 150 Content Collector for SAP: Configuring for use with Content Manager V8

165 Figure 108 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 ArchiveLink 1 RFC dispatcher Engine CM agent Content Manager 3 HTTP dispatcher Collector Server instance 1 = RFC communication = SAP = archives = Content Collector for SAP = connection information 3 = HTTP communication Figure 108. 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. 7.1, Setting up Viewing Client, on page 89 b. 7.2, Enabling Collector Server to use Viewing Client, on page , Registering Viewing Client with SAP, on page , 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 157 Chapter 8. Configuring your environment for basic tasks 151

166 8.7.1 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 7, Configuring Viewing Client, on page 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 109 shows the New Entries: Details of Added Entries window containing the required settings. Figure 109. New Entries: Details of Added Entries window containing the required settings 5. Click the Save icon to save your settings. 152 Content Collector for SAP: Configuring for use with Content Manager V8

167 What to do next: 8.7.2, 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: 8.7.1, Registering Viewing Client with SAP, on page 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 110 shows the ArchiveLink: Application Maintenance window containing the sample application name. Figure 110. 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. Chapter 8. Configuring your environment for basic tasks 153

168 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 111 shows what the SAP window might look like after you completed step 7 on page 153. Figure 111. 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 112 on page 155 shows the Windows SAPGUI OLE automation page with status Maintained for Display Stored Document. 154 Content Collector for SAP: Configuring for use with Content Manager V8

169 Figure 112. Windows SAPGUI OLE automation page showing status Maintained for Display Stored Document What to do next: 8.7.3, Adapting the SAP ArchiveLink protocol for viewing documents 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: 8.7.2, Creating an SAP ArchiveLink application for viewing documents, on page 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 113 on page 156 shows which item to double-click in the ArchiveLink Protocols: Overview of Protocol window. Chapter 8. Configuring your environment for basic tasks 155

170 Figure 113. 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 114 shows which radio button and which icon to click in the ArchiveLink Protocols: Overview of Protocol window. Figure 114. ArchiveLink Protocols: Overview of Protocol window showing which radio button and which icon to click 156 Content Collector for SAP: Configuring for use with Content Manager V8

171 5. In the Communication Type field of the small window that opens, specify OPEN and then click the Continue icon. Figure 115 shows the ArchiveLink Protocols: Overview of Protocol window containing the necessary communication type. Figure 115. 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 116 shows the ArchiveLink Protocols: Overview of Protocol window containing the sample application name. Figure 116. 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: 8.7.4, 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: 8.7.3, Adapting the SAP ArchiveLink protocol for viewing documents, on page 155 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: Chapter 8. Configuring your environment for basic tasks 157

172 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. Note: Type the command exactly as it is shown in the table. Figure 117 shows what the SAP window might look like after you completed step 4a and step 4b Figure 117. 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. 158 Content Collector for SAP: Configuring for use with Content Manager V8

173 The status next to Close window changes to Maintained. Figure 118 shows the Windows SAPGUI OLE automation page with status Maintained for Close window. Figure 118. Windows SAPGUI OLE automation page showing status Maintained for Close window 8.8 Configuring for viewing archived documents with Content Manager eclient By integrating Content Manager eclient into Content Collector for SAP, you can also use the additional features of the eclient, such as adding annotations to the archived documents. Before you begin: 1. Install the eclient extension. For more information, see the corresponding topic 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 viewing Content Manager documents with eclient. 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 Chapter 2, Preparing your environment, on page Chapter 3, Configuring Content Manager for use with Content Collector for SAP, on page , Configuring Collector Server for use with Content Manager, on page , Setting up the connection between Collector Server and SAP through HTTP, on page , Starting Collector Server for the first time, on page 49 Figure 119 on page 160 shows which parts of the Content Collector for SAP environment must be configured so that you can view archived documents with Content Manager eclient. Chapter 8. Configuring your environment for basic tasks 159

174 WebSphere Content Manager eclient SAP GUI eclient extension of Content Collector for SAP SAP ERP Browser ArchiveLink Engine CM agent Content Manager 3 HTTP dispatcher 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 v v Content Manager Enterprise Edition, where the documents to be viewed are stored Collector Server An HTTP connection between Collector Server and SAP To integrate Content Manager eclient, you must change the server configuration profile to establish a connection between eclient and Collector Server. 1. Open the server configuration profile of the Collector Server that you want to use, in a text editor. 2. Specify the fully qualified host name of the server where Content Manager eclient is installed by setting the ECLIENT_URL_PREFIX keyword. For example: ECLIENT_URL_PREFIX /myserver.com:9080/eclient/ Note: ECLIENT_URL_PREFIX is a global keyword. Specified once in the server configuration profile, it is valid for all archives that are enabled for eclient. 3. Add the following line to the ARCHIVE sections of the archives that you want to enable for eclient: ECLIENT_VIEWING YES 4. If you want to connect to eclient by using HTTPS, also add the following line to the ARCHIVE sections of the archives that you want to enable: ECLIENT_PROTOCOL HTTPS 3 = HTTP communication Figure 119. Configuration of your Content Collector for SAP environment for viewing archived documents with Content Manager eclient 160 Content Collector for SAP: Configuring for use with Content Manager V8

175 5. Optional: You can restrict the document types that can be viewed and edited in eclient. Use the following keywords: ECLIENT_INCLUDED_TYPES Specifies which document types can be viewed and edited in eclient. By default, all types are allowed. You can restrict the document types by specifying one or more MIME types, separated by a comma. For example, to specify that only text documents can be viewed or edited in eclient, specify the keyword as follows: ECLIENT_INCLUDED_TYPES text/plain Note: This keyword is a global keyword. Specified once in the server configuration profile, it is valid for all archives that are enabled for eclient. ECLIENT_EXCLUDED_TYPES Specifies the document types that cannot be viewed and edited in eclient. Specify one or more MIME types as in the following example: ECLIENT_EXCLUDED_TYPES application/pdf,text/plain Notes: v This keyword is a global keyword. Specified once in the server configuration profile, it is valid for all archives that are enabled for eclient. v By default, the MIME type application/x-alf is already excluded. 6. Optional: To view or edit a document in eclient, you must log on to Content Manager Enterprise Edition. You can continue to view documents without further authentication until you close the browser. If you do not want to require authentication, add the following global keyword to the server configuration profile: ECLIENT_USER user_id Specify a user ID that is restricted to viewing documents. The user ID applies to all archives that are specified in a server configuration profile and that are enabled for eclient. Important: This keyword can pose a security risk. Archived documents can be viewed without authentication from any computer that is included in the setup. 7. Save the server configuration profile, and restart Collector Server for the changes to take effect. If you specified the ECLIENT_USER keyword in the server configuration profile, take these steps to restart Collector Server: a. Open a command line and change to the instance directory. b. Enter the following command: archpro -f eclientpasswd c. You are prompted for the password. Enter it. The password is stored in the password file. d. Enter archpro to start Collector Server. Chapter 8. Configuring your environment for basic tasks 161

176 8.9 Configuring for searching for and viewing archived documents by using SAP Document Finder You can search for, and view, archived documents by using SAP Document Finder. SAP Document Finder can handle queries that contain more than one search argument. Before you begin: 1. Chapter 2, Preparing your environment, on page 5 2. Chapter 3, Configuring Content Manager for use with Content Collector for SAP, on page , Configuring Collector Server for use with Content Manager, on page , Setting the number of RFC dispatchers, on page , Setting up the connection between Collector Server and SAP through HTTP, on page , Creating an RFC destination, on page 42 Important: When you create the RFC destination, remember to append the number 1 to the ID that you must specify in the Program ID field , Starting Collector Server for the first time, on page 49 SAP Document Finder searches in a document area. A document area corresponds to an item type and determines all of the following: v v v The operating system, the application, and the logical archive where the documents are to be searched The attributes to be used for the search The layout of the result list, which contains the found documents Content Collector for SAP supplies the attributes to SAP. SAP supplies the query classes that refer to the attributes and the display classes. You can use these classes or implement your own. Because you normally do not know in which document area your documents are, you can group several document areas in an aggregated document area. With aggregated document areas, you can search across the document areas and thus in different content repositories or logical archives. Attributes with the same data type and semantics from different document areas do not need the same technical name. However, by configuring SAP Document Finder, you can group the different attributes under one name in an aggregated document area. Figure 120 on page 163 shows which parts of the Content Collector for SAP environment must be configured so that you can use SAP Document Finder. 162 Content Collector for SAP: Configuring for use with Content Manager V8

177 SAP GUI SAP ERP ArchiveLink 2 SAP JCo 3 Java RFC dispatcher Engine CM agent Content Manager 3 HTTP dispatcher Collector Server instance = SAP = archives = Content Collector for SAP = connection information 2 = SAP Document Finder 3 = HTTP communication Figure 120. Configuration of your Content Collector for SAP environment for searching for and viewing documents by using SAP Document Finder 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 stored v Collector Server v An HTTP connection and an RFC connection between Collector Server and SAP To use SAP Document Finder, you must change the server configuration profile and you must create a document area with the SAP GUI. 1. Change the server configuration profile: a. Open the server configuration profile in a text editor. b. Add the ARCHIVETYPE keyword to the ARCHIVE section of the archives that are to be searched and set it to MULTIPART_GENERIC. c. Save the server configuration profile, and restart Collector Server for the changes to take effect. 2. Create a document area in SAP: a. Enter the transaction code SPRO to open the Customizing: Execute Project window. b. Click SAP Reference IMG. c. In the Display IMG window, expand the navigation tree as follows: SAP NetWeaver > Application Server > Basis Services > ArchiveLink > Document Finder Customizing > Register Document Areas. d. Click the IMG - Activity icon in front of Register Document Areas. If a window opens with the message Caution: The table is cross-client., press Enter. Chapter 8. Configuring your environment for basic tasks 163

178 Figure 121 shows the Display IMG window reflecting step 2c on page 163 and step 2d on page 163. Figure 121. Display IMG window showing which item to select in the navigation tree e. In the Change View "ArchiveLink: Document Areas": Overview window, click New Entries. f. In the Document Area field of the New Entries: Details of Added Entries window, type the name of the content repository or logical archive that you defined for the Remote Function Call (RFC) connection. For example, type: A1 g. In the Destination field, specify the name of the RFC destination. For example, type: KD7.ICCSAP h. Optional: Under ArchiveLink: Document Areas, type a description for the document area. i. In the Query Class field, type: CL_ALINK_QUERY j. In the Maximum No. of Hits field, type If you leave this field empty, your result list shows all documents that match the search criteria. k. To enable full-text search, select the FTS Active check box. If you enable full-text search, a field for specifying keywords is displayed in SAP Document Finder. l. Select the Document Area Active check box. m. Click the Save icon. 164 Content Collector for SAP: Configuring for use with Content Manager V8

179 n. 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. o. Click the Continue icon. p. Click the Back icon to return to the Change View "ArchiveLink: Document Areas": Overview window. Figure 122 shows what the New Entries: Details of Added Entries window might look like after you completed step 2f on page 164 through step 2l on page 164 Figure 122. New Entries: Details of Added Entries window containing your specifications The new document area is displayed in the list of document areas in the Change View "ArchiveLink: Document Areas": Overview window 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 Content Manager for use with Content Collector for SAP, on page 21 Chapter 8. Configuring your environment for basic tasks 165

180 4. 4.1, Configuring Collector Server for use with Content Manager, on page , Starting Collector Server for the first time, on page You completed either of the following tasks: v 8.2, Configuring for archiving incoming documents, on page 111 v 8.4, Configuring for linking archived documents to SAP, on page 132 Figure 123 shows which parts of the Content Collector for SAP environment must be configured so that you can transfer index information. Content Collector for SAP clients Utility Client SAP JCo 3 SAP ERP Index transfer enablement package ArchiveLink Engine CM agent Content Manager Collector Server instance = SAP = archives = Content Collector for SAP = connection information Figure 123. 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 Content Manager V8

181 What to do next: You can transfer index information from several SAP business objects to one archived document: 9.12, Enabling a Content Manager archive for links between one document and several SAP business objects, on page 201. Chapter 8. Configuring your environment for basic tasks 167

182 168 Content Collector for SAP: Configuring for use with Content Manager V8

183 Chapter 9. Configuring your environment for additional 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. 9.1 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 27. v You need a browser that complies with HTTP 1.1. In addition, you must configure your browser to use HTTP 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. 9.2 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 27 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. 2011,

184 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. 170 Content Collector for SAP: Configuring for use with Content Manager V8

185 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. 9.4 Securing the connection between Collector Server and SAP HTTPS is a widely used standard for the transfer of private data or confidential data over open networks. With Content Collector for SAP, you can use the HTTPS protocol for the communication between Collector Server and SAP. With HTTPS, you can encrypt data that is sent to, or received by, Collector Server. In addition, you can use HTTPS to prevent unauthorized users from accessing critical data when it is transferred to or from Collector Server. Before you begin: 1. Install the SAP Cryptographic Library. 2. Chapter 2, Preparing your environment, on page 5 3. Chapter 3, Configuring Content Manager for use with Content Collector for SAP, on page , Setting up the connection between Collector Server and SAP through HTTP, on page , Starting Collector Server for the first time, on page 49 Chapter 9. Configuring your environment for additional or advanced tasks 171

186 To enable SAP to use HTTPS for accessing the archives, you can configure the following authentication methods: v v Server authentication. Connecting web browsers check the identity of Collector Server to ensure that data is sent to, or received, from Collector Server. Client authentication. Collector Server checks the identity of the requesting clients to prevent unauthorized clients from accessing Collector Server. This feature is available only in addition to the server authentication. After the configuration of the authentication methods, insecure HTTP connections are still possible. If you want to ensure that all data can be accessed only with an HTTPS connection, you must enforce the use of HTTPS , Configuring the server authentication 2. Optional: 9.4.2, Configuring the client authentication, on page Optional: 9.4.3, Enforcing the use of HTTPS, on page Configuring the server authentication You must configure the server authentication in Content Collector for SAP and in SAP , Configuring server authentication on Collector Server , Configuring the server authentication in SAP, on page Configuring server authentication on Collector Server Create an SSL keystore and a certificate for Collector Server, configure Collector Server for server authentication, and export the certificate to SAP , Creating an SSL keystore and a certificate for Collector Server 2. Optional: , Having the certificate signed by a certificate authority, on page , Enabling Collector Server for the server authentication, on page , Exporting the Collector Server certificate, on page Creating an SSL keystore and a certificate for Collector Server: Use the Java Keytool or the IBM Key Management Utility (IKEYMAN) to create the SSL keystore, the private key, and the public key and to associate the public key with a self-signed certificate. The Java Keytool and IKEYMAN are both delivered with Content Collector for SAP as part of the IBM JRE and have the following fully qualified file names: v The Java Keytool: Linux UNIX InstallHome/java/jre/bin/keytool Windows InstallHome\java\jre\bin\keytool.exe v IKEYMAN: Linux UNIX InstallHome/java/jre/bin/ikeyman Windows InstallHome\java\jre\bin\ikeyman.exe 172 Content Collector for SAP: Configuring for use with Content Manager V8

187 To use IKEYMAN, start the ikeyman program. To use the Java Keytool, take these steps: 1. Open a command line on the system where the Collector Server instance runs. 2. Enter the following command on one line: keytool -genkeypair -keyalg key_algorithm -keysize keysize -sigalg signature_algorithm -alias name -validity number_of_days -keystore ssl_keystore_file key_algorithm Specify the algorithm that is to be used to generate the key pair. Specify RSA. keysize Specify the size of the keys that are to be generated. signature_algorithm Specify the algorithm that is to be used to sign the certificate. Specify SHA256withRSA or SHA512WithRSA. name Specify a name of your choice for the certificate chain and the private key that are created with this command. The name must be unique in the keystore. number_of_days Specify for how many days the certificate is to be valid. ssl_keystore_file Specify a fully qualified file name for the SSL keystore. Tip: Because an SSL keystore is required for each instance of Collector Server, it is good practice to create the SSL keystore in the instance directory. For example, specify: v Linux UNIX /home/iccsapadmin/instance1/security/https/ keystore.jks v Windows C:\Users\iccsapadmin\AppData\Roaming\IBM\iccsap\ instance1\security\https\keystore.jks Example: keytool -genkeypair -keyalg RSA -keysize sigalg SHA256withRSA -alias iccsap_instance1 -validity 365 -keystore /home/iccsapadmin/instance1/security/https/keystore.jks Important: Ensure that your web application server can handle the level of cryptography that you specify for the keys, such as the keysize parameter. To be on the safe side, install the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files on your web application server. 3. Enter a password when you are prompted by this message: Enter keystore password: Chapter 9. Configuring your environment for additional or advanced tasks 173

188 For example, enter: icc4sap 4. Enter an answer for each prompt for your organization information. For example: What is your first and last name? [Unknown]: server_name What is the name of your organizational unit? [Unknown]: Myunit What is the name of your organization? [Unknown]: Myorg What is the name of your City or Locality? [Unknown]: Mycity What is the name of your State or Province? [Unknown]: Mystate What is the two-letter country-code for this unit? [Unknown]: US Is <CN=myserver.com, OU=Myunit, O=Myorg, L=Mycity, ST=Unknown, C=US> correct? [no]: yes Enter key password for server_name (Press Enter if you want to use the same password as for the keystore) For server_name in the first and last prompts, specify the host name or the IP address of Collector Server. A self-signed certificate is created. What to do next: , Having the certificate signed by a certificate authority Having the certificate signed by a certificate authority: A certificate authority might have to sign the self-signed certificate. The signed certificate must have a key algorithm and a signature algorithm that are, by default, enabled in IBM JRE and that are supported by the installed SAP Cryptographic Library. Before you begin: , Creating an SSL keystore and a certificate for Collector Server, on page 172 Complete these steps to have a certificate signed and to include the signed certificate: 1. Open a command line on the system where the Collector Server instance runs. 2. Generate a Certificate Signing Request (CSR) by entering the following command on one line: keytool -certreq -file certreq_file -alias name -keystore ssl_keystore_file For name and ssl_keystore_file, specify the same values as in the keytool -genkeypair command. See step 2 on page 173. For certreq_file, specify the fully qualified file name of the CSR. Example: keytool -certreq -file /home/iccsapadmin/instance1/security/https/certreq.csr -alias iccsap_instance1 -keystore /home/iccsapadmin/instance1/security/https/keystore.jks 3. Enter the keystore password when you are prompted for it. For example, enter icc4sap 174 Content Collector for SAP: Configuring for use with Content Manager V8

189 4. Send the CSR (certreq.csr) to a certificate authority. The certificate authority must return a certificate reply. A certificate reply is a file that contains, as a minimum, the certificate that is signed by the certificate authority. The contents depends on your chain of trust. Assume, for example, that file name of the certificate reply is CA_reply_iccsap.txt and that you stored it in the following directory: /home/iccsapadmin/instance01/security/server_sap 5. Import the certificate reply into the keystore by entering the following command on one line: keytool -importcert -file CA_reply -alias name -keystore ssl_keystore_file -trustcacerts For name and ssl_keystore_file, specify the same values as in step 2 on page 174. For CA_reply, specify the fully qualified path to the certificate reply. Assume, for example, that the file name of the certificate reply is CA_reply_iccsap.txt and that you stored it in the /home/iccsapadmin/instance1/security/https directory. Your command would then look as follows: keytool -importcert -file /home/iccsapadmin/instance1/security/https/ca_reply_iccsap.txt -alias iccsap_instance1 -keystore /home/iccsapadmin/instance1/security/https/keystore.jks -trustcacerts 6. Enter the keystore password when you are prompted for it. For example, enter icc4sap 7. Enter YES if you get the following response:... is not trusted. Install reply anyway? [no]: You get the following final response: Certificate reply was installed in keystore What to do next: , Enabling Collector Server for the server authentication Enabling Collector Server for the server authentication: You must enable Collector Server to use Secure Socket Layer (SSL) and the SSL keystore that you created. Before you begin: , Having the certificate signed by a certificate authority, on page Open the server configuration profile of the Collector Server that you want to use, in a text editor. 2. Turn on SSL support by specifying the port that is to be used for HTTPS connections. For example, type: SSL_WEBPORT Specify the fully qualified file name of the SSL keystore, by using the KEYSTORE_FILE keyword. On Linux and UNIX systems, type, for example: KEYSTORE_FILE /home/iccsapadmin/instance01/security/server_sap/keystore.jks 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: Chapter 9. Configuring your environment for additional or advanced tasks 175

190 archpro -f keystore_passwd c. You are asked for the password. Enter it. The password is stored in the password file. d. Enter archpro to start Collector Server. What to do next: , Exporting the Collector Server certificate Exporting the Collector Server certificate: Use Java Keytool or the IBM Key Management Utility (IKEYMAN) to export the certificate from the SSL keystore. Before you begin: , Enabling Collector Server for the server authentication, on page 175 To use IKEYMAN, start the ikeyman program. To use the Java Keytool, take these steps: 1. Open a command line on the system where the Collector Server instance runs. 2. Enter the following command on one line: keytool -exportcert -file certificate_file -alias name -keystore ssl_keystore_file certificate_file Specify a fully qualified file name for the Collector Server certificate. If you omit the path, the certificate is stored in the current directory. name Specify the name that you assigned to the keystore entry when you created the SSL keystore and the Collector Server certificate. ssl_keystore_file Specify the fully qualified file name of the SSL keystore. Example: keytool -exportcert -file /home/iccsapadmin/instance1/security/https/iccsap_instance1.cer -alias iccsap_instance1 -keystore /home/iccsapadmin/instance1/security/https/keystore.jks What to do next: , Configuring the server authentication in SAP Configuring the server authentication in SAP On each SAP system, you must add the Collector Server certificate to SSL client SSL Client (Standard) Personal Security Environment (PSE). In addition, you must enable the content repositories for HTTPS. Before you begin: v The SSL client SSL Client (Standard) Personal Security Environment (PSE) must exist. v , Configuring server authentication on Collector Server, on page Content Collector for SAP: Configuring for use with Content Manager V8

191 , Importing the Collector Server certificate into SAP , Enabling SSL support for the content repositories, on page Importing the Collector Server certificate into SAP: You must import the Collector Server certificate into various Personal Security Environments (PSEs). 1. In the SAP GUI, enter the transaction code STRUST to open the Trust Manager window. 2. In the navigation pane, double-click SSL client SSL Client (Standard). 3. Under Certificate, click the Import certificate icon. Figure 124 shows which items you must click in the Trust Manager window in step 2 and step 3. Figure 124. Trust Manager window showing which items to click 4. In the File path field of the Import Certificate window, specify the fully qualified file name of the Collector Server certificate that you created, and press Enter. 5. In the Trust Manager window, click. See Figure 124. Chapter 9. Configuring your environment for additional or advanced tasks 177

192 6. Click the Save icon. What to do next: , Enabling SSL support for the content repositories Enabling SSL support for the content repositories: Complete these steps to enable Secure Socket Layer (SSL) support for your content repositories. Before you begin: , Importing the Collector Server certificate into SAP, on page In the SAP GUI, enter the transaction code OAC0 to open the Display Content Repositories: Overview window. 2. Double-click a content repository. For example, double-click LP. 3. In the Display Content Repositories: Detail window, click the Display/Change icon. 4. In the SSL Port Number field, type the value of the SSL_WEBPORT keyword, which you specified when you enabled Collector Server for the server authentication. For example, type: In the field in the toolbar, type: %https Figure 125 on page 179 shows what the Change Content Repositories: Detail window might look like after you completed step 4 and step Content Collector for SAP: Configuring for use with Content Manager V8

193 Figure 125. Change Content Repositories: Detail window containing the necessary entries 6. Press Enter. The following fields become available: v HTTPS on frontend v HTTPS on backend Figure 126 on page 180 shows the Change Content Repositories: Detail window containing these fields. Chapter 9. Configuring your environment for additional or advanced tasks 179

194 Figure 126. Change Content Repositories: Detail window containing the fields HTTPS on frontend and HTTP on backend 7. Select HTTPS required in both fields. Figure 127 shows what the Change Content Repositories: Detail window might look like with your selection. Figure 127. Change Content Repositories: Detail window showing your selection What to do next: 9.4.2, Configuring the client authentication, on page Content Collector for SAP: Configuring for use with Content Manager V8

195 9.4.2 Configuring the client authentication You must export the SAP certificates with the trust manager of SAP and import them into the SSL keystore on Collector Server. In addition, you must enable Collector Server for client authentication. Before you begin: 9.4.1, Configuring the server authentication, on page , Exporting the SAP certificate , Importing the SAP certificate into the SSL truststore, on page , Enabling Collector Server for the client authentication, on page Exporting the SAP certificate You must export the certificate from the SSL client SSL Client (Standard) Personal Security Environment (PSE). 1. In the SAP GUI, enter the transaction code STRUST to open the Trust Manager window. 2. In the navigation pane, double-click SSL client SSL Client (Standard). 3. Under Own Certificate, double-click the certificate in the Owner field. The certificate is displayed under Certificate. 4. Under Certificate, click the Export certificate icon Figure 128 on page 182 shows which items you must click in the Trust Manager window in step 2 through step 4. Chapter 9. Configuring your environment for additional or advanced tasks 181

196 Figure 128. Trust Manager window showing which items to click 5. In the File path field of the Export Certificate window, specify a fully qualified file name for the SAP certificate. 6. Click Base64 as file format. Then, press Enter. 7. In the SAP GUI Security window, click Allow. What to do next: , Importing the SAP certificate into the SSL truststore Related information Configuring the SAP Application Server for Using SSL SAP Application Server notes and Importing the SAP certificate into the SSL truststore You must import the SSL client SSL Client (Standard) certificate into the SSL truststore on Collector Server. You use Java Keytool or the IBM Key Management Utility (IKEYMAN) for this task. Before you begin: , Exporting the SAP certificate, on page 181 To use IKEYMAN, start the ikeyman program. To use the Java Keytool, take these steps: 1. Copy the exported SAP certificate to the system where Collector Server runs. 2. Open a command line on the system where the Collector Server instance runs. 182 Content Collector for SAP: Configuring for use with Content Manager V8

197 3. Enter the following command on one line: keytool -importcert -file certificate_file -alias name -keystore ssl_truststore_file certificate_file Specify the fully qualified file name of the SAP certificate. name Specify a name of your choice for the certificate. The name must be unique in the truststore that is to contain the certificate. truststore_name Specify a fully qualified file name for the SSL truststore. Tip: Because an SSL truststore must not be shared by several instances of Collector Server, it is good practice to create the truststore in the instance directory. For example, specify: v Linux UNIX /home/iccsapadmin/instance1/security/https/ truststore.jks v Windows C:\Users\iccsapadmin\AppData\Roaming\IBM\iccsap\ instance1\security\https\truststore.jks Example: keytool -importcert -file /home/iccsapadmin/sapsystem1.cer -alias sapsystem1 -keystore /home/iccsapadmin/instance1/security/https/truststore.jks What to do next: , Enabling Collector Server for the client authentication Enabling Collector Server for the client authentication You must enable Collector Server to use the SAP certificates. Before you begin: , Importing the SAP certificate into the SSL truststore, on page Open the server configuration profile of the Collector Server for which you want to secure the communication, in a text editor. 2. Set the SSL_CLIENTAUTH keyword to YES: SSL_CLIENTAUTH YES 3. Specify the fully qualified file name of the SSL truststore, which contains the trusted SAP certificates, by using the TRUSTSTORE_FILE keyword. On Linux and UNIX systems, type, for example: TRUSTSTORE_FILE /home/iccsapadmin/instance01/security/server_sap/truststore.jks 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 truststore_passwd c. You are asked for the password. Enter it. The password is stored in the password file. Chapter 9. Configuring your environment for additional or advanced tasks 183

198 d. Enter archpro to start Collector Server. What to do next: 9.4.3, Enforcing the use of HTTPS Enforcing the use of HTTPS After the configuration of server authentication, client authentication, or both authentication methods, insecure HTTP requests are still processed. You can disable the processing of HTTP requests for specific archives only, or you can disable the processing of all HTTP requests. Before you begin: 9.4.2, Configuring the client authentication, on page Open the server configuration profile of the Collector Server for which you want to secure the communication, in a text editor. 2. If you want to disable the processing of HTTP requests for specific archives only, add the following keyword to the ARCHIVE section of all archives that you want to protect in this way: SSL YES Assume, for example, that all clients must use HTTPS to access the Content Manager Enterprise Edition archives A1 and A2. Then your archive statements would look like the following example: ARCHIVE A1 STORAGETYPE CM LIBSERVER LIBSCM ITEM_TYPE MAIL CMUSER CSTORE SSL YES ARCHIVE A2 STORAGETYPE CM LIBSERVER LIBSCM ITEM_TYPE DOCS CMUSER CSTORE SSL YES 3. If you want to avoid that Collector Server receives any HTTP requests, disable the TCP/IP port that accepts HTTP requests by setting the WEBPORT keyword as follows: WEBPORT 0 Note: It is not sufficient to remove the WEBPORT keyword from the server configuration profile because this keyword has a default value of Save the server configuration profile, and restart Collector Server for the changes to take effect. 9.5 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 27 Each instance must have its own instance directory and its own server configuration profile. 184 Content Collector for SAP: Configuring for use with Content Manager V8

199 , Creating additional instance directories , Configuring the server configuration profiles for the instances , Assigning fixed ports to the client dispatchers, on page Creating additional instance directories Each instance of Collector Server requires its own instance directory. 1. Create a folder for each additional instance. 2. Copy the content of the instance folder to each new instance folder. Note: Ensure that the same port number is not specified several times. If you also copy the password file (default name: archint.cfg), this file is updated the first time you start the new Collector Server instance. What to do next: 9.5.2, 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: 9.5.1, Creating additional instance directories 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. 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, on page 186. Chapter 9. Configuring your environment for additional or advanced tasks 185

200 9.5.3 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, 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. 9.6 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. 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, you can omit the -i parameter. 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 186 Content Collector for SAP: Configuring for use with Content Manager V8

201 9.6.2 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: v In the command prompt that you opened as administrator, enter the following command: archservice start -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, you can omit the -i parameter. 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 -i profile 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 -i profile 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, you can omit the -i parameter. 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. Chapter 9. Configuring your environment for additional or advanced tasks 187

202 3. Repeat step 2 on page 187 for each instance of Collector Server that you want to install as a service , Assigning fixed ports to the client dispatchers, on page 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 it. 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 Collector Server cannot verify that the paths are available, it does not start. 9.7 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 27 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. 188 Content Collector for SAP: Configuring for use with Content Manager V8

203 Port_2 The port of this other instance. Server_3 The name or IP address of a third instance of Collector Server. 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. 9.8 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. Chapter 9. Configuring your environment for additional or advanced tasks 189

204 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. 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: 190 Content Collector for SAP: Configuring for use with Content Manager V8

205 v v v v Except for the file name extension, the file name of the input file is identical to the file name of the extended input file. The extended input file has always the extension.input. The name of the input file is included as the first file name in the [Data] section of the extended input file. 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: Chapter 9. Configuring your environment for additional or advanced tasks 191

206 Parameter Description Mandatory or optional File The name of the output file that contains the document and that is created by the preprocessor. Mandatory DocType [INDEX] section 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 index_field=index_value Mandatory if different from the input file 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. You can specify one file name only. 192 Content Collector for SAP: Configuring for use with Content Manager V8

207 Parameter Description Mandatory or optional documenttype The MIME type of the document after it is changed by the preprocessor. Mandatory if different from the input file indexvalues The list of attributes that are returned by the preprocessor in the format attribute_name=attribute_value Optional 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 Content Manager, on page , Setting up the connection between Collector Server and SAP through HTTP, on page , Starting Collector Server for the first time, on page 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 mime_type The MIME type of the documents that are to be processed. exec The fully qualified file name of the executable file that is to process the documents of the specified MIME type. Chapter 9. Configuring your environment for additional or advanced tasks 193

208 v Example: PREPROC_MIMETYPE PREPROC_EXEC image/tiff 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 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. 9.9 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: 194 Content Collector for SAP: Configuring for use with Content Manager V8

209 DESTINATION KD7 MSHOST sapmskd7 GROUP mygroup R3NAME KD7 LOGICAL_SYSTEM T90CLNT090 CLIENT 800 USER CPICUser1 LOGICAL_SYSTEM T90CLNT091 CLIENT 801 USER CPICUser2 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 Content Manager Enterprise Edition. 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 8.2.2, Configuring for archiving incoming documents by processing their bar codes, on page 129. 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. 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 Chapter 9. Configuring your environment for additional or advanced tasks 195

210 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. 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 129 on page 197 shows what the IBM Content Collector for SAP Applications - Document Import window might look like after you completed step 3 on page 195 through step Content Collector for SAP: Configuring for use with Content Manager V8

211 Figure 129. IBM Content Collector for SAP Applications - Document Import window showing the sample settings and the default settings 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. 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 have been archived in order to be linked. The default start date is The default end date is Chapter 9. Configuring your environment for additional or advanced tasks 197

212 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. l. In the FNERROR field, the fully qualified file name of 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 130 on page 199 shows what the IBM Content Collector for SAP Applications - Document Import window might look like after you completed step 2b on page 197 through step 2m. 198 Content Collector for SAP: Configuring for use with Content Manager V8

213 Figure 130. 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 on page , Linking documents that are not archived yet by using the Cold program, on page 195. Create a link for each document in the SAP print-list tables by completing step 2 on page 195 through step 12 on page 196. The documents are now accessible from the SAP GUI Associating SAP document classes to MIME types Content Manager eclient must know the MIME type of a document to be able to display a document correctly. You can view most archived SAP documents without further configuration because an internal list already contains the required mappings of SAP. However, you can add missing mappings Overview of the mappings of SAP document classes to MIME types An internal list contains the required mappings of SAP document classes to MIME types. The following table provides an overview of these mappings. SAP document class MIME type * text/x-doctype 123 application/vnd.lotus123 alf application/x-alf Chapter 9. Configuring your environment for additional or advanced tasks 199