Configurations for the REPOSITORYMANAGER Service

Configure yuuvis® Momentum and the SAP system to properly operate the REPOSITORYMANAGER service.

Table of Contents

Introduction

After installing the REPOSITORYMANAGER Service, further configurations of yuuvis® Momentum and the SAP system are required.

Configuring the App Schema

The REPOSITORYMANAGER service requires the repositorymanager app schema shown in the code block below. It is imported to yuuvis® Momentum via the endpoint POST /api/system/apps/{app}/schema.

The app schema contains the document object type definitions archiveLinkComponent and ilmObject.

Properties of 'archiveLinkComponent'

Objects of type archiveLinkComponent will be used both for documents (logical placeholders) and components (actual documents with content). It contains metadata related to ArchiveLink documents and ArchiveLink components.

PropertyType

Description

CreationdateStringDate of creation
CreationtimeStringTime of creation
DatelastmodificationStringDate of the last modification
TimelastmodificationStringTime of the last modification
ContentrepositoryStringName of the content repository

ArchiveLinkversion

String

ArchiveLink log version number (e.g., 0046)

DocumentprotectionStringDocument protection: user-defined combination of the r (read), c (create), u (update), and d (delete) operations defined in the ArchiveLink ACL (AccessControlList). If SAP does not provide information when a document is created, the default value as defined in the KGS configuration interface will be valid (normally rcud: i.e., the document is protected from all operations).
DocIDStringDocument ID that unambiguously identifies the SAP document.
LegalholdlockString

Specifies that the document has to be retained due to legal reasons (legal hold), thus preventing the document or its components from being deleted.

This property was introduced with component version 7.0. It is enabled for specific scenarios only.

ExpirationdateString

Retention period for the document and its components.

This property was introduced with component version 7.0. It is enabled for specific scenarios only.

BarcodeStringTemporary unique ID that can be used to assign a document object located in yuuvis® Momentum to a business transaction in the SAP system.
BarcodesenttoR3BooleanThis document flag indicates whether the barcode and thus the document have already been reported to SAP.
CompIDStringComponent ID (data for multi-page TIFF files or data, data1, data2, etc. for single-page TIFF files)
ContenttypeStringMIME type (image/tiff or application/pdf, for example)
FilenameStringFile name of the source file. As this name is always filed through Apache Tomcat's working directory, the name is always a temporary file name.
ApplicationversionStringVersion number of the application (e.g., 1.0)
CharsetStringCharacter set
CompressionstringString

Compression with gzip is performed by the content server for components with a size that exceeds the adjustable threshold value CompressionSize. This offers advantages for storing, especially for storing print lists that have an uncompressed size bigger than 2 GB. By this compression, they are usually reduced to 10% of the original size.

With this administrative information, the content server is able to determine the uncompressed size of the component and which compression parameters have been used.

Properties of 'ilmObject'

The objects of type ilmObject have the common ILM properties (URL and properties table), as well as a content length property and a type property.

PropertyTypeDescription
typestring

Specifies the ILM object type. Available values:

  • collection (set 0 for contentlength)
  • resource
contentlengthinteger

Content size in Bytes

0 for ILM collections

propertiestableTable with name and value columns of type string
urlstringURL of the ILM object

Combination with Library-based Client

If a client application for yuuvis® Momentum is used that is based on our developer libraries, the IDs of properties and object types should be localized.
>> Localization for Clients

An example key-value mapping is shown in the following code block.

Example localization for library-based clients
{
	"appRepositorymanager:Contentrepository_label": "Content Repository",
	"appRepositorymanager:ArchiveLinkversion_label": "Archive Link Version",
	"appRepositorymanager:Documentprotection_label": "Document Protection",
	"appRepositorymanager:DocID_label": "Document ID",
	"appRepositorymanager:Creationdate_label": "Creation Date",
	"appRepositorymanager:Creationtime_label": "Creation Time",
	"appRepositorymanager:Datelastmodification_label": "Last Modified Date",
	"appRepositorymanager:Timelastmodification_label": "Last Modified Time",
	"appRepositorymanager:Legalholdlock_label": "Legal Hold Lock",
	"appRepositorymanager:Expirationdate_label": "Expiration Date",
	"appRepositorymanager:Barcode_label": "Barcode",
	"appRepositorymanager:BarcodesenttoR3_label": "Barcode Sent to R3",
	"appRepositorymanager:CompID_label": "Component ID",
	"appRepositorymanager:Contenttype_label": "Content Type",
	"appRepositorymanager:Filename_label": "File Name",
	"appRepositorymanager:Applicationversion_label": "Application Version",
	"appRepositorymanager:Charset_label": "Chartset",
	"appRepositorymanager:Compressionstring_label": "Compression String",
	"appRepositorymanager:archiveLinkComponent_label": "ArchiveLink object type",
	"appRepositorymanager:archiveLinkComponent_description": "Type used for ArchiveLink documents and components",
	"appRepositorymanager:timestampProperties_label": "Timestamp properties",
	"appRepositorymanager:componentProperties_label": "Component properties",
	"appRepositorymanager:documentProperties_label": "Document properties",
	"appRepositorymanager:type_label": "Type",
	"appRepositorymanager:url_label": "URL",
	"appRepositorymanager:properties_label": "Properties",
	"appRepositorymanager:contentlength_label": "Content Length",
	"appRepositorymanager:ilmObject_label": "ILM object type",
	"appRepositorymanager:ilmObject_description": "Type used for ILM collections and resources"
}


Configuration of the KGS SAP Connector

Open the KGS Administration Page as described in the installation guide for the REPOSITORYMANAGER service. Go to Main > KGS SAP Connector.

An SAP connector is required for the RFC configuration later on.

In the Configuration Editor, configure a debug level between 0 and 4. For productive systems, value 0 is usually set.

The barcode scenario is set up with the following steps.

  • Create a bridge connection via Main > KGS SAP Connector > Bridge Status > Generate Bridge.


  • Create a connection via Main > KGS SAP ConnectorAdd config.


  • Edit the connection via Main > KGS SAP Connector > EditThe following information needs to be entered: Description, SAP AS Host, SAP System Number, SAP Client, SAP User, SAP User Password, SAP Language
  • Configure the repositories via MainContentserver4ArchiveLinkEdit and adjust the values in the following tabs:
    • License - Specify the KGS-license key.
    • Barcode - Tick the Enable Barcode checkbox.
    • Protocol - For normal work mode, untick all checkboxes.
    • Common - Adjust only the debug level if necessary.
    • Security
      • Configure the default security level for the communication between SAP and embedded tomcat:
        0 - certificate is not used
        1 - certificate is used, but not validated
        2 - certificate is used and validated
        We recommend level 2 for productive systems.
      • Specify the clients that should be allowed to change the certificate via Allowed CSAdmin Clients. Avoid the use of a wildcard. Specify only the needed IP addresses instead.
    • RFC - Choose one of the connections you configured before.
    • Components - Usually no changes needed. In case you see a need, please contact your OS or KGS consultant.
    • Backend - Usually no changes needed. In case you see a need, please contact your OS or KGS consultant.
    • Content - Usually no changes needed. In case you see a need, please contact your OS or KGS consultant.
    • Index Export - If barcode upload is used, the time period for requesting new barcodes can be adjusted here. Please ensure that the period in productive systems is long enough to avoid overlapping runs (1800 s recommended). 
    • ILM - Set ILM for the ILM Repository. Enter the user name and password of an existing SAP account that should be used for the connection.
  • Assign a configuration at repository level or global level via Main > ContentServer4ArchiveLink > Edit > RFC > RFC Connection Name. The barcode configuration you create will be assigned. To use barcode synchronization from multiple SAP systems, remove any global barcode configuration and use the configuration at repository level instead.
    • Repository level:
    • Global level:
  • Enable barcode via Main > ContentServer4ArchiveLink > Edit Configuration > Barcode > Enable barcode.
  • Define the barcode timer via Main > ContentServer4ArchiveLink > Edit Configuration > Index Export > BarcodeTimer. Recommended: 60 (seconds)
  • SAPMimeExtensionLookup needs to be enabled to be able to correctly assign file formats to document types. Enable SAPMimeExtensionLookup via Main > ContentServer4ArchiveLink > Edit Configuration > Common > SAPMimeExtensionLookup

Configuration of the SAP System

To connect the SAP system with the HTTP content server and make all necessary settings, we recommend following the SAP guidelines using the SPRO transaction under Netware > Application Server > Basis Services > ArchiveLink.

To customize the interface for print lists and outbound documents, we recommend attending the SAP course BIT615. To file reorg data, we recommend attending the SAP course BIT660.

The main transactions required to establish a connection are listed below:

Transaction OAC0 defines one or several repositories.

This and all further activities within the SAP system have to be carried out by the SAP system administrator or another authorized user of the customer.

These activities include:

  • For the first time:

    • Creation of a communication user (SU01) with the corresponding authorizations (SAP_BC_ENDUSER, SAP_BC_SRV_ARL_ADMIN, SAP_BC_SRV_ARL_USER, SAP_BC_SRV_COM_ADMIN)

    • ArchiveLink: maintenance of basic settings (OAG1)

    • Creation of number range intervals (OANR) for print lists

    • Create log (OAA3) or import prepared transports from OPTIMAL SYSTEMS with the log.

    • Creation of an archive device (name ARCH) as output device (SPAD), assignment of the SAP ArchiveLink archiver, hostspool access method (I: archiver)

  • One or several times; depending on how many content repositories have to be defined:

    • Creation of a content repository (OAC0)
      DocArea – ArchiveLink
      Filing method – HTTP content server
      Log – OPTIMALA
      Version no. – 0046 or 0047
      http script – cs/contentserver
      Output device – ARCH
      HTTP server – name or IP address of the server on which yuuvis® Momentum REPOSITORYMANAGER is running
      Port number – The port used to access yuuvis® Momentum REPOSITORYMANAGER (default: 8010).

    • After successful configuration of yuuvis® Momentum REPOSITORYMANAGER, the certificate (OAC0/CSADMIN) has to be sent and activated for each repository.

Summary

The REPOSITORYMANAGER service uses properties and object types that are defined in a separate app schema. If a library-based client is used, the corresponding property and object type IDs have to be localized in order to replace the technical terms in the graphical user interface of the client application. Furthermore, the SAP system needs some manual configuration.

Read on

Schema - Defining Object Types

Detailing the available schema, object type definitions as well as property definitions. Keep reading

Custom Client Build with Libraries

Documentation of the client core and framework libraries, as usable for custom client development. Keep reading

Localization for Clients

Configure localizations for a custom client built with our libraries or for yuuvis® client as reference implementation. Keep reading