IBM Content Collector for SAP Applications

https://www.ibm.com/docs/en/ccfsa
Admin
IBM Content Collector for SAP Applications is an enterprise software solution for collecting and...
Tokens:152,240
Snippets:1,262
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install Base Package on Windows (GUI Mode)

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=iigm-windows

This procedure outlines the steps to install the base package of IBM Content Collector for SAP Applications on a Windows 64-bit operating system using the GUI mode of IBM Installation Manager. It details running the installer and navigating the installation wizard.

```shell
userinst
```

--------------------------------

### Install IBM Installation Manager and Base Package

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=mode-linux-unix-systems

This command initiates the installation process for IBM Installation Manager and the base package. Ensure you are in the correct directory on the DVD or extracted package before running this command.

```shell
./userinstc -c
```

--------------------------------

### Install Collector Server Service

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=service-from-command-line

Installs a Collector Server instance as a service. Requires administrator privileges. The 'profile' parameter specifies the configuration file, and 'suffix' customizes the service name.

```bash
archservice install -i profile -n suffix
```

--------------------------------

### Example API Configuration with Client Profile

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=idccs-setting-up-secure-connection-collector-server-adapting-client-configuration-profile

An example demonstrating how to configure the API connection using the client configuration profile. This includes setting the server name, port, keystore path, and trace file parameters.

```ini
Server=myICCSAPServer
Port=7654
keystore=C:\Users\cuser1\AppData\Roaming\IBM\iccsap\security\client_1\client_1.kdb
```

```ini
DLLTracefile=c:\temp\dlltrace.trc
DLLTraceLevel=1
DLLTraceMax=1024
Interactive=0
```

--------------------------------

### Start Collector Server Service

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=service-from-command-line

Starts the Collector Server service. This command can be executed from an administrator command prompt. Starting the service also initiates the archpro program and related processes.

```bash
archservice start
```

--------------------------------

### Start Collector Server Instance

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=archpro-content-manager-ondemand

Starts the Collector Server instance after all configuration passwords have been set.

```bash
archpro
```

--------------------------------

### Run Base Package Installer Script

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=iigm-linux-unix-systems

This command executes the installation script for the IBM Content Collector for SAP base package. Ensure you are in the correct directory on the product DVD or extracted package before running this command. This is a crucial step in initiating the installation process.

```shell
./userinst
```

--------------------------------

### Install Microsoft Visual C++ 2010 Redistributable (Windows)

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=installation-preparing-windows

This snippet indicates the command to execute for installing the Microsoft Visual C++ 2010 Redistributable Package on a 64-bit Windows system. This is a prerequisite for installing the base package of IBM Content Collector for SAP Applications.

```batch
VisualStudio2010\vcredit_x64.exe
```

--------------------------------

### Example ars.ini Instance Configuration (INI)

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=server-if-collector-runs-linux-unix-system

This example demonstrates how to configure a new instance in the ars.ini file for the Content Manager OnDemand library server. It specifies the host, protocol, and port for the connection.

```INI
[@SRV@_MYODSERVER1]
HOST=myhost.yourcompany.com
PROTOCOL=2
PORT=1500
.
.
.

```

--------------------------------

### Configure Multiple User Exit URLs (Example)

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=tasks-integrating-java-applications-into-your-archiving-setup

This example demonstrates how to specify multiple URLs for user exits in parallel. URLs are not enclosed in quotation marks, are on a single line, separated by commas without spaces, and do not exceed 255 characters. Each URL represents a distinct port for an agent.

```shell
rmi://localhost:1099/Transformer,rmi://localhost:1100/Transformer
```

--------------------------------

### Generate Client Keys with Batch Script

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=gen-listing-labels-client-certificates-in-server-keystore

This batch script is used to generate client keys. It requires the path to the server keystore and the password for encryption. The example assumes execution on Windows from the C: directory.

```batch
client_key_gen.bat -list -sdb Users\iccsapadmin\AppData\Roaming\IBM\iccsap\
instance1\security\server_clients\server\server.kdb -p secure
```

--------------------------------

### Set ARS_ARSCMNSTR_INSTALL_DIR Environment Variable (Windows)

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=sap-installing-content-manager-ondemand

Sets the ARS_ARSCMNSTR_INSTALL_DIR environment variable on Windows systems. This variable points to the bin directory within the Content Manager OnDemand installation. 'InstallHome_OD' should be replaced with the actual installation path.

```batch
set ARS_ARSCMNSTR_INSTALL_DIR=InstallHome_OD\bin
```

--------------------------------

### Set ARS_ARSCMNSTR_INSTALL_DIR Environment Variable (Linux/Unix)

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=sap-installing-content-manager-ondemand

Sets the ARS_ARSCMNSTR_INSTALL_DIR environment variable on Linux/Unix systems. This variable points to the exits directory within the Content Manager OnDemand installation. 'InstallHome_OD' should be replaced with the actual installation path.

```shell
export ARS_ARSCMNSTR_INSTALL_DIR=InstallHome_OD/bin/exits
```

--------------------------------

### Command to Create Server Keystore and Initial Client Keystores

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=gen-adding-client-keystores

This is a prerequisite command used in conjunction with other examples. It creates a server keystore (myserver.kdb) and two initial client keystores, encrypting them with the password 'secure'.

```bash
client_key_gen.sh -c -p secure -n 2 -sn myserver -cn myclient
```

--------------------------------

### Set ARS_INSTALL_SERVER_Vx_DIR Environment Variable (Windows)

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=sap-installing-content-manager-ondemand

Sets the ARS_INSTALL_SERVER_Vx_DIR environment variable on Windows systems. This variable should be set to the installation directory of Content Manager OnDemand, where 'x' represents the specific version number.

```batch
set ARS_INSTALL_SERVER_Vx_DIR=InstallHome_OD
```

--------------------------------

### Set ARS_INSTALL_SERVER_Vx_DIR Environment Variable (Linux/Unix)

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=sap-installing-content-manager-ondemand

Sets the ARS_INSTALL_SERVER_Vx_DIR environment variable on Linux/Unix systems. This variable should be set to the installation directory of Content Manager OnDemand, where 'x' represents the specific version number.

```shell
export ARS_INSTALL_SERVER_Vx_DIR=InstallHome_OD
```

--------------------------------

### Application-Mapping File Example

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=tasks-configuring-viewing-documents-ondemand-client

This is an example of the contents of an application-mapping file. It demonstrates how to map different content types (like 'PDF', 'application/pdf', 'TXT', 'text/plain', 'syz') to their corresponding application names. The file uses a simple text format where each line specifies a content type and its associated application.

```text
PDF               application_pdf
application/pdf   application_pdf
TXT               application_txt
text/plain        application_txt
syz               'application name with spaces'  
```

--------------------------------

### Set PATH Environment Variable (Windows)

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=sap-installing-content-manager-ondemand

Sets the PATH environment variable on Windows systems to include the fully qualified path to the bin directory of your Content Manager OnDemand installation. This ensures that executable files within the bin directory are accessible.

```batch
set PATH=%PATH%;InstallHome_OD\bin
```

--------------------------------

### Start Collector Server Instance with Master Key (Command Line)

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=security-changing-master-key

This command initiates the Collector Server instance using the command line. It requires specifying the server configuration profile and the master key generation option. The 'profile' parameter is optional if the command is run from the directory containing the default profile name 'archint.ini'.

```shell
archpro -i profile -f masterkey
archpro
```

--------------------------------

### API Initialization with Client Configuration Profile

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=idccs-setting-up-secure-connection-collector-server-adapting-client-configuration-profile

This configuration enables the use of settings from the client configuration profile. It requires mandatory parameters like Server, Port, and keystore path. Optional parameters for trace file generation are also included.

```ini
Server=server_name
Port=port
keystore=path
```

```ini
DLLTraceFile=trace_file
DLLTraceLevel=1
DLLTraceMax=max_trace_size
Interactive=0
```

--------------------------------

### Install Content Collector for SAP in Silent Mode (imcl)

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=installed-installing-in-silent-mode

Installs the base or add-ons package of IBM Content Collector for SAP Applications in silent mode using the 'imcl' command. This method requires a pre-generated response file and accepts licenses automatically. Ensure IBM Installation Manager is already installed.

```shell
./imcl input install_response_file -log log_file -acceptLicense
```

```shell
imcl input install_response_file -log log_file -acceptLicense
```

--------------------------------

### Install Base Package in Console Mode on Windows

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=mode-windows

Installs the base package of IBM Content Collector for SAP Applications on a Windows 64-bit operating system using console mode. This process involves running the userinstc command and following prompts for installation paths, licenses, and features. It also provides an option to generate a response file for silent installations.

```bash
userinstc -c
```

--------------------------------

### Daemon Configuration Parameters

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=daemon-starting

Example input for configuring the IBM Content Collector for SAP Applications daemon. This includes details about keystore and truststore files, passwords, the daemon port, and the instance base path. Fully qualified paths are required, and environment variables should not be used.

```text
Keystore file:
/home/iccsapadmin/daemon/keystore.jks

Keystore password:
icc4sap

Truststore file:
/home/iccsapadmin/daemon/truststore.jks

Truststore password:
was

Daemon port:
5000

Instance base path:
/home/iccsapadmin/instances
```

--------------------------------

### Configure IBM Installation Manager for Linux GUI Mode

Source: https://www.ibm.com/docs/en/ccfsa/4.0_topic=installation-base-package-cannot-be-installed-in-gui-mode-linux

Modify the `userinst.ini` or `install.ini` file to disable Cairo graphics, preventing assertion failures during GUI mode installations on Linux. This involves adding specific Java system properties to the end of the file.

```ini
-Dorg.eclipse.swt.internal.gtk.useCairo=false
-Dorg.eclipse.swt.internal.gtk.cairoGraphics=false
```
Tokens:
Raw