SAP-ArchiveLink® und yuuvis® RAD repository-manager

Gültig für: yuuvis® RAD Version 6.x

Durch die Kombination von KGS SAPALink und yuuvis® RAD repository-manager kann über die SAP-ArchiveLink® Schnittstelle yuuvis® RAD an SAP angebunden werden.

yuuvis® RAD repository-manager ist ein Microservice, dessen Daten bei der Installation von yuuvis® RAD service-manager automatisch mit installiert werden.

Für die Konfiguration sind folgende Schritte notwendig:

  • Objekttypen und Rollen anlegen
  • Import-Konfigurationen über den REST WebService hochladen
  • Konfiguration des Microservices 'ERM'.
  • Daten-Mapping

Für die Konfiguration werden weitere Daten benötigt, die als Download bereitstehen:

ERM-Service.zip

Objekttypen und Rollen

Im Schema von yuuvis® RAD wird eine Objekttypgruppe mit Ordnertyp und Dokumenttyp für SAP-Daten benötigt und eine Rolle für den Zugriff auf diese Objekttypen:

  • In yuuvis® RAD designer die Projektdatei ERMTypes.eoproj aus dem Verzeichnis \ERMTypes des ZIP-Archivs öffnen.
  • Die Objekttypgruppe 'SAPRepository' in das Schema des aktiven Projekts kopieren.
  • Die Rolle 'SAP-Repository-All' in das Schema des aktiven Projekts kopieren.
  • Das Projekt speichern und auf dem Server bereitstellen.
  • In yuuvis® RAD management-studio die Rolle 'SAP-Repository-All' den Systemadministratoren zuordnen.

    Die Rolle 'SAP-Repository-All' gewährt alle Objekttyprechte für die Objektypen 'SAP-Document' und 'SAP-Component'. Sie können weitere Rollen für den Zugriff auf die SAP-Objekttypen erstellen und Benutzern zuweisen und die SAP-Objekttypen bestehenden Rollen zuordnen.

Import-Konfigurationen laden

Die Import-Konfigurationsdateien werden über den REST WebService hochgeladen:

  • Folgende Seite öffnen:

    http://<host-gateway>/rest-ws/#ENDPOINT:EtlService.createOrUpdateConfiguration

  • Für jede Datei aus dem Verzeichnis \ETL des ZIP-Archivs folgende Schritte ausführen:
    • Im Abschnitt Endpoint request body > As file Datei auswählen.
    • Im Abschnitt Request auf Execute POST request klicken und das Hochladen bestätigen.

Konfiguration des Microservices 'ERM'

  1. Der Dienst 'yuuvis RAD service-manager' vor der Konfiguration des Microservices 'ERM' anhalten.
  2. Folgende Verzeichnisse anlegen:
    • <service-manager>\erm
    • <service-manager>\data\erm-work
  3. Die Datei ermservice-app.jar aus dem Verzeichnis <service-manager>\apps\ermservice mit einem ZIP-Programm öffnen und folgende Dateien kopieren:
    • Die Datei contentserver-config.properties aus dem Verzeichnis \BOOT-INF\classes in das Verzeichnis <service-manager>\apps\ermservice kopieren.
    • Das Verzeichnis ContentServer_4.3.0P2 aus dem Verzeichnis \BOOT-INF\classes\MISC in das Verzeichnis <service-manager>\erm kopieren.
  4. Die Datei erm-prod.yml aus dem Verzeichnis \config des ZIP-Archivs in das Verzeichnis <service-manager>\config kopieren.
  5. Die Datei servicewatcher-sw.yml aus dem Verzeichnis <service-manager>\config bearbeiten:
    - name: erm 
       type: microservice 
       profiles: prod,cloud,red 
       instances: 01   zum Einschalten eingeben
       memory: 512MOptional: Speicher anpassen
       port: 7351 
       path: ${appBase}/ermservice/ermservice-app.jar 
       options: 
       ‑ ' ‑Djava.io.tmpdir=D:\yuuvis-data\service‑manager\erm‑work\temp'Den Pfad zum angelegten Verzeichnis \erm-work anpassen
  6. Die Datei contentserver-config.properties aus dem Verzeichnis <service-manager>\apps\ermservice bearbeiten:
    ParameterWert
    ContentServer.PABName=C\:\\enaio\\services\\erm\\SecurityX\\ContentServer.pseDen Pfad zum angelegten Verzeichnis \erm anpassen
    ContentServer.LogFile=C\:\\enaio\\services\\logs\\ContentServer.logDen Pfad zum Verzeichnis <service-manager>\logs anpassen
    ContentServer.WorkingDirectory=C\:\\enaio\\services\\data\\erm-workDen Pfad zum angelegten Verzeichnis \erm-work anpassen
    ContentServer.BCSAPHost=10.10.0.215Die IP-Adresse des SAP-Servers eintragen
    ContentServer.AllowedCSAdmin=localhost,127.0.0.1,10.1.3.8Alle IP-Adressen als kommaseparierte Liste eintragen, von denen aus auf die Zertifikatsverwaltung von yuuvis® RAD repository-manager zugegriffen werden darf
    ContentServer.Repositories=D3Das für yuuvis® RAD verwendete SAP Repository eintragen
    ContentServer.BCSAPUser=OSECMDen für den Barcode-Upload zu verwendenden SAP-Benutzer eintragen
    ContentServer.BCSAPPassword=secret Das Password des für den Barcode-Upload zu verwendenden SAP-Benutzers eintragen
    ContentServer.BarcodeTimer=0

    Wartezeit zwischen den Barcode-Uploads in Sekunden

    Der Wert '0' deaktiviert die Funktion

    Nicht unter 10 Sekunden, Richtwert: 60 Sekunden

    ContentServer.Debug=0Log-Level des Microservices 'ERM' einstellen
  7. Den Pfad des Verzeichnisses \<service-manager>\erm\ContentServer_4.3.0P2 in den Windows-Eintellungen der Umgebungsvariablen als Systemvariable an erster Stelle einfügen.
  8. Rechner neu starten.

    Nach dem Neustart startet yuuvis® RAD service-manager den Microservice 'ERM'. Der Start wird in der Datei services.log im Verzeichnisses \<service-manager>\logs protokolliert. Nach erfolgreichem Start kann über die SAP-GUI ein Zertifikat installiert werden.

Daten-Mapping

Dokumenttyp-Mapping

Bei der Barcode-Meldung an das SAP-System wird auch ein SAP-Dokumenttyp übermittelt. Der SAP-Dokumenttyp ist nicht Teil der Indexdaten der SAP-Komponente, denn diese hat einen Content-Type.

Die Konfiguration erfolgt über die Datei erm-prod.yml aus dem Verzeichnis \<service-manager>\config.

Für die Übermittlung sind folgende Konfigurationsparameter möglich:

Parameter Beschreibung
ct2doc.default

Standard-SAP-Dokumenttyp, falls dieser nicht ermittelt werden kann.

Beispiel: ct2doc.default: PDF

map_ct2doctype

Der Parameter definiert eine Liste von Abbildungen, von Content-Type nach Dokumenttyp. Der Content-Type ist Bestandteil der Indexdaten der SAP-Komponente.

Die einzelnen Listenelemente werden per Pipe-Zeichen voneinander getrennt. Ein Listenelement besteht aus der Angabe <contenttype>:<doctype>. Der Doppelpunkt stellt das Abbildungszeichen dar.

Syntax: <contenttype1>:<doctype1>|<contenttype2>:<doctype2>|

Beispiel: map_ct2doctype: DEFAULT:TIF|IMAGE/TIFF:FAX|APPLICATION/PDF:PDF|

Die folgende Tabelle zeigt, welcher Content-Type auf welchen SAP-Dokumenttyp abgebildet wird:

Content-Type SAP-Dokumenttyp
IMAGE/TIFF FAX
APPLICATION/PDF PDF
andere TIF

Barcode-Upload

Die Barcodes, die an das SAP-System übermittelt werden sollen, werden per eSQL-Anfrage aus yuuvis® RAD ermittelt. Die eSQL-Anfrage befindet sich in der Datei getBarcodes.esql im Verzeichnis \BOOT-INF\classes von \<service-manager>\apps\ermservice-app.jar:

# eSQL for determining all unreported document-barcodes
# DOCUMENT_TYPE placeholder will be replaced by full qualified document-type name (e.g.: [dms]:[sapaldocument])
# COMPONENT_TYPE placeholder will be replaced by full qualified component-type name (e.g.: [dms]:[sapalcomponent])
# PARENT2CHILD_TYPE placeholder will be replaced by full qualified relation-type name
#
	SELECT [d] FROM DOCUMENT_TYPE [d] 
	WHERE
	([d].[isdeleted]=false OR [d].[isdeleted]=null) AND 
	([d].[isBarcodeReported]=false OR [d].[isBarcodeReported]=null) AND
	(LENGTH([d].[barcode]) > 0)
						

Ergebnis der eSQL-Anfrage: Es werden alle nicht gelöschten Dokumente ([d].[isdeleted]=false) geliefert, auf denen ein Barcode gesetzt wurde (LENGTH([d].[barcode]) > 0), wobei der Barcode bisher nicht an das SAP-System übermittelt wurde (isBarcodeReported=false).

Für Anpassungen muss der Service 'ERM' beendet werden, die Datei getBarcodes.esql aus ermservice-app.jar ausgepackt, angepasst und dann wieder eingepackt werden. Danach muss der Service 'ERM' wieder gestartet werden.

Temporäre Dateien

Für jeden Datei-Transfer werden temporäre Dateien im Temp-Verzeichnis angelegt, die nicht automatisch gelöscht werden aber regelmäßig gelöscht werden sollten.

Dazu kann die Batch-Datei DeleteERMTempFilesOlderThan1Day.bat aus dem ZIP-Archivs verwendet werden:

  • Kopieren Sie die Datei beispielsweise in das Verzeichnis <service-manager>\erm.
  • Tragen Sie das Temp-Verzeichnis in die Batch-Datei ein.
  • Erstellen Sie über die Windows-Aufgabenplanung einen Task, der die Batch-Datei regelmäßig, beispielsweise einmal täglich, ausführt.