Below you can find the available event handlers, with their variables and explanations. For more information about variables, see Available VBScript variables.
Vault-level event handlers
The event handlers listed in this section are triggered by operations on the vault level.
Event handler | Variables | Execution |
|---|---|---|
|
AfterBringOnline BeforeTakeOffline |
AfterBringOnline: The event is triggered after the vault is brought online. BeforeTakeOffline: The event is executed before the vault is taken offline. An exception in any of the two event handlers does not prevent the online/offline transition. |
|
|
AfterCancelCheckoutFinalize |
An event triggered after the undo checkout operation is complete, meaning that the object is no longer checked out. A script can be used for performing the checkout operation and for performing further object operations with the checked out object version. |
|
|
AfterCheckInChangesFinalize |
The event is triggered when the check-in operation and all the operations after the check-in are complete. The event is also triggered when an object is immediately checked in after it has been created. If the object check-in starts a series of automatic state transitions, AfterCheckInChangesFinalize is triggered after the first transition. |
|
|
AfterFileUpload |
The event handler is executed when the file transfer to the server is completed. |
|
|
AfterLoginToVault |
The event handler is executed when the user has successfully logged in to the document vault. |
|
|
AfterLogoutFromVault |
The event handler is executed when the user has been logged out of the document vault. The logout cannot be interrupted during this event handler. The client software does not react to any error messages received from this event handler. |
|
|
AfterUndeleteObjectFinalize |
This event is triggered after the object undelete operation is complete and you are able to work with the undeleted object. |
|
|
BeforeAddUserGroupMember AfterAddUserGroupMember |
BeforeAddUserGroupMember: The event is triggered before the API call AddMemberToUserGroup. AfterAddUserGroupMember: The event is triggered after the API call AddMemberToUserGroup. |
|
|
BeforeCancelCheckOut AfterCancelCheckOut |
The event handlers are executed when modifications of a checked out object are undone using, for example, the Undo Checkout function. The event handlers are also executed if the object is checked in without any modifications. During execution of the AfterCancelCheckOut event handler, the object cannot be modified as the object is no longer checked out. |
|
|
BeforeCancelCreateObject AfterCancelCreateObject |
The event handlers are executed when an object which has never been checked in is removed from the document vault. The execution takes place, for instance, when the user performs the "Undo Checkout" function on the object or removes the object from the document vault. |
Server-level event handlers
This section lists event handlers that are triggered by server-level operations. These operations also cause a corresponding event to be executed in all online vaults of the server.
Event handler | Variables | Execution |
|---|---|---|
|
BeforeCreateLoginAccount AfterCreateLoginAccount |
BeforeCreateLoginAccount: The event is triggered for all online vaults before a login account is created on the server. AfterCreateLoginAccount: The event is triggered for all online vaults after a login account is created on the server. |
|
|
BeforeModifyLoginAccount AfterModifyLoginAccount |
BeforeModifyLoginAccount: The event is triggered for all online vaults before a login account is modified on the server. AfterModifyLoginAccount: The event is triggered for all online vaults after a login account is modified on the server. |
|
|
BeforeModifyMFilesCredentials AfterModifyMFilesCredentials |
BeforeModifyMFilesCredentials: The event handler is triggered for all online vaults before the password of an M-Files login account is changed. AfterModifyMFilesCredentials: The event handler is triggered for all online vaults after the password of an M-Files login account is changed. |
|
|
BeforeRemoveLoginAccount AfterRemoveLoginAccount |
BeforeRemoveLoginAccount: The event is triggered for all online vaults before a login account is removed from the server. AfterRemoveLoginAccount: The event is triggered for all online vaults after a login account is removed from the server. |
|
|
BeforeRunScheduledJob AfterRunScheduledJob |
The event handler is executed when one of the timed jobs of the server is performed. These event handlers can be used to automatically monitor the execution of the automatically timed jobs. In case of error, the event handler can automatically send an e-mail notification to the administrator to facilitate resolution of the problem. |
