Verfügbare Ereignishandler

Nachfolgend finden Sie die verfügbaren Ereignishandler mit den zugehörigen Variablen und Erklärungen. Weitere Informationen zu Variablen finden Sie im Abschnitt Verfügbare VBScript-Variablen.

Ereignishandler auf Dokumentenverwaltungsebene

Die Ereignishandler, die in diesem Abschnitt aufgeführt sind, werden durch Vorgänge auf Dokumentenverwaltungsebene ausgelöst.

Hinweis: Eine Ausnahme bei einem Ereignishandler verhindert, dass ein Vorgang ausgelöst wird.
Ereignishandler Variablen Ausführung

BeforeSetProperties

AfterSetProperties

Die Ereignishandler werden ausgeführt, wenn die Eigenschaftswerte des in der Dokumentenverwaltung gespeicherten Objekts zurückgesetzt werden. Die Eigenschaften können während BeforeSetProperties geprüft werden, bevor sie eingestellt werden. Es wird jedoch nicht empfohlen, die Eigenschaften während BeforeSetProperties zu ändern, da sie dabei überschrieben werden können, nachdem der Ereignishandler ausgeführt wurde. Eigenschaften hingegen können während des AfterSetProperties Ereignisses geändert werden.

BeforeCreateNewObjectFinalize

AfterCreateNewObjectFinalize

Der Ereignishandler kann ausgeführt werden, wenn ein neues Objekt in der Dokumentenverwaltung erstellt wird, unabhängig davon, ob das neue Objekt eingecheckt wurde oder nicht. Beim Ausführen des AfterCreateNewObjectFinalize Ereignishandlers, kann das Objekt bereits eingecheckt worden sein. Aus diesem Grunde können die Metadaten oder Dateien während der Ausführung des Ereignishandlers nicht weiterbearbeitet werden, das heißt der Ereignishandler ist nur zur Bestätigung von Änderungen geeignet.

BeforeCancelCreateObject

AfterCancelCreateObject

Die Ereignishandler werden ausgeführt, wenn ein Objekt, das vorher nicht eingecheckt wurde, aus der Dokumentenverwaltung entfernt wird. Die Ausführung erfolgt beispielsweise dann, wenn der Benutzer die Funktion „Auschecken rückgängig machen“ für das Objekt ausführt oder das Objekt aus der Dokumentenverwaltung entfernt.

BeforeCheckInChanges

AfterCheckInChanges

Die Ereignishandler werden ausgeführt, wenn der Benutzer das Objekt eincheckt. Die Ereignishandler werden nicht ausgeführt, wenn das Objekt nicht geändert wurde, sodass in diesem Fall die BeforeCancelCheckOut und AfterCancelCheckOut Ereignishandler ausgeführt werden. Man kann das Objekt während BeforeCheckInChanges immer noch ändern. Diese Ereignishandler können auch ausgeführt werden, wenn der Benutzer ein neues Objekt erstellt, ohne die Sofort einchecken Option zu markieren und das Objekt eincheckt, ohne eine Änderung an der Datei vorzunehmen. Diese Ereignishandler werden nicht ausgeführt, wenn ein neues Objekt mit markierter Sofort einchecken Option erstellt wird. Während der Ausführung des AfterCheckInChanges Ereignishandlers kann das Objekt nicht geändert werden, da das Objekt bereits eingecheckt wurde und der Ereignishandler folglich nur zur Überprüfung der Änderungen dienen kann.

BeforeCancelCheckOut

AfterCancelCheckOut

Die Ereignishandler werden ausgeführt, wenn die Änderungen an einem ausgecheckten Objekt rückgängig gemacht werden, z. B. mithilfe der Funktion Auschecken rückgängig machen. Die Ereignishandler werden auch dann ausgeführt, wenn das Objekt eingecheckt wird, ohne dass Veränderungen vorgenommen wurden. Während der Ausführung des AfterCancelCheckOut Ereignishandlers kann das Objekt nicht bearbeitet werden, da das Objekt nicht mehr ausgecheckt werden kann.

AfterCancelCheckoutFinalize

Falls ein Ereignis nachdem das Auschecken abgeschlossen ist, ausgelöst wird, bedeutet dies, dass das Objekt nicht mehr ausgecheckt ist. Für den Vorgang des Auscheckens und weitere Vorgänge im Zusammenhang mit der ausgecheckten Objektversion kann ein Skript verwendet werden.

BeforeCheckOut

AfterCheckOut

The event handlers are executed when a document vault object is checked out. During execution of the BeforeCheckOut event handler, the object has not been checked out, so the object cannot be modified.

BeforeDeleteObject

AfterDeleteObject

Die Ereignishandler werden ausgeführt, wenn ein Objekt als gelöscht markiert wird.

BeforeDestroyObject

AfterDestroyObject

Die Ereignishandler werden ausgeführt, wenn ein Objekt aus der Dokumentenverwaltung gelöscht wird.

BeforeDestroyObjectVersion

AfterDestroyObjectVersion

Die Ereignishandler werden ausgeführt, wenn eine einzelne Version des Objekts aus der Dokumentenverwaltung gelöscht wird.

BeforeSetObjectPermissions

AfterSetObjectPermissions

Die Ereignishandler werden ausgeführt, wenn die Objektberechtigungen geändert werden.

BeforeFileUpload

Der Ereignishandler wird ausgeführt, wenn der Benutzer den Dateitransfer auf dem M-Files Server startet.

AfterFileUpload

Der Ereignishandler wird ausgeführt, wenn der Dateitransfer auf den Server abgeschlossen ist.

BeforeFileDownload

AfterFileDownload

Die Ereignishandler werden ausgeführt, wenn der Benutzer die Datei vom M-Files Server in den lokalen Cache des Clientcomputers lädt. Bei Bedarf kann mithilfe der Ereignishandler verhindert werden, dass bestimmte Dateien auf die Computer der Benutzer übertragen werden.

BeforeCreateNewValueListItem

AfterCreateNewValueListItem

Die Ereignishandler werden ausgeführt, wenn einer bestimmten Werteliste der Dokumentenverwaltung neue Werte hinzugefügt werden. Diese Ereignishandler können beispielsweise verwendet werden, um sicherzustellen, dass alle in die Werteliste eingegebenen Werte in einem festgelegten Format vorliegen.

BeforeLoginToVault

Der Ereignishandler wird kurz vor der Anmeldung des Benutzers in der Dokumentenverwaltung ausgeführt. Zu diesem Zeitpunkt wurde der Benutzer bereits auf dem M-Files Server identifiziert, sodass der Ereignishandler nicht ausgeführt wird. Dies ist beispielsweise dann der Fall, wenn ein Benutzer versucht, sich anzumelden und über kein Benutzerkonto auf dem Server verfügt.

AfterLoginToVault

Der Ereignishandler wird ausgeführt, wenn sich der Benutzer erfolgreich in der Dokumentenverwaltung angemeldet hat.

BeforeLogoutFromVault

Der Ereignishandler wird ausgeführt, kurz bevor der Benutzer aus der Dokumentenverwaltung abgemeldet wird. Die Abmeldung kann während dieses Ereignishandlers nicht unterbrochen werden. Die Clientsoftware reagiert nicht auf Fehlermeldungen, die sie vom Ereignishandler erhält.

AfterLogoutFromVault

Der Ereignishandler wird ausgeführt, wenn der Benutzer aus der Dokumentenverwaltung abgemeldet wurde. Die Abmeldung kann während dieses Ereignishandlers nicht unterbrochen werden. Die Clientsoftware reagiert nicht auf Fehlermeldungen, die sie vom Ereignishandler erhält.

Replikation: AfterCheckInChanges

Die Ereignishandler werden aktiviert, wenn neue Versionen aus dem Inhaltspaket in das vorhandene Objekt importiert werden oder wenn ein Konflikt zwischen zwei Objekten zu Gunsten der Quelldokumentenverwaltungsversion gelöst wird. Wenn der AfterCheckInChanges Ereignishandler aufgerufen wird, ist das Objekt bereits eingecheckt. Aus diesem Grunde können die Metadaten oder Dateien während der Ausführung des Ereignishandlers nicht weiterbearbeitet werden.

Replikation: AfterCreateNewObjectFinalize

Der Ereignishandler wird aktiviert, wenn ein neues Objekt aus dem Inhaltspaket in die Dokumentenverwaltung importiert wird. Beim Aufrufen des AfterCreateNewObjectFinalize Ereignishandlers, ist das Objekt bereits eingecheckt. Aus diesem Grunde können die Metadaten oder Dateien während der Ausführung des Ereignishandlers nicht weiterbearbeitet werden.

VaultExtensionMethod

Der Ereignishandler wird ausdrücklich vom Client aufgerufen (die sog. Dokumentenverwaltungserweiterungsmethode).

Der Entwickler der Erweiterungsmethode für Dokumentenverwaltungen muss sicherstellen, dass dem Benutzer die Ausführung der Methode gestattet werden kann. Mit anderen Worten, die Methode muss die Identität des aufrufenden Nutzers überprüfen und beendet werden, wenn dieser nicht über die erforderlichen Administratorrechte in der Dokumentenverwaltung verfügt.

BeforeCreateLoginAccount

AfterCreateLoginAccount

BeforeCreateLoginAccount: Das Ereignis wird ausgelöst, bevor ein Benutzerkonto in der Dokumentenverwaltung erstellt wird.

AfterCreateLoginAccount: Das Ereignis wird ausgelöst, nachdem ein Benutzerkonto in der Dokumentenverwaltung erstellt wird.

BeforeModifyLoginAccount

AfterModifyLoginAccount

BeforeModifyLoginAccount: Das Ereignis wird ausgelöst, bevor ein Benutzerkonto in der Dokumentenverwaltung geändert wird.

AfterModifyLoginAccount: Das Ereignis wird ausgelöst, nachdem ein Benutzerkonto in der Dokumentenverwaltung geändert wird.

BeforeRemoveLoginAccount

AfterRemoveLoginAccount

BeforeRemoveLoginAccount: Das Ereignis wird ausgelöst, bevor ein Benutzerkonto in der Dokumentenverwaltung entfernt wird.

AfterRemoveLoginAccount: Das Ereignis wird ausgelöst, nachdem ein Benutzerkonto in der Dokumentenverwaltung entfernt wird.

BeforeCreateUserAccount

AfterCreateUserAccount

BeforeCreateUserAccount: Das Ereignis wird ausgelöst, bevor ein Benutzerkonto in der Datenbank der Dokumentenverwaltung erstellt wird.

AfterCreateUserAccount: Das Ereignis wird ausgelöst, nachdem ein Benutzerkonto in der Datenbank der Dokumentenverwaltung erstellt wird.

BeforeModifyUserAccount

AfterModifyUserAccount

BeforeModifyUserAccount: Das Ereignis wird ausgelöst, bevor ein Benutzerkonto in der Datenbank der Dokumentenverwaltung geändert wird.

AfterModifyUserAccount: Das Ereignis wird ausgelöst, nachdem ein Benutzerkonto in der Datenbank der Dokumentenverwaltung geändert wird.

BeforeRemoveUserAccount

AfterRemoveUserAccount

BeforeRemoveUserAccount: Das Ereignis wird ausgelöst, bevor ein Konto in der Datenbank der Dokumentenverwaltung entfernt wird.

AfterRemoveUserAccount: Das Ereignis wird ausgelöst, nachdem ein Konto in der Datenbank der Dokumentenverwaltung entfernt wird.

BeforeCreateUserGroup

AfterCreateUserGroup

BeforeCreateUserGroup: Das Ereignis wird ausgelöst, bevor eine Benutzergruppe in der Datenbank der Dokumentenverwaltung erstellt wird.

AfterCreateUserGroup: Das Ereignis wird ausgelöst, nachdem eine Benutzergruppe in der Datenbank der Dokumentenverwaltung erstellt wird.

BeforeModifyUserGroup

AfterModifyUserGroup

BeforeModifyUserGroup: Das Ereignis wird ausgelöst, bevor eine Benutzergruppe in der Datenbank der Dokumentenverwaltung geändert wird.

AfterModifyUserGroup: Das Ereignis wird ausgelöst, nachdem eine Benutzergruppe in der Datenbank der Dokumentenverwaltung geändert wird.

Hinweis: Der AfterModifyUserGroup Ereignishandler wird nicht ausgeführt, wenn die Alle internen Benutzer Gruppe geändert wird.

BeforeRemoveUserGroup

AfterRemoveUserGroup

BeforeRemoveUserGroup: Das Ereignis wird ausgelöst, bevor eine Benutzergruppe in der Datenbank der Dokumentenverwaltung entfernt wird.

AfterRemoveUserGroup: Das Ereignis wird ausgelöst, nachdem eine Benutzergruppe in der Datenbank der Dokumentenverwaltung entfernt wird.

AfterBringOnline

BeforeTakeOffline

AfterBringOnline: Das Ereignis wird ausgelöst, nachdem die Dokumentenverwaltung online ist.

BeforeTakeOffline: Das Ereignis wird wiederum ausgeführt, bevor die Dokumentenverwaltung offline geschaltet wird. Eine Ausnahme bei einem der beiden Ereignishandler verhindert den online/offline Übergang nicht.

AfterCheckInChangesFinalize

Das Ereignis wird ausgelöst, wenn der Vorgang des Eincheckens und alle Vorgänge nach dem Einchecken abgeschlossen sind. Das Ereignis wird auch ausgelöst, wenn ein Objekt unmittelbar nach seiner Erstellung eingecheckt wird.

Wenn das Einchecken des Objekts eine Reihe automatischer Statuswechsel startet, wird AfterCheckInChangesFinalize nach dem ersten Wechsel ausgelöst.

BeforeCreateView

AfterCreateView

BeforeCreateView: Das Ereignis wird ausgelöst, bevor die Ansicht in der Dokumentenverwaltung erstellt wird.

AfterCreateView: Das Ereignis wird ausgelöst, nachdem eine neue Ansicht in der Dokumentenverwaltung erstellt worden ist.

BeforeModifyView

AfterModifyView

BeforeModifyView: Das Ereignis wird ausgelöst, bevor die Änderungen einer Ansicht übernommen werden.

AfterModifyView: Das Ereignis wird ausgelöst, nachdem die Änderungen einer Ansicht übernommen worden sind.

BeforeDeleteView

AfterDeleteView

BeforeDeleteView: Das Ereignis wird ausgelöst, bevor eine Ansicht, die auf Löschen gestellt wird, als gelöscht gilt.

AfterDeleteView: Das Ereignis wird ausgelöst, nachdem eine Ansicht gelöscht wurde.

BeforeReturnView

Dieser Ereignishandler wird ausgelöst, nachdem die Ansicht von der Dokumentenverwaltung angefordert aber bevor sie wieder zum Client übermittelt wurde. Dies ermöglicht es Ihnen, die Ansicht zu ändern. Sie können beispielsweise nach dynamische Suchbedingungen filtern, wie diese, die dem aktuellen Benutzer zugewiesen sind.

BeforeUndeleteObject

AfterUndeleteObject

BeforeUndeleteObject: Der Ereignishandler wird ausgelöst, bevor das Objekt wiederhergestellt wird.

AfterUndeleteObject: Der Ereignishandler wird ausgelöst, nachdem das Objekt wiederhergestellt wird. Für den Vorgang des Auscheckens und weitere Vorgänge im Zusammenhang mit der ausgecheckten Objektversion kann ein Skript verwendet werden.

AfterUndeleteObjectFinalize

Dieses Ereignis wird ausgelöst, nachdem der Wiederherstellen-Vorgang abgeschlossen ist und Sie mit den wiederhergestellten Objekten arbeiten können.

BeforeModifyMFilesCredentials

AfterModifyMFilesCredentials

BeforeModifyMFilesCredentials: Der Ereignishandler wird ausgelöst, bevor das Passwort des M-Files Benutzerkontos geändert worden ist.

AfterModifyMFilesCredentials: Der Ereignishandler wird ausgelöst, nachdem das Passwort des M-Files Benutzerkontos geändert worden ist.

BeforeCheckinChangesFinalize

Der BeforeCheckinChangesFinalize Ereignishandler wird ausgelöst, bevor ein Objekt eingecheckt wird, aber nachdem der Statuswechsel und die Signaturen vollendet worden sind. Änderungen am Workflow sind nicht zugelassen.

BeforeAddUserGroupMember

AfterAddUserGroupMember

BeforeAddUserGroupMember: Das Ereignis wird vor dem API-Aufruf AddMemberToUserGroup ausgelöst.

AfterAddUserGroupMember: Das Ereignis wird nach dem API-Aufruf AddMemberToUserGroup ausgelöst.

BeforeRemoveUserGroupMember

AfterRemoveUserGroupMember

BeforeRemoveUserGroupMember: Das Ereignis wird vor dem API-Aufruf RemoveMemberFromUserGroup ausgelöst.

AfterRemoveUserGroupMember: Das Ereignis wird nach dem API-Aufruf RemoveMemberFromUserGroup ausgelöst.

Ereignishandler auf Serverebene

Dieser Abschnitt führt Ereignishandler auf, die durch Vorgänge auf Serverebene ausgelöst werden. Diese Vorgänge bewirken auch, dass ein entsprechendes Ereignis in allen Online-Dokumentenverwaltungen des Servers ausgeführt wird.

Hinweis: Eine Ausnahme in einem Ereignishandler auf Serverebene verhindert die Auslösung des Vorgangs, wobei die Ereignishandler-Ausnahmen auf der Ebene der Dokumentenverwaltung die Vorgänge auf Serverebene nicht beeinflussen.
Ereignishandler Variablen Ausführung

BeforeRunScheduledJob

AfterRunScheduledJob

Der Ereignishandler wird ausgeführt, wenn einer der geplanten Aufträge des Servers ausgeführt wird. Mithilfe dieses Ereignishandlers kann die Ausführung der automatisch geplanten Aufträge automatisch überwacht werden. Bei Auftreten eines Fehlers kann der Ereignishandler automatisch eine E-Mail an den Administrator senden, um die Lösung des Problems zu erleichtern.

BeforeCreateLoginAccount

AfterCreateLoginAccount

BeforeCreateLoginAccount: Das Ereignis wird für alle Online-Dokumentenverwaltungen ausgelöst, bevor ein Benutzerkonto auf dem Server erstellt wird.

AfterCreateLoginAccount: Das Ereignis wird für alle Online-Dokumentenverwaltungen ausgelöst, nachdem ein Benutzerkonto auf dem Server eingerichtet worden ist.

BeforeModifyLoginAccount

AfterModifyLoginAccount

BeforeModifyLoginAccount: Das Ereignis wird für alle Online-Dokumentenverwaltungen ausgelöst, bevor ein Benutzerkonto auf dem Server geändert wird.

AfterModifyLoginAccount: Das Ereignis wird für alle Online-Dokumentenverwaltungen ausgelöst, nachdem ein Benutzerkonto auf dem Server geändert worden ist.

BeforeRemoveLoginAccount

AfterRemoveLoginAccount

BeforeRemoveLoginAccount: Das Ereignis wird für alle Online-Dokumentenverwaltungen ausgelöst, bevor ein Benutzerkonto auf dem Server entfernt wird.

AfterRemoveLoginAccount: Das Ereignis wird für alle Online-Dokumentenverwaltungen ausgelöst, nachdem ein Benutzerkonto auf dem Server entfernt worden ist.

BeforeModifyMFilesCredentials

AfterModifyMFilesCredentials

BeforeModifyMFilesCredentials: Der Ereignishandler wird für alle Online-Dokumentenverwaltungen ausgelöst, bevor das Passwort des M-Files Benutzerkontos geändert wird.

AfterModifyMFilesCredentials: Der Ereignishandler wird für alle Online-Dokumentenverwaltungen ausgelöst, nachdem das Passwort des M-Files Benutzerkontos geändert wird.