Repository-specific keywords for IBM Content Manager

Edit online

Create an ARCHIVE section for each logical IBM Content Manager archive that you want to use.

The first keyword in an ARCHIVE section is always ARCHIVE, and the second keyword is always STORAGETYPE. Except for those keywords, all keywords in this topic are sorted alphabetically so that they are easier to find.

* ARCHIVE archive_id

Specifies the logical archive ID, for example, A1. The archive ID must be unique within the server configuration profile. Content Collector for SAP uses it to identify a logical archive.

Immediately following the ARCHIVE keyword, you must specify the STORAGETYPE keyword. All other repository-specific keywords can be specified in random order.

Example:
ARCHIVE  A1
    STORAGETYPE  CM
Note: Do not change the ID after you complete your setup. Retrieval operations depend on the settings.

* STORAGETYPE CM

Specifies that the logical archive is attached to IBM Content Manager. Content Collector for SAP needs this information to select the appropriate agent. You must specify the storage type for each logical archive that you define.

Example:
STORAGETYPE  CM
Note: Specify the STORAGETYPE keyword immediately after the ARCHIVE keyword.

ADDVIEWFILTERATTR YES | NO

To ensure that only documents with specific attribute values can be viewed, the documents can be stored in an item-type subset where one or more attributes are filtered. If the documents do not have these filter attributes, Content Collector for SAP can add them. The filter attributes and their values are added only if they are not multivalued attributes and if they are not specified in an attribute-name mapping file.

Example:
ARCHIVE  A1
    STORAGETYPE       CM
    LIBSERVER         ICMNLSDB
    CMUSER            CMUSER
    ITEM_TYPE         ItemTypeSubset
    ADDVIEWFILTERATTR YES

ARCHIVETYPE GENERIC_MULTIPART | SAP

Specifies the type of the logical archive:
GENERIC_MULTIPART
Specifies that the logical archive is read-only. The documents in this logical archive can be viewed with SAP Document Finder only.

The logical archive is not protected and the access to the documents is not checked. See SECKEY_CHECK prot_flags | OFF.

If you want to use SAP Document Finder, you must specify this value.

SAP
Specifies that the logical archive must have all the attributes that SAP needs. Collector Server verifies that the attributes exist.

ATTRMAPPING_FILE path

Specifies the fully qualified path to an attribute-name mapping file. The attributes that are required by Content Collector for SAP, have reserved names. If you cannot use a reserved name, for example, because it exists in your environment, you must map the name of your choice to the reserved name. For this purpose, you must create a mapping file.

Example:
ATTRMAPPING_FILE  C:\iccsap\server\instance1\cmmapping.txt
Important: All logical archives that use the same library server (LIBSERVER keyword) and the same item type (ITEM_TYPE keyword) must also use the same attribute-name mapping file. Otherwise, Collector Server does not start.

* CMUSER user_id

Specifies the user ID that the Collector Server instance uses to log on to IBM Content Manager. You created the user ID when you configured IBM Content Manager for use with Content Collector for SAP.

Example:
CMUSER  sampleuser1

COMMENT

Specifies a comment. The comment is displayed by the HTTP command server.

Example:
COMMENT  Archive is used for testing purposes only.

(*) ICN_DESKTOP id

Required if you want to view archived documents and folders with IBM Content Navigator.

Specifies the ID of the IBM Content Navigator desktop that contains IBM Content Manager as repository.

Example:
ICN_DESKTOP  iccsapview

ICN_EXCLUDED_MIMETYPES mime_type | *

Specifies the MIME types that are to be viewed with the SAP GUI. Documents of all other MIME types are displayed in IBM Content Navigator.

If you want to specify more than one MIME type, separate the MIME types by commas. Do not use this keyword if you specify the ICN_INCLUDED_MIMETYPES keyword.

Example:
ICN_EXCLUDED_MIMETYPES  application/binary,application/x-alf

ICN_INCLUDED_MIMETYPES mime_type | *

Specifies the MIME types that are to be displayed in IBM Content Navigator. Documents of all other MIME types can be viewed with the SAP GUI. Separate the MIME types by a comma.

If you want to specify more than one MIME type, separate the MIME types by commas. Do not use this keyword if you specify the ICN_EXCLUDED_MIMETYPES keyword.

Example:
ICN_INCLUDED_MIMETYPES  image/tiff,text/plain

(*) ICN_REPOSITORY_ID id

Required if you want to view archived documents and folders with IBM Content Navigator.

Specifies the ID that you assigned to the repository when you configured the connection from IBM Content Navigator to the repository.

Example:
ICN_REPOSITORY_ID  CM

(*) ICN_SESSION_DOMAIN domain

Required if you want view archived documents with IBM Content Navigator under a common user ID.

Specifies the domain name or the domain labels that the session cookie is to apply to.

Example:
ICN_SESSION_DOMAIN  myserver.example.com
ICN_SESSION_DOMAIN  example.com

(*) ICN_URL url

Required if you want to view archived documents and folders with IBM Content Navigator.

Specifies the URL of IBM Content Navigator in the following format:
protocol://hostname:portnumber/context_root/
Example:
ICN_URL  http://myserver.com:9080/navigator/

(*) ICN_USERID user

Required if you want view archived documents with IBM Content Navigator under a common user ID.

Specifies a user ID that is to be used for the logon to IBM Content Navigator. Then, all users with access to the logical archive do not need to log on with their own user ID.

Example:
ICN_USERID  viewuser1

INDEXCHILDNAME child_component

Specifies the name of the child component (multivalue attribute) that is used to store the metadata of several SAP business objects. A child component is required if the index information of several SAP business objects relate to a single document.

Example:
ARCHIVE  A1
    STORAGETYPE       CM
    .
    .
    .
    INDEXCHILDNAME    MYINDEXCHILD

* ITEM_TYPE name

Specifies the item type or item-type subset where Collector Server archives the documents. You created the item type or the item-type subset when you configured IBM Content Manager for use by Content Collector for SAP.

Example:
ITEM_TYPE  itemtypeA1

(*) ITEM_TYPE_MIG name

Required if you want to view the documents that are in the read-only item type. This item type was generated during the migration of a IBM Content Manager Version 7 index class to a Version 8 item type.

Specifies the name of the read-only item type.

* LIBSERVER server_name

Specifies the alias name of the library server where the documents are to be stored. The Collector Server instance establishes a connection to this server by using the parameters that follow.

Example:
LIBSERVER  LIBSERV1

(*) LOGICAL_SYSTEM name

Required if you want to archive or link documents by processing their bar codes or by creating a work item.

Specifies the name of the logical system that is connected to an SAP client. You specified the logical system when you configured the connection between the Collector Server instance and SAP.

Example:
LOGICAL_SYSTEM  T90CLNT090
Note: The LOGICAL_SYSTEM keyword is used in the DESTINATION section and in the ARCHIVE section. If, for a request, only the archive ID is known, Content Collector for SAP uses the LOGICAL_SYSTEM keyword in the ARCHIVE section to look up the connection parameters to the SAP system that is specified by the LOGICAL_SYSTEM keyword in the DESTINATION section.

MULTIPART YES | NO

Specifies if the documents are to be stored in the archive in several parts. This keyword is useful if the documents are too large for your repository or your operating system to handle.

If possible, store the documents in one part because multipart documents can cause problems when they are displayed in IBM Content Navigator.

Example:
MULTIPART  YES

(*) PREPROC_CLASS java_class

Required if you want to change outgoing documents by using a preprocessor before the documents are archived and if you want to start the preprocessor as a Java™ class.

Specifies the fully qualified Java class name of the preprocessor.

This keyword must be specified after the PREPROC_MIMETYPE keyword.

Example:
PREPROC_MIMETYPE   text/plain
PREPROC_CLASS      Preprocessor.SamplePreprocText
PREPROC_CLASSPATH  D:\preprocessors\preproc_java.jar
Note: You can use the same preprocessor several times. You can also use a different preprocessor for each MIME type. If you want to use different processors, ensure that each preprocessor has a unique Java class name even if the Java classes are in different class paths. Java class paths are concatenated. If you use the same Java class name for more than one preprocessor, the preprocessor user exit calls the first preprocessor that it finds for this Java class name.

(*) PREPROC_CLASSPATH java_classpath

Required if you want to start the preprocessor as a Java class.

Specifies the fully qualified path to the Java class.

This keyword must be specified after the PREPROC_CLASS keyword.

Example:
PREPROC_MIMETYPE   text/plain
PREPROC_CLASS      Preprocessor.SamplePreprocText
PREPROC_CLASSPATH  D:\preprocessors\preproc_java.jar

(*) PREPROC_EXEC exec

Required if you want to change outgoing documents by using a preprocessor before the documents are archived and if you want to start the preprocessor as an executable file.

Specifies the fully qualified path to the executable file that is to process the documents of the specified MIME type.

This keyword must be specified after the PREPROC_MIMETYPE keyword.

Example:
PREPROC_MIMETYPE  text/plain
PREPROC_EXEC      D:\preprocessors\preproc_text.bat

(*) PREPROC_MIMETYPE mime_type

Required if you want to change outgoing documents by using a preprocessor before the documents are archived.

Specifies the MIME type of the documents that are to be processed.

This keyword must be specified before you specify the preprocessor.

Example:
PREPROC_MIMETYPE  image/tiff

PROTECTION prot_flags | OFF

Specifies the protection for a logical archive.

If the docProt parameter is not supplied as part of a create request, the setting of the PROTECTION keyword used. If you specify PROTECTION OFF, the docProt setting is ignored.

prot_flags stands for the letter r (read), c (create), u (update), d (delete), or for a combination of these letters. The default value depends on the value of the ARCHIVETYPE keyword, as shown in the following table.
ARCHIVETYPE Default value of PROTECTION
GENERIC_MULTIPART OFF
SAP rcud
Example:
PROTECTION  rcu

In this example, READ, CREATE, and UPDATE operations can be performed on the documents.

Important: If you want to exploit the protection concept that is provided by SAP, do not specify the PROTECTION keyword.

(*) SCAN_PROCESS process_name

Required if you want to include an IBM Content Manager workflow in your archiving scenario.

Specifies the name of the workflow. Use this keyword with the WORKLIST_SCAN keyword and the WORKLIST_ERROR keyword.

Example:
ARCHIVE  A2
    STORAGETYPE     CM
    LIBSERVER       LIBSCM
    ITEM_TYPE       SCANDOCS
    CMUSER          cmuser1
    SCAN_PROCESS    SapScanProcess
    WORKLIST_SCAN   SapScanWL_A2
    WORKLIST_ERROR  SapErrorWL_A2

SECKEY_CHECK prot_flags | OFF

For use with an HTTP or HTTPS communication between the Collector Server instance and SAP.

Specifies the access modes that the secKey is checked for. Use this keyword if the secKey is to be checked for access modes other than the ones that are specified for the PROTECTION keyword. If you do not specify this keyword, the value that you set for the PROTECTION keyword is used as the default.

prot_flags stands for the letter r (read), c (create), u (update), d (delete), or for a combination of these letters. Set this keyword to OFF if the SAP requests do not contain a secKey.

Important: If you want to exploit the protection concept that is provided by SAP, do not specify the SECKEY_CHECK keyword. Use it only if the requests are issued from applications other than SAP applications.

SSL YES | NO

If set to YES, the logical archive accepts only HTTPS requests from SAP.

TEXT_SEARCHABLE YES | NO

Enables or disables full-text search in documents that are stored in item types. The item type must be enabled for text search in the system administration client of IBM Content Manager.

TIMEOUT seconds | 86400

Specifies the period, in seconds, for which the agent must have been idle before the agent closes the connection to a repository. The connection is reestablished automatically when a new request is sent to the repository.

Example:
TIMEOUT  300

TRANSFORM_URL url

Starts a user exit. With this user exit, you can run a Java application that uses Java Remote Method Invocation (RMI). This means that the Java method or the application is called over a web interface. The Java application is run before Content Collector for SAP starts to archive the documents. An example for an application is a conversion tool.

You must specify an RMI string (URL) for the keyword. At run time, Collector Server calls the URL over an HTTP server and starts the Java method or the application.

Example:
ARCHIVE  A1
    STORAGETYPE    CM
    LIBSERVER      LIBSCM
    ITEM_TYPE      DOCS1
    CMUSER         cmuser1
    .
    .
    .
    TRANSFORM_URL  rmi://localhost:1099/Transformer,rmi://localhost:1100/Transformer

In this example, the Java applications are installed on the same system as Collector Server.

You can include more than one URL in order to use several user exits in parallel. The specification of several URLs must meet the following requirements:
  • A URL is not enclosed in quotation marks.
  • All URLs are specified on one line.
  • The URLs are separated by commas. Do not specify a blank before or after the comma.
  • Your specification does not exceed a total length of 255 characters.

If you started more than one agent with the CMAGENTS keyword, specify at least as many URLs as agents are started. On the RMI server, the specified ports must be available.

TRUNCATE_ATTRIBUTE YES | NO

Specifies whether the attribute values are truncated if they are longer than the defined maximum length.

Example:
TRUNCATE_ATTRIBUTE  YES
Notes:
  • The setting applies to all attributes that are associated with the specified item type. You cannot truncate only a subset of the available attributes.
  • If set to YES, it can happen that data is lost.
  • If set to NO and an attribute value is too long, the documents that contain this value are not archived, and an error is logged.

(*) WORKLIST_ERROR worklist_name

Required if you want to include an IBM Content Manager workflow in your archiving scenario.

Specifies the name of the worklist that is associated with the error work node. Use this keyword with the WORKLIST_SCAN keyword and the SCAN_PROCESS keyword.

Example:
ARCHIVE  A2
    STORAGETYPE     CM
    LIBSERVER       LIBSCM
    ITEM_TYPE       SCANDOCS
    CMUSER          cmuser1
    SCAN_PROCESS    SapScanProcess
    WORKLIST_SCAN   SapScanWL_A2
    WORKLIST_ERROR  SapErrorWL_A2

(*) WORKLIST_SCAN worklist_name

Required if you want to include an IBM Content Manager workflow in your archiving scenario.

Specifies the name of the worklist that is associated with the scan work node. Use this keyword with the WORKLIST_ERROR keyword and the SCAN_PROCESS keyword.

Example:
ARCHIVE  A2
    STORAGETYPE     CM
    LIBSERVER       LIBSCM
    ITEM_TYPE       SCANDOCS
    CMUSER          cmuser1
    SCAN_PROCESS    SapScanProcess
    WORKLIST_SCAN   SapScanWL_A2
    WORKLIST_ERROR  SapErrorWL_A2