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.
Configure 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.
Property | Type | Description |
---|---|---|
Creationdate | String | Date of creation |
Creationtime | String | Time of creation |
Datelastmodification | String | Date of the last modification |
Timelastmodification | String | Time of the last modification |
Contentrepository | String | Name of the content repository |
| String | ArchiveLink log version number (e.g., |
Documentprotection | String | Document 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). |
DocID | String | Document ID that unambiguously identifies the SAP document. |
Legalholdlock | String | 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. |
Expirationdate | String | Retention period for the document and its components. This property was introduced with component version 7.0. It is enabled for specific scenarios only. |
Barcode | String | Temporary unique ID that can be used to assign a document object located in yuuvis® Momentum to a business transaction in the SAP system. |
BarcodesenttoR3 | Boolean | This document flag indicates whether the barcode and thus the document have already been reported to SAP. |
CompID | String | Component ID (data for multi-page TIFF files or data , data1 , data2 , etc. for single-page TIFF files) |
Contenttype | String | MIME type (image/tiff or application/pdf , for example) |
Filename | String | File 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. |
Applicationversion | String | Version number of the application (e.g., 1.0 ) |
Charset | String | Character set |
Compressionstring | String | 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. With previous 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.
Property | Type | Description |
---|---|---|
type | string | Specifies the ILM object type. Available values:
|
contentlength | integer | Content size in Bytes 0 for ILM collections |
properties | table | Table with name and value columns of type string |
url | string | URL 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.
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.
For customizing the interface for print lists and outbound documents, we recommend attending the SAP course BIT615.
For filing 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 undertaken 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.