Sei sulla pagina 1di 192

IBM Content Collector for SAP Applications 

Configuring Content Collector for SAP for


use with IBM Tivoli Storage Manager: Best
practices
Version 3 Release 0
IBM Content Collector for SAP Applications 

Configuring Content Collector for SAP for


use with IBM Tivoli Storage Manager: Best
practices
Version 3 Release 0
Note
Before using this information and the product it supports, read the information in “Notices” on page 171.

Second edition (July 2013)


This edition applies to version 3, release 0, modification 0 of IBM Content Collector for SAP Applications (product
number 5725-B46) and to all subsequent releases and modifications until otherwise indicated in new editions.
Technical changes and major changes to the text since the previous edition are indicated by a vertical bar (|) to the
left of each new or changed line of information.
© Copyright IBM Corporation 2010, 2013.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
About this information . . . . . . . . v Enabling Collector Server to connect to SAP . . 47
Intended audience . . . . . . . . . . . . v Starting Collector Server for the first time . . . . 49
Terminology and conventions used in this Stopping Collector Server. . . . . . . . . . 51
information. . . . . . . . . . . . . . . v
Screen captures . . . . . . . . . . . . . vi Chapter 5. Configuring Archiving Client 53
How to send your comments . . . . . . . . vi Setting up Archiving Client . . . . . . . . . 54
Defining the connection to Collector Server. . . 54
What’s new in the second edition . . . vii Specifying the directory for the temporary files 56
Loading the modules for the queues . . . . . 56
Chapter 1. General information . . . . . 1 Specifying the number of bar codes in a batch job 56
Sending the document format of the queues to
Default location of installed files and of files created
SAP . . . . . . . . . . . . . . . . 57
at run time . . . . . . . . . . . . . . . 1
Enabling logging and tracing for Archiving Client 58
Completing the setup of Archiving Client . . . 59
Chapter 2. Preparing your environment 3 Managing the queues . . . . . . . . . . . 59
Preparing your environment for Collector Server . . 3 Creating queues . . . . . . . . . . . . 60
Preparing your environment for Collector Server Saving and reusing the queue information . . . 71
on Linux or UNIX . . . . . . . . . . . 3 Viewing and changing the properties of a queue 72
Preparing your environment for Collector Server Viewing the connection between Archiving Client
on Windows . . . . . . . . . . . . . 4 and the Collector Servers . . . . . . . . . 73
Configuring your environment for Tivoli Storage Deleting a queue . . . . . . . . . . . 74
Manager . . . . . . . . . . . . . . . . 4 Adding or removing SAP document formats . . 74
Setting up a basic SAP system . . . . . . . . 5 Enabling Collector Server to use Archiving Client . 75
Creating a user with CPIC access . . . . . . 5
Linking a logical system to the SAP client . . . 15
Chapter 6. Configuring Viewing Client 77
Defining a number range for SAP ArchiveLink 17
Setting up Viewing Client . . . . . . . . . 77
Defining the connection to Collector Server. . . 78
Chapter 3. Configuring Tivoli Storage Specifying the directory for temporary files. . . 79
Manager for use with Content Collector Specifying a viewer application. . . . . . . 80
for SAP . . . . . . . . . . . . . . 19 Enabling logging and tracing for Viewing Client 81
Registering a Tivoli Storage Manager node with Enabling the closing of applications . . . . . 82
Content Collector for SAP . . . . . . . . . 19 Completing the setup of Viewing Client . . . . 83
Creating a management class . . . . . . . . 19 Enabling Collector Server to use Viewing Client . . 83
Creating an archive copy group . . . . . . . 20
Validating and activating the STANDARD policy set 21 Chapter 7. Configuring your
Setting the password options . . . . . . . . 21 environment for basic tasks . . . . . 85
Configuring a connection to a remote Tivoli Storage Configuring for archiving data . . . . . . . . 85
Manager server . . . . . . . . . . . . . 22 Setting up the sample archiving object FI_BANKS 86
Configuring the SAP ArchiveLink path . . . . 88
Chapter 4. Configuring Collector Server 25 Checking your data archiving configuration . . 92
Configuring Collector Server for use with Tivoli Creating test data for the sample archiving object 94
Storage Manager . . . . . . . . . . . . 25 Running an archiving session to test your
Server configuration profile: General information archiving setup . . . . . . . . . . . . 95
and structure . . . . . . . . . . . . . 26 Configuring for archiving data by using BC-ILM . . 99
Creating a server configuration profile for Tivoli Creating a user for ILM-enabled data archiving 101
Storage Manager . . . . . . . . . . . 30 Enabling Collector Server for data archiving by
Creating client options files . . . . . . . . 33 using BC_ILM . . . . . . . . . . . . 105
Configuring the connection between Collector Creating a root collection in the empty Tivoli
Server and SAP . . . . . . . . . . . . . 34 Storage Manager archive . . . . . . . . 105
Setting the number of Java RFC dispatchers . . 35 Creating a destination in XML Data Archiving
Setting up the connection between Collector Service (XML DAS) . . . . . . . . . . 106
Server and SAP through HTTP . . . . . . . 35 Creating an archive store in XML Data
Setting up the connection between Collector Archiving Service (XML DAS) . . . . . . . 108
Server and SAP through Remote Function Call
(RFC) . . . . . . . . . . . . . . . 41

© Copyright IBM Corp. 2010, 2013 iii


Configuring the connection between SAP Web Enabling caching of retrieved documents . . . . 155
Application Server ABAP and XML Data Setting timeout periods for the RFC or Java RFC
Archiving Service (XML DAS) . . . . . . . 109 dispatcher and the agents . . . . . . . . . 156
Creating the home paths for the archiving Setting the timeout period for the RFC or Java
objects in the Tivoli Storage Manager archive . . 112 RFC dispatcher . . . . . . . . . . . . 156
Assigning the home paths to the archive store 114 Setting the timeout period for the agents . . . 157
Configuring for archiving incoming documents . . 114 Creating several instances of Collector Server. . . 157
Configuring for archiving incoming documents Creating more instance directories . . . . . 157
by creating work items in an SAP workflow . . 115 Configuring the server configuration profiles for
Configuring for archiving incoming documents the instances . . . . . . . . . . . . 158
by processing their bar codes . . . . . . . 132 Assigning fixed ports to the instances . . . . 158
Configuring for archiving outgoing documents . . 134 Running Collector Server as a service . . . . . 160
Configuring for archiving and viewing print lists 134 Installing Collector Server as a service and
Defining an archive device . . . . . . . . 135 uninstalling the service . . . . . . . . . 160
Associating the document type of the print lists Starting and stopping the service . . . . . . 160
with an SAP workflow . . . . . . . . . 137 Running several instances of Collector Server as
Creating an SAP ArchiveLink batch job. . . . 137 services . . . . . . . . . . . . . . 161
Enabling extended ALF viewing . . . . . . 140 Hints and tips . . . . . . . . . . . . 161
Enabling print-list viewing . . . . . . . . 142 Configuring for viewing documents from several
Configuring for viewing archived documents with SAP systems. . . . . . . . . . . . . . 162
the SAP GUI . . . . . . . . . . . . . 143 Configuring for preprocessing outgoing documents 163
Configuring for viewing archived documents with The preprocessor user exit . . . . . . . . 163
an external viewer application. . . . . . . . 144 Requirements for running a preprocessor . . . 163
Registering Viewing Client with SAP . . . . 145 Including the preprocessors in the archiving
Creating an SAP ArchiveLink application for process . . . . . . . . . . . . . . 167
viewing documents . . . . . . . . . . 147 Enabling Collector Server to log on to an SAP
Adapting the SAP ArchiveLink protocol for logon group . . . . . . . . . . . . . . 168
viewing documents . . . . . . . . . . 149 Configuring for storing documents in more than
Configuring an SAP ArchiveLink application for one Tivoli Storage Manager archive . . . . . . 169
closing viewer applications . . . . . . . . 151 Integrating Content Collector for SAP into the SAP
Solution Manager . . . . . . . . . . . . 170
Chapter 8. Configuring your
environment for more or advanced Notices . . . . . . . . . . . . . . 171
tasks . . . . . . . . . . . . . . . 155
Preventing the storage of web content in the Index . . . . . . . . . . . . . . . 175
browser cache . . . . . . . . . . . . . 155

iv Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
About this information
This book shows how to configure IBM® Content Collector for SAP Applications
for use with IBM Tivoli® Storage Manager. For better guidance, it includes screen
captures of the Content Collector for SAP windows and the SAP windows.

Intended audience
This book is intended for administrators who are responsible for configuring IBM
Content Collector for SAP Applications.

Administrators should have an in-depth knowledge of SAP and the archives that
they intend to use. It is assumed that they are familiar with the three-tier
architecture of SAP and that they have a basic understanding of document
management and the archives. In addition, they should have a good working
knowledge of the underlying operating system.

This book also addresses programmers who must create customized archive clients,
and who must therefore familiarize themselves with the concepts of IBM Content
Collector for SAP Applications and SAP so that they can modify and extend
sample code.

Terminology and conventions used in this information


To facilitate reading, product names are abbreviated in this information, where
applicable. In addition, you might have changed the names of specific files and
paths when you installed IBM Content Collector for SAP Applications Version 3.0.
The default names are shown in this section.
v IBM Content Collector for SAP Applications Version 3.0 is abbreviated to Content
Collector for SAP.
v The following path variables are used in this information, listed in alphabetical
order:
Windows env_var_appdata
The full path to the directory that contains the application-specific files
for a user. To determine the path, open a command prompt and enter
the following command:
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
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%

© Copyright IBM Corp. 2010, 2013 v


UserHome
The full path to the directory that contains the files for a user.
v Archiving is a process where data, documents, or print lists are stored in Tivoli
Storage Manager and are linked to an SAP business object for future retrieval.
v A basic environment consists of the SAP GUI, the Collector Server of Content
Collector for SAP, and Tivoli Storage Manager.

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 Tivoli
Storage Manager 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.

How to send your comments


Your feedback is important in helping to provide the most accurate and
high-quality information.

You can use any of the following methods to provide comments:


v Go to the Information Management Reader Comment Form home page at
https://www14.software.ibm.com/webapp/iwm/web/signup.do?lang=en_US
&source=swg-rcf
There, you find the feedback page where you can enter and submit your
comments.
v Send your comments by email to swsdid@de.ibm.com. Include the name of the
product, the version number of the product, and the name and publication
number of the information, if applicable. If you are commenting on specific text,
include the location of the text (for example, a title, a table number, or a page
number).
v Complete one of the forms at the back of this book and mail it, send it by fax, or
give it to an IBM representative.

vi Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
What’s new in the second edition
This edition includes the following updates:
v When you issue the archadmin, archcert, archpro, archservice, or archstop
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 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.

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.

© Copyright IBM Corp. 2010, 2013 vii


viii Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 3
2. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.
3. Chapter 4, “Configuring Collector Server,” on page 25

After you complete these steps, decide which task you want to perform with
Content Collector for SAP and go to the appropriate configuration topic under
Chapter 7, “Configuring your environment for basic tasks,” on page 85. 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.

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
Default location on Linux Default location on
File and UNIX systems Windows
archint_sample_tsm.ini InstallHome/server/bin InstallHome\Server\
instances\instance01
Example of a server
configuration profile.
CSClient_sample.ini Not applicable. env_var_appdata\IBM\ICCSAP

Example of a client env_var_appdata stands for


configuration profile. the directory that contains
the application-specific files
for the user who installed
Archiving Client or Viewing
Client.
csmimes.properties InstallHome/server/bin InstallHome\Server\
instances\instance01
Maps the document format of
the archived documents to
MIME types so that SAP can
display the document content
correctly.

© Copyright IBM Corp. 2010, 2013 1


Table 1. Installed files (continued)
Default location on Linux Default location on
File and UNIX systems Windows
ArchcheckApiSample.java InstallHome InstallHome

Contains a sample program for


calling the archcheck Java™
API.

Table 2. Files that are created at run time


Default location on Linux Default location on
File and UNIX systems Windows
archint.cfg Instance path as set by the Instance path as set by the
INSTANCEPATH keyword in INSTANCEPATH keyword in
Default password file. It your server configuration your server configuration
contains all passwords that a profile profile
Collector Server instance needs
to communicate with the
Content Collector for SAP
clients, SAP, and the archives.

It is created when you start


Collector Server for the first
time.

2 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 Tivoli Storage Manager, Content Collector for SAP,
and any additional programs.

Procedure:
1. “Preparing your environment for Collector Server”
2. “Configuring your environment for Tivoli Storage Manager” on page 4
3. “Setting up a basic SAP system” on page 5

Preparing your environment for Collector Server


Content Collector for SAP requires at least one instance of Collector Server.

Before you begin: Plan for a secure Collector Server. For more information, see the
corresponding topic in the Planning part of the information center or of IBM
Content Collector for SAP Applications: Installation, Configuration, and User's
Guide, SH12-6989.

Preparing your environment for Collector Server on Linux or


UNIX
Create an instance user and an instance directory that is to contain all
instance-related files.

Procedure:
1. Create a user for a Collector Server instance. For example, create user
iccsapadmin.
2. Log on as the Collector Server instance user.
3. Add the following call of the shell script to the .profile file, which is in the
home directory of the instance user:
. InstallHome/server/bin/csenv.sh
Note the space between the period (.) and InstallHome.
4. Create an instance directory where all instance-related files are to be stored, in
the UserHome directory. For example:
/home/iccsapadmin/instance01
The instance user must have full permissions for this directory.
Make a note of the path to this directory. You must specify this path for the
INSTANCEPATH keyword in the server configuration profile when you configure
Collector Server for use with Tivoli Storage Manager.
| 5. In the instance directory, create a directory named SAPCertificates. The SAP
| certificates for the archives are stored in this directory.

| Important: The directory name is case-sensitive.


6. In the instance directory, create a directory named queue. Instead of creating the
queue directory, you can add the QUEUEPATH keyword to the server configuration

© Copyright IBM Corp. 2010, 2013 3


profile and specify a path to an existing directory for it. You can add the
keyword when you configure Collector Server for use with Tivoli Storage
Manager.

Hint: If you expect many queues, use the QUEUEPATH keyword.

What to do next: “Configuring your environment for Tivoli Storage Manager”

Preparing your environment for Collector Server on Windows


After you install Collector Server, a Collector Server instance is already set up in
the InstallHome\Server\instances\instance01 directory. If you want to start
Collector Server as a user without administrator rights, you must create an
instance directory in a directory other than the Program Files directory.

Complete the following steps to configure an instance:


1. Create the instance directory. It is good practice to create the instance directory
in the env_var_appdata directory of the user who is allowed to start Collector
Server. For example:
C:\Users\iccsapadmin\AppData\Roaming\IBM\ICCSAP\instance01
2. Make a note of the path to the new instance directory. You must specify this
path for the INSTANCEPATH keyword in the server configuration profile when
you configure Collector Server for use with Tivoli Storage Manager.
| 3. In the instance directory, create a directory named SAPCertificates. The SAP
| certificates for the archives are stored in this directory.
4. In the instance directory, create a directory named queue. Instead of creating the
queue directory, you can add the QUEUEPATH keyword to the server configuration
profile and specify a path to an existing directory for it. You can add the
keyword when you configure Collector Server for use with Tivoli Storage
Manager.

Hint: If you expect many queues, use the QUEUEPATH keyword.

What to do next: “Configuring your environment for Tivoli Storage Manager”

Configuring your environment for Tivoli Storage Manager


You must configure specific environment variables so that the Tivoli Storage
Manager API clients can locate certain files.

Before you begin: “Preparing your environment for Collector Server” on page 3

Proceed as follows:
v Set the DSMI_CONFIG environment variable to the fully qualified path to the
empty client option file dsm.opt. Examples:
– Linux UNIX If you saved the file to the /opt/ibm/cssap/server/
client_opt directory, specify the environment variable as follows:
DSMI_CONFIG=/opt/ibm/iccsap/server/client_opt/dsm.opt
– WindowsIf you saved the file to the C:\Program Files\IBM\ICCSAP\Server\
client_opt directory, specify the environment variable as follows:
DSMI_CONFIG=C:\Program Files\IBM\ICCSAP\Server\client_opt\dsm.opt
v Set the DSMI_DIR environment variable to the following path:

4 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
– Linux UNIX /usr/tivoli/tsm/client/api/bin64. The environment
variable must point to the bin64 directory. It must not point to the bin
directory.
– Windows The path where the Tivoli Storage Manager message file dscenu.txt
is stored.
v Set the DSMI_LOG environment variable to the directory where the Tivoli Storage
Manager error log dsmerror.log is stored.
v Set the PATH environment variable to the directory where the Tivoli Storage
Manager API DLLs are stored.

What to do next: “Setting up a basic SAP system”

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: “Configuring your environment for Tivoli Storage Manager” on
page 4

Procedure:
1. “Creating a user with CPIC access”
2. “Linking a logical system to the SAP client” on page 15
3. “Defining a number range for SAP ArchiveLink” on page 17

Creating a user with CPIC access


Create a user in the SAP client that you want to use with Content Collector for
SAP.

This topic shows how to create the sample user CPICUSER1 in SAP client 800.

Procedure:
1. In the SAP GUI, enter the transaction code SU01 to open the User Maintenance:
Initial Screen window.
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 6 shows the User Maintenance: Initial Screen window
containing the sample user name CPICUSER1.

Chapter 2. Preparing your environment 5


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 Tivoli Storage Manager.
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.

6 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 6.

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 8 shows the Profiles page of the Maintain User window
containing the necessary authorizations for sample user CPICUSER1.

Chapter 2. Preparing your environment 7


Figure 4. Profiles page of the Maintain User window containing the necessary authorizations
for sample user CPICUSER1

d. Click the Save icon to save your settings.


v 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 “Linking a logical system to the SAP client” on page 15

Restricting the access of the CPIC user


Instead of giving the CPIC user access to the entire SAP system, you can give the
CPIC user only those authorizations that are needed to archive, link, and view
data, print lists, and documents.

Creating a role and a profile for the CPIC user:

You must create a role for the CPIC user. In addition, you must create a profile
where you specify the necessary authorizations.

This topic shows how to create sample ICCSAP_USER.

Procedure:
1. In the SAP GUI, enter the transaction code PFCG to open the Role Maintenance
window.
2. In the Role field, type a name for the role.
For example, type:
ICCSAP_USER

8 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 10 shows the Change Roles window containing the
generated profile name and description. You can change the description.

Chapter 2. Preparing your environment 9


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 7.
9. 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 11 shows the “Manual selection of authorizations” window
containing the necessary authorizations.

10 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 11


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 13 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

12 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 11. “Change role: Authorizations” window after activating all authorizations

14. Click the Save icon to save your settings.

15. Click the Generate icon to create the role and thus the profile.

What to do next: “Assigning the role to the CPIC user”

Assigning the role to the CPIC user:

You must assign the role, including the profile, to the CPIC user.

This topic shows how to assign sample role ICCSAP_USER to the sample user
CPICUSER1.

Procedure:
1. In the SAP GUI, enter the transaction code SU01 to open the User Maintenance:
Initial Screen window.
2. In the User field, specify the name of the CPIC user to which you want to
assign the role.
For example, type
CPICUSER1
3. Click the Change icon .
4. In the Maintain User window, click the Roles tab.
5. In the Role column of the Role Assignments table, specify the name of the role
that you want to assign and press Enter.
For example, type:
ICCSAP_USER
Figure 12 on page 14 shows the Roles page of the Maintain User window
containing the specified role.

Chapter 2. Preparing your environment 13


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-E6550422 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

14 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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: “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: “Creating a user with CPIC access” on page 5

Procedure:
1. In the SAP GUI, enter the transaction code BD54 to open the Change View
"Logical Systems": Overview window. If a window opens with the message
Caution: The table is cross-client., press Enter.
2. If the table already contains logical systems, you can use one of them. If you
want to use an existing logical system, continue with 4 on page 16.

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 Tivoli Storage Manager.
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 16 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 15


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 17 shows the Display View "Clients": Overview window
containing your selection in step 4d.

16 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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: “Defining a number range for SAP ArchiveLink”

Defining a number range for SAP ArchiveLink


Define a range 0000000001–9999999999 for SAP ArchiveLink, if this interval does
not exist yet.

Before you begin: “Linking a logical system to the SAP client” on page 15

Procedure:
1. In the SAP GUI, enter the transaction code OANR to open the “SAP ArchiveLink
Number range” window.

2. Click the Change Intervals icon .


Figure 16 on page 18 shows the Maintain Number Range Intervals window
containing the required interval.

Chapter 2. Preparing your environment 17


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:
0000000001
3) In the To number column, type:
9999999999
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 16.

4. Click the Save icon to save your settings.

What to do next: Chapter 3, “Configuring Tivoli Storage Manager for use with
Content Collector for SAP,” on page 19

18 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Chapter 3. Configuring Tivoli Storage Manager for use with
Content Collector for SAP
Configure Tivoli Storage Manager. If the Tivoli Storage Manager server and
Collector Server are not installed on the same computer, you must also configure a
connection between the two servers.

If you use tape drives or optical disks for archiving, you must complete extra steps
to configure the Tivoli Storage Manager server for the chosen storage media. For
details about the additional configuration steps, see the Tivoli Storage Manager
Information Center.

Procedure:
1. “Registering a Tivoli Storage Manager node with Content Collector for SAP”
2. “Creating a management class”
3. “Creating an archive copy group” on page 20
4. “Validating and activating the STANDARD policy set” on page 21
5. “Setting the password options” on page 21
6. “Configuring a connection to a remote Tivoli Storage Manager server” on page
22

Registering a Tivoli Storage Manager node with Content Collector for


SAP
Complete these steps to register a Tivoli Storage Manager node with Content
Collector for SAP.
1. From a command line, change to the directory where the dsmadmc program is
installed.
2. Enter dsmadmc to start the command-line interface for administering the Tivoli
Storage Manager server.
3. Log on with the user ID and the password of an administrator. The initial user
ID and the initial password are both admin. After a successful logon, the
following information is displayed: tsm: <NODE>
4. Enter the following command to register a new node with Content Collector for
SAP:
register node name password archdel=yes
name is the name of the new node. password is the password that is used to log
on to that node. archdel=yes specifies that the node can be deleted.

What to do next: “Creating a management class”

Creating a management class


Create a Tivoli Storage Manager management class that Collector Server can use to
archive the documents.

Before you begin: “Registering a Tivoli Storage Manager node with Content
Collector for SAP”

© Copyright IBM Corp. 2010, 2013 19


Enter the following command to create a management class:
define mgmtclass standard standard class_name

class_name is the name of the new management class, for example, R3DOCS. It can
be up to 16 characters long. The additional parameters standard standard specify
that the management class is to be created in the STANDARD policy domain, by
using the STANDARD policy set.

What to do next: “Creating an archive copy group”

Creating an archive copy group


Create a Tivoli Storage Manager archive copy group for use by Content Collector
for SAP.

Before you begin: “Creating a management class” on page 19

Proceed as follows:

Enter either of the following commands to create an archive copy group:


v For regular archiving, where SAP NetWeaver is connected to document
management systems by using SAP ArchiveLink (BC-AL) or by using an HTTP
protocol (BC-HCS), enter the following command:
define copygroup standard standard class_name
type=archive dest=diskpool
serialization=static
retver=nolimit
v For data archiving by using the WebDAV Storage Interface for SAP NetWeaver
Information Lifecycle Management (BC-ILM), enter the following command:
define copygroup standard standard class_name
type=archive dest=diskpool
retver=0 retinit=event retmin=0
class_name is the name of the management class that you previously created.
Explanation of the parameters:
standard
Uses the STANDARD policy domain.
standard
Uses the STANDARD policy set.
type=archive
Creates an archive copy group as opposed to a backup copy group.
destination=diskpool
Uses DISKPOOL (hard disks) as the primary storage pool.
retver=nolimit | 0
nolimit means that there is no restriction regarding the number of days that a
file is kept in the copy group. Files stay in the copy group indefinitely. 0 means
that the objects in the copy group can be deleted immediately after the
retention period ends. This setting is required for BC-ILM archives.
serialization=static
Makes sure that Tivoli Storage Manager archives a file only if it is not currently
modified. Tivoli Storage Manager attempts to archive a file only once.

20 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
retinit=event
Specifies that the retention time for the archived data is initiated by an
application that uses API function calls. This setting is required for BC-ILM
archives.
retmin=0
Sets the minimum number of days to retain an archive object to 0. This setting
is required for BC-ILM archives.

What to do next: “Validating and activating the STANDARD policy set”

Validating and activating the STANDARD policy set


Make sure that no configuration errors occurred and then validate and activate the
STANDARD policy set.

Before you begin: “Creating an archive copy group” on page 20

Procedure:
1. Validate the STANDARD policy set by entering the following command:
validate policyset standard standard

If the validation was successful, a message like this one is displayed: ANR1515I
Policy set STANDARD validated in domain STANDARD (ready for activation).
2. Activate the policy set by entering the following command:
activate policyset standard standard

You receive a response like this one: ANR1514I Policy set STANDARD activated
in policy domain STANDARD.
3. To leave the dsmadmc program, enter quit.

What to do next: “Setting the password options”

Setting the password options


Tivoli Storage Manager offers different options for handling passwords. You must
specify, in several files, the settings for the password options that Content Collector
for SAP supports.

Before you begin: “Validating and activating the STANDARD policy set”

Content Collector for SAP supports the following password options:


v PASSWORDACCESS PROMPT
v PASSWORDACCESS GENERATE

The following table shows the settings that you must add to the appropriate files
when you configure Collector Server for use with Tivoli Storage Manager:

PASSWORDACCESS PROMPT PASSWORDACCESS GENERATE


dsm.sys or client SERVERNAME server_name SERVERNAME server_name
options file PASSWORDACCESS PROMPT PASSWORDACCESS GENERATE
NODENAME node_name

Chapter 3. Configuring Tivoli Storage Manager for use with Content Collector for SAP 21
PASSWORDACCESS PROMPT PASSWORDACCESS GENERATE
server ARCHIVE archive_id ARCHIVE archive_id
configuration STORAGETYPE TSM STORAGETYPE TSM
profile SERVER server_name SERVER server_name
MGMT_CLASS management_class MGMT_CLASS management_class
ADSMNODE node_name

Notes:
v Specify the node in either the client options file or the server configuration
profile. Do not specify the node in both files.
v The use of the PASSWORDACCESS PROMPT option presupposes that you specified a
password for the Tivoli Storage Manager node to which the option relates. You
must specify this password when you start Collector Server for the first time.
The password is used for all connections. When it expires, update it on the
Tivoli Storage Manager server and on Collector Server.
v The use of the PASSWORDACCESS GENERATE option presupposes that you manually
set an initial password for the node to which the option relates. You must
specify this initial password when you connect to the Tivoli Storage Manager
node for the first time. After the first access, Tivoli Storage Manager changes the
initial password by generating a new password. The generated password is
updated automatically and is stored on the Tivoli Storage Manager client and on
the Tivoli Storage Manager server. All subsequent connections are established by
using the generated password.
v You connect to the Tivoli Storage Manager node for the first time by entering the
following commands on a command line:
1. dsmc -se= server_name (to log on to Tivoli Storage Manager server)
2. dsmc q mgm (to query the management classes)
After you enter the command for querying the management classes, Tivoli
Storage Manager prompts you for the initial password.
v Use the PASSWORDACCESS PROMPT option for initial testing because this option is
easy to set. Use the PASSWORDACCESS GENERATE for your production environment
because the passwords are automatically generated and updated.

What to do next: “Configuring a connection to a remote Tivoli Storage Manager


server”

Configuring a connection to a remote Tivoli Storage Manager server


If the Tivoli Storage Manager server is not installed on the same computer as
Collector Server, you must configure a connection between the two servers.

Before you begin: “Setting the password options” on page 21

Procedure:
1. In the \TSM\config directory of your Tivoli Storage Manager installation, create
the file server_name.opt. server_name stands for the name of the Tivoli Storage
Manager library server.
2. Specify the following information in this file:

Option Value
commmethod TCPIP

22 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Option Value
tcpport 1500
tcpserveraddress Specify the TCP/IP address of the Tivoli
Storage Manager library server.

What to do next: Chapter 4, “Configuring Collector Server,” on page 25

Chapter 3. Configuring Tivoli Storage Manager for use with Content Collector for SAP 23
24 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 the information center or of IBM Content Collector for SAP
Applications: Installation, Configuration, and User's Guide, SH12-6989.
3. Chapter 2, “Preparing your environment,” on page 3.
4. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.

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 Engine


archdp archpro
DISPATCHERS keyword
ARCHPRO_
Java RFC dispatcher PORT
cssap.jar keyword
DISPATCHERS keyword

HTTP dispatcher TSM agent


archcls.jar archagent
WEBDPS keyword ADSMAGENTS keyword

Collector Server instance

Figure 17. Configuration of Collector Server

Complete the following tasks to configure Collector Server:

Procedure:
1. “Configuring Collector Server for use with Tivoli Storage Manager.”
2. “Configuring the connection between Collector Server and SAP” on page 34
3. “Starting Collector Server for the first time” on page 49
4. “Stopping Collector Server” on page 51

Configuring Collector Server for use with Tivoli Storage 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.

| You can configure more than one instance of Collector Server. Each instance must
| have its own server configuration profile.

© Copyright IBM Corp. 2010, 2013 25


Before you begin:
v Plan for a secure Collector Server.
v Plan for the master key and for secure passwords.

For more information, see the topics Planning for a secure Collector Server and
Planning for the master key and for secure passwords in the Planning part of the
information center or of IBM Content Collector for SAP Applications: Installation,
Configuration, and User's Guide, SH12-6989.

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 Tivoli Storage Manager, the sample profile is archint_sample_tsm.ini.

There are many keywords that you can add to the profile to fine-tune the behavior
of Collector Server. The following topics, however, show how to change the basic
settings that are necessary to start and run Collector Server and to perform the
most important tasks.

For a complete list of the keywords that you can add and for an overview of the
values that you can specify and of the default values, see the topic Keywords in
the server configuration profile in the Reference part of the information center or
of IBM Content Collector for SAP Applications: Installation, Configuration, and
User's Guide, SH12-6989.

Important: The length of a line in the server configuration profile must not exceed
2048 bytes.

Server configuration profile: General information and


structure
A server configuration profile is an ASCII file that can be changed with any ASCII
editor. It consists of keywords and their values.

A keyword can have one value, sometimes even a list of values that are separated
by commas. Most of the keywords have a default value. If you omit such a
keyword, the default value is used. When Collector Server is started, it checks the
syntax of the server configuration profile. Collector Server starts successfully only
if the keywords and their values are specified correctly and in the correct order.

A server configuration profile contains the following sections:


v A general section, where you specify the following information:
– The paths, such as the path to the Collector Server instance and the path to
the temporary files
– The log and trace settings
v The DESTINATION section, where you specify the connection to the related SAP
system
v One or more ARCHIVE sections, where each ARCHIVE section contains the settings
for one logical archive

26 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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
DESTINATION section. The DESTINATION section must be defined once in the server
configuration profile. Archive-specific keywords must be specified for each archive
that you want to use.

The following examples for the individual sections reflect the contents of the
sample server configuration profile on a Windows system.

Example of a general section:


#-----------------------------------------------------------------------#
# The full path to the directory containing the program files of
# Collector Server.
#-----------------------------------------------------------------------#
BINPATH C:\Program Files\IBM\ICCSAP\Server\bin

#-----------------------------------------------------------------------#
# The full path to the instance directory of Collector Server,
# containing all instance-related files, such as trace files and
# log files.
#-----------------------------------------------------------------------#
INSTANCEPATH C:\Program Files\IBM\ICCSAP\Server\instances\instance01

#-----------------------------------------------------------------------#
# Enables or disables Collector Server to write additional information
# to stdout, which is normally the console.
#-----------------------------------------------------------------------#
#REPORT ON

#-----------------------------------------------------------------------#
# Specifies how tracing is handled.
#-----------------------------------------------------------------------#
#TRACE DYNAMIC_ON

#-----------------------------------------------------------------------#
# The maximum size of the Collector Server trace file, in KB.
#-----------------------------------------------------------------------#
#TRACEMAX 2000

#-----------------------------------------------------------------------#
# The fully qualified path to the Collector Server trace file. This
# trace file contains the messages that are issued by the individual
# Content Collector for SAP components after the connection to Collector
# Server is established.
#-----------------------------------------------------------------------#
#TRACEFILE env_var_appdata\IBM\ICCSAP\instance01\traces\icc_trace.trc

#-----------------------------------------------------------------------#
# The full path to the directory where Collector Server is to store
# the temporary files that are needed for processing.
#-----------------------------------------------------------------------#
TEMPPATH C:\temp\

#-----------------------------------------------------------------------#
# Specifies whether Collector Server creates a log file on every day that
# it is active.
#-----------------------------------------------------------------------#
#LOG ON

#-----------------------------------------------------------------------#

Chapter 4. Configuring Collector Server 27


# The full path to the exchange directory where your SAP applications
# should store the files that are to be archived by Content Collector
# for SAP. The path should be shared by all SAP Application Servers
# by using NFS mount.
# Note: This keyword is only required if RFC_DISPATCHERS > 0.
#-----------------------------------------------------------------------#
#BASEPATH \\SAPSERVER\transfer\base\

#-----------------------------------------------------------------------#
# The full path to the directory where Collector Server and SAP can
# retrieve the archived files.
# Note: This keyword is only required if RFC_DISPATCHERS > 0.
#-----------------------------------------------------------------------#
#ARCHPATH \\SAPSERVER\transfer\arch\

#-----------------------------------------------------------------------#
# The fully qualfied path to the master key file, which is to hold
# the master key that encrypts the password file and the SAP certificates.
#-----------------------------------------------------------------------#
MASTER_KEYFILE C:\Users\iccadm\instance01\masterkey.txt

#-----------------------------------------------------------------------#
# The fully qualified file name of the server keystore. The server
# keystore holds the self-signed certificate of Collector Server
# and the certificates of all trusted installations of Archiving Client
# and Viewing Client.
#-----------------------------------------------------------------------#
DLL_KEYSTORE_FILE env_var_appdata\IBM\ICCSAP\instance01\server_clients\
server\server.kdb

Example of a DESTINATION section:


#-----------------------------------------------------------------------#
# Defines the connection between Collector Server and SAP. It is similar
# to the SAP sideinfo configuration file.
# You can specify several LOGICAL_SYSTEM sections. In this way, you can
# connect one Collector Server instance to several SAP clients.
# Note: For the DESTINATION keyword, 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

28 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
USER CPICUser1
LOGICAL_SYSTEM T90CLNT091
CLIENT 801
USER CPICUser2

Notes:
v The LOGICAL_SYSTEM keyword can be used in the DESTINATION section and in the
ARCHIVE section.
v In the DESTINATION section, the LOGICAL_SYSTEM keyword starts a section where
you specify the SAP client that is linked to the logical system and where you
specify the CPIC user that is used to log on to the SAP client. A LOGICAL_SYSTEM
section can be specified several times. In this way, you can connect a Collector
Server instance to several SAP clients.
v If you want to archive or only link documents by processing their bar codes or
by creating work items in the SAP, the ARCHIVE section must contain the
LOGICAL_SYSTEM keyword.

Example of an ARCHIVE section:


#-----------------------------------------------------------------------#
# You need an ARCHIVE section for each Tivoli Storage Manager server
# and for each management class.
#-----------------------------------------------------------------------#

#-----------------------------------------------------------------------#
# Minimum archive definition.
#-----------------------------------------------------------------------#
ARCHIVE A1
STORAGETYPE TSM
SERVER ADSMSERV01
MGMT_CLASS SAP_MGMT01
ADSMNODE samplenode1

#-----------------------------------------------------------------------#
# Definition for archiving documents by processing their bar codes.
#-----------------------------------------------------------------------#
ARCHIVE A2
STORAGETYPE TSM
SERVER ADSMSERV02
MGMT_CLASS SAP_MGMT02
ADSMNODE samplenode2
LOGICAL_SYSTEM T90CLNT090

#-----------------------------------------------------------------------#
# Definition for archiving data by using BC-ILM.
#-----------------------------------------------------------------------#
ARCHIVE A3
STORAGETYPE TSM_WEBDAV
SERVER ADSMSERV03
MGMT_CLASS SAP_MGMT03
ADSMNODE samplenode3
LOGICAL_SYSTEM T90CLNT090

#-----------------------------------------------------------------------#
# Definition of the user allowed to archive data by using BC-ILM.
#-----------------------------------------------------------------------#
WEBDAV_AUTH XMLDAS

Note: WEBDAV_AUTH is a global keyword.

Example of a subprocess section:

Chapter 4. Configuring Collector Server 29


#-----------------------------------------------------------------------#
# The number of parallel instances of the Content Collector for SAP
# child programs.
#-----------------------------------------------------------------------#
RFC_DISPATCHERS 0
JRFC_DISPATCHERS 0
ADSMAGENTS 1
ODAGENTS 0
CMAGENTS 0
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 Do not specify any characters in front of a keyword. You can specify spaces,
however.
v Specifying a keyword several times can produce unpredictable results.
v Values that contain blanks or paths can be, but do not have to be, enclosed in
single quotation marks.
v The profile is scanned up to the END keyword or until the end of the file is
reached.
v 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 Tivoli Storage


Manager
Use the sample file archint_sample_tsm.ini to create a server configuration profile
for use with Tivoli Storage Manager.
| 1. Copy the sample file archint_sample_tsm.ini to a directory of your choice and
| rename it. For example, copy it to the instance directory and rename it to

30 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
| 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 the
information center or of IBM Content Collector for SAP Applications:
Installation, Configuration, and User's Guide, SH12-6989.

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.
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.
TEMPPATH Specify the full path to the
directory where Collector
Server is to store the
temporary files that are
needed for processing.
MASTER_KEYFILE Specify the fully qualified The master key is generated
name of the file that is to when you complete the steps
hold the master key to that are required to start
encrypt the password file Collector Server for the first
(default name: archint.cfg) time.
and the SAP certificates for
the archives. Ensure that the user who
starts Collector Server has
access permissions for the
entire path.
| DLL_KEYSTORE_FILE For the initial setup, You need this keyword later
| comment out this keyword when you set up secure client
| with a number sign (#). connections between
| Collector Server and
| Archiving Client or Viewing
| Client. For more information,
| see the topic Setting up
| secure client connections in
| the Security part of the
| information center or of IBM
| Content Collector for SAP
| Applications: Installation,
| Configuration, and User's
| Guide, SH12-6989.

Chapter 4. Configuring Collector Server 31


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 You specified this name when
logical system that is you defined the logical
connected to the SAP client. system in SAP.
CLIENT Specify the name of the SAP
client that is linked to the
logical system.
USER Specify the name of the user You specified this name when
with CPIC access. you created the user with
CPIC access in SAP.
ARCHIVE The sample file contains three You must specify this ID
predefined profiles for logical again when you create the
archives: content repository in SAP.
v A1 contains the minimum
The ID can be used more
settings for an archive so
than once in the server
that you can archive
configuration profile and in
outgoing documents, print
SAP. It does not have to be
lists, and data.
unique.
v A2 contains the settings for
archiving documents with
bar codes.
v A3 contains the settings for
XML-based archiving
(BC-ILM).

You can adapt and keep all


definitions, or you can
remove the unnecessary ones.
SERVER Specify a name for the Tivoli You must specify the server
Storage Manager server to name again when you create
which you logged on when the client options file for this
you registered the Tivoli server.
Storage Manager node with
Content Collector for SAP.
MGMT_CLASS Specify the management class You created the management
that Collector Server uses to class when you configured
archive the documents. Tivoli Storage Manager for
use with Content Collector
for SAP.
ADSMNODE Specify the name of the Tivoli You need this keyword only
Storage Manager node that if you do not specify the
you registered with Content node in the client options file.
Collector for SAP.

32 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Keyword Description Remarks
| ARCHWINS For the initial setup, set the If you specify a number
| value of this keyword to 0. greater than 0, you must also
set the DLL_KEYSTORE_FILE
keyword. For more
information, see the topic
Setting up secure client
connections in the Security
part of the information center
or of IBM Content Collector
for SAP Applications:
Installation, Configuration,
and User's Guide, SH12-6989.
ARCHPRO_PORT If another program does not
use this port, leave the port
that is specified in the sample
profile, namely 5500.

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: “Creating client options files”

Creating client options files


Create a client options file for each Tivoli Storage Manager server that is specified
in the server configuration profile with the SERVER keyword. A client options file
ensures that Collector Server connects to the correct server.

Before you begin: “Creating a server configuration profile for Tivoli Storage
Manager” on page 30

Procedure:
1. Copy the dsm.opt file, which is packaged with Tivoli Storage Manager, to a
directory that does not contain the server configuration profile. Collector Server
must have write access to this directory.
2. Open the file with a text editor, delete its contents, and then save it as an
empty file under the same name.
3. Make as many copies of the original dsm.opt file as there are Tivoli Storage
Manager servers specified in the server configuration profile. Save these copies
to the directory that contains the empty dsm.opt file. Name each copy
server_name.opt server_name stands for the value that you specified for the
SERVER keyword in the server configuration profile.

Chapter 4. Configuring Collector Server 33


4. Open each copy with an editor and replace the value for the tcpserveraddress
parameter with the address of the Tivoli Storage Manager server.
5. Linux UNIXAdd an entry with the address of each Tivoli Storage
Manager to the dsm.sys file. The dsm.sys file contains all Tivoli Storage
Manager parameters for connecting to the specified server.

What to do next: “Configuring the connection between Collector Server and SAP”

Configuring the connection between Collector Server and SAP


The connection that you must configure and the dispatchers that you must start
depend on the task that you want to perform.

Before you begin:


v Plan for a secure connection between Collector Server and SAP. For more
information, see the corresponding topic in the Planning part of the information
center or of IBM Content Collector for SAP Applications: Installation,
Configuration, and User's Guide, SH12-6989.
v Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19

The following table shows which connection you must set up for which task and
which dispatchers must be started.

HTTP connection, RFC connection,


which uses the HTTP which uses the RCF
Task dispatcher dispatcher Java RFC dispatcher Remarks
Archiving data x x Either an HTTP
connection or an RFC
connection is
required.
Archiving data by x Only the HTTP
using BC-ILM dispatcher is used.
Archiving documents x
by creating work
items in an SAP
workflow
Archiving documents The bar code is sent
by processing their directly to SAP.
bar codes
Archiving outgoing x x Either an HTTP
documents connection or an RFC
connection is
required.
Archiving and x x Either an HTTP
viewing print lists connection or an RFC
connection is
required.
Viewing archived x x An RFC connection
documents with the can be used for print
SAP GUI lists only.

34 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
HTTP connection, RFC connection,
which uses the HTTP which uses the RCF
Task dispatcher dispatcher Java RFC dispatcher Remarks
Viewing archived x x An RFC connection
documents with an can be used for print
external viewer lists only.

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 Java RFC dispatchers


A Java RFC dispatcher is required if you want to archive and link a document by
creating a work item or if you want to search for and view documents by using
the SAP Document Finder.

Procedure:
1. Open the server configuration profile in a text editor.
2. Set the JRFC_DISPATCHERS keyword to a number greater than 0, for example:
JRFC_DISPATCHERS 4
3. Save the server configuration profile, and restart Collector Server for the
changes to take effect.

What to do next: Continue with one of the following tasks:


v “Setting up the connection between Collector Server and SAP through HTTP”
v “Setting up the connection between Collector Server and SAP through Remote
Function Call (RFC)” on page 41
v “Enabling Collector Server to connect to SAP” on page 47

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: “Setting the number of Java RFC dispatchers.”

Procedure:
1. “Setting the number of HTTP dispatchers” on page 36
2. “Creating an SAP ArchiveLink protocol for use by the HTTP connection” on
page 36

Chapter 4. Configuring Collector Server 35


3. “Creating SAP ArchiveLink queues for use by the HTTP connection” on page
37
4. “Creating a content repository for the HTTP connection” on page 38
5. “Sending an SAP certificate to Collector Server” on page 40

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 5580. 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”

Procedure:
1. In the SAP GUI, enter the transaction code OAA3 to open the ArchiveLink:
Communications Interface Administration window.

2. Click the New protocol icon .


3. In the Create New Protocol window, specify the following settings:

Field Description Example


Protocol Type a name for the protocol. Type:
HTTP1
Version Specify the version of the Type:
SAP ArchiveLink HTTP 0045
Content Server Interface.

Normally, 0045 is sufficient.


However, if a cache server is
used, specify 0046.

36 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Field Description Example
Description Specify information about Type:
this protocol. Demo_HTTP

Figure 18 shows the Create New Protocol window containing the sample
specifications.

Figure 18. Create New Protocol window containing the sample protocol name, the version,
and a sample description

4. Press Enter and then click the Save icon to save your settings.

The ArchiveLink: Communications Interface Administration window lists the new


protocol.

What to do next: “Creating SAP ArchiveLink queues for use by the HTTP
connection”

Creating SAP ArchiveLink queues for use by the HTTP


connection
Complete the following steps to create SAP ArchiveLink queues.

Before you begin: “Creating an SAP ArchiveLink protocol for use by the HTTP
connection” on page 36

Procedure:
1. In the SAP GUI, enter the transaction code OAQI to open the SAP ArchiveLink:
Create All Queues (CFBC, CARA, CGDA) window.
2. Make sure that all fields except for Queue Administrator contain an X.
3. In the Queue Administrator field, type the logon ID of an SAP user who
should receive error notifications. By default, the current logon ID is inserted.
For example, type:
ADMIN

4. Click the Execute icon .

Figure 19 on page 38 shows the SAP ArchiveLink: Create All Queues (CFBC,
CARA, CGDA) window containing the required settings.

Chapter 4. Configuring Collector Server 37


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 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 37

Procedure:
1. In the SAP GUI, enter the transaction code OAC0 to open the Display Content
Repositories: Overview window.

2. Click the Change icon .


3. In the Change Content Repositories: Overview window, click the Create icon
.
4. In the Change Content Repositories: Detail window, click Full administration.
5. Specify the following information:

Field Description Example


Content Rep. Type the logical archive ID that Type:
you specified for the ARCHIVE A2
keyword in the server
configuration profile.
Description Type a short description for the Type:
repository or archive. Sample archive A2
Document area Select ArchiveLink.
Storage type Select HTTP content server.
Protocol Select the SAP ArchiveLink Select HTTP1.
protocol that you created.

38 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Field Description Example
Version no. Select the version of the SAP Select 0045.
ArchiveLink HTTP Content Server
Interface, which you specified
when you created the SAP
ArchiveLink protocol.
HTTP server Type the host name or IP address Type:
of Collector Server. myhost.yourserver.com
Port Number Type the port number of the Type:
TCP/IP port through which the 5580
HTTP dispatcher of Collector
Server gets its requests.

The port number must match the


value that you specified for the
WEBPORT keyword when you set
the number of HTTP dispatchers.
HTTP Script Type:
cs
Basic Path Type the full path to the exchange Type:
directory where your SAP D:\SAPSERVER\transfer\base\
applications is to store the files
that are to be archived by Content
Collector for SAP.

The path must end with a


delimiter, which is \ on Windows
and / on Linux and UNIX
systems.

Make sure that both servers can


access this directory.
Archive Path Type the full path to the directory Type:
where Collector Server and SAP D:\SAPSERVER\transfer\arch\
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.
OutputDevice Select ARCH.
No signature If selected, no signature is used.
Generally, use it for test purposes
only.

Figure 20 on page 40 shows the Change Content Repositories: Detail window


containing your specifications.

Chapter 4. Configuring Collector Server 39


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 38

You can send the certificate in either of the following ways:

v After you click Save icon in the Change Content Repositories: Detail
window, click the Send certificate icon .
v Complete the following steps:
1. In the SAP GUI, enter the transaction code OAHT to open the “Send certificates
to HTTP content server” window.
2. Double-click the content repository for which an SAP certificate is needed.
For example, double-click A2.
The corresponding Collector Server receives the SAP certificate and saves it in
the SAPCertificates directory.
For example, the SAP certificate for the content repository or logical archive A2
would be stored as A2.pse.fingerprint.TO_BE_CONFIRMED. fingerprint stands for
the hash value that uniquely identifies the SAP certificate.
3. To accept the SAP certificate, complete these steps:

40 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
a. Open a command line and change to the directory where the appropriate
server configuration profile is stored. The server configuration profile must
contains the logical archive that corresponds to the content repository.
b. Enter the following command:
archcert -a archive_id
archive_id stands for the content repository ID, which is equal to the logical
archive ID. For example, A2.
For more information about this command and the parameters that you can
specify, see the topic archcert in the Reference part of the information center
or of IBM Content Collector for SAP Applications: Installation,
Configuration, and User's Guide, SH12-6989.
c. The content of the SAP certificate is displayed. Review it.
d. If you decide to accept the SAP certificate, enter YES.

Collector Server saves the SAP certificate in the SAPCertificates directory as


archive_id.pse.fingerprint, for example, A2.pse.fingerprint. You can verify the
SAP certificate in SAP by comparing the fingerprint to the one in the Trust
Manager (transaction code STRUST).

What to do next: “Enabling Collector Server to connect to SAP” on page 47

Setting up the connection between Collector Server and SAP


through Remote Function Call (RFC)
You use the SAP GUI to configure the RFC connection.

Before you begin: If you want to search for and view documents by using the SAP
Document Finder, or if you want to archive or link a document by creating a work
item in an SAP workflow: “Setting the number of Java RFC dispatchers” on page
35.

Procedure:
1. “Setting the number of RFC dispatchers”
2. “Creating an RFC destination” on page 42
3. “Creating an SAP ArchiveLink protocol for use by the Remote Function Call
(RFC) connection” on page 43
4. “Creating SAP ArchiveLink queues for use by the Remote Function Call (RFC)
connection” on page 44
5. “Creating a content repository for the Remote Function Call (RFC) connection”
on page 45

Setting the number of RFC dispatchers


You must start at least one RFC dispatcher. In addition, you must specify where
the files that are to be exchanged between SAP and Content Collector for SAP are
to be stored. You set the number of RFC dispatchers and specify the paths in the
server configuration profile.

Procedure:
1. Open the server configuration profile in a text editor.
2. Set the RFC_DISPATCHERS keyword to a number greater than 0, for example:
RFC_DISPATCHERS 4
3. Add the following keywords to specify the paths for the temporary storage of
the files:

Chapter 4. Configuring Collector Server 41


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.
4. Save the server configuration profile, and restart Collector Server for the
changes to take effect.

What to do next: “Creating an RFC destination”

Creating an RFC destination


Complete the following steps to create an RFC destination.

This topic shows how to create the sample RFC destination KD7.ICCSAP.

Before you begin: “Setting the number of RFC dispatchers” on page 41

Procedure:
1. In the SAP GUI, enter the transaction code SM59 to open the Configuration of
RFC Connections window.
2. In the RFC Connections column, click TCP/IP connections and then click
Create icon .
3. In the RFC Destination field of the RFC Destination window, type a name for
the RFC destination. You can use a name of your choice. However, you might
want to use the same name as in the Program ID field, which you specify in
step 7.
For example, type:
KD7.ICCSAP
4. Under Description, type a description in one or more of the Description fields.
For example, type:
RFC Connection 1
5. Click the Technical Settings tab.
6. Under Activation Type, click Registered Server Program.
7. In the Program ID field, type the program ID under which the dispatcher is
registered on the SAP Gateway server.
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 Tivoli Storage Manager: Best practices
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 42

Procedure:
1. In the SAP GUI, enter the transaction code OAA3 to open the ArchiveLink:
Communications Interface Administration window.

2. Click the New protocol icon .


3. In the Create New Protocol window, specify the following settings:

Field Description Example


Protocol Type a name for the protocol. Type:
RFC1

Chapter 4. Configuring Collector Server 43


Field Description Example
Version Specify the version of the
SAP ArchiveLink Interface,
namely 0031.
Description Specify information about Type:
this protocol. 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 43

Procedure:
1. In the SAP GUI, enter the transaction code OAQI to open the SAP ArchiveLink:
Create All Queues (CFBC, CARA, CGDA) window.
2. Make sure that all fields except for Queue Administrator contain an X.
3. In the Queue Administrator field, type the logon ID of an SAP user who
should receive error notifications. By default, the current logon ID is inserted.
For example, type:
ADMIN

4. Click the Execute icon .

Figure 23 on page 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 Tivoli Storage Manager: Best practices
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 44

Procedure:
1. In the SAP GUI, enter the transaction code OAC0 to open the Display Content
Repositories: Overview window.

2. Click the Change icon .


3. In the Change Content Repositories: Overview window, click the Create icon
.
4. In the Change Content Repositories: Detail window, click Full administration.
5. Specify the following information:

Field Description Example


Content Rep. Type the logical archive ID Type:
that you specified for the A1
ARCHIVE keyword in the
server configuration profile.
Description Type a short description for Type:
the repository or archive. Sample archive A1
Document area Select ArchiveLink.
Storage type Select RFC archive.
Protocol Select the SAP ArchiveLink Select RFC1.
protocol that you created.
Version no. Select 0031.

Chapter 4. Configuring Collector Server 45


Field Description Example
RFC destination Select the RFC destination Select KD7.ICCSAP.
that you previously created.
Basic Path Type the full path to the Type:
exchange directory where D:\SAPSERVER\transfer\base\
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.

Use the path that you


specified for the BASEPATH
keyword in the server
configuration profile.

Make sure that both servers


can access this directory.
Archive Path Type the full path to the Type:
directory where Collector D:\SAPSERVER\transfer\arch\
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.
OutputDevice Select 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 Tivoli Storage Manager: Best practices
Figure 24. Change Content Repositories: Detail window containing your specifications

6. Click the Save icon to save your settings.

What to do next: “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 “Setting the number of Java RFC dispatchers” on page 35
v “Setting up the connection between Collector Server and SAP through HTTP” on
page 35
v “Setting up the connection between Collector Server and SAP through Remote
Function Call (RFC)” on page 41

The DESTINATION section defines the connection between one Collector Server
instance and one SAP system. Within this section, however, you can define the
connection to several SAP clients.

Procedure:
1. Open the server configuration profile in a text editor.
2. You already specified the DESTINATION section and some of the keywords in this
section when you configured Collector Server for use with the archives. The
following table shows which keywords are required for which connection types
and tasks. Add the missing keywords.

Chapter 4. Configuring Collector Server 47


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
When Collector Server is to log on to an SAP DESTINATION KD7
logon group, the keywords LU and TP must PROGID KD7.ICCSAP
be replaced with the keywords MSHOST, GWHOST /H/sapserver
R3NAME, and GROUP. GWSERV sapgw00
MSHOST sapmsKD7
GROUP myGroup
R3NAME KD7
Archiving and linking documents by DESTINATION KD7
processing their bar codes. The number of GWHOST /H/sapserver
RFC dispatchers and Java RFC dispatchers is GWSERV sapgw00
0. LU sapserver
TP sapdp00
LOGICAL_SYSTEM T90CLNT090
CLIENT 800
USER CPICUser1
Archiving and linking of documents where, DESTINATION KD7
for each document, a work item is created in PROGID KD7.ICCSAP
the SAP workflow. The number of Java RFC GWHOST /H/sapserver
dispatchers must be greater than 0. GWSERV sapgw00
LU sapserver
TP sapdp00
LOGICAL_SYSTEM T90CLNT090
CLIENT 800
USER CPICUser1

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.
You can specify several LOGICAL_SYSTEM sections within the DESTINATION
section. Each LOGICAL_SYSTEM section defines the connection to a SAP client.

48 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
LU The host name or the IP address of the SAP Application Server.
MSHOST
The host name of the SAP Message Server.
PROGID
| The program ID under which the RFC dispatcher is registered on the SAP
| Gateway server or that is used by SAP Document Finder. You specified this
| program ID when you created the RFC destination in SAP.

| Note: If the RFC destination is to be used by SAP Document Finder, the


| program ID that you specified in SAP is appended with the number 1. Do
| not specify this number as part of the PROGID keyword. For example, if
| you specified DOCF.GIN.OD1 in SAP, specify DOCF.GIN.OD for the PROGID
| keyword.
R3NAME
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: “Starting Collector Server for the first time”

Starting Collector Server for the first time


To start Collector Server for the first time, you use the archpro command.

Before you begin:


1. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.
2. “Configuring the connection between Collector Server and SAP” on page 34
| 3. 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 You enter the command from the directory that contains the server configuration
| profile.
| v The server configuration profile has the default name archint.ini.

| The procedures that are shown in this information are based on the following
| assumptions:
| v The server configuration profile is in the instance directory.
| v The server configuration profile has the default name archint.ini.
| v You enter the archpro command from the instance directory.

Procedure:

Chapter 4. Configuring Collector Server 49


1. Open a command line and change to the instance directory.
2. Enter the following command to generate the master key, which encrypts the
password file (default name: archint.cfg) and the SAP certificates for the
archives:
archpro -f masterkey
You must specify this command once when you want to start Collector Server
for the first time.
You must have read and write access for the fully qualified path to the master
key file, which contains the master key. Ideally, you are the owner of this file
and no other user has access to this file. Linux and UNIX systems check the
permissions for this file.
Content Collector for SAP creates a master key and saves it in the file that you
specified for the MASTER_KEYFILE keyword.
3. Enter the following command to enable Collector Server to access your
archives:
archpro -f serverpasswd
You must specify this command once when you want to start Collector Server
for the first time.
4. Enter the password of the Tivoli Storage Manager node.
If this password changes, also change the logon password for Collector Server.
You might also be prompted for the names of a logon server and a node.
5. Enter either of the following commands to log on to SAP:
v If you want to log on to a specific SAP client, enter the following command:
archpro -f r3passwd user_name
user_name stands for the name of the CPIC user that Collector Server uses to
log on to the SAP client. You are prompted for the password of the specified
CPIC user.
v If you want to log on to all SAP clients that are listed in your server
configuration profile, enter the following command:
archpro -f r3passwd
You are prompted for the password of each CPIC user.

Notes:
v Type the password exactly as you specified it for the CPIC user.
v You must enter this command each time you want to change the SAP
password.
6. Enter archpro to start Collector Server.
For more information about this command and the parameters that you can
specify, see the topic archpro in the Reference part of the information center or
of IBM Content Collector for SAP Applications: Installation, Configuration, and
User's Guide, SH12-6989.

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 7, “Configuring your environment for basic tasks,” on


page 85

50 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Stopping Collector Server
At any time, you can stop Collector Server. Collector Server waits until all jobs are
finished and then shuts down.

Procedure:
1. Open a command line and change to the instance directory.
2. Enter the following command:
archstop
When the archpro program receives the archstop command, it first stops all
child processes and then it stops itself.
For more information about this command and the parameters that you can
specify, see the topic archstop in the Reference part of the information center or
of IBM Content Collector for SAP Applications: Installation, Configuration, and
User's Guide, SH12-6989.

Chapter 4. Configuring Collector Server 51


52 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Chapter 5. Configuring Archiving Client
Configure Archiving Client if you want to archive incoming documents.

Before you begin:


1. Install Archiving Client from the client package. For more information, see the
topic Installing the client package in console mode or GUI mode in the
Installing part of the information center or of IBM Content Collector for SAP
Applications: Installation, Configuration, and User's Guide, SH12-6989.
2. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.
3. Chapter 4, “Configuring Collector Server,” on page 25.
4. Set up secure client connections. For more information, see the corresponding
topic in the Security part of the information center or of IBM Content Collector
for SAP Applications: Installation, Configuration, and User's Guide, SH12-6989.

Start Archiving Client by clicking start > All Programs > IBM Content Collector
for SAP Applications > Archiving Client.

When you start Archiving Client for the first time, the Setup window opens.
Otherwise, the IBM Content Collector for SAP Applications - Archiving Client
window opens.

Figure 25 shows what the IBM Content Collector for SAP Applications - Archiving
Client window looks like before you configure it. In the lower right corner of the
window, you see a red cross because the connection to Collector Server is not
defined yet.

Figure 25. IBM Content Collector for SAP Applications - Archiving Client window before
configuration

Procedure:
1. “Setting up Archiving Client” on page 54

© Copyright IBM Corp. 2010, 2013 53


2. “Managing the queues” on page 59
3. “Enabling Collector Server to use Archiving Client” on page 75

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 “Defining the connection to Collector Server” through “Enabling logging
and tracing for Archiving Client” on page 58.

Figure 26. Setup window containing sample specifications

Procedure:
1. “Defining the connection to Collector Server”
2. “Specifying the directory for the temporary files” on page 56
3. “Loading the modules for the queues” on page 56
4. “Specifying the number of bar codes in a batch job” on page 56
5. “Sending the document format of the queues to SAP” on page 57
6. Optional: “Enabling logging and tracing for Archiving Client” on page 58
7. “Completing the setup of Archiving Client” on page 59

Defining the connection to Collector Server


You must connect Archiving Client to the Collector Server that you want to use for
archiving your documents.

54 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 127.0.0.1 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:
5500
3. Click Test to check whether a connection between Archiving Client and the
specified Collector Server can be established. The test result is displayed to the
right of the button. If an error occurs, an error description is displayed in a
separate window.

If Archiving Client can connect to the specified Collector Server, the connection
status is set to OK and a green bullet is shown. In addition, the WebPort field
shows the port that is set as value for the WEBPORT keyword in the server
configuration profile.

If a connection cannot be established, the connection status is set to FAILED and a


red cross is shown.

Figure 27 shows what the Preferred Server Connection area of the Setup window
might look like after you completed step 1 through step 3.

Figure 27. Preferred Server Connection area of the Setup window containing the default IP
address and the ports as specified in the sample configuration profile

What to do next:
v If you had to stop automatic processing, enable it again by clicking Autom.
Processing > Enable in the IBM Content Collector for SAP Applications -
Archiving Client window.
v “Specifying the directory for the temporary files” on page 56.

Chapter 5. Configuring Archiving Client 55


Specifying the directory for the temporary files
| By default, Archiving Client stores the temporary files in the env_var_appdata\IBM\
| ICCSAP\ArchivingClient directory of the user who started Archiving Client. You
| can specify another directory.

Under Work path in the Setup window, specify the following information:

Specify the full path to the directory where Archiving Client should store its
temporary files.
For example, type:
C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\

Figure 28 shows the Work path area of the Setup window containing the sample
path.

Figure 28. Work path area of the Setup window containing the sample path

What to do next: “Loading the modules for the queues”

Loading the modules for the queues


Archiving Client collects the scanned documents that are to be archived, from a
queue. The type of queue that you can use depends on your scanning application.
For each type of queue, you must load a software module.

Under Modules in the Setup window, specify the following information:


v Select the DirQueue check box if your scanning application stores the scanned
documents in the file system.
v Select the FileQueue check box if your scanning application stores the scanned
documents in the file system and creates a description file.

Figure 29 shows the Modules area of the Setup window containing your selections

Figure 29. Modules area of the Setup window containing your sample selections

What to do next: “Specifying the number of bar codes in a batch job”

Specifying the number of bar codes in a batch job


If the documents are to be linked by processing their bar codes, you can increase
the performance by sending up to 50 bar codes in one batch job instead of sending
the bar codes one by one.

56 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Note: If one of the documents that are processed in a batch job are not linked, you
get one return code for the entire batch job. You do not get a return code for each
document processed.

Under Barcode in the Setup window, specify the following information:

In the Number of Barcodes to be sent in a batch field, click the arrows to select
the number of bar codes that are to be sent together. You can also type the number,
which can be 1–50.
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: “Sending the document format of the queues to SAP”

Sending the document format of the queues to SAP


If you want to view archived documents in the format in which they are archived,
you must enable Collector Server to send the document format to SAP. Otherwise,
a document is displayed in the FAX format. You specify the document format
when you create a queue for the documents.

Under Document format sent to SAP in the Setup window, specify the following
information:

Select the As configured in queue setup (if unchecked FAX is sent) check box if
you want to archive your documents in a format other than FAX. In this case, the
document format that you specify when you create the queues is sent to SAP.
If you select this check box, ensure that SAP can use a viewer application that
recognizes the document format of the archived documents.
For this example, select the check box.

Figure 31 shows the Document format sent to SAP area of the Setup window
containing your selection

Figure 31. “Document format sent to SAP” area of the Setup window containing your
selection

What to do next: “Enabling logging and tracing for Archiving Client” on page 58

Chapter 5. Configuring Archiving Client 57


Enabling logging and tracing for Archiving Client
You can enable Archiving Client to log its activities in log files and trace files. You
can enable logging in a general log file, in a log file that contains information
about the communication between Archiving Client and Collector Server, and in a
trace file for error recovery. In addition, you can specify where the log files and
trace files are to be stored.

Note, however, that logging and tracing affects the performance of Content
Collector for SAP.

If possible, use the path where you store the temporary files, as path for all log
files and trace files.

Under Logging and Tracing in the Setup window, specify the following
information:

Procedure:
v To enable general logging, complete these steps:
1. Select the Enable check box next to the Log file field.
2. In the Log file field, specify the fully qualified path to the log file. You can
specify a path of your choice.
For example, type:
C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\
ICCSAP_AC.log
v To record information about the communication between Archiving Client and
Collector Server, complete these steps:
1. Select the Enable check box next to the API trace file field.
2. In the API trace file field, specify the fully qualified path the trace file. You
can specify a path of your choice.
For example, type:
C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\
ICCSAP_ClientAPI.trc
v To collect more details about the activities of Archiving Client, complete these
steps:
1. Select the Enable check box next to the Client trace file field.
2. In the Client trace file field, specify the fully qualified path to the trace file.
You can specify a path of your choice.
For example, type:
C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\
ICCSAP_AC.trc
3. In the Maximum file size field, click the arrows to select the maximum size
of the trace file, in KB. You can specify a number up to, and including, 10240
KB. If the trace file exceeds the limit, the oldest information is overwritten.
For example, type:
300
4. Select the Clear trace file check box if you want to delete the existing trace
file each time you start Archiving Client.

Note: If you select this check box, you might lose valuable information for
error recovery if the same error recurs.
For this example, leave this check box clear.

58 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 32 shows the Logging and Tracing area of the Setup window with the
entire logging and tracing enabled.

Figure 32. Logging and Tracing area of the Setup window containing the sample
specifications

What to do next: “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.

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 “Creating queues” on page 60.

Managing the queues


A queue is a container for scanned documents with common properties. Archiving
Client collects the scanned documents from a queue and stores them in an archive
or in SAP.

For example, you might want to create a queue for documents with a certain
content, such as invoices, or for documents in a certain format, such as a GIF, or
for documents that you want to store in the same archive. The scanning
application that you use determines the queue type.

You can create queues, view and change the properties of the queues, import
scanned documents into the queues, and remove documents from the queues. You
perform these tasks in Archiving Client. To start Archiving Client:

Procedure:

Chapter 5. Configuring Archiving Client 59


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 “Setting up Archiving Client” on page 54.
v Plan for secure connections to Archiving Client and Viewing Client. For more
information, see the corresponding topic in the Security part of the information
center or of IBM Content Collector for SAP Applications: Installation,
Configuration, and User's Guide, SH12-6989.

In the IBM Content Collector for SAP Applications - Archiving Client window,
click Queue > New Queue. The Queue window opens.

Create at least one queue:


v “Creating queues if the scanned documents are in the file system”
v “Creating queues if the scanned documents are in the file system and a
description file exists” on page 65

Creating queues if the scanned documents are in the file system


Create queues of type DirQueue if your scanning application stores the scanned
documents in the file system. Archiving Client collects the scanned documents
from the file system. It can use the file names of the scanned documents as bar
codes.

Procedure:
1. “Providing details about the queue of type DirQueue”
2. “Defining the connection to Collector Server” on page 61
3. “Connecting the queue to a logical archive” on page 63
4. “Providing details about the directory” on page 64
5. “Completing the creation of the queue of type DirQueue” on page 65

Providing details about the queue of type DirQueue:

You must provide some details about the queue that you want to create.

In the Queue window, provide the following information:

Procedure:
1. From the Queue Type list, select DirQueue.
2. In the Queue Name field, type a name for the queue.
For example, type:
my_dirqueue
3. From the Document Format list, select an SAP document format.
For example, select FAX.

60 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 “Adding or removing SAP
document formats” on page 74.
If you select a document format other than FAX, ensure that the As configured
in queue setup (if unchecked FAX is sent) check box is selected in the Setup
window. Only if this check box is selected, the document format that you
specify here is sent to SAP when the documents are archived. Otherwise, the
document format FAX is sent to SAP. SAP uses the document format to open a
suitable viewer application for the archived documents.
4. If you plan to archive your documents by creating work items in an SAP
workflow, specify a document type in the Document type field. The document
type categorizes the documents that are to be imported into the queue. When
you later configure your environment for archiving incoming documents, you
must enable this document for an SAP workflow so that the documents can be
linked to a specific SAP business object.
For example, type:
FIIINVOICE
5. Click Next to connect the queue with a Collector Server.

Figure 33 shows what the Queue window might look like after you completed step
1 on page 60 through step 4.

Figure 33. Queue window showing the sample details for a queue of type DirQueue

What to do next: “Defining the connection to Collector Server”

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.

Chapter 5. Configuring Archiving Client 61


Before you begin: “Providing details about the queue of type DirQueue” on page
60

In the Connection Properties window, provide the following information:

Procedure:
1. You can use an existing server connection or create one:
v To use an existing server connection, click it under Available connections.
The details of the server connection are shown in the Archive Host/IP
address, Port, and WebPort fields.
v To create a server connection, complete these steps:
a. In the Archive Host/IP address field, type the host name or the IP
address of Collector Server.
If Collector Server and Archiving Client are not installed on the same
computer and you want to specify the host name, use the fully qualified
host name, such as myhost.yourserver.com, or the IP address of the
remote host. The default value is 127.0.0.1 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:
5580
2. Click Next to connect the queue to a logical archive.

Figure 34 on page 63 shows the Connection Properties window containing the


sample Collector Server that you specified in the Setup window as the preferred
Collector Server.

62 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 61

In the “Logical archive” window, specify the following information:

Procedure:
1. In the SAP Archive field, specify the logical archive ID. Use the ID that you
specified for the ARCHIVE keyword in the server configuration profile and that
you specified when you created a content repository or logical archive in SAP.
For example, select A1.
2. If, during archiving, Content Collector for SAP should check whether the
archive ID that is submitted by an Object Linking and Embedding (OLE)
request matches the specified logical archive ID, select the Check archive
matching check box.
For this example, select the check box.
3. Click Next to provide information about the selected queue type.

Figure 35 on page 64 shows the Logical archive window containing the sample
specifications.

Chapter 5. Configuring Archiving Client 63


Figure 35. Logical archive window showing the sample specifications

What to do next: “Providing details about the directory”

Providing details about the directory:

You must specify the directory in which the scanning application stores the
scanned documents.

In the Directory Queue window, specify the following information:

Procedure:
1. In the Path name field, specify the full path to the directory that contains the
scanned documents.
For example, type:
C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\queues\
dir
2. Make sure that the Use filename as barcode check box is selected. During
archiving, Content Collector for SAP sends the file names of the scanned
documents as bar codes to SAP. If you leave the check box clear, you receive an
error message because the archived documents cannot be linked to the SAP
business objects.
3. Click Next.

Figure 36 on page 65 shows the Directory Queue window containing the sample
path to the directory where the scanned documents are stored.

64 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 36. Directory Queue window showing the sample path to the directory where the
scanned documents are stored

What to do next: “Completing the creation of the queue of type DirQueue”

Completing the creation of the queue of type DirQueue:

Click Finish to create the queue.

You are returned to the IBM Content Collector for SAP Applications - Archiving
Client window. The queue is listed in the navigation pane and is ready for use.

What to do next:
v If you had to stop automatic processing, enable it again by clicking Autom.
Processing > Enable in the IBM Content Collector for SAP Applications -
Archiving Client window.
v “Saving and reusing the queue information” on page 71.

Creating queues if the scanned documents are in the file system


and a description file exists
Create queues of type FileQueue if your scanning application stores the scanned
documents in the file system and creates a description file. The description file
contains an entry for each scanned document.

Archiving Client stores only the documents for which an entry in the description
file exists. Each entry must contain the file name of the scanned document. If the
bar code of the document is to be processed, the entry must also contain the bar
code. If the entries contain additional attribute values for the documents, Archiving
Client can store them with the documents.

Procedure:
1. “Providing details about the queue of type FileQueue” on page 66
2. “Defining the connection to Collector Server” on page 67

Chapter 5. Configuring Archiving Client 65


3. “Connecting the queue to a logical archive” on page 68
4. “Providing details about the directory and the description file” on page 69
5. “Completing the creation of the queue of type FileQueue” on page 71

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:

Procedure:
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 “Adding or removing SAP
document formats” on page 74.
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 67 shows what the Queue window might look like after you
completed step 1 through step 4.

66 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 37. 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
66

In the Connection Properties window, provide the following information:

Procedure:
1. You can use an existing server connection or create one:
v To use an existing server connection, click it under Available connections.
The details of the server connection are shown in the Archive Host/IP
address, Port, and WebPort fields.
v To create a server connection, complete these steps:
a. In the Archive Host/IP address field, type the host name or the IP
address of Collector Server.
If Collector Server and Archiving Client are not installed on the same
computer and you want to specify the host name, use the fully qualified
host name, such as myhost.yourserver.com, or the IP address of the
remote host. The default value is 127.0.0.1 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 67


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:
5580
2. 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 67

In the “Logical archive” window, specify the following information:

Procedure:

68 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 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 68

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"

Chapter 5. Configuring Archiving Client 69


Each attribute value of a document is enclosed in double quotation marks to mark
its beginning and its end. 246148 is an example for a bar code, and
C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\queues\
file\order.tiff is an example for a fully qualified file name of a scanned
document. Both attribute values are mandatory. Other attribute values, such as
myclient or order, are optional. You can store optional attribute values with the
documents so that the documents are easier to find.

In the File Queue window, specify the following information:

Procedure:
1. In the Path name for description files field, specify the full path to the
directory that contains the description file.
For example, type:
C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ArchivingClient\FileData
2. In the Extension of description files field, type the extension of the description
file.
For example, type:
txt
3. In the File column field, type the number of the column in the description file
that contains the file name of each scanned document.
In the description file example, the file name is in the fourth column. Thus, you
would enter 4 in the File column field.
4. In the Barcode column field, type the number of the column in the description
file that contains the bar code of each scanned document.
In the description file example, the bar code is in the third column. Thus, you
would enter 3 in the Barcode column field.
5. Click Next to select the attributes that are listed in the description file for each
document and that are to be stored with a document.

Figure 40 on page 71 shows what the File Queue window might look like after you
completed step 1 through step 4.

70 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 40. File Queue window showing the sample specifications

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 “Saving and reusing the queue information.”

Saving and reusing the queue information


At any time, you can save the queue information to a file. When you start
Archiving Client the next time, you can open and reuse the queue information.

You can save various statuses of the queue information under different file names.
For example, you might want to create one queue and then save the information
under a specific file name. After you create another queue, you might want to save
the information about both queues under a different file name.

You save, change, and reopen the queue information in the IBM Content Collector
for SAP Applications - Archiving Client window.

Procedure:

Chapter 5. Configuring Archiving Client 71


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: “Enabling Collector Server to use Archiving Client” on page 75

Viewing and changing the properties of a queue


You can view the properties of a queue and you can change some of the queue
properties.

Before you begin: If automatic processing is enabled and you want to change any
properties, disable automatic processing by clicking Autom. Processing > Stop in
the IBM Content Collector for SAP Applications - Archiving Client window.

Procedure:
1. In the navigation pane of the IBM Content Collector for SAP Applications -
Archiving Client window, select the queue that you want to change, and click
Queue > Properties. The “Properties of queue” window opens.
2. In the “Properties of queue” window, you can change specific settings on
various pages.

Note: For queues of type CMQueue, you cannot change the server connection
because these queues always use the Collector Server that you specified when
you created the queue.
3. Click OK to save your changes and to return to the IBM Content Collector for
SAP Applications - Archiving Client window.

Figure 41 on page 73 shows the Queue page of the “Properties of queue” window
containing the details about a sample queue of type DirQueue.

72 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 41. 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 Servers
You can view details about the connections between Archiving Client and the
Collector Servers.

Before you begin: If you enabled automatic processing, disable it by clicking


Autom. Processing > Stop in the IBM Content Collector for SAP Applications -
Archiving Client window.

Procedure:
1. In the navigation pane of the IBM Content Collector for SAP Applications -
Archiving Client window, click a queue, and click Queue > Connections Info.
In the Connections Information window, you can view the details about all
configured connections, which are sorted by queue name. The information
includes the connections status and details about the SAP system to which
Collector Server is connected.
2. Click Refresh to view the latest information. You might want to refresh if a
new connection was configured after you opened the Connections Information
window.
3. Click Close to close the window.

Figure 42 on page 74 shows the Connections Information window with two sample
connections.

Chapter 5. Configuring Archiving Client 73


Figure 42. Connections Information window showing the connection information that you
defined for two sample queues

If you had to stop automatic processing, enable it again by clicking Autom.


Processing > Enable in the IBM Content Collector for SAP Applications -
Archiving Client window.

Deleting a queue
You can delete a queue even if it still contains scanned documents. You can delete
the scanned documents together with the queue.

Procedure:
1. In the navigation pane of the IBM Content Collector for SAP Applications -
Archiving Client window, select a queue, and click Queue > Delete. If the
queue contains scanned documents, the following message is displayed:
DIALOG19: When deleting the selected queue, do you want
the scanned original documents to be deleted as well?
2. Make your selection. If you click Yes, the scanned documents are deleted
together with the queue. If you click No, only the queue is removed.

Adding or removing SAP document formats


When you create a queue, you must select a document format so that SAP can
open a suitable application for viewing the archived documents. When you archive
a document, the selected format is stored with it. The document formats from
which you can choose are in the file csdoctypes.ini. You can add more document
formats to this file or remove document formats.

Procedure:
1. Open the csdoctypes.ini file in a text editor. This file is in the directory of
your Archiving Client installation. The content of the file looks as follows:
;FAX is a mandatory doctype. It has to be in the list of doctypes.

[CSClientDocTypes]
doctypes=FAX,TIF,PDF,ALF,TXT,JPG,GIF,DOC,RTF,XLS,PPT,LWP,123,MPG
The lines that start with a semicolon are comments.
2. Add the missing SAP document formats after the doctypes= tag. Separate the
entries by a comma. Type all formats on one line.

74 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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.

Enabling Collector Server to use Archiving Client


You must enable Collector Server to start at least one client dispatcher.

Procedure:
1. Open the server configuration profile of the Collector Server that you want to
use, in a text editor.
2. Set the ARCHWINS keyword to a value greater than 0.
3. Save the server configuration profile, and restart Collector Server for the
changes to take effect.

What to do next: If you are configuring your environment for archiving your
documents by creating work items in an SAP workflow, return to “Configuring for
archiving incoming documents by creating work items in an SAP workflow” on
page 115.

Chapter 5. Configuring Archiving Client 75


76 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Chapter 6. Configuring 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 the information center or of IBM Content Collector for SAP
Applications: Installation, Configuration, and User's Guide, SH12-6989.
2. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.
3. Chapter 4, “Configuring Collector Server,” on page 25.
4. Set up secure client connections. For more information, see the corresponding
topic in the Security part of the information center or of IBM Content Collector
for SAP Applications: Installation, Configuration, and User's Guide, SH12-6989.

Setting up Viewing Client


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 43 on page 78 shows what the Viewing Client Setup window might look
like after you completed the topics “Defining the connection to Collector Server”
on page 78 through “Enabling logging and tracing for Viewing Client” on page 81.

© Copyright IBM Corp. 2010, 2013 77


Figure 43. Viewing Client Setup window containing sample specifications

Procedure:
1. “Defining the connection to Collector Server”
2. “Specifying the directory for temporary files” on page 79
3. “Specifying a viewer application” on page 80
4. “Enabling the closing of applications” on page 82
5. Optional: “Enabling logging and tracing for Viewing Client” on page 81
6. “Completing the setup of Viewing Client” on page 83

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 127.0.0.1 for Internet Protocol
version 4 (IPv4) and ::1 for Internet Protocol version 6 (IPv6), which designates
the local host.

78 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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:
5500
3. 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 44 shows what the Preferred Server Connection area of the Setup window
might look like after you completed step 1 on page 78 through step 3.

Figure 44. 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: “Specifying the directory for temporary files”

Specifying the directory for temporary files


| By default, Viewing Client stores the temporary files in the env_var_appdata\IBM\
| ICCSAP\ViewingClient directory of the user who started Viewing Client. You can
| specify another directory.

Before you begin: Plan for secure connections to Archiving Client and Viewing
Client. For more information, see the corresponding topic in the Security part of
the information center or of IBM Content Collector for SAP Applications:
Installation, Configuration, and User's Guide, SH12-6989.

Under Work path in the IBM Content Collector for SAP Applications - Viewing
Client Setup window, specify the following information:

Specify the full path to the directory where Viewing Client should store its
temporary files.
For example, type:
C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ViewingClient\

Chapter 6. Configuring Viewing Client 79


Figure 45 shows the Work path area of the Viewing Client Setup window
containing the sample path.

Figure 45. Work path area of the Viewing Client Setup window containing the sample path

What to do next: “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: “Setting up the connection between Collector Server and SAP
through HTTP” on page 35.

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 email 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:
5580
2. Select the Enhanced functionality check box if the functions Process note
and Send email are to be displayed in the browser. With Process note, you
can add text notes to an archived document. With Send email, you can
attach the displayed document, including any notes, to an email.
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 46 on page 81 shows what the Viewing area of the Viewing Client Setup
window might look like after you completed step 1 through step 3.

80 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 46. Viewing area of the Viewing Client Setup window containing the sample
specifications

What to do next: “Enabling logging and tracing for Viewing Client”

Enabling logging and tracing for Viewing Client


You can enable Viewing Client to log its activities in log files and trace files. You
can enable a general log file, a log file that contains information about the
communication between Viewing Client and Collector Server, and a trace for error
analysis. In addition, you can specify where the log files and the trace files are to
be stored.

Note, however, that logging and tracing affects the performance of Content
Collector for SAP.

If possible, use the path where you store the temporary files as path for all log files
and trace files.

Under Logging and Tracing in the IBM Content Collector for SAP Applications -
Viewing Client Setup window, specify the following information:
v To enable general logging, complete these steps:
1. Select the Enable check box next to the Log file field.
2. In the Log file field, specify the fully qualified path to the log file. You can
specify a path of your choice.
For example, type:
C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ViewingClient\
ICCSAP_VC.log
v To record information about the communication between Viewing Client and
Collector Server, complete these steps:
1. Select the Enable check box next to the API trace file field.
2. In the API trace file field, specify the fully qualified path to the trace file.
You can specify a path of your choice.
For example, type:
C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ViewingClient\
ICCSAP_ClientAPI.trc
v To collect more details about the activities of Viewing Client, complete these
steps:
1. Select the Enable check box next to the Trace file field.

Chapter 6. Configuring Viewing Client 81


2. In the Trace file field, specify the fully qualified path to the trace file. You
can specify a path of your choice.
For example, type:
C:\Users\iccsapuser1\AppData\Roaming\IBM\ICCSAP\ViewingClient\
ICCSAP_VC.trc
3. In the Maximum file size field, click the arrows to select the maximum size
of the trace file, in KB. You can specify a number up to, and including, 10240
KB. If the trace file exceeds the limit, the oldest information is overwritten.
For example, type:
300
4. Select the Clear trace file check box if you want to delete the existing trace
file each time you start Viewing Client.

Note: If you select the check box, you might lose valuable information for
error recovery if the same error recurs.
For this example, leave this check box clear.

Figure 47 shows the Logging and Tracing area of the Setup window with the
entire logging and tracing enabled.

Figure 47. Logging and Tracing area of the Viewing Client Setup window containing the
sample specifications

What to do next: “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 48 on page 83 shows the File and Viewer Management area of the Viewing
Client Setup window containing your selection.

82 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 48. File and Viewer Management area of the Viewing Client Setup window containing
your selection

What to do next: “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: “Enabling Collector Server to use Viewing Client”

Enabling Collector Server to use Viewing Client


You must enable Collector Server to start at least one client dispatcher.

Procedure:
1. Open the server configuration profile of the Collector Server that you want to
use, in a text editor.
2. Set the ARCHWINS keyword to a value greater than 0.
3. Save the server configuration profile, and restart Collector Server for the
changes to take effect.

What to do next: If you are configuring your environment for viewing archived
documents, continue with “Registering Viewing Client with SAP” on page 145.

Chapter 6. Configuring Viewing Client 83


84 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Chapter 7. Configuring your environment for basic tasks
Archiving and viewing data and print lists and archiving, linking, and viewing
documents are the basic tasks that you probably perform most frequently. As a
basic environment, you need the SAP GUI, Collector Server, and one or more
archives. For some tasks, you need an additional Content Collector for SAP
component. The following sections explain how to configure your environment for
the basic tasks and which additional components you need.

This information does not cover the tasks that you configure in SAP only. It covers
only those tasks where the configuration of one or more components of Content
Collector for SAP is required.

Configuring for archiving data


Content Collector for SAP supports various data archiving solutions. For example,
it supports the archiving of data on different media, such as hard disks, tapes, or
WORMs. In addition, it supports automatic moving of data from one medium to
another. To archive data, you need the basic environment.

Before you begin:


1. Chapter 2, “Preparing your environment,” on page 3.
2. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.
3. “Configuring Collector Server for use with Tivoli Storage Manager” on page 25.
4. “Configuring the connection between Collector Server and SAP” on page 34.
Configure either an HTTP connection or a Remote Function Call (RFC)
connection.
5. “Starting Collector Server for the first time” on page 49.

Figure 49 on page 86 shows which parts of the Content Collector for SAP
environment must be configured so that you can archive data.

© Copyright IBM Corp. 2010, 2013 85


SAP GUI

SAP ERP
1
RFC dispatcher
ArchiveLink®
Engine

3
Tivoli TM Storage Manager/
HTTP dispatcher TSM agent System Storage
Archive Manager

Collector Server instance

= SAP = archives = Content Collector for SAP = connection information


1 = RFC 3 = HTTP
communication communication

Figure 49. 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.

Procedure:
1. “Setting up the sample archiving object FI_BANKS”
2. “Configuring the SAP ArchiveLink path” on page 88
3. “Checking your data archiving configuration” on page 92
4. “Creating test data for the sample archiving object” on page 94
5. “Running an archiving session to test your archiving setup” on page 95

Setting up the sample archiving object FI_BANKS


Configure SAP for the use of the sample archiving object FI_BANKS.

Procedure:
1. In the SAP GUI, enter the transaction code SARA to open the Archive
Administration: Initial Screen window.
2. In the Object Name field, specify:
FI_BANKS
Figure 50 on page 87 shows the Archive Administration: Initial Screen
containing the sample archiving object name.

86 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 50. 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 51 shows which item to double-click in the Data Archiving Customizing
window.

Figure 51. 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 7. Configuring your environment for basic tasks 87


Figure 52 shows what the Change View "Customizing View for Archiving":
Details window might look like after you completed step 5a on page 87 and
step 5b on page 87.

Figure 52. Change View "Customizing View for Archiving": Details window containing your
settings

6. Click the Save icon to save your settings.


7. In the “Prompt for Workbench request” window, select a request in the
Request field. If a request does not exist yet, click the Create icon to create
a request.

8. Click the Continue icon to return to the Change View "Customizing View
for Archiving": Details window.

What to do next: “Configuring the SAP ArchiveLink path”

Configuring the SAP ArchiveLink path


Complete these steps to configure the SAP ArchiveLink path.

Before you begin: “Setting up the sample archiving object FI_BANKS” on page 86

Procedure:
1. In the SAP GUI, enter the transaction code FILE to open the Change View
"Logical File Path Definition": Overview window. If a window opens with the
message Caution: The table is cross-client., press Enter.
2. In the table, select ARCHIVE_GLOBAL_PATH by clicking in the first cell of
the row that contains this entry.
3. Double-click Assignment of Physical Paths to Logical Path in the Dialog
Structure pane on the left.

88 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 53 shows which items you must select in the Change View "Logical File
Path Definition": Overview window.

Figure 53. 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 54 on page 90 shows what your selection might look like.

Chapter 7. Configuring your environment for basic tasks 89


Figure 54. 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 55 shows what your specification might look like.

Figure 55. 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.

90 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
7. In the Change View "Logical File Name Definition, Cross-Client": Overview
window, double-click ARCHIVE_DATA_FILE_WITH_ARCHIVE_LINK.
Figure 56 shows which item you must double-click.

Figure 56. 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 57 shows which field you must check.

Figure 57. 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 56, which also lists the ARCHIVE_DATA_FILE table entry.

Chapter 7. Configuring your environment for basic tasks 91


11. Check whether the Logical path field shows ARCHIVE_GLOBAL_PATH. Correct the
path, if necessary.
Figure 58 shows which field you must check.

Figure 58. Change View "Logical File Name Definition, Cross-Client": Details window showing
which field to check

12. Click the Save icon to save your settings.

What to do next: “Checking your data archiving configuration”

Checking your data archiving configuration


Check the configuration for your sample archiving object FI_BANKS.

Before you begin: “Configuring the SAP ArchiveLink path” on page 88

Procedure:
1. In the SAP GUI, enter the transaction code SARA to open the Archive
Administration: Initial Screen window.
2. In the Object Name field, specify:
FI_BANKS
Figure 50 on page 87 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 51 on page 87 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

92 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
c. Check whether the Production Mode Variant field contains a production
variant, for example:
SAP&PROD
d. Under Delete Jobs, check whether Start Automatically is selected.
e. Under Place File in Storage System, check whether the correct archive is
specified in the Content Repository field.
For example, check if A1 is specified.
f. Check whether the Start Automatically check box is selected. This setting
ensures that, when the archiving session is run, a request is automatically
sent to Content Collector for SAP to archive the file that was generated with
SAP.
g. Under Sequence, check whether Store Before Deleting is selected.
Figure 59 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 92 through step 5g.

Figure 59. Change View "Customizing View for Archiving": Details window containing the
necessary settings

6. Click the Save icon to save your settings.


7. In the “Prompt for Workbench request” window, select a request in the
Request field. If a request does not exist yet, click the Create icon to create
a request.

Chapter 7. Configuring your environment for basic tasks 93


8. Click the Continue icon to return to the Change View "Customizing View
for Archiving": Details window.

Your settings are saved.

What to do next: “Creating test data for the sample archiving object”

Creating test data for the sample archiving object


Complete these steps to create test data for the sample archiving object FI_BANKS.

Before you begin: “Checking your data archiving configuration” on page 92

Procedure:
1. In the SAP GUI, enter the transaction code FI01 to open the Create Bank: Initial
Screen window.
2. In the Bank Country field, type:
AD
3. In the Bank Key field, type:
1234567
Figure 60 shows what the Create Bank: Initial Screen window might look like
after you completed step 2 and step 3.

Figure 60. 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 61 on page 95 shows the Create Bank: Detail Screen window containing
the bank name.

94 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 61. Create Bank: Detail Screen window containing the bank name

6. Click the Save icon to save your settings.

What to do next: “Running an archiving session to test your archiving setup”

Running an archiving session to test your archiving setup


Test your setup by archiving the test data for archiving object FI_BANKS.

Before you begin: “Creating test data for the sample archiving object” on page 94

Procedure:
1. In the SAP GUI, enter the transaction code SARA to open the Archive
Administration: Initial Screen window.
2. In the Object Name field, specify:
FI_BANKS
3. Optional: If necessary, click Customizing to check and correct your
configuration settings.
4. Click Write.
5. In the Archive Administration: Create Archive Files window, specify a variant
in the Variant field
For example, type:
test_variant
Figure 62 on page 96 shows the Archive Administration: Create Archive Files
window containing the sample variant test_variant.

Chapter 7. Configuring your environment for basic tasks 95


Figure 62. 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 63 on page 97 shows what the Maintain Variant window might look
like after you completed step 9.

96 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 63. 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 64 on page 98 shows which button to click in the Start Time window.

Chapter 7. Configuring your environment for basic tasks 97


Figure 64. 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 65 shows the Background Print Parameters window containing the
sample printer.

Figure 65. Background Print Parameters window containing the sample printer LP01

98 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 submit
ARV_FI_BANKS_WRIno write
ARV_FI_BANKS_DELno delete
ARV_FI_BANKS_STOno 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 59 on page 93.

Configuring for archiving data by using BC-ILM


To archive data by using the WebDAV Storage Interface for SAP NetWeaver
Information Lifecycle Management (BC-ILM), SAP Application Server must be
installed as a J2EE Engine, or as an ABAP Engine and a J2EE Engine.

Before you begin:


1. “Preparing your environment for Collector Server” on page 3.
2. “Configuring your environment for Tivoli Storage Manager” on page 4.
3. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19. Ensure that you created an archive copy group for
XML-based data archiving.
4. “Configuring Collector Server for use with Tivoli Storage Manager” on page 25.
5. “Setting the number of HTTP dispatchers” on page 36.
6. “Starting Collector Server for the first time” on page 49.

Figure 66 on page 100 gives an overview of how the life-cycle management of SAP
data is integrated with Content Collector for SAP.

Chapter 7. Configuring your environment for basic tasks 99


local archive local archive
. .. administration . .. administration
XML Archiving XML Archiving
Program Program
Applications XML Archive API XML Archive API
XML DAS Connector XML DAS Connector

SAP NetWeaver Application Server Java SAP NetWeaver Application Server ABAP

http(s) http(s)

XML Data Administration XML Data Archiving Service


Archiving
system

(robust) Content Collector


file system for SAP

Figure 66. Overview of a life-cycle management environment

Figure 67 shows which parts of the Content Collector for SAP environment must
be configured so that you can archive data by using BC-ILM.

SAP ERP

ArchiveLink®

Engine
SAP J2EE

XML DAS

Tivoli TM Storage Manager/


HTTP dispatcher TSM agent System Storage
Archive Manager
WebDAV
Collector Server instance

= SAP = archives = Content Collector for SAP = connection information

Figure 67. Configuration of your Content Collector for SAP environment for archiving data by using BC-ILM

By completing the prerequisite tasks that are listed at the beginning of this topic,
you should have configured the following parts:
v Tivoli Storage Manager, where the data is to be stored
v Collector Server
v At least one HTTP dispatcher for the communication between Collector Server
and SAP

To archive data by using BC-ILM, you must configure XML Data Archiving Service
(XML DAS) and your SAP system. In addition, you must further configure Content
Collector for SAP. Take these steps:
100 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
1. “Creating a user for ILM-enabled data archiving”
2. “Enabling Collector Server for data archiving by using BC_ILM” on page 105
3. “Creating a root collection in the empty Tivoli Storage Manager archive” on
page 105
4. “Creating a destination in XML Data Archiving Service (XML DAS)” on page
106
5. “Creating an archive store in XML Data Archiving Service (XML DAS)” on
page 108
6. “Configuring the connection between SAP Web Application Server ABAP and
XML Data Archiving Service (XML DAS)” on page 109
7. “Creating the home paths for the archiving objects in the Tivoli Storage
Manager archive” on page 112
8. “Assigning the home paths to the archive store” on page 114

Creating a user for ILM-enabled data archiving


Create a user who is allowed to archive data by using XML Data Archiving Service
(XML DAS). The procedure for creating this user depends on whether the user
data is stored in the SAP J2EE database or in the SAP ECC database.

It is assumed that the administrator who is allowed to create such a user exists.

Creating a user for ILM-enabled data archiving if the user data is


stored in the SAP J2EE database
Complete these steps if you installed the SAP Application Server as a J2EE Engine.
This topic shows how to create the sample user XMLDAS.
1. Start the J2EE Engine Visual Administrator.
2. In the navigation pane on the left, click the Cluster tab.
3. Select your server and then select Services > Security Provider.
4. In the content pane, click the Switch to the edit mode icon .
5. Create the user:
a. In the content pane, click the User Management tab.
b. Click Create User.
c. In the Create New User window, type the name of the user. For example,
type:
XMLDAS
You must later specify this user name in the server configuration profile and
when you create the destination for the data.
d. Type a password for the user. Repeat the password in the Confirm
password field. Then click OK.
6. Change a property for the user:
a. On the Users page of the User Management page, type XMLDAS in the Name
field. Then click Search.
Figure 68 on page 102 shows how to search for sample user XMLDAS.

Chapter 7. Configuring your environment for basic tasks 101


Figure 68. Visual Administrator window showing where to specify the user name and where
to click Search

b. Click the user in the search result box. The pane in the middle of the User
Management page shows the properties for the selected user.
c. Under Authentication, select the No password change required check box.
Figure 69 on page 103 reflects step 6b and step 6c.

102 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 69. Visual Administrator window showing how to specify No password change
required for sample user XMLDAS

7. Add the user to the necessary security concept:


a. Click the Policy Configurations tab.
b. Under Components, click sap.com/
tc~TechSrv~XML_DAS*DataArchivingService. The list might not be sorted
alphabetically.
c. Click the Security Roles tab.
d. Under Security Roles, click XMLDASSecurityRole.
e. Under Mappings, next to Users, click Add to add the user to the selected
security role.
Figure 70 on page 104 shows how to add user XMLDAS to the specified
security role.

Chapter 7. Configuring your environment for basic tasks 103


Figure 70. Visual Administrator window showing how to add sample user XMLDAS to the
specified security role

What to do next: “Enabling Collector Server for data archiving by using BC_ILM”
on page 105

Creating a user for ILM-enabled data archiving if the user data is


stored in the SAP ECC database
Complete these steps if you installed the ABAP and the J2EE stack on the SAP
Application Server.
1. “Creating a user with CPIC access” on page 5. Note the following
specifications:
v As user name, you can specify a name of your choice. For example, specify:
XMLDAS
v On the “Logon data” page of the Maintain User window, select System from
the User Type list.
2. Start the J2EE Engine Visual Administrator.
3. In the navigation pane on the left, click the Cluster tab.
4. Select your server and then select Services > Security Provider.
5. In the content pane, click the Switch to the edit mode icon .
6. Add the user to the necessary security concept:
a. Click the Policy Configurations tab.
b. Under Components, click sap.com/
tc~TechSrv~XML_DAS*DataArchivingService. The list might not be sorted
alphabetically.
c. Click the Security Roles tab.
d. Under Security Roles, click XMLDASSecurityRole.
e. Under Mappings, next to Users, click Add to add the user to the selected
security role.
See Figure 70.

104 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
What to do next: “Enabling Collector Server for data archiving by using BC_ILM”

Enabling Collector Server for data archiving by using BC_ILM


You enable Collector Server to communicate with XML Data Archiving Service
(XML DAS) by changing the appropriate ARCHIVE section in the server
configuration profile.

Before you begin: “Creating a user for ILM-enabled data archiving” on page 101

Procedure:
1. Open the server configuration profile of the Collector Server that you want to
use, in a text editor.
2. Search for the ARCHIVE section that defines an archive for ILM-enabled data
archiving. In the ARCHIVE section, the STORAGETYPE keyword must have the
setting TSM_WEBDAV:
ARCHIVE A3
STORAGETYPE TSM_WEBDAV
.
.
.
The server configuration profile that is delivered with Content Collector for
SAP (archint_sample_tsm.ini) provides a complete example of such an
ARCHIVE section.
3. For the WEBDAV_AUTH keyword, specify the user who is allowed for ILM-enabled
data archiving and whom you previously created:
WEBDAV_AUTH XMLDAS
You must specify this user once in a server configuration profile. It applies to
all archives for ILM-enabled data archiving that are defined in the server
configuration profile.
4. Save the 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 webdavpasswd password
password stands for the password of the user who is allowed for
ILM-enabled data archiving. The password is stored in the password file.
c. Enter archpro to start Collector Server.

What to do next: “Creating a root collection in the empty Tivoli Storage Manager
archive”

Creating a root collection in the empty Tivoli Storage Manager


archive
Content Collector for SAP supplies a command-line tool for creating a root
collection.

Before you begin: “Enabling Collector Server for data archiving by using BC_ILM”

Procedure:
1. Log on to the operating system with your Content Collector for SAP user ID.

Chapter 7. Configuring your environment for basic tasks 105


2. On a command line, change to the bin directory of your Collector Server
installation.
3. Enter the following command:
manage_root_collection port archive_id root_collection_path create
port Specify the value of the ARCHPRO_PORT keyword, which is defined in the
server configuration profile.
archive_id
Specify the logical archive ID of the Tivoli Storage Manager archive
where you want to create the root collection. You find this ID next to
the ARCHIVE keyword in your server configuration profile. Note that the
ARCHIVE section must contain the following setting:
STORAGETYPE TSM_WEBDAV
root_collection_path
Specify a path in the following format:
/node_1/node_2/.../node_N/

Each node_i is the name of a logical node in the storage hierarchy. If


you use a single path, the root node, which is denoted by the slash (/),
is sufficient. If you need several paths, make sure that they do not
overlap.
Example:
manage_root_collection 5500 A3 /rootcoll1/ create
4. To remove an existing empty root collection, run the following command:
manage_root_collection port archive_id root_collection_path remove

The entire path is removed.

What to do next: “Creating a destination in XML Data Archiving Service (XML


DAS)”

Creating a destination in XML Data Archiving Service (XML


DAS)
In the destination, you specify where the data must be archived.

This topic shows how to create the sample destination WEBDAV_DEST.

Before you begin: “Creating a root collection in the empty Tivoli Storage Manager
archive” on page 105

Procedure:
1. Start the J2EE Engine Visual Administrator.
2. In the navigation pane on the left, click the Cluster tab.
3. Select Services > Destinations.
4. In the Destinations pane on the Runtime page, select HTTP.
Figure 71 on page 107 shows where to select HTTP.

106 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 71. Visual Administrator window showing where to select HTTP

5. Click New to create a destination.


6. In the window that opens, type a name for the destination, and then click OK.
For example, type:
WEBDAV_DEST
7. Under Connection Settings, in the URL field, type the fully qualified path to
the root collection that you previously created. Use the following format for
the path:
http://server:port/root_collection_path
server Specify the host name or the IP address of Collector Server.
port Specify the value of the WEBPORT keyword, which is defined in the
server configuration profile.
root_collection_path
Specify the path to the root collection.
Example:
http://localhost:5580/rootcoll1/
8. Under Logon Data, select BASIC from the Authentication list.
9. Under Basic Authentication, type the name of the user who is allowed for
ILM-enabled data archiving.
For example, type:
XMLDAS
Figure 72 on page 108 shows the Visual Administrator window containing the
sample information and the necessary settings that you specified in step 7
through step 9.

Chapter 7. Configuring your environment for basic tasks 107


Figure 72. Visual Administrator window containing the necessary settings for creating a
destination

10. Click Save.


11. If necessary, restart the Destinations service so that the new destination can be
used.

What to do next: “Creating an archive store in XML Data Archiving Service (XML
DAS)”

Creating an archive store in XML Data Archiving Service (XML


DAS)
Complete these steps to create an archive store.

This topic shows how to create the sample archive store WEBDAV_STORE.

Before you begin: “Creating a destination in XML Data Archiving Service (XML
DAS)” on page 106

Procedure:
1. Open XML DAS Administration by using the following web address:
http://SAP J2EE Engine host:HTTP port/DataArchivingService/DAS

An example web address would be:


http://sapj2ee:50000/DataArchivingService/DAS
2. Log on to XML DAS Administration with the name of the user who is allowed
for ILM-enabled data archiving, for example, XMLDAS.
3. Click Archive Store Management.
4. Click Define.

108 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
5. Specify the following information:
a. In the Archive Store column, type a name for the store.
For example, type:
WEBDAV_STORE
b. Optional: In the Description column, type a description.
c. From the list in the Store Type column, select WebDAV System.
d. From the list in the Destination column, select the destination that you
previously created.
For example, select WEBDAV_DEST.
e. In the Proxy Port column, type the HTTP port of your proxy server, if
necessary.
6. Click OK to create the archive store.

Figure 73 shows what your specifications can look like.

Figure 73. XMLDASAdministration window containing sample specifications

What to do next: “Configuring the connection between SAP Web Application


Server ABAP and XML Data Archiving Service (XML DAS)”

Configuring the connection between SAP Web Application


Server ABAP and XML Data Archiving Service (XML DAS)
Create an HTTP connection.

This topic shows how to create the sample connection XML_SRV_CONN1.

Before you begin: “Creating an archive store in XML Data Archiving Service (XML
DAS)” on page 108

Procedure:
1. In the SAP GUI, enter the transaction code SM59 to open the Configuration of
RFC Connections window.
2. In the RFC Connections column, click HTTP Connections to External Server
and then click the Create icon .
3. In the RFC Destination field of the RFC Destination window, type a name for
the RFC destination.
For example, type:
XML_SRV_CONN1

Chapter 7. Configuring your environment for basic tasks 109


4. Under Description, type a description in one or more of the Description
fields.
For example, type:
XML Data Archiving Service
5. Click the Technical Settings tab.
6. Under Target System Settings, in the Target Host field, type the host name or
the IP address of the SAP J2EE Engine.
For example, type:
sapj2ee
7. In the Path Prefix field, type the relative path to the XML DAS installation.
For example, type:
/DataArchivingService/DAS
Figure 74 shows what the RFC Destination window looks like after you
completed step 3 on page 109 through step 7.

Figure 74. RFC Destination window containing the sample settings

8. Click the Logon & Security tab. When the message HTTP connections may not
be secure is displayed, press Enter.
9. Under Logon Procedure, click Basic Authentication.
Figure 75 on page 111 shows the Logon & Security page of the RFC
Destination window containing the required setting.

110 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 75. Logon & Security page of the RFC Destination window containing the required
setting

10. When the message Do you want to change the HTTP logon procedure is
displayed, click Yes.
11. Click the Special Options tab.
12. Under Status of HTTP Version, select HTTP 1.1.
Figure 76 on page 112 shows the Special Options page of the RFC Destination
window containing the required setting.

Chapter 7. Configuring your environment for basic tasks 111


Figure 76. Special Options page of the RFC Destination window containing the required
setting

13. Click the Save icon to save your settings.


14. Click Connection Test to verify that the connection can be established.

What to do next: “Creating the home paths for the archiving objects in the Tivoli
Storage Manager archive”

Creating the home paths for the archiving objects in the Tivoli
Storage Manager archive
For each archiving object, create a home path in the empty root collection of the
archive.

This topic shows how to create a home path for sample archiving object
BC_SBOOK_X.

Before you begin: “Configuring the connection between SAP Web Application
Server ABAP and XML Data Archiving Service (XML DAS)” on page 109

Procedure:
1. In the SAP GUI, enter the transaction code SARA to open the Archive
Administration: Initial Screen window.
2. In the Object Name field, specify the name of the archiving object, for example,
BC_SBOOK_X.
3. Click Customizing to open the Data Archiving Customizing window.
4. Under Basis Customizing, double-click Customizing of Home Paths.

112 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 77 shows which item to double-click in the Data Archiving Customizing
window.

Figure 77. Data Archiving Customizing window

5. In the Change View "Customizing View for Archiving": Details window, check
whether the Home Path field contains the following entry:
/<SYSID>/<CLIENT>/<OBJECT>/
At run time, the individual parameters are replaced as follows:
SYSID
Is replaced with the system ID of your SAP system.
CLIENT
Is replaced with for the name of the SAP client.
OBJECT
Is replaced with for the name of the archiving object.
Figure 78 shows what the setting must look like.

Figure 78. Change View "Customizing of Home Paths": Details window containing the
required setting

6. Click the Back icon twice to return to the Data Archiving Customizing
window.
7. Under Basis Customizing, double-click Synchronization of Home Paths.

Chapter 7. Configuring your environment for basic tasks 113


8. In the Synchronization of Home Paths for XML-Based Archiving window, click
Production Mode and then click the Execute icon .

If, for example, you are working with SAP client 800 of SAP ID (SID) EC6 and the
root collection path is /rootcoll1/, your Tivoli Storage Manager archive then
contains the following folder structure:
/rootcoll1/ec6/
/rootcoll1/ec6/800/
/rootcoll1/ec6/800/bc_sbook_x

What to do next: “Assigning the home paths to the archive store”

Assigning the home paths to the archive store


You must assign the home paths to the archive store that you created in XML Data
Archiving Service (XML DAS).

This topic shows how to assign the home path for sample archiving object
SB_BOOK_X, which is /rootcoll1/ec6/800/bc_sbook_x, to the sample archive store
WEBDAV_STORE.

Before you begin: “Creating the home paths for the archiving objects in the Tivoli
Storage Manager archive” on page 112
1. Open XML DAS Administration by using the following web address:
http://SAP J2EE Engine host:HTTP port/DataArchivingService/DAS

An example web address would be:


http://sapj2ee:50000/DataArchivingService/DAS
2. Log on to XML DAS Administration with the name of the user who is allowed
for ILM-enabled data archiving, for example, XMLDAS.
3. Click Archive Hierarchy & Store Assignment.
4. Under Archive Paths, you see the contents of the root collection. Expand the
folder that shows the system ID of your SAP system until you see the archiving
objects.
To see the sample archiving object SB_BOOK_X, you would expand ec6 > 800.
5. Click an archiving object.
For example, click SB_BOOK_X.
6. Under Archive Path Properties, from the Archive Store list, select the archive
store to which you want to assign the home path. For example, select
WEBDAV_STORE.
7. Click Assign.
8. Repeat step 5 through step 7 for each home path that you want to assign.

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.

114 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 the information center or of IBM Content Collector for SAP
Applications: Installation, Configuration, and User's Guide, SH12-6989. Install
Archiving Client and the scanning application on the same computer as the
SAP GUI.
2. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.
3. “Configuring Collector Server for use with Tivoli Storage Manager” on page 25.
4. “Setting the number of Java RFC dispatchers” on page 35
5. 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 36
b. “Creating a content repository for the HTTP connection” on page 38
6. “Starting Collector Server for the first time” on page 49.

Figure 79 on page 116 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.

Chapter 7. Configuring your environment for basic tasks 115


OLE communication

Content Collector for SAP clients

Archiving Client

SAP GUI
csclient.dll

SAP ERP
Client dispatcher

ArchiveLink®

2
Engine
SAP
JCo 3 Java RFC dispatcher

Tivoli TM Storage Manager/


TSM agent System Storage
Archive Manager

Collector Server instance

= SAP = archives = Content Collector for SAP = connection information


2 = create work item

Figure 79. 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 At least one Java RFC dispatcher for the communication between Collector
Server and SAP
v 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. “Setting up Archiving Client” on page 54
b. “Creating queues if the scanned documents are in the file system” on page
60 or “Creating queues if the scanned documents are in the file system and
a description file exists” on page 65
c. “Saving and reusing the queue information” on page 71
d. “Enabling Collector Server to use Archiving Client” on page 75
2. “Associating the document type of the incoming documents with an SAP
workflow” on page 117
3. “Registering Archiving Client with SAP” on page 125

116 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
4. 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 126
b. “Adapting the SAP ArchiveLink protocol for archiving documents” on page
129

Associating the document type of the incoming documents with


an SAP workflow
Only those documents are linked to SAP business objects that can be associated
with a specific SAP workflow. You associate the documents with a specific SAP
workflow by specifying their document type in the queue from which the
documents are collected and by enabling this document type for the SAP
workflow.

Before you begin: Chapter 5, “Configuring Archiving Client,” on page 53

You added the document type to the queue when you created the queue in
Archiving Client. You enable the document type for an SAP workflow by taking
these steps:

Procedure:
1. In the SAP GUI, enter the transaction code OAD5 to open the ArchiveLink:
Document Type Customizing Wizard.
Figure 80 shows what the Start page of the ArchiveLink: Document Type
Customizing Wizard might look like.

Figure 80. Start page of the ArchiveLink: Document Type Customizing Wizard

2. Click Continue.
3. On the “Document type” page, specify the following information:

Chapter 7. Configuring your environment for basic tasks 117


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 81 shows what the “Document type” page of the ArchiveLink:
Document Type Customizing Wizard might look like with the sample
entries.

Figure 81. “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 82 on page 119 shows what the “Document type template” page of the
ArchiveLink: Document Type Customizing Wizard might look like.

118 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 82. “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 83 shows what the “Workflow document type” page of the
ArchiveLink: Document Type Customizing Wizard might look like.

Figure 83. “Workflow document type” page of the ArchiveLink: Document Type Customizing
Wizard with selected item

Chapter 7. Configuring your environment for basic tasks 119


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 118.
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 Value
Object type BKPF
Method CREATE
Task (for entry) TS30001128
Task (for assignment) TS30001117

For more details, see the SAP documentation.


Figure 84 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 84. “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.

120 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 85 shows what the “Workflow parameter” page of the ArchiveLink:
Document Type Customizing Wizard might look like with the sample
transaction code.

Figure 85. “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 86 on page 122 shows what the “Storage system and link table”
page of the ArchiveLink: Document Type Customizing Wizard might look
like with the sample values.

Chapter 7. Configuring your environment for basic tasks 121


Figure 86. “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 87 on page 123 shows what the “Selection from available presettings”
page of the ArchiveLink: Document Type Customizing Wizard might look
like.

122 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 87. “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 88 on page 124 shows what the “Create new presettings” page of the
ArchiveLink: Document Type Customizing Wizard might look like with a
sample presetting.

Chapter 7. Configuring your environment for basic tasks 123


Figure 88. “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 89 on page 125 shows the “Details of presettings” page of the
ArchiveLink: Document Type Customizing Wizard containing the
necessary settings.

124 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 89. “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 117

Procedure:
1. In the SAP GUI, enter the transaction code SOLE to open the Display View
“Maintenance view for OLE applications”: Overview window.

2. Click the Display –> Change icon . If a window opens with the message
Caution: The table is cross-client., press Enter.
3. Click New Entries.
4. In the New Entries: Details of Added Entries window, specify the following
information:

Chapter 7. Configuring your environment for basic tasks 125


Field name Description
OLE application Type:
CSCLIENT.DOCUMENT

You must specify this name again when you


configure an SAP ArchiveLink application for
use with Archiving Client.
CLSID Type:
{C8452EF3-19FE-11D1-A16E-0004AC62FCBA}
Type Info key Type:
NO_TYPELIB

Leave all other fields blank.


Figure 90 shows the New Entries: Details of Added Entries window containing
the necessary settings.

Figure 90. 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 125

Procedure:
1. In the SAP GUI, enter the transaction code OAA4 to open the ArchiveLink:
Application Maintenance window.

2. Click the Create icon .

126 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
3. In the ArchiveLink: Application Maintenance window, type a name of your
choice for the SAP ArchiveLink application.
For example, type:
CSARCH
Figure 91 shows the ArchiveLink: Application Maintenance window with the
sample application name.

Figure 91. 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 Command


M setAID @AID

The specified command is used as a method.


M doQueueArchive =@DID

The specified command is used to set an attribute in Archiving Client.


G @EID =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.

Chapter 7. Configuring your environment for basic tasks 127


Figure 92 shows what the SAP window might look like after you completed
step 7 on page 127.

Figure 92. 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 93 on page 129 shows the “Windows SAPGUI OLE automation” page with
status Maintained for Archive from Frontend.

128 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 93. “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 126

Procedure:
1. In the SAP GUI, enter the transaction code OAA3 to open the ArchiveLink:
Communications Interface Administration window.
2. Double-click the SAP ArchiveLink protocol.
For example, double-click HTTP1.
3. In the ArchiveLink Protocols: Overview of Protocol window, double-click
Archive from frontend.
Figure 94 on page 130 shows which item to double-click in the ArchiveLink
Protocols: Overview of Protocol window.

Chapter 7. Configuring your environment for basic tasks 129


Figure 94. 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 95 on page 131 shows which radio button and which icon to click in the
ArchiveLink Protocols: Overview of Protocol window.

130 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 95. 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 96 shows the ArchiveLink Protocols: Overview of Protocol window
containing the necessary communication type.

Figure 96. 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 97 on page 132 shows the ArchiveLink Protocols: Overview of Protocol
window containing the sample application name.

Chapter 7. Configuring your environment for basic tasks 131


Figure 97. 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 the information center or of IBM Content Collector for SAP
Applications: Installation, Configuration, and User's Guide, SH12-6989.
2. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.
3. “Configuring Collector Server for use with Tivoli Storage Manager” on page 25.
4. “Starting Collector Server for the first time” on page 49.

Figure 98 on page 133 shows which parts of the Content Collector for SAP
environment must be configured so that you can archive documents by processing
their bar codes.

132 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
OLE communication

Content Collector for SAP clients

Archiving Client

SAP GUI
csclient.dll

SAP ERP send


bar code Client dispatcher

ArchiveLink®

Engine

Tivoli TM Storage Manager/


TSM agent System Storage
Archive Manager

Collector Server instance

= SAP = archives = Content Collector for SAP = connection information

Figure 98. 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. “Setting up Archiving Client” on page 54
b. “Creating queues if the scanned documents are in the file system” on page
60 or “Creating queues if the scanned documents are in the file system and
a description file exists” on page 65
c. “Saving and reusing the queue information” on page 71
d. “Enabling Collector Server to use Archiving Client” on page 75
2. 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.

Chapter 7. Configuring your environment for basic tasks 133


For more information about how to complete these steps, refer to the SAP
documentation.

Configuring for archiving outgoing documents


To archive outgoing documents, you need the basic environment.

Before you begin:


1. Chapter 2, “Preparing your environment,” on page 3.
2. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.
3. “Configuring Collector Server for use with Tivoli Storage Manager” on page 25
4. “Configuring the connection between Collector Server and SAP” on page 34.
5. “Starting Collector Server for the first time” on page 49

Figure 99 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

3 Tivoli TM Storage Manager/


HTTP dispatcher TSM agent System Storage
Archive Manager
Collector Server instance

= SAP = archives = Content Collector for SAP = connection information


1 = RFC 3 = HTTP
communication communication

Figure 99. 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.

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 3.

134 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
2. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.
3. Chapter 4, “Configuring Collector Server,” on page 25. Configure either an
HTTP connection or a Remote Function Call (RFC) connection.

Figure 100 shows which parts of the Content Collector for SAP environment must
be configured so that you can archive and view print lists.

SAP GUI

SAP ERP

ArchiveLink® 1
RFC dispatcher

Engine

3 Tivoli TM Storage Manager/


HTTP dispatcher TSM agent System Storage
Archive Manager

Collector Server instance

= SAP = archives = Content Collector for SAP = connection information


1 = RFC 3 = HTTP
communication communication

Figure 100. 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:
1. “Defining an archive device”
2. “Associating the document type of the incoming documents with an SAP
workflow” on page 117
3. “Creating an SAP ArchiveLink batch job” on page 137
4. “Enabling extended ALF viewing” on page 140
5. “Enabling print-list viewing” on page 142

Defining an archive device


Define an archive device where the print lists can be archived.

Procedure:
1. In the SAP GUI, enter the transaction code SPAD to open the Spool
Administration: Initial Screen window.

Chapter 7. Configuring your environment for basic tasks 135


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 .
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 101 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 101. 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 102 on page 137 shows the DeviceAttributes page of the Spool
Administration: Output Device (Change) window containing your selection.

136 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 102. DeviceAttributes page of the Spool Administration: Output Device (Change)
window containing your selection

9. Click the Save icon to save your settings.

What to do next: “Associating the document type of the print lists with an SAP
workflow”

Associating the document type of the print lists with an SAP


workflow
Print lists must be linked to an SAP business object of type DRAW. Only those
print lists are linked to this particular SAP business object that can be associated
with a specific workflow.

Before you begin: “Defining an archive device” on page 135

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 117. The following values
are mandatory:

Field in ArchiveLink: Document Type


Customizing Wizard Value
Doc.class ALF
Object type DRAW

What to do next: “Creating an SAP ArchiveLink batch job”

Creating an SAP ArchiveLink batch job


Create an SAP ArchiveLink batch job to archive spooled print lists automatically.

Before you begin: “Associating the document type of the print lists with an SAP
workflow”

Procedure:

Chapter 7. Configuring your environment for basic tasks 137


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 103 shows what the Define Background Job window might look like
after you completed step 2 and step 3.

Figure 103. 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 104 on page 139 shows the Start Time window containing a sample
schedule specification.

138 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 104. 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, in the Name field, type the name of the ABAP
program.
For example, type:
ILQBATCH
Figure 105 on page 140 shows the Create Step 1 window containing a sample
ABAP program name.

Chapter 7. Configuring your environment for basic tasks 139


Figure 105. Create Step 1 window containing the sample ABAP program name ILQBATCH

10. Click the Save icon at the bottom of the window. The Step List Overview
window opens. It contains the ABAP program that you specified.

What to do next: “Enabling extended ALF viewing”

Enabling extended ALF viewing


Complete these steps to enable extended ALF viewing.

Before you begin: “Creating an SAP ArchiveLink batch job” on page 137

Procedure:
1. In the SAP GUI, enter the transaction code RZ10 to open the Edit Profiles
window.
2. In the Profile field, specify the name of an existing profile.
For example, select DEFAULT.
3. Under Edit Profile, click Extended maintenance and then click the Change
icon .
Figure 106 on page 141 shows what the Edit Profiles window might look like
after you completed step 2 and step 3.

140 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 106. 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 107 shows what the Edit Profiles window might look like after you
completed step 5 and step 6.

Figure 107. Maintain Profile window containing your specifications

7. Click the Exit icon .


8. When the message The parameter was changed. Do you want to save the
changes? is displayed, click Yes.

9. In the Edit Profiles window, click the Save icon .


10. When you are asked whether you want to activate the profile, click Yes.

What to do next: “Enabling print-list viewing” on page 142

Chapter 7. Configuring your environment for basic tasks 141


Enabling print-list viewing
To enable the viewing of print lists, you must adapt SAP ArchiveLink protocol.

This topic shows how to adapt the sample protocol HTTP1.

Before you begin: “Enabling extended ALF viewing” on page 140

Procedure:
1. In the SAP GUI, enter the transaction code OAA3 to open the ArchiveLink:
Communications Interface Administration window.
2. Double-click the SAP ArchiveLink protocol.
For example, double-click HTTP1.
3. In the ArchiveLink Protocols: Overview of Protocol window, double-click
Display Stored Document.
Figure 108 shows which item to double-click in the ArchiveLink Protocols:
Overview of Protocol window.

Figure 108. 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 109 on page 143 shows which radio button and which icon to click in
the ArchiveLink Protocols: Overview of Protocol window.

142 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 109. 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 110 shows what the ArchiveLink Protocols: Overview of Protocol
window might look like after you specify the communication type.

Figure 110. ArchiveLink Protocols: Overview of Protocol window showing the necessary
communication type

6. Click the Continue icon to confirm your specifications and to close the
window.

7. Click the Save icon to save your settings.

Configuring for viewing archived documents with the SAP GUI


To view archived documents with the SAP GUI, you need only the basic
environment.

Before you begin:


1. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.
2. Chapter 4, “Configuring Collector Server,” on page 25. Configure an HTTP
connection. For print lists, you can configure an HTTP connection or a Remote
Function Call (RFC) connection.

Figure 111 on page 144 shows which parts of the Content Collector for SAP
environment must be configured so that you can view archived documents with

Chapter 7. Configuring your environment for basic tasks 143


the SAP GUI.

SAP GUI

SAP ERP

ArchiveLink® 1
RFC dispatcher

Engine

3 Tivoli TM Storage Manager/


HTTP dispatcher TSM agent System Storage
Archive Manager

Collector Server instance

= SAP = archives = Content Collector for SAP = connection information


1 = RFC 3 = HTTP
communication communication

Figure 111. 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”.

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 the information center or of IBM Content Collector for SAP
Applications: Installation, Configuration, and User's Guide, SH12-6989.
2. Chapter 3, “Configuring Tivoli Storage Manager for use with Content Collector
for SAP,” on page 19.
3. Chapter 4, “Configuring Collector Server,” on page 25. Configure an HTTP)
connection. For print lists, you can configure an HTTP connection or a Remote
Function Call (RFC) connection.

144 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 112 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
Content Collector for SAP clients
External
viewer
application
Viewing Client

SAP GUI
csclient.dll Browser

SAP ERP
Client dispatcher

ArchiveLink® 1
RFC dispatcher

Engine

3 Tivoli TM Storage Manager/


HTTP dispatcher TSM agent System Storage
Archive Manager

Collector Server instance

= SAP = archives = Content Collector for SAP = connection information


1 = RFC 3 = HTTP
communication communication

Figure 112. 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. “Setting up Viewing Client” on page 77
b. “Enabling Collector Server to use Viewing Client” on page 83
2. “Registering Viewing Client with SAP”
3. “Creating an SAP ArchiveLink application for viewing documents” on page 147
4. “Adapting the SAP ArchiveLink protocol for viewing documents” on page 149
5. “Configuring an SAP ArchiveLink application for closing viewer applications”
on page 151

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.

Chapter 7. Configuring your environment for basic tasks 145


Before you begin: Chapter 6, “Configuring Viewing Client,” on page 77

Procedure:
1. In the SAP GUI, enter the transaction code SOLE to open the Display View
“Maintenance view for OLE applications”: Overview window.

2. Click the Display –> Change icon . If a window opens with the message
Caution: The table is cross-client., press Enter.
3. Click New Entries.
4. In the New Entries: Details of Added Entries window, specify the following
information:

Field name Description


OLE application Type:
OLEDISPA.DOCUMENT

You must specify this name again when you


configure an SAP ArchiveLink application for
use with Viewing Client.
CLSID Type:
{45526A21-AA41-11CF-B90A-0004ACED415F}
Type Info key Type:
NO_TYPELIB

Leave all other fields blank.


Figure 113 shows the New Entries: Details of Added Entries window containing
the required settings.

Figure 113. New Entries: Details of Added Entries window containing the required settings

5. Click the Save icon to save your settings.

What to do next: “Creating an SAP ArchiveLink application for viewing


documents” on page 147

146 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Creating an SAP ArchiveLink application for viewing
documents
You must create an SAP ArchiveLink application and configure it for use with
Viewing Client.

Before you begin: “Registering Viewing Client with SAP” on page 145

Procedure:
1. In the SAP GUI, enter the transaction code OAA4 to open the ArchiveLink:
Application Maintenance window.

2. Click the Create icon .


3. In the ArchiveLink: Application Maintenance window, type a name of your
choice for the SAP ArchiveLink application.
For example, type:
CSVIEW
Figure 114 shows the ArchiveLink: Application Maintenance window containing
the sample application name.

Figure 114. 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 7. Configuring your environment for basic tasks 147


Radio button Command
M SetUID @UID
Note: This step is necessary only if you want to save the user ID when you
process notes.
M SetAID @AID

The specified command is used as a method.


M doView @DID

The specified command is used as a method.


G @EID =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 115 shows what the SAP window might look like after you completed
step 7 on page 147.

Figure 115. 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 116 on page 149 shows the “Windows SAPGUI OLE automation” page with
status Maintained for Display Stored Document.

148 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Figure 116. “Windows SAPGUI OLE automation” page showing status Maintained for Display
Stored Document

What to do next: “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: “Creating an SAP ArchiveLink application for viewing


documents” on page 147

Procedure:
1. In the SAP GUI, enter the transaction code OAA3 to open the ArchiveLink:
Communications Interface Administration window.
2. Double-click the SAP ArchiveLink protocol.
For example, double-click HTTP1.
3. In the ArchiveLink Protocols: Overview of Protocol window, double-click
Display Stored Document.
Figure 117 on page 150 shows which item to double-click in the ArchiveLink
Protocols: Overview of Protocol window.

Chapter 7. Configuring your environment for basic tasks 149


Figure 117. 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 118 shows which radio button and which icon to click in the
ArchiveLink Protocols: Overview of Protocol window.

Figure 118. ArchiveLink Protocols: Overview of Protocol window showing which radio button
and which icon to click

150 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
5. In the Communication Type field of the small window that opens, specify OPEN
and then click the Continue icon .
Figure 119 shows the ArchiveLink Protocols: Overview of Protocol window
containing the necessary communication type.

Figure 119. 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 120 shows the ArchiveLink Protocols: Overview of Protocol window
containing the sample application name.

Figure 120. ArchiveLink Protocols: Overview of Protocol window showing the sample SAP
ArchiveLink application name CSVIEW

7. Click the Continue icon to confirm your specifications and to close the
window.

8. Click the Save icon to save your settings.

What to do next: “Configuring an SAP ArchiveLink application for closing viewer


applications”

Configuring an SAP ArchiveLink application for closing viewer


applications
SAP ArchiveLink can call Object Linking and Embedding (OLE) functions in the
SAP ArchiveLink application that close external viewer applications. In this way,
you can save resources on your computer.

Before you begin: “Adapting the SAP ArchiveLink protocol for viewing
documents” on page 149

When Viewing Client receives a doCloseWindow call, it closes the current instance of
the viewer application. Take these steps to configure an SAP ArchiveLink
application for this purpose:

Procedure:

Chapter 7. Configuring your environment for basic tasks 151


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 Command


M doCloseWindow
Note: The specified command is used as a method.

Note: Type the command exactly as it is shown in the table.


Figure 121 shows what the SAP window might look like after you completed
step 4a and step 4b

Figure 121. 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.

152 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
The status next to Close window changes to Maintained.

Figure 122 shows the “Windows SAPGUI OLE automation” page with status
Maintained for Close window.

Figure 122. “Windows SAPGUI OLE automation” page showing status Maintained for Close
window

Chapter 7. Configuring your environment for basic tasks 153


154 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Chapter 8. Configuring your environment for more or
advanced tasks
To use specific functions, to automate the start of Collector Server, or to increase
the performance, you must further configure your environment.

Preventing the storage of web content in the browser cache


Browsers maintain a cache memory of the entire web content and downloaded
content. You can control the cache properties of the web content but you cannot
control the cache properties of the downloaded content. This lack of control might
be a problem if sensitive material is viewed in a web browser because cache
directories are not secure. You can prevent the web content from being stored in
the cache memory of your web browser by configuring the server configuration
profile.

Before you begin:


v Chapter 4, “Configuring Collector Server,” on page 25.
v You need a browser that complies with HTTP 1.1. In addition, you must
configure your browser to use HTTP 1.1.

Procedure:
1. Open the server configuration profile in a text editor.
2. Add the BROWSERCACHING keyword and set its value to NO, as follows:
BROWSERCACHING NO
The default value for this keyword is YES.

Documents and plug-ins are downloaded to the folder where the web browser
temporarily stores the displayed content. To ensure that this folder is emptied,
close your web browser after you finish.

Enabling caching of retrieved documents


Unless you view documents in a web browser, the retrieved documents and the
query information can be stored in the local cache. The dynamic-link library
csclient.dll supports the local caching of retrieved documents.

Before you begin: Chapter 4, “Configuring Collector Server,” on page 25

The local cache is filled with documents that were viewed until the maximum size
is reached, which is specified by the CacheMax parameter. When the maximum size
is reached, the cache is flushed, and caching starts again.

To enable caching, add the following keywords to the


[ARCHPRO_CONNECTIONPARAMETER] section of the client configuration
profile:
CachePath
Specifies the fully qualified path to the cache. The directory must exist but
should not be used by any other function because all files are deleted when the
maximum cache size is exceeded.

© Copyright IBM Corp. 2010, 2013 155


CacheMax
Specifies the maximum size of the cache, in KB. The default value is 10240.

Example:
[ARCHPRO_CONNECTIONPARAMETER]
.
.
.
CachePath=E:\CSClient\cache
CacheMax=10240

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 86400 (1 day)
P8 agent 86400 (1 day)
OD agent 86400 (1 day)
RFC dispatcher or Java RFC dispatcher 86400 (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.

156 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Set the keyword to an integer value that is equal to, or greater than, 0. The value
represents seconds.
Example:
DESTINATION KD7
PROGID KD7.ICCSAP
GWHOST /H/sapserver
GWSERV sapgw00
LU sapserver
TP sapdp00
TIMEOUT 15 # 15 seconds
LOGICAL_SYSTEM T90CLNT090
CLIENT 800
USER CPICUser1

After you save the changed server configuration profile, restart Collector Server for
the changes to take effect.

Setting the timeout period for the agents


To specify a timeout period for an agent, add the TIMEOUT keyword to the ARCHIVE
section of each archive in the server configuration profile for which you want to
specify a timeout period.

Set the keyword to an integer value that is equal to, or greater than, 0. The value
represents seconds.
Example:
ARCHIVE UA
STORAGETYPE TSM
SERVER iceberg
MGMT_CLASS docs
ADSMNODE docs
LOGICAL_SYSTEM T90CLNT090
TIMEOUT 10 # 10 seconds

After you save the changed server configuration profile, restart Collector Server for
the changes to take effect.

Creating several instances of Collector Server


You might need more than one instance of Collector Server. The instances can run
on the same computer or on different computers.

Before you begin: Chapter 4, “Configuring Collector Server,” on page 25

Each instance must have its own instance directory and its own server
configuration profile.

Procedure:
1. “Creating more instance directories”
2. “Configuring the server configuration profiles for the instances” on page 158
3. “Assigning fixed ports to the instances” on page 158

Creating more instance directories


Each instance of Collector Server requires its own instance directory.

Procedure:
1. Create a folder for each additional instance.

Chapter 8. Configuring your environment for more or advanced tasks 157


2. Copy the content of the instance folder to each new instance folder.

Note: If you copy the password file and the SAPCertificates folder, ensure
that you also copy the master key file. Several Collector Server instances can
use the same master key but they must not share a master key file.

What to do next: “Configuring the server configuration profiles for the instances”

Configuring the server configuration profiles for the instances


Each instance requires a separate server configuration profile. You must adapt
specific settings in the profile.

Before you begin: “Creating more instance directories” on page 157

Procedure:
v If you leave the server configuration profiles in the instance directories, they can
all have the same name. If, however, you want to group them in a separate
directory, give each server configuration profile a different name.
v Change each server configuration profile as follows:
– Change the following paths:
- Set the INSTANCEPATH keyword to the new instance directory.
- Set the QUEUEPATH keyword, if available, to the directory where the queues
are to be stored.
- Specify a new path for the TEMPPATH keyword. Each instance should have
its own directory for its temporary files.
- You can use the same exchange directories (BASEPATH and ARCHPATH
keywords) for all instances. If you want to use different exchange
directories, they must be defined in SAP.
- Adapt the paths of the log files.
- Set the MASTER_KEYFILE keyword to the new location of the file.
- Set the DLL_KEYSTORE_FILE keyword to the location of the server keystore
for the new instance.
– Change the TCP/IP ports that are used for communication with the remote
Content Collector for SAP components:
- WEBPORT, if the WEBDPS 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.
2. “Assigning fixed ports to the instances.”

Assigning fixed ports to the instances


Unless you use fixed ports for the processes of an instance, such as the web
dispatchers and the agents, Collector Server automatically assigns port numbers to
the processes. If you have more than one instance, several processes might be
assigned to the same port number and fail. Therefore, use fixed ranges of
consecutive port numbers for each Collector Server instance.

Before you begin: “Configuring the server configuration profiles for the instances”

158 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
The port number of a Collector Server instance is specified by the ARCHPRO_PORT
keyword in the server configuration profile.

To assign fixed ranges of consecutive port numbers to each instance, you must
change the value of the ARCHPRO_PORT keyword in the server configuration profile
of each instance. Open the server configuration profile for each instance in a text
editor and proceed as follows:
1. Specify a value for the ARCHPRO_PORT keyword that is greater than 5000. This
value is the start port number of the range that you want to assign to this
instance. Make sure that the value does not fall in the estimated port range of
another instance.
To determine the end port number, calculate the number of processes and
threads that are started by a server instance. The following table helps you
estimate the required number of processes and threads for each instance.

Process Description Number of ports


archpro Collector Server instance 2
archwin Number of parallel client connections to 2 per client connection.
Collector Server Because the number of
connections is variable, take
the maximum of possible
connections for your
calculation.
RFC The number of RFC dispatcher processes 2 per process
dispatcher
Java RFC Single process automatically started by the 1 in addition to the RFC
dispatcher RFC dispatcher dispatcher ports
HTTP The number of HTTP dispatcher sessions, (number of threads) + 1
dispatcher which is determined by the WEBDPS keyword
CM agent The number of Content Manager Enterprise 2 per process
Edition agent processes, which is
determined by the CMAGENTS keyword
P8 agent The number of FileNet® P8 agent processes, 2 per process
which is determined by the P8AGENTS
keyword
OD agent The number of Content Manager 1 per process
OnDemand agent processes determined by
the ODAGENTS keyword
TSM agent The number of Tivoli Storage Manager agent 1 per process
processes, which is determined by the
ADSMAGENTS keyword

Example:
Assume that you have a server configuration profile with the following entries:
ARCHPRO_PORT 5799
.
.
WEBDPS 3
.
.
CMAGENTS 2
In this example, two fixed ports are reserved for Collector Server instance, four
(3+1) for the HTTP dispatcher threads, and four for the CM agents. There are

Chapter 8. Configuring your environment for more or advanced tasks 159


10 fixed ports in total. As a result, the port numbers 5799–5808 would be
exclusively assigned to this Collector Server instance.
Of the 10 ports, the first two ports are reserved by Collector Server. The
following ports are reserved by the client connections. These ports are used if
the CLIENT_ALL_PORTS_FIXED keyword is set to YES in the server configuration
profile. All other processes occupy the remaining ports.
2. Add the following line:
CLIENT_ALL_PORTS_FIXED YES
3. Save the server configuration profiles and restart each Collector Server instance.

Running Collector Server as a service


On Windows, you can run Collector Server as a service. As a service, Collector
Server runs continuously even if all users are logged off. This is useful, for
example, if you want to use monitoring tools.

Installing Collector Server as a service and uninstalling the


service
You use the archservice program to install and uninstall Collector Server as a
service.

Procedure:
1. Open a command prompt as an administrator, and enter the following
command:
archservice install -i profile
| profile stands for the fully qualified file name of the server configuration profile.
| If you enter the command from the directory that contains the server
| configuration profile and if the server configuration profile has the default
| name archint.ini, -i profile is optional.
You can give the service a different name by adding -n name to the command.
The service is installed, and the Windows Services window lists the Content
Collector for SAP service under its original name or under the name that you
assigned.
2. To uninstall the service, enter the following command:
archservice remove -i profile

Starting and stopping the service


You can start and stop Collector Server as a service in various ways.
1. To start the service, use either of the following ways on the computer where
Collector Server is installed:
v In the command prompt that you opened as administrator, enter the
following command:
archservice start
| profile stands for the fully qualified file name of the server configuration
| profile. If you enter the command from the directory that contains the server
| configuration profile and if the server configuration profile has the default
| name archint.ini, -i profile is optional.
v Right-click the Collector Server service in the Services window, and click the
menu item to start the service.
The Collector Server service is started. In addition, the archpro program is
started, which in turn starts other related programs. The Collector Server

160 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
service checks every few seconds if the archpro program is still running. If the
service detects that this program stopped, it waits for 1 minute and then tries
to restart it.
2. To obtain status information about the Collector Server service, enter the
following command:
archservice status
3. To stop the service, use either of the following ways on the computer where
Collector Server is installed:
v In the command prompt that you opened as administrator, enter the
following command:
archservice stop
v Select the Collector Server service in the Services window and then click
Action > All Tasks > Stop.
The Collector Server service is stopped, together with the archpro program and
the programs that were started by the archpro program.

Running several instances of Collector Server as services


You can run several instances of Collector Server as services on a single operating
system, for example, to improve the performance.

To install several instances as services:


1. Open a command prompt as administrator.
2. Enter the following command:
archservice install -i profile -n name
| profile stands for the fully qualified file name of the server configuration profile.
| If you enter the command from the directory that contains the server
| configuration profile and if the server configuration profile has the default
| name archint.ini, -i profile is optional. name stands for the name of the
| service.
For more information, see the topic archservice in the Reference part of the
information center or of IBM Content Collector for SAP Applications:
Installation, Configuration, and User's Guide, SH12-6989.
The service is installed, and the Windows Services window lists the Content
Collector for SAP service under the name that you assigned.
3. Repeat step 2 for each instance of Collector Server that you want to install as a
service.
4. “Assigning fixed ports to the instances” on page 158.
5. Each service requires a service initialization file of its own. Place each
initialization file in a different directory and make sure that the
SERVICE_TRACEFILE keyword has a different value in each file.
6. To uninstall a specific service, enter the following command:
archservice remove -i profile -n name

Hints and tips


If a problem occurs when you run Collector Server as a service, the following hints
and tips might help you solve the problem.
v 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.

Chapter 8. Configuring your environment for more or advanced tasks 161


v 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 the
information center or of IBM Content Collector for SAP Applications:
Installation, Configuration, and User's Guide, SH12-6989.
v If the number of RFC dispatchers is greater than 0, the paths that are defined by
the keywords BASEPATH and ARCHPATH are probably unavailable when you run
Collector Server as a service. However, for Collector Server to start, all paths
must be available. If the Collector Server cannot verify that the paths are
available, it does not start.

Configuring for viewing documents from several SAP systems


Normally, you can view a document from one SAP system only because the
dynamic-link library csclient.dll can connect to only one instance of Collector
Server. To view documents from several SAP systems, you must configure the
client configuration profile.

Before you begin: Chapter 4, “Configuring Collector Server,” on page 25

To define that the csclient.dll library can connect to three instances of the
Collector Server, take these steps:
1. Open the client configuration profile in a text editor.
2. Add the following keywords to the [ARCHPRO_CONNECTIONPARAMETER] section in
the client configuration profile:
Server
The name or the IP address of an instance of Collector Server.
Port
The port of this instance.
Server_2
The name or IP address of another instance of Collector Server.
Port_2
The port of this other instance.
Server_3
The name or IP address of a third instance of Collector Server.
Port_3
The port of this third instance.
Example:
[ARCHPRO_CONNECTIONPARAMETER]
Server = w3362117
Port = 5500
Server_2 = w3362117
Port_2 = 5502
Server_3 = archifix
Port_3 = 8017

162 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Important: Keep the order of the keywords and do not skip a number. For
example, if you specify Server and Port, and then Server_2 and Port_2, and
then Server_4 and Port_4, the csclient.dll library stops reading after
Server_2 and Port_2.
3. Suppress the messages that are displayed when the csclient.dll library cannot
connect to a Collector Server. Specify the following keyword in the
[ARCHPRO_CONNECTIONPARAMETER] section:
Interactive=0
The default is Interactive=1.

The csclient.dll library contacts the specified set of Collector Server instances.
The first instance that can successfully handle the request to retrieve a document
becomes the active instance. The following request is then always sent to the active
instance first. If this instance cannot retrieve the requested document, the next
instance is contacted until the request is handled successfully or until all of the
specified instances are contacted. If the request finishes successfully, the document
is displayed. Otherwise, an error message is sent to SAP.

Configuring for preprocessing outgoing documents


Content Collector for SAP provides a preprocessor user exit. By using this user
exit, you can change outgoing documents with a preprocessor before the
documents are archived. To include preprocessors in the archiving process, you
must change the server configuration profile.

The preprocessor user exit


The preprocessor user exit supports one preprocessor per MIME type.

The preprocessor user exit checks the MIME type of a document that is sent by
SAP and that was created by using create or mCreate operations. If a document
consists of more than one component, the preprocessor user exit checks the MIME
type of only the first component. After the user exit reads all components of a
document, it calls the preprocessor that is defined for this MIME type in the server
configuration profile. The preprocessor can run as an executable file or as a Java
class.

The preprocessor user exit of Content Collector for SAP currently supports the
following types of preprocessing:
v Changing the format of a document, for example, from TIFF to PDF.
v Merging a document that consists of several single-page components into a
document with a multi-page component. In this way, you can merge, for
example, single-page documents in TIFF format into one multi-page TIFF
document.

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.

Chapter 8. Configuring your environment for more or advanced tasks 163


To run the preprocessor as an executable file, the command to start the
preprocessor must look as follows:
preprocessor_command> <input_file> <result_file

To run the preprocessor as a Java class, you must provide a Java class that
implements the following interface:
public interface ACPreprocessor {
public ResultSection execute(String archiveFileName);
}

The input for the preprocessor is created by Content Collector for SAP. You are
responsible for creating the preprocessor that produces a result that Content
Collector for SAP can evaluate.

The input for the preprocessor


Content Collector for SAP creates the following input for your preprocessor: an
input file and an extended input file.

The name of the input file is the temporary file name of the outgoing document. If
the document consists of more than one component, the name of the input file is
the temporary file name of the first component. The extended input file contains
the temporary files of all components of the document, including the name of the
input file. The temporary file names ensure that the individual components are
uniquely identified during preprocessing even if several SAP requests are
processed in parallel.

The extended input file can contain the following sections:


[Data] Contains the temporary file names of all components that are not
annotations or descriptions. If you want to transform several single-page
documents into one multi-page document, this section contains the
temporary file names of all pages.
[Note] Contains the temporary file name of an annotation.
[Desc] Contains the temporary file name of a description. This section is specified
only for documents of MIME type application/x-alf.

If a specific component type does not exist, the corresponding section is omitted.
For example, if there is no annotation, the extended input file does not contain the
[NOTE] section.

Notes:
v Except for the file name extension, the file name of the input file is identical
with the file name of the extended input file. The extended input file has always
the extension .input.
v The name of the input file is included as the first file name in the [Data] section
of the extended input file.
v The extended input file lists the file names in the order in which the components
are to be preprocessed.
v 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.

164 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 and an INDEX section. The following
example shows the various sections and the parameters that you can specify:
[GLOBAL]
File=output_file_name
DocType=new_mimetype

[INDEX]
index_field1=index_value1
index_field2=index_value2

Explanation of the parameters:

Parameter Description Mandatory or optional


File 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.


DocType The MIME type of the document after it is Mandatory if different from
changed by the preprocessor. the input file
[INDEX] section The list of attributes that are returned by the Optional
preprocessor in the format
index_field=index_value

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.
Chapter 8. Configuring your environment for more or advanced tasks 165
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.


documentType The MIME type of the document after it is Mandatory if different
changed by the preprocessor. from the input file
indexValues The list of attributes that are returned by the Optional
preprocessor in the format
attribute_name=attribute_value

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:

166 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
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 3
2. “Configuring Collector Server for use with Tivoli Storage Manager” on page 25.
3. “Setting up the connection between Collector Server and SAP through HTTP”
on page 35
4. “Starting Collector Server for the first time” on page 49

Procedure:
1. Open the server configuration profile in a text editor.
2. In the ARCHIVE section, add either of the following set of keywords:
v If you want to run the preprocessor as an executable file, specify the
following keywords in the sequence shown:
PREPROC_MIMETYPE mime_type
PREPROC_EXEC exec
mime_type
The MIME type of the documents that are to be processed.
exec
The fully qualified path to the executable file that is to process the
documents of the specified MIME type.
Example:
PREPROC_MIMETYPE image/tiff
PREPROC_EXEC d:\preprocessors\preproc_tif.bat
v 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

Chapter 8. Configuring your environment for more or advanced tasks 167


Note: You can use the same preprocessor several times. You can also use a
different preprocessor for each MIME type. If you want to use different
processors, ensure that each preprocessor has a unique Java class name even
if the Java classes are in different class paths. Java class paths are
concatenated. If you use the same Java class name for more than one
preprocessor, the preprocessor user exit calls the first preprocessor that it
finds for this Java class name.
3. Save the server configuration profile, and restart Collector Server for the
changes to take effect.

Enabling Collector Server to log on to an SAP logon group


When you archive or link your documents by processing their bar codes or by
creating work items in the SAP workflow, you might want to distribute the work
to several SAP Application Servers. For this purpose, you must enable Collector
Server to log on to an SAP logon group.

The SAP logon group that you want to use must exist.

Change the server configuration profile as follows:


1. Open the server configuration profile in a text editor.
2. Add the following keywords to the DESTINATION section:
MSHOST hostname
GROUP group_name
R3NAME sap_system
hostname
The host name of the SAP Message Server.
group_name
The name of the SAP logon group.
sap_system
The ID of the SAP system that contains the group of SAP Application
Servers.
Example:
DESTINATION KD7
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
3. Save the server configuration profile, and restart Collector Server for the
changes to take effect.

168 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Configuring for storing documents in more than one Tivoli Storage
Manager archive
To enhance the availability of your archived documents and the safety against data
loss, you can store a document in more than one Tivoli Storage Manager archive
with a single archiving operation. When a document cannot be retrieved from one
of the archives, Content Collector for SAP addresses the next archive that contains
the requested document and tries to retrieve it from there.

Before you begin:


v Install each archive on a different Tivoli Storage Manager node. The safest
method is to have the nodes on different servers and the servers on different
computers.
v Chapter 2, “Preparing your environment,” on page 3
v “Configuring Collector Server for use with Tivoli Storage Manager” on page 25

When you store a document in more than one archive, each copy of a document is
archived with the same document ID. Content Collector for SAP checks whether
another document on the same node already uses this ID. The document is
archived only if the ID does not exist yet.

To configure Content Collector for SAP for storing a document in several Tivoli
Storage Manager archives, you must specify all archives with the same logical
archive ID in the server configuration profile as shown in the following example:
ARCHIVE U1
STORAGETYPE TSM
SERVER blackbox
MGMT_CLASS arc1
ADSMNODE PRIMARY

ARCHIVE U1
STORAGETYPE TSM
SERVER whitebox
MGMT_CLASS arc2
ADSMNODE SECONDARY

Content Collector for SAP then creates two copies of your documents. One copy is
placed in management class arc1 on server blackbox. The other copy is stored in
management class arc2 on server whitebox.

Notes:
v After you save the changed the server configuration profile, restart Collector
Server for the changes to take effect.
v If your server configuration profile contains incorrect definitions, Collector
Server does not start and the documents are not archived. Note, for example, the
STORAGETYPE keyword must always be set to TSM.
v Content Collector for SAP treats storing in, and retrieving from, several archives
like a single archiving or retrieving operation: Only one job is created, and you
receive only one return message.
v An archiving operation is considered successful only if the document could be
archived in all specified archives. If Content Collector for SAP cannot access one
of the archives, it deletes the copies that were already archived. In this case, the
document is not stored in any archive.

Chapter 8. Configuring your environment for more or advanced tasks 169


v If Content Collector for SAP can retrieve the document from one of the archives,
a retrieving operation is considered successful. So, if Content Collector for SAP
can retrieve the requested document from one archive, it ignores any errors with
the other archives.
v Archiving documents in several archives decreases the performance because
more operations are necessary.

Integrating Content Collector for SAP into the SAP Solution Manager
You can integrate Content Collector for SAP into the SAP Solution Manager by
registering Content Collector for SAP with the SAP System Landscape Directory
(SLD).

Procedure:
1. Change to the directory of your Collector Server installation. The default
installation directory is as follows:
v Linux UNIX InstallHome/server
v Windows InstallHome\Server
2. Open the file slddata.xml in a text editor. This file is in the installation
directory.
3. Replace all occurrences of the word HOSTNAME with the fully qualified name of
the host where Collector Server is installed.
4. Copy the modified file slddata.xml to a directory on the computer where the
SAP Solution Manager is installed.
5. Run the sldreg tool to upload the information that is contained in the modified
slddata.xml file to the SLD. For a description of the sldreg tool, open the SAP
Help Portal and search for “Configuring sldreg and transferring data to SLD”.

170 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Notices
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing


IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte character set (DBCS) information,


contact the IBM Intellectual Property Department in your country or send
inquiries, in writing, to:

Intellectual Property Licensing


Legal and Intellectual Property Law
IBM Japan Ltd.
1623-14, Shimotsuruma, Yamato-shi
Kanagawa 242-8502 Japan

The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.

This information could include technical inaccuracies or typographical errors.


Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.

Any references in this information to non-IBM websites are provided for


convenience only and do not in any manner serve as an endorsement of those
websites. The materials at those websites are not part of the materials for this IBM
product and use of those websites is at your own risk.

© Copyright IBM Corp. 2010, 2013 171


IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:

IBM Deutschland GmbH


Dept. M358
IBM-Allee 1
71139 Ehningen
Germany

Such information may be available, subject to appropriate terms and conditions,


including in some cases, payment of a fee.

The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.

Information concerning non-IBM products was obtained from the suppliers of


those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which


illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. The sample
programs are provided "AS IS", without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.

Trademarks

IBM, the IBM logo, and ibm.com are trademarks of International Business
Machines Corporation, registered in many jurisdictions worldwide. Other product
and service names might be trademarks of IBM or other companies. A current list
of IBM trademarks is available on the web at “Copyright and trademark
information” at http://www.ibm.com/legal/copytrade.shtml

Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.

Linux is a trademark of Linus Torvalds in the United States, other countries, or


both.

172 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other
countries.

Other product and service names might be trademarks of IBM or other companies.

Notices 173
174 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Index
Special characters Collector Server (continued)
hints and tips 161
document preprocessing (continued)
if run as a Java class 166
env_var_appdata v starting for the first time 49 if run as an executable file 165
InstallHome v stopping 51 document type
SystemRoot v Collector Server configuration enabling for an SAP workflow
UserHome vi sample server configuration incoming documents 117
profiles 26
server configuration profile 26
A Collector Server connection F
abbreviations v Archiving Client
feedback vi
ALF viewing 140 defining 55
files
archint_sample_tsm.ini 30 viewing 73
default location 1
archive device for print lists 135 DirQueue 62
archive store FileQueue 67
assigning home paths 114 HTTP 35
creating for data archiving with RFC (Remote Function Call) 41 H
BC-ILM 108 SAP 34 HTTP dispatchers 36
archiving vi Viewing Client 78
Archiving Client Collector Server installation
log files 58 as a service 160
Collector Server instances
I
queues incoming documents
creating 60 creating 157
configuring for archiving 114
description 59 connection between Collector Server and
instances of Collector Server
saving 71 SAP
creating 157
trace files 58 configuring
Archiving Client configuration 53 HTTP 35
connection to Collector Server RFC (Remote Function Call) 41
defining 55 Content Collector for SAP J
viewing 73 integrating into SAP Solution Java RFC dispatchers 35
directory for temporary files 56 Manager 170
document format 57 content repository
modules for the queues 56 for HTTP 38
for Remote Function Call (RFC) 45
K
number of bar codes in a batch keywords
job 57 CPIC user
ARCHPATH
registering with SAP 125 creating 5
creating a content repository or
setup 54 restricting access 8
logical archive 45
archiving documents setting RFC dispatchers 41
by creating work items in an SAP ARCHPRO_PORT
workflow D assigning fixed ports to the server
configuring 115 data archiving instances 158
by processing their bar codes configuring 85 connecting Archiving Client to
configuring 132 configuring for archiving with Collector Server 55
outgoing documents 134 BC-ILM 99 ARCHWINS
audience v default location of files 1 configuring Archiving Client 53
destination for archived data 106 configuring Viewing Client 83
doCloseWindow BASEPATH
B configuring an SAP ArchiveLink creating a content repository or
basic environment vi application for 151 logical archive 45
browser cache 155 enabling Viewing Client for 82 setting RFC dispatchers 41
document archiving BROWSERCACHING
by creating work items in an SAP preventing the storage of web
C workflow
configuring 115
content in the browser
cache 155
caching of retrieved documents 155 by processing their bar codes DESTINATION
certificates configuring 132 creating an RFC destination 42
SAP certificates for content document formats of SAP 74 GROUP
repositories 40 document preprocessing logging on to an SAP logon
Collector Server configuring 167 group 168
assigning fixed ports 158 input to the preprocessor 164 JRFC_DISPATCHERS
configuring 25 preprocessor user exit 163 setting the number of Java RFC
running as a service 160 result from the preprocessor 165 dispatchers 35

© Copyright IBM Corp. 2010, 2013 175


keywords (continued)
LOGICAL_SYSTEM
O SAP ArchiveLink protocol (continued)
creating for viewing documents 149
defining a logical system for a outgoing documents SAP ArchiveLink queues
Remote Function Call (RFC) archiving creating for a Remote Function Call
connection 15 configuring 134 (RFC) connection 44
MSHOST preprocessing creating for an HTTP connection 37
logging on to an SAP logon configuring 163 SAP certificates
group 168 accepting 40
PREPROC_CLASS sending to Collector Server 40
preprocessing outgoing P SAP Document Finder
documents 167 preprocessing outgoing documents creating an RFC destination 42
PREPROC_CLASSPATH configuring 163 SAP document formats 74
preprocessing outgoing input to the preprocessor 164 SAP logon group 168
documents 167 preprocessor user exit 163 SAP Solution Manager 170
PREPROC_EXEC result from the preprocessor 165 SAP Web Application Server ABAP
preprocessing outgoing if run as a Java class 166 connection to XML DAS 109
documents 167 if run as an executable file 165 SAP workflow
PREPROC_MIMETYPE server configuration profile 167 incoming documents 117
preprocessing outgoing print lists print lists 137
documents 167 configuring for archiving and screen captures vi
PROGID viewing 134 server configuration profile
creating an RFC destination 42 viewing Archiving Client 75
R3NAME enabling 142 creating 30
logging on to an SAP logon data archiving by using BC-ILM 105
group 168 description 26
RFC_DISPATCHERS
setting the number of RFC
Q DESTINATION section
enabling Collector Server for
dispatchers 41 queues connecting to SAP 47
SERVICE_TRACEFILE creating 60 HTTP dispatcher sessions 36
running several instances of DirQueue 60 Java RFC dispatchers 35
Collector Server as services 161 FileQueue 65 RFC dispatchers 41
STORAGETYPE deleting 74 samples 26
data archiving by using description 59 several Collector Server
BC-ILM 105 properties 72 instances 158
TIMEOUT saving 71 TCP/IP port for the HTTP
setting 156 dispatchers 36
setting for the agents 157 Viewing Client 83
setting for the RFC or Java RFC R
dispatcher 157 reader's comments vi
USER
creating a user with CPIC
RFC (Remote Function Call) 41 T
RFC destination 42 TCP/IP port for the HTTP
access 5 RFC dispatchers 41 dispatchers 36
WEBDAV_AUTH root collection in an empty Tivoli Storage terminology v
data archiving by using Manager archive 105 timeout period setting 156
BC-ILM 105
Tivoli Storage Manager
WEBDPS
archive copy group 20
specifying the number of parallel
HTTP dispatcher sessions 36
S client options files 33
sample archiving object configuring 19
WEBPORT
creating test data 94 configuring a remote connection 22
setting the TCP/IP port for the
setting up for data archiving 86 configuring for storing documents in
HTTP dispatchers 36
SAP ArchiveLink several archives 169
creating a protocol management class 19
for a Remote Function Call (RFC) password options 21
L connection 43 registering node with Content
log files for an HTTP connection 36 Collector for SAP 19
Archiving Client defining a number range 17 setting the environment variables 4
enabling 58 SAP ArchiveLink application STANDARD policy set 21
Viewing Client configuring for closing viewer Tivoli Storage Manager documents
enabling 81 applications 151 configuring for archiving
logical archive 30 creating for archiving documents 126 by creating work items in an SAP
logical system 15 creating for viewing documents 147 workflow 115
logon group 168 SAP ArchiveLink batch job for print-list by processing their bar codes 132
archiving 137 configuring for viewing
SAP ArchiveLink path for data with an external viewer
archiving 88 application 144
SAP ArchiveLink protocol with the SAP GUI 143
creating for archiving documents 129

176 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
trace files
Archiving Client
enabling 58
Viewing Client
enabling 81

U
user exit for preprocessing
documents 163
users
for data archiving with BC-ILM 101
with CPIC access
creating 5
restricting access 8

V
Viewing Client
closing of applications 82
log files 81
trace files 81
Viewing Client configuration 77
connection to Collector Server 78
directory for the temporary files 79
registering with SAP 146
setup 77
viewer application 80
viewing documents
configuring for viewing from several
SAP systems 162

W
web content 155

X
XML Data Archiving Service (XML DAS)
connection to SAP Web Application
Server ABAP 109

Index 177
178 Content Collector for SAP: Configuring for use with Tivoli Storage Manager: Best practices
Readers’ Comments — We'd Like to Hear from You
IBM Content Collector for SAP Applications
Configuring Content Collector for SAP for use with IBM Tivoli Storage Manager: Best practices
Version 3 Release 0

We appreciate your comments about this publication. Please comment on specific errors or omissions, accuracy,
organization, subject matter, or completeness of this book. The comments you send should pertain to only the
information in this manual or product and the way in which the information is presented.

For technical questions and information about products and prices, please contact your IBM branch office, your
IBM business partner, or your authorized remarketer.

When you send comments to IBM, you grant IBM a nonexclusive right to use or distribute your comments in any
way it believes appropriate without incurring any obligation to you. IBM or any other organizations will only use
the personal information that you supply to contact you about the issues that you state on this form.

Comments:

Thank you for your support.


Send your comments to the address on the reverse side of this form.
If you would like a response from IBM, please fill in the following information:

Name Address

Company or Organization

Phone No. Email address


___________________________________________________________________________________________________
Readers’ Comments — We'd Like to Hear from You Cut or Fold
 Along Line

_ _ _ _ _ _ _Fold
_ _ _and
_ _ _Tape
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _Please
_ _ _ _ do
_ _ not
_ _ _staple
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _Fold
_ _ _and
_ _ Tape
______

PLACE
POSTAGE
STAMP
HERE

IBM Deutschland Research & Development GmbH


ATTN: Dept. 0446
Schoenaicher Strasse 220
71032 Boeblingen
Germany

________________________________________________________________________________________
Fold and Tape Please do not staple Fold and Tape

Cut or Fold
Along Line


Product Number: 5725-B46

Potrebbero piacerti anche