Administrationshandbuch (EVI-ELO)

Installation

Voraussetzungen für die Verwendung des Moduls

• Das Modul EVI-Basis ist vorhanden und aktiv

• Das Modul C12ELO ist vorhanden und aktiv

Globale Variablen

• Folgende Globale Variablen sind zu konfigurieren

  • C12ELOExportDir

  • C12ELOImportDir

  • C12ELOURL

  • C12ELODeleteDocuments

Einrichtung der Timer

Die mit dem Modul ausgelieferten Timer sind zu konfigurieren

• C12ELOResponseImport

• C12ELODeleteDocument

Update

Bei jedem Modul-Update wird empfohlen, eine eventuelle Übersteuerung der Skriptbibliotheksmethoden und Prozesse zu prüfen. Ggf. kann es sinnvoll sein, auf den Standard zurück zu gehen, wenn die Übersteuerungen mit dem Standard übereinstimmt.

Technische Dokumentation

Komponentenübersicht

Prozesse

• C12ELOArchiveDocuments

  • C12ELOChooseArchiveMethod

  • C12ELOEditMetadata 

• C12ELOResponseImport

• C12ELORequestExport

• C12ELODeleteDocument

Skriptbibliothek

• SC12EVIBaseUtils

• SC12ELOUtils

• SC0InterfaceUtils

Globale Variablen

• C12ELOExportDir

• C12ELOImportDir

• C12ELOURL

• C12ELODeleteDocuments

Timer

• C12ELOResponseImport

• C12ELODeleteDocument

Die Timer rufen jeweils den gleichnamigen Prozess auf.

Transaktionstabellen + Events

• Event DOCUMENT_TRANSFER_DMS

• Event DOCUMENT_DELETE_DMS

• Es existiert keine dedizierte Transaktionstabelle

Administrationsmöglichkeiten

Administration über die globalen Variablen

Übersteuerungsmöglichkeiten

Grundsätzlich können die mit dem Modul bereitgestellten Komponenten wie BPM-Prozesse, -teilprozesse, Suchen und Skriptbibliotheksmethoden übersteuert werden, um diese an individuelle Anforderungen und Bedürfnisse anzupassen.

Interner Ablauf

Einstiegsmethoden

Maskenskript

Das Maskenskript der Entität Dokumente wird durch das Modul angepasst. Die Verfügbarkeit der Aktionsbox-Buttons "Archivieren" und "Metadaten-Aktualisierung" werden in der Callback-Methode beforeRenderActionbox gesteuert.
Hierfür stehen für jeden Button separate Methoden "SC12ELOUtils.isActiveArchiveButton" und "SC12ELOUtils.isActiveMetadataUpdateButton" zur Verfügung.

Beim Laden eines Datensatzes (entryLoaded) wird geprüft, ob der Datensatz innerhalb eines Prozesses (C12ELOEditMetadata, C12ELOArchiveDocuments) verwendet wird. Ist das der Fall, werden alle Felder gesperrt.
Anschließend werden die in der Methode "SC12ELOUtils.getFieldsForMetadataUpdate" definierten Felder wieder freigegeben, sodass der Anwender Änderungen vornehmen kann.

Beim Klicken des Buttons "Metadaten-Aktualisierung" wird der Prozess "C12ELOArchiveDocuments" aufgerufen. Der Datensatz wird in der Ansicht aktualisiert, sodass die Freigabe der Felder greift.

Prozesse

C12ELOArchiveDocument

Der Prozess kann sowohl aus der Aktionsbox (oberer Einstiegspunkt) als auch per Maskenskript (unterer Einstiegspunkt) gestartet werden. Der obere Prozesspfad prüft zu Beginn, welche Aktionen für die ausgewählten Dokumente verfügbar sind. Die verwendeten Methoden lauten "SC12ELOUtils.isMetadataUpdateAvailableForDocument", "SC12ELOUtils.isArchiveRevisionAvailableForDocument" und "SC12ELOUtils.isArchiveWithoutRevisionAvailableForDocument". Die jeweiligen Ausprägungen der Archivierung können über die Methoden "SC12ELOUtils.isActiveMetadataUpdate" und "SC12ELOUtils.isArchiveRevisionAvailableForDocument" aktiviert bzw. deaktiviert werden. Im Task "Auswahl" wird der Teilprozess "C12ELOChooseArchiveMethod" eingebunden. Als Eingabeparameter dienen die Variablen "listSelections" und "strMessage", welche die zuvor ermittelten möglichen Auswahlmöglichkeiten sowie die anzuzeigende Meldung enthalten. Als Ausgabeparameter dient die Variable iSelectedValue, welche den Index des gewählten Eintrages aus "listSelections" enthält. Da die Auswahlmöglichkeiten internationalisiert sind, müssen sie im Tasks "Auswahl auswerten" überprüft und mit einem allgemeinen Aktionsnamen ersetzt werden. Nun wird je nach Auswahl entschieden, ob der Teilprozess "C12ELOEditMetadata" ausgeführt wird, oder ob die Meldung erscheinen soll, ob der Anwender die Aktion durchführen möchte. Bestätigt der Anwender die Meldung, wird bei nur einem gewählten Datensatz die Einzelverarbeitung und bei mehreren Datensätzen die Verarbeitung per Massendatentask angestoßen. Die Verarbeitung innerhalb der Tasks ist identisch. Bei einem Prozessstart aus dem Maskenskript werden die Prozessvariablen entsprechend initialisiert und direkt in die Datenerfassung "C12ELOEditMetadata" gesprungen. In der Verarbeitung der Datensätze werden die Methoden "SC12ELOUtils.prepareDocumentForArchive" und "SC12ELOUtils.doCustomAction" aufgerufen. Letztere ist für eine kundenspezifische Nachverarbeitung der Daten gedacht und daher nicht implementiert.

C12ELOChooseArchiveMethod

Dieser Teilprozess dient zur Auswahl der Aktion. Über die Eingabevariable "strMessage" wird der anzuzeigende Text eingereicht. Die Auswahlmöglichkeiten werden bereits internationalisiert über die Eingabevariable "listSelections" eingereicht. Als Ausgabewert dient "selectedValue".

C12ELOEditMetadata

Dieser Teilprozess öffnet das Dokument in der CRM-Detailmaske. Der Primärschlüssel des Dokuments wird über die Eingabevariable "pkDocument" gesetzt.

C12ELORequestExport

Dieser Prozess dient dem Export der Daten für ELO. Der Prozess reagiert auf die Neuanlage eines C12EVENT mit dem Eventname "DOCUMENT_TRANSFER_DMS" (weitere Informationen zu dem Event finden Sie hier.)
Der Skripttask ruft anschließend die Methode "SC12ELOUtils.createArchiveFiles" oder "SC12ELOUtils.createMetadataUpdateFiles", je nach gewählter Aktion im vorherigen Prozessverlauf, auf. Zudem wird ein C12EVENTRESULT im jeweiligen Status erzeugt und der DMS Status am Dokument entsprechend gesetzt.

C12ELOResponseImport

Dieser Teilprozess importiert die ELO-Rückgabedateien und aktualisiert die entsprechenden Dokumenten Datensätze. Weiterhin werden die Rückgabe-Ergebnisse im zugehörigen Event Result festgehalten. Hier wird in 3 mögliche Use Cases unterschieden. Der Timer zur Verarbeitung der Rückantwort muss eingerichtet sein.

1. Erfolgreiche Verarbeitung in ELO

   Im Importverzeichnis muss eine Datei mit folgendem Inhalt abgelegt werden:

   OK: Dateiname_der_in_5_exportierten_Datei mit PK: PK_der_Datei importiert. guid:(9F33CCE7-C583-4B51-B41E-039ADC651F5A)

   EVI verarbeitet diese Datei via Timer. Die Datei wird aus dem Importverzeichnis gelöscht. Das zugehörige Dokument hat nun den Status 100. Die in der TXT enthaltene guid ist in DMS ID am Dokument hinterlegt.

2. Fehlgeschlagene Verarbeitung in ELO

   Im Importverzeichnis muss eine Datei mit folgendem Inhalt abgelegt werden:

   FEHLER: Dateiname_der_in_5_exportierten_Datei mit PK: PK_der_Datei nicht importiert.

   EVI verarbeitet diese Datei via Timer. Die Datei wird aus dem Importverzeichnis gelöscht. Das zugehörige Dokument hat nun den Status -1. Das Feld DMS ID des Dokumentes wurde nicht verändert.

3. Fehlerhafte Antwortdatei

   Im Importverzeichnis muss eine Datei mit folgendem Inhalt abgelegt werden:

   OK: Dokument 3C_ELO_TEST importiert. guid:(A49AB969-B919-5528-4FEE-119D12CE4C28)

   EVI verarbeitet diese Datei via Timer. Die Datei verbleibt im Importverzeichnis. Es wird ein neuer Schnittstellen-Details-Datensatz angelegt. Hier ist die fehlerhafte Datei im Ergebnis der Schnittstelle hinterlegt.

C12ELODeleteDocument

Bei dem Teilprozess "Löschen eines Dokuments" unterscheidet man in insgesamt 3 Use Cases:

Use Case: Nicht archiviertes Dokument wird gelöscht 

Der Anwender erstellt ein neues Dokument. Nun löscht der Anwender das Dokument. Das Dokument wird auf inaktiv gesetzt. Es wird kein Event "DOCUMENT_DELETE_DMS" erzeugt.

Use Case: In Übertragung befindliches Dokument wird gelöscht
Voraussetzung: Der Timer zum Löschen der Dokumente ist aktiviert.

Der Anwender steht auf dem Dokument. Das Dokument hat den DMS Status 30. Die Antwort von ELO wurde noch nicht eingelesen. Der Anwender löscht das Dokument über den Systemstandard (Trash-Symbol). Es wird ein Event "DOCUMENT_DELETE_DMS" mit dem PK des soeben gelöschten Dokumentes erzeugt. Durch den Timer wird eine XML-Datei mit einem Dateinamen nach dem Muster yyyyMMddhhmmss_pk.erweiterung mit der Endung xml abgelegt. Die Datei enthält folgende Elemente:

<?xml version="1.0"  encoding="ISO-8859-1" ?>
<elodeletelist ver="1.0">
	<obj>
		<source value="#()"/>
	</obj>
</elodeletelist>

Es wird eine SIG-Datei nach dem bekannten Muster erstellt. Das Attribut value am Element source in der XML-Datei ist leer, da keine DMS ID am Dokument hinterlegt ist. Solche Fälle sind über die Events und EventResults zu identifizieren und manuell in ELO zu korrigieren. Dies ist möglich, da der Dokumenten-PK an ELO übermittelt und im Event hinterlegt ist. Weitere Informationen zu dem Event finden Sie hier.

3. Use Case: Ein archiviertes Dokument wird gelöscht

Voraussetzung: Der Timer zum Löschen der Dokumente ist aktiviert.

Der Anwender steht auf dem Dokument. Das Dokument hat den DMS Status 100. Der Anwender löscht das Dokument. Es wird ein Event "DOCUMENT_DELETE_DMS" mit dem PK des soeben gelöschten Dokumentes erzeugt. Durch den Timer wird eine XML-Datei mit einem Dateinamen nach dem Muster yyyyMMddhhmmss_pk.erweiterung mit der Endung xml abgelegt. Die Datei enthält folgende Elemente:

<?xml version="1.0"  encoding="ISO-8859-1" ?>
<elodeletelist ver="1.0">
    <obj>
        <source value="#(C12DMSID.Document)"/>
    </obj>
</elodeletelist>

Es wird ebenfalls eine SIG-Datei nach dem bekannten Muster erstellt. Die Rückantwort von ELO wird in einem Event-Result am Event festgehalten. Weitere Informationen zu dem Event finden Sie hier.