Clientseitige Events
enaio® client bzw. enaio® server führt VB-Skripte aus, wenn das zugeordnete Event eintrifft. Wählen Sie ein Event aus und erstellen Sie den VB-Skript-Code. Events benötigen teilweise einen Rückgabewert, den Sie in die Übergabedatei schreiben.
Die Client-Events sind in folgende Gruppen eingeteilt:
-
Anwendung
Events mit Bezug zu enaio® client.
-
Datenblatt
Events mit Bezug zu Datenblättern von Objekten, die neu angelegt werden oder deren Indexdaten geändert wird.
-
Trefferliste
Events mit Bezug zu Trefferlisten als Ergebnis einer Suche oder Inhaltslisten von Ordnern und Registern.
-
Anfrage
Events mit Bezug zu Anfragemasken.
-
Schrank
Event für Drag&Drop von Dokumenten in einen Ordner
Die folgenden clientseitigen Events stehen zur Verfügung:
Event |
Bezug |
Zeitpunkt des Aufrufs |
Beschreibung der Rückgabe |
Event-Code |
---|---|---|---|---|
AfterLogin |
Anwendung |
nachdem sich der Benutzer angemeldet hat |
keine Rückgabe |
8 |
BeforeLogout |
Anwendung |
bevor sich der Benutzer ausloggt |
1 = Ausloggen wird durchgeführt 0 = Ausloggen wird nicht durchgeführt |
9 |
OnStartApp |
Anwendung |
nachdem enaio® client gestartet wurde, unmittelbar vor 'AfterLogin' |
keine Rückgabe |
14 |
OnCloseApp |
Anwendung |
nach dem Einchecken aller Dokumente direkt vor dem Beenden von enaio® client |
1 = Beenden wird durchgeführt 0 = Beenden wird nicht durchgeführt |
15 |
BeforeLink |
Anwendung |
nachdem in enaio® client eine Verknüpfung erstellt wurde, bevor die Daten zum Server übertragen werden |
0 = Verknüpfung erstellen Jeder Wert ungleich 0 führt zum Abbruch. |
21 |
AfterLink |
Anwendung |
nachdem der Server die Verknüpfung angelegt hat |
keine Rückgabe |
22 |
BeforeDeleteLink |
Anwendung |
nachdem in enaio® client eine Verknüpfung gelöscht wurde, bevor die Daten zum Server übertragen werden |
0 = Verknüpfung löschen -2 = Komplett abbrechen Andere Werte führen zum Abbruch des aktuellen Löschvorganges, es wird mit dem nächsten markierten Objekt weitergemacht. |
23 |
AfterDeleteLink |
Anwendung |
nachdem der Server die Verknüpfung gelöscht hat |
keine Rückgabe |
24 |
StartAction |
Anwendung |
Aufruf durch eine Server-Benachrichtigung |
keine Rückgabe |
31 |
OnClickItem |
Datenblatt |
wenn eine Schaltfläche angeklickt wurde |
1 = Daten werden aus der Übergabedatei in das Datenblatt gelesen 0 = Daten des Datenblatts werden nicht geändert |
13 |
OnShow |
Datenblatt |
vor dem Öffnen des Datenblatts In der Übergabedatei steht 'Action=NEW', wenn ein Datenblatt zur Neuanlage geöffnet wird, 'Action=UPDATE', wenn ein Datenblatt zum Bearbeiten geöffnet wird, 'Action=READONLY', wenn ein Datenblatt schreibgeschützt geöffnet wird, 'Action=REQUEST', wenn eine Anfragemaske geöffnet wird. |
1 = Daten werden aus der Übergabedatei in das Datenblatt gelesen 0 = Daten des Datenblatts werden nicht geändert -1 = Datenblatt wird nicht geöffnet |
1 |
BeforeValidate |
Datenblatt |
nachdem auf 'Speichern' geklickt wurde, noch vor der Plausibilitätsprüfung von enaio® client und dem Speichern. In der Übergabedatei steht 'Action=NEW', wenn ein Objekt neu angelegt wird oder 'Action=Update', wenn die Daten geändert werden. |
1 = Daten werden aus der Übergabedatei in das Datenblatt gelesen enaio® client führt danach die Plausibilitätsprüfung durch und speichert die Daten. 0 = das Speichern des Datenblattes wird durchgeführt, die Daten aus der Übergabedatei werden dabei nicht in das Datenblatt gelesen -1 = das Neuanlegen oder das Ändern der Daten wird abgebrochen -2 = Daten werden aus der Übergabedatei in das Datenblatt gelesen, das Datenblatt bleibt offen, die Daten werden nicht gespeichert |
2 |
AfterValidate |
Datenblatt |
nach der Plausibilitätsprüfung von enaio® client und vor dem Speichern In der Übergabedatei steht 'Action=NEW', wenn ein Objekt neu angelegt wird oder 'Action=Update', wenn die Daten geändert werden. |
1 = Daten werden aus der Übergabedatei in das Datenblatt gelesen 0 = das Speichern des Datenblattes wird durchgeführt, die Daten aus der Übergabedatei werden dabei nicht in das Datenblatt gelesen -1 = das Neuanlegen oder das Ändern der Daten wird abgebrochen -2 = Daten werden aus der Übergabedatei in das Datenblatt gelesen, das Datenblatt bleibt offen, die Daten werden nicht gespeichert |
36 |
AfterSave |
Datenblatt |
nach der Plausibilitätsprüfung von enaio® client und dem Speichern In der Übergabedatei steht 'Action=NEW', wenn ein Objekt neu angelegt wird oder 'Action=Update', wenn die Daten geändert werden. |
keine Rückgabe |
3 |
BeforeCancel |
Datenblatt |
nachdem auf einem Datenblatt auf 'Abbrechen' geklickt wurde |
0 = das Datenblatt wird nicht geschlossen. Bei anderen Rückgabewerten wird das Datenblatt geschlossen. |
30 |
OnEnterPage |
Datenblatt |
beim Wechseln der Seite des Dialogelements 'Pagecontrol' |
1 = Daten von Feldern auf dem PageControl, die in der Übergabedatei gesetzt sind, werden in die Anfragemaske zurückgelesen 0 = Daten aus der Übergabedatei werden ignoriert |
25 |
OnLeavePage |
Datenblatt |
wenn eine Seite des Dialogelements 'Pagecontrol' verlassen wird |
keine Rückgabe |
37 |
OnFocusGained |
Datenblatt |
Wenn der Fokus auf ein Textfeld gelegt wird. Das Event kann jedem Textfeld eines Datenblatts zugeordnet werden. |
keine Rückgabe |
32 |
OnCellFocusGained |
Datenblatt |
Wenn der Fokus auf ein Tabellenzelle gelegt wird. |
keine Rückgabe |
39 |
OnValueChanged |
Datenblatt |
Wenn die Eingabe in einem Feld abgeschlossen und das Feld, bei Katalogen und AddOns der Dialog, verlassen wurde. |
0 = Keine Änderung -1 = Zurück zum Textfeld, der Eintrag wird nicht geändert 1 = Daten werden aus der Übergabedatei in das Textfeld eingelesen |
33 |
OnCellValueChanged |
Datenblatt |
Wenn die Eingabe in einer Tabellenzelle abgeschossen wurde |
0 = Keine Änderung -1 = Zurück zum Textfeld, der Eintrag wird nicht geändert 1 = Daten werden aus der Übergabedatei in das Textfeld eingelesen |
40 |
BeforeAddRow |
Datenblatt |
Bevor in einer Tabelle eine neue Zeile hinzugefügt wird. |
0 = Keine Änderung -1 = Zeile wird nicht hinzugefügt |
34 |
BeforeDeleteRow |
Datenblatt |
Bevor in einer Tabelle eine Zeile gelöscht wird. |
0 = Keine Änderung -1 = Zeile wird nicht gelöscht |
35 |
BeforeStartQuery |
Anfrage |
nachdem auf der Anfragemaske auf 'Anfrage starten' geklickt wurde, noch vor dem eigentlichen Durchführen der Suche |
1 = Daten werden aus der Übergabedatei in die Anfragemaske gelesen enaio® client startet danach die Suche. 0 = Suche ohne Änderung starten -1 = Suche wird abgebrochen |
4 |
AfterFinishQuery |
Trefferliste |
nach der Suche |
keine Rückgabe |
5 |
BeforeDelete |
Trefferliste |
bevor ein Objekt gelöscht wird |
1 = Löschen wird durchgeführt 0 = Löschen wird nicht durchgeführt |
11 |
BeforeUndoCheckOut |
Trefferliste |
bevor in enaio® client auf einem Dokument die Benutzeraktion 'Auschecken zurücknehmen' ausgeführt wird Über die Konstante 'NumberOfSelectedDocuments' können Sie im Skript abfragen, für wie viele Dokumente das Auschecken zurückgenommen werden soll. |
-2 = Auschecken rückgängig für dieses Dokument nicht zulassen -1 = Auschecken rückgängig für alle markierten Dokumente abbrechen 0 = Normaler Ablauf für Benutzeraktion 'Auschecken zurücknehmen' 1 = Auschecken rückgängig erlaubt, Benutzer wird nicht gefragt |
27 |
AfterDelete |
Trefferliste |
nachdem ein Objekt gelöscht wurde |
keine Rückgabe |
12 |
BeforeOpen |
Trefferliste |
bevor ein Dokument geöffnet wird |
0 = nicht öffnen 1 = Öffnen, falls ausgecheckt, schreibgeschützt Öffnen 2 = schreibgeschützt Öffnen 3 = Öffnen, falls ausgecheckt, schreibgeschützt Öffnen mit Hinweis -4 = Nur Workflow-Event: geöffnetes Objekt wird im Dokumenten-Viewer angezeigt |
16 |
OnMove |
Trefferliste |
wenn ein Dokument oder Register innerhalb eines Schranks verschoben wird |
0, 1 = Verschieben wird durchgeführt -1 = Verschieben wird nicht durchgeführt |
17 |
OnMoveExtern |
Trefferliste |
wenn ein Dokument in einen anderen Schrank verschoben wird |
0, 1 = Verschieben wird durchgeführt -1 = Verschieben wird nicht durchgeführt |
42 |
OnAddLocation |
Trefferliste |
wenn ein Dokument oder Register per Drag & Drop einen weiteren Standort erhält |
0, 1 = Standort zuordnen -1 = Standort nicht zuordnen |
18 |
OnCreateCopy |
Trefferliste |
wenn ein Dokument oder Register kopiert wird |
0, 1 = Kopieren wird durchgeführt -1 = Kopieren wird nicht durchgeführt |
43 |
BeforeSaveDocument |
Trefferliste |
vor dem Einchecken eines Dokuments |
0 = Dokument wird eingecheckt -2 = komplett abbrechen, Dokument wird nicht eingecheckt Bei anderen Rückgabewerten wird das Dokument nicht eingecheckt, sondern mit den folgenden Dokumenten fortgefahren. |
19 |
AfterSaveDocument |
Trefferliste |
nach dem Einchecken eines Dokuments |
keine Rückgabe |
20 |
BeforeRestore |
Trefferliste |
vor dem Wiederherstellen eines Objektes aus dem Papierkorb |
0 = Das Objekt wird nicht wiederhergestellt. Bei anderen Rückgabewerten wird das Objekt wiederhergestellt. |
28 |
AfterRestore |
Trefferliste |
nach dem Wiederherstellen eines Objektes aus dem Papierkorb |
keine Rückgabe |
29 |
FileDrop |
Schrank |
nach dem Ablegen von Dateien an einem Standort |
-1 = Abbruch 1 = Client aktualisiert nur die Trefferliste 0 = Client übernimmt die Dateien |
200 |
Events für Sammeländerungen
Für Sammeländerungen sind die folgenden Datenblatt-Events eingebunden:
Event |
Event-Code |
---|---|
BeforeValidate |
100 |
AfteValidate |
104 |
OnShow |
101 |
OnClickItem |
102 |
OnChangeActivePage |
103 |
Übergabedateien enthalten einen zusätzlichen Abschnitt mit folgender Struktur:
[BATCHUPDATE]
Count=<Anzahl der Objekte>
ID0=<Objekt-ID>
IDn= …
Für Sammeländerungen können nur diese Events eingesetzt werden.
Events für Sammeländerungen werden in enaio® client ebenfalls aus der Objektsuche über das Kontextmenü eines Objekttyps hinzugefügt.
Im Bereich 'Objektsuche' sind Events für Sammeländerungen mit einem Blitz gekennzeichnet.
Die Funktion entspricht derjenigen der Events für ein Objekt.
Wenn die Events 'BeforeValidate' bzw. 'OnShow' einem Objekttyp zugeordnet sind, dann sind Sammeländerungen für diesen Objekttyp nur möglich, wenn auch entsprechende Sammeländerungs-Events zugeordnet sind. Die Skripte müssen keine Funktion haben. Skripte müssen zumindest ein Hochkomma als Kommentarzeichen enthalten, damit sie gespeichert werden.
Events 'StartAction'
Das Event 'StartAction' wird über die Methode 'krn.SendMessageToClients' aufgerufen. Die Methode kann über enaio® enterprise-manager oder aus Skripten und Anwendungen aufgerufen werden. Informationen zu 'krn.SendMessageToClients' finden Sie in der Dokumentation 'enaio® Server API'.
Der Aufruf des Events erfolgt über den Wert 'StartEvent' des Parameters 'Message'. Der Wert des Parameters 'Text' wird als Event-Datei übergeben und kann durch das Skript ausgewertet werden.