Connector für dg hyparchive in Applikationen

Modul Applikationen Fremddaten einbinden

1. Anwendungsentwicklung

1.1. Datengruppen

Um Stempeldaten und Dokumente über Intrexx in dg hyparchive speichern zu können, wird eine Intrexx-Standard-Datengruppe benötigt. Fremddatengruppen werden zurzeit nicht vom Connector unterstützt. Die Datenfelder der Datengruppe können dann mit dg hyparchive-Stempelfeldern verknüpft werden. Für Dateien wird der Datengruppe ein Datei-Datenfeld hinzugefügt, das eine spezielle FileHandler-Klasse für dg hyparchive erhält.

Es ist zwar grundsätzlich möglich mehrere dg hyparchive-Datei-Datenfelder zu erstellen, empfohlen wird aber nur eines pro Datengruppe, da sonst die Zuordnung der Stempelfelder unübersichtlich wird.



Markieren Sie die Datengruppe, die mit dg hyparchive verbunden werden soll, in der Applikationsstruktur und legen Sie über das Hauptmenü Neu / Datenfeld mindestens folgende Datenfelder an:

1.2. Datei-Datenfelder




Erstellen Sie anschließend ein weiteres Datenfeld mit dem Datentyp Datei. Klicken Sie auf "mehr...".



Wählen Sie hier die Option "Intrexx Handler" und den Handler "dg hyparchive Handler" aus. Klicken Sie dann auf "OK".



Öffnen Sie den Eigenschaftendialog des neuen Datei-Datenfeldes mit einem Doppelklick auf das Feld in der Applikationsstruktur. Die Datenfelder können Sie mit dem Hauptmenü Bearbeiten / Datenfelder anzeigen in der Applikationsstruktur einblenden, wenn die Datengruppe dort markiert ist. Auf dem Reiter Allgemein werden der Titel des Feldes und die zuvor ausgewählte Handlerklasse angezeigt. Daneben werden spezifische Angaben benötigt:

1.3. Stempelfelder

1.3.1. Zuordnung von Intrexx Feldern

Wechseln Sie dann auf den Reiter Feldzuordnung. Hier werden Intrexx-Datenfelder bzw. -Werte den dg hyparchive-Stempelfeldern zugeordnet.



Auf der linken Seite des Dialogs werden die dg hyparchive-Stempel des zuvor gewählten dg hyparchive-Servers aufgelistet, rechts die Felder der Intrexx-Datengruppe, ggfs. die Felder einer Eltern-Datengruppe und benutzerspezifische Werte. Zur besseren Übersicht können die dg hyparchive-Felder nach Stempel gefiltert werden. Mit den Pfeilschaltflächen können dg hyparchive-Felder und Intrexx-Datenfelder zugeordnet werden. Beim Speichern eines Datensatzes in Intrexx wird der Wert des Intrexx-Datenfeldes automatisch im verknüpften dg hyparchive-Feld gespeichert. Dabei ist zu beachten, dass der Datentyp in dg hyparchive kompatibel zu dem des Intrexx-Datenfeldes ist.

1.3.2. Zuordnung von benutzerspezifischen Werten

Neben Datenfeldern können dg hyparchive-Felder auch benutzerspezifische Werte zugewiesen werden. Klicken Sie dazu auf Wert hinzufügen.



Wählen Sie hier einen statischen Wert, Systemwert, eine GUID oder einen Null-Wert aus. Dies ist z.B. hilfreich, wenn für ein Stempel-Pflichtfeld immer der gleiche Wert verwendet werden soll. Auf gleiche Art und Weise können so berechnete Datumswerte oder Systemwerte wie z.B. der aktuelle Intrexx-Benutzer angelegt werden. Ein weiteres Beispiel wäre die Generierung einer GUID zur Laufzeit als eindeutige Datensatz-ID für Intrexx und dg hyparchive. Hilfe zu diesem Dialog finden Sie hier. Berechnete Werte werden standardmäßig nicht in Intrexx-Datenfeldern, sondern nur in dg hyparchive-Feldern gespeichert. Für bestimmte Zwecke ist es notwendig, einen statischen Wert auch in einem Intrexx-Datenfeld zu speichern. Daher werden Sie nach der Zuweisung eines Wertes an ein dg hyparchive-Feld automatisch gefragt, ob der Wert auch in ein Intrexx-Datenfeld gespeichert werden soll.



Hier kann die Einstellung Wert in Datenfeld speichern aktiviert werden. Klicken Sie "OK".



Die Einstellung "Wert in Datenfeld speichern" kann in der Feldzuordnung mit Klick auf Wert in Datenfeld speichern bearbeitet werden.

1.3.3. Zuordnung von Auswahllisten

Wie Intrexx bietet auch dg hyparchive die Möglichkeit, Auswahllisten für Datenfelder zu definieren. Felder mit Auswahllisten haben in dg hyparchive den Datentyp "sngsel" bzw. "mltsel (für Listen mit Mehrfachauswahl). Auswahllisten in dg hyparchive können Werte aus Intrexx-Datenfeldern oder statische Werte zugewiesen werden. Dabei ist zu beachten, dass über den Wert in Intrexx der entsprechende Eintrag der Auswahlliste in dg hyparchive ermittelt werden kann. Wird als dem dem Listenfeld ein String-Intrexx-Datenfeld zugewiesen, so muss der darin gespeicherte Wert einem Anzeigewert in der dg hyparchive-Auswahlliste entsprechen. Dabei ist die Groß-/Kleinschreibung zu beachten.

1.3.4. Ansichts- und Eingabeseiten

Zur Ansicht und Bearbeitung von Stempelfeldern stehen die üblichen Datenfelder-Kontrollen auf Ansichts- und Eingabeseiten zur Verfügung. Damit Intrexx das für den jeweiligen Datensatz verknüpfte Dokument in dg hyparchive ermitteln kann, ist es notwendig, die Felder für Department-ID und Dokument-ID auf jeder Ansichts- und Eingabeseite mit dg hyparchive-Bezug zu hinterlegen. Die Department-ID kann in den Eigenschaften des Dateifeldes auf dem Reiter Expert in den Settings ermittelt werden (Wert des Attributs hyparchive.department.id).



Um bestehende dg hyparchive-Dokumente in der Intrexx-Applikation anzuzeigen, müssen entsprechende Datensätze mit der korrekten Department-ID und Dokument-ID angelegt werden. Dies kann auch im versteckten Bereich erfolgen, damit die Felder für Benutzer nicht sichtbar sind. Wenn Stempeldaten eines Dokuments direkt in dg hyparchive geändert werden, können diese nicht ohne weiteres unmittelbar automatisiert in Intrexx synchronisiert werden. Daher aktualisiert Intrexx die Felder eines dg hyparchive-Stempels automatisch, sobald der Datensatz auf einer Ansichts- oder Eingabeseite geöffnet wird. Um die aktualisierten Daten auch in Intrexx zu speichern, muss der Benutzer anschließend auf "Speichern" klicken.

1.4. Authentifizierung

Als letzter Schritt der Datei-Datenfeld-Konfiguration kann über den Reiter Authentifizierung definiert werden, welcher Portalbenutzer für die Authentifizierung beim Zugriff auf den dg hyparchive-Server ermittelt werden soll.



Standardmäßig wird hier der aktuell angemeldete Portal-Benutzer verwendet. Besteht für diesen keine dg hyparchive-Sitzung und wurde in der Konfiguration der Verbindung Benutzername und Passwort als Authentifizierungsmethode gewählt, so wird der Benutzer im Portal aufgefordert, sich an dg hyparchive anzumelden. Es gibt Anwendungsfälle, bei denen Zugriffe auf dg hyparchive immer über den gleichen dg hyparchive-Benutzer erfolgen sollen, unabhängig welcher Portalbenutzer aktuell angemeldet ist. Dies ist z.B. der Fall, wenn es nicht zu jedem Intrexx-Benutzer einen dg hyparchive-Benutzer gibt oder grundsätzlich Dokumente aus Intrexx immer unter dem gleichen Benutzer in dg hyparchive gespeichert werden sollen. Für diesen Fall kann hier ein statischer Benutzer gewählt werden. Dabei handelt es sich um einen Intrexx-Benutzer, dem in der dg hyparchive Konfiguration ein dg hyparchive-Benutzerkonto zugewiesen wurde. Über den Dialog kann auch direkt ein statischer Benutzer angelegt werden. Sobald ein solcher Benutzer in dem Datei-Datenfeld hinterlegt wird, erfolgen alle Zugriffe auf dg hyparchive über die Datengruppe unter diesem dg hyparchive-Benutzerkonto. Das bedeutet, dass eine interaktive Anmeldung an dg hyparchive im Portal nicht mehr notwendig ist. Dadurch lassen sich auch einfache Single-Sign-On-Szenarien realisieren, ohne auf die Kerberos-Authentifizierung zurückgreifen zu müssen.

1.5. dg hyparchive Datengruppen-Handler

Sobald einer Intrexx-Datengruppe ein Datei-Datenfeld für dg hyparchive hinzugefügt und dieses konfiguriert wurde, wird automatisch die Datahandler-Klasse in den Expert-Attributen der Datengruppe auf 
de.uplanet.lucy.server.dghyparchive.connector.rtdata.RtDataGroupTableHypArchive
geändert. Dies kann auch nachträglich vorgenommen werden. Die dg hyparchive-spezifische Datengruppen-Handler-Klasse ist optional, bietet aber zusätzliche Funktionalität im Zusammenspiel von Intrexx und dg hyparchive. So wird eine automatische Synchronisation der Stempelwerte aus dg hyparchive vorgenommen, sobald ein hyparchive-Datensatz auf einer Intrexx-Ansichts- oder Eingabeseite geladen wird. Dadurch ist gewährleistet, dass ein Intrexx-Portalbenutzer stets die aktuellen Stempeldaten aus dg hyparchive angezeigt bekommt. Unter Umständen kann es nämlich vorkommen, dass Stempeldaten in dg hyparchive geändert wurden und in Intrexx noch die vorherigen Werte gespeichert sind.

1.6. Ländereinstellungen

Datums-/Zahlen- und Währungsfelder werden von dg hyparchive mit dem vom Benutzer eingestellten Format unter Ländereinstellungen formatiert. dg hyparchive benötigt dabei den vollen Sprach-/Kultur-Code (z.B. de-DE oder en-US anstatt de oder en). Die Formate für die benötigten Sprachen können in den Portaleigenschaften definiert werden. Alternativ kann für dg hyparchive eine Standardsprache in der Konfiguration des Datei-Datenfelds hinterlegt werden. In dem Fall wird bei allen dg hyparchive-Aufrufen der gleiche Sprachcode verwendet. Dabei ist zu beachten, dass in Intrexx für Datums-/Zahlen- und Währungseingabefelder das von dg hyparchive erwartete Format eingestellt wird.

1.7. Unterstützung von SAP-Dokumenten

Für die Unterstützung von SAP ArchiveLink-Dokumenten (verfügbar ab Intrexx 8 / Online-Update 07) müssen die folgenden zusätzlichen Einstellungen in der Applikation vorgenommen werden:
  1. Ein Datenfeld mit Datentyp Kurzer Text wird für die SAP-Archiv-Id benötigt.
  2. In den Eigenschaften des Datei-Datenfeldes müssen auf dem Reiter Expert /Settings folgende Settings hinzugefügt werden:
    • hyparchive.sap.archive = true (Typ: Boolean)
    • hyparchive.sap.archive.id.field.guid = [GUID des SAP ArchiveLink ID Datenfelds] (Typ: GUID)

1.8. Expert-Settings

In den Eigenschaften des Datei-Datenfelds stehen auf dem Reiter Expert folgende Settings zur weiteren Konfiguration des Connectors zur Verfügung:

2. dg hyparchive in Portalapplikationen

2.1. Authentifizierung

Beim ersten Zugriff auf eine Portal-Applikation mit einer Datengruppe, die dg hyparchive Datei-Datenfelder enthält, wird der Benutzer aufgefordert, sich an dg hyparchive anzumelden. Pro Sitzung und dg hyparchive-Server ist das nur einmal erforderlich. Sollte Integrierte Windows-Authentifizierung aktiv sein, wird der Benutzer automatisch beim ersten Zugriff angemeldet. Eine Anmeldung wird nicht benötigt, wenn im Datei-Datenfeld der Datengruppe ein statischer Benutzer für die dg hyparchive-Authentifizierung hinterlegt wurde. Nach erfolgreicher Authentifizierung kann über die Intrexx-Applikation auf dg hyparchive-Daten zugegriffen werden. Dem Portalbenutzer stehen dabei mit dg hyparchive-Datengruppen die gleichen Funktionen zur Verfügung, wie mit normalen Intrexx-Datengruppen. Bezüglich der Dateioperationen gibt es nur wenige Besonderheiten zu beachten.

2.2. Dateioperationen in Ansichtstabellen

dg hyparchive-Datei-Datenfelder können in Ansichtstabellen platziert werden, um Dateien direkt aus Tabellen zu öffnen. Standardmäßig werden aus Performancegründen jedoch keine Dateien aus dg hyparchive in Datei-Datenfeldern angezeigt, wenn sie in einer Ansichtstabelle dargestellt werden. Aktivieren Sie dazu die Option "Dateien aus dg hyparchive auch in Ansichtstabellen anzeigen" in der Datei-Datenfeld-Konfiguration. Sollen Dokumente direkt aus Tabellen heraus heruntergeladen werden können, muss dies in den Optionen des Datei-Datenfeldes in der Ansichtstabelle aktiviert werden.

Bitte beachten Sie, dass keine Thumbnails für dg hyparchive-Dateien angezeigt werden können, weil diese nicht auf dem Intrexx-Portalserver, sondern nur in dg hyparchive vorgehalten werden. Somit können auch keine Vorschaubilder von Intrexx generiert werden.

2.3. Dateioperationen auf Ansichtsseiten

dg hyparchive-Dateien werden auf Ansichtsseiten über das Applikations-Element Dateiauswahl Ansicht dargestellt.



Auch hier kann ein Download der Dateien ermöglicht werden.

2.4. Dateioperationen auf Eingabeseiten

Mit dem Dateiauswahl auf Eingabeseiten können Dateien und Dokumente über Intrexx hochgeladen, geändert und in dg hyparchive gespeichert werden. Es stehen dabei alle Funktionen von Standard-Intrexx-Datei-Datenfeldern zur Verfügung.



Neben dem Freischalten von Downloads kann auch das Upload-Verhalten definiert werden. Grundsätzlich werden neue Dateien bei dg hyparchive-Dokumentenmappen den vorhandenen Dateien hinzugefügt. Es ist aber auch möglich, Dateien zu ersetzen.



Außerdem kann eingestellt werden, wie viele Dateien maximal pro Datei-Datenfeld gespeichert werden dürfen. Auch die maximale Größe einer Datei kann vorgegeben werden. Daneben gibt es noch erweiterte Funktionen zum Upload von Dateien, die sich auf das Verhalten der Kontrolle im Portal auswirken. Im Browser können Dateien per Drag & Drop auf die Dateikontrolle gezogen und damit automatisch auf den Intrexx-Server hochgeladen werden. Beim Speichern der Eingabeseite werden die hochgeladenen Dateien zusammen mit den Informationen in den Stempelfeldern an den dg hyparchive Server übertragen. Die neue Dokumenten-ID werden in Intrexx gespeichert. Bestehende Dateien können im Browser mit Klick auf "Löschen" in dg hyparchive gelöscht werden.

Bei Einzeldatei-Dokumenten können Dateien aktualisiert bzw. ersetzt werden, in dem zunächst eine bestehende Datei entfernt und dann die neue Datei hochgeladen wird.

2.5. Dateioperationen in Auswahllisten

Um dem Portalbenutzer die Pflege der dg hyparchive-Stempelfelder so einfach wie möglich zu machen, bietet es sich an, für Auswahllisten in dg hyparchive identische Auswahllisten auf Eingabeseiten in Intrexx anzulegen. Die Werte von dg hyparchive-Auswahllisten können über das hyparchive FormEdit-Tool ermittelt werden. In Intrexx kann auf einer Eingabeseite eine Auswahlliste erstellt werden, deren Einträge die einer dg hyparchive-Werteliste reflektieren. Dazu können die Werte aus anderen Applikation, Referenzen oder benutzerspezifisch definiert werden.

2.6. Stempeldaten-Aktualisierung

Da Dokumente und Dateien nur in dg hyparchive gespeichert und vorgehalten werden, sind diese stets auf dem aktuellen Stand, wenn darauf über Intrexx zugegriffen wird. Etwas anders verhält es sich mit den Stempeldaten eines Dokuments. Diese werden sowohl in Datenfeldern der Intrexx-Datengruppe als auch in dg hyparchive gespeichert. Das hat den Vorteil, dass auch in Intrexx nach Stempelfeldern gesucht und auf Datensätze zugegriffen werden kann, ohne dass jedes Mal ein Zugriff auf den dg hyparchive-Server stattfinden muss. Der Nachteil dieses Ansatzes ist, dass sich mit der Zeit die Metadaten eines Dokuments in dg hyparchive ändern können, während in Intrexx noch die alten Werte gespeichert sind.

Da Intrexx über Änderungen an Stempelfeldern nicht automatisch von dg hyparchive informiert werden kann, werden Stempeldaten in Intrexx aktualisiert, sobald ein Datensatz auf einer Ansichts- oder Eingabeseite geladen wird, der ein dg hyparchive Datei-Datenfeld beinhaltet. Beim Speichern der Seite werden die aktualisierten Daten wieder in Intrexx gespeichert.

Ein weiterer Ansatz, um Stempeldaten zwischen Intrexx und dg hyparchive stets synchron zu halten, besteht durch Verwendung von Prozessen.

2.7. Suche in dg hyparchive Dokumenten

2.7.1. Suchoptionen

Dokumente und Dateien in dg hyparchive-Datenfeldern werden nur auf dem dg hyparchive-Server aufbewahrt. Dadurch ist es für die Intrexx-Suchmaschine nicht möglich, die Inhalte der Dateien zu indexieren, um sie für Suchanfragen in Intrexx verfügbar zu machen. Lediglich Stempeldaten, die in Intrexx Datengruppen gespeichert werden, sind auch über die Intrexx-Suche durchsuchbar. Die dg hyparchive-Web-Service-Schnittstelle bietet die Möglichkeit, über die dg hyparchive-Volltextsuche nach Dokumenten in dg hyparchive zu suchen. Die Ergebnisse müssen dann entsprechend für Intrexx aufbereitet werden, so dass sich bei Klick auf einen Treffer das Dokument im dg hyparchive-Web-Client öffnet oder der entsprechende Datensatz via Filter in Intrexx mit der Verknüpfung zum dg hyparchive-Dokument geöffnet wird.

2.7.2. Intrexx Suche

Um in Intrexx gespeicherte Stempelfelder eines Dokuments zu suchen, können Sie wie gewohnt die Suche in einer Applikation konfigurieren. Erstellen Sie dazu eine Suchkonfiguration und wählen Sie die Stempelfelder in der dg hyparchive-Datengruppe aus, die von der Suchmaschine indexiert werden sollen. Anschließend können dg hyparchive-Datensätze über die Suchfunktion in Intrexx nach Stempeldaten durchsucht werden. Ein weiterer Ansatz ist die Suche über Filter in Intrexx-Applikationen. Dabei werden Filter auf Ansichtstabellen definiert, die entsprechend Datensätze gemäß den Werten in den Stempelfeldern der Intrexx Datengruppe filtern.

2.7.3. Volltextsuche

Soll neben den Stempeldaten auch nach Stichwörtern in den Dokumenten gesucht werden, bietet sich die dg hyparchive-Volltextsuche an. Dabei kann direkt in Intrexx nach in Intrexx verwalteten dg hyparchive-Dokumenten gesucht und die Treffer angezeigt werden. Im Portal kann auch nach Dokumenten in dg hyparchive gesucht werden, die nicht über Intrexx erfasst wurden. Für den letzteren Fall benötigen die Portalbenutzer auch Zugriff auf den dg hyparchive-WebClient bzw. -DocPresenter, um gefundene Dokumente darin zu öffnen. Im Folgenden wird die Umsetzung beider Ansätze beschrieben.

2.7.4. Volltextsuche über in Intrexx verwaltete Dokumente




Im folgenden Beispiel soll in dg hyparchive-Dokumenten gesucht werden, für die es einen entsprechenden Datensatz in einer dg hyparchive-Datengruppe gibt. Dazu erstellen Sie eine Ansichtstabelle auf die dg hyparchive-Datengruppe für die Suchergebnisse. Zudem wird ein Eingabefeld für den Suchausdruck benötigt. Öffnen Sie dann den Eigenschaftendialog der Ansichtstabelle und wechseln Sie auf den Reiter Abhängigkeiten. Klicken Sie dort auf "Abhängigkeit hinzufügen", um eine neue Abhängigkeit zu definieren. Zunächst wird ein auslösendes Ereignis benötigt. Klicken Sie dazu auf "Ereignis hinzufügen" und wählen Sie als Kontrolle das Eingabefeld und als Ereignis z.B. onchange aus. Anschließend wird ein Filter benötigt. Klicken Sie dafür auf "Filter im Expertmodus bearbeiten". Kopieren Sie folgendes XML-Fragment in den Editor innerhalb des <filter></filter> Elements: 
<exp op="" type="in">
	<arg content="1414DAF1C286E4E92CC553C65615FE60D1500B15" type="fieldguid"/>	
	<arg adapterGuid="8B74A66AB861FC2265829FB96D6985F07C5EBBBB" content="de.uplanet.lucy.server.dghyparchive.connector.rendering.HypArchiveFullTextSearchFilterHandler" searchControlName="textcontrol7D64D21B" singleton="false" type="handlerClass"/>
</exp>
Passen Sie dann die Filter Argumente entsprechend Ihrer Applikation an: Bestätigen Sie nun alle Dialoge mit Klick auf "OK" und veröffentlichen Sie die Applikation. Anschließend steht die Suche im Portal zur Verfügung.

2.7.5. Volltextsuche über nicht mit Intrexx verwaltete Dokumente

Über die dg hyparchive-Web-Service-Schnittstelle lassen sich auch in Groovy-Action-Handlern und Velocity-Templates nach Dokumenten suchen und die Ergebnisse in Intrexx darstellen. Dazu sind die Aufrufe der Suche und die Darstellung der Ergebnisse selbst zu programmieren, da diese immer anforderungsspezifisch sind.

2.8. Stempelsuche

Entsprechend der Volltextsuche ist es auch möglich, nach Dokumenten anhand von Stempel-/Systemfeldern zu suchen. Dazu gehen Sie genau so vor wie bei der Volltextsuche. Lediglich ein anderer Filter-Handler kommt für die Suche nach Stempelwerten zum Einsatz: 
<exp op="" type="in">
	<arg content="1414DAF1C286E4E92CC553C65615FE60D1500B15" type="fieldguid"/>
	<arg adapterGuid="8B74A66AB861FC2265829FB96D6985F07C5EBBBB" content="de.uplanet.lucy.server.dghyparchive.connector.rendering.HypArchiveQueryFilterHandler" singleton="false" stampControls="textcontrol3A8C3723" stampFields="IXTITLE" stampName="IX" systemStampControls="textcontrol38DDAF24" systemStampFields="TIMESTAMP" type="handlerClass"/>
</exp>
Passen Sie die Filter-Argumente entsprechend Ihrer Applikation an:

Weitere Informationen

Verbindung im Modul Integrationen konfigurieren
dg hyparchive in Prozessen