Gestionnaires d'événements disponibles

Remarque : Ce contenu n’est plus mis à jour. Pour le contenu le plus récent, veuillez consulter le guide de l’utilisateur pour M-Files Online. Pour plus d’informations sur les versions de produit prises en charge, consultez notre politique de cycle de vie.

Ci-dessous se trouvent les gestionnaires d'événements disponibles avec leurs variables et explications. Pour davantage d'informations sur les variables, veuillez vous reporter à la section Variables VBScript disponibles.

Gestionnaires d’événements du coffre

Les gestionnaires d'événements listés dans cette section sont déclenchés par différentes opérations réalisées sur le coffre.

Remarque : Une exception au niveau du gestionnaire d’événements empêche l’opération de déclenchement d’avoir lieu.
Gestionnaire d'événements Variables Exécution

BeforeSetProperties

AfterSetProperties

les gestionnaires d'événements sont exécutés quand les valeurs de propriétés de l'objet stocké dans le coffre sont réinitialisées. Les propriétés peuvent être inspectées pendant BeforeSetProperties avant qu’elles ne soient configurées. Cependant, il n’est pas recommandé de modifier les propriétés pendant BeforeSetProperties car elles pourraient être écrasées une fois le gestionnaire d’événements exécuté. D'autre part, les propriétés peuvent être modifiées lors de l’évènement AfterSetProperties.

BeforeCreateNewObjectFinalize

AfterCreateNewObjectFinalize

Les gestionnaires d'événements sont exécutés si un nouvel objet est créé dans le coffre, peu importe si le nouvel objet a été publié ou non. Pendant l’exécution du gestionnaire d’événements AfterCreateNewObjectFinalize, l’objet peut avoir déjà été publié. C'est pourquoi les métadonnées ou fichiers ne peuvent plus être modifiés pendant l'utilisation du gestionnaire d'événements, et par conséquent le gestionnaire d'événements ne convient que pour valider les changements.

BeforeCancelCreateObject

AfterCancelCreateObject

les gestionnaires d'événements sont exécutés quand un objet qui n'a jamais été publié est supprimé du coffre. L'exécution a lieu par exemple quand l'utilisateur exécute la commande "Déverrouiller" sur l'objet ou supprime l'objet du coffre.

BeforeCheckInChanges

AfterCheckInChanges

Les gestionnaires d'événements sont exécutés quand l’utilisateur publie l’objet. Les gestionnaires d’événements ne sont pas exécutés si l’objet n’a pas été modifié, auquel cas les gestionnaires d’événements BeforeCancelCheckOut et AfterCancelCheckOut sont exécutés. Il est toujours possible de modifier l'objet pendant BeforeCheckInChanges. Ces modifications d’événements sont également exécutées lorsque l’utilisateur crée un nouvel objet sans cocher l’option Publier immédiatement et publie l’objet sans effectuer de transformations au fichier. Ces gestionnaires d’événements ne sont pas exécutés lorsqu’un nouvel objet est créé avec l’option Publier immédiatement désactivée. Au cours de l'exécution du gestionnaire d'événements AfterCheckInChanges, l'objet ne peut plus être modifié une fois que l'objet a déjà été publié. Par conséquent, le gestionnaire d'événements ne convient que pour valider les changements.

BeforeCancelCheckOut

AfterCancelCheckOut

Les gestionnaires d'événements sont exécutés quand les modifications d'un objet verrouillé sont annulées, par exemple avec la fonction Déverrouiller. Les gestionnaires d'événements sont également exécutés si l'objet est publié sans modifications. Au cours de l'exécution du gestionnaire d'événements AfterCancelCheckOut, l'objet ne peut pas être modifié car il n'est plus verrouillé.

AfterCancelCheckoutFinalize

Un événement s’est déclenché après l’opération d’annulation du verrouillage, ce qui signifie que l’objet n’est plus verrouillé. Un script peut être utilisé pour effectuer l’opération de déverrouillage et d’autres opérations d’objet avec la version objet verrouillée.

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

les gestionnaires d'événements sont exécutés quand un objet est marqué comme supprimé.

BeforeDestroyObject

AfterDestroyObject

Les gestionnaires d'événements sont exécutés quand un objet est détruit dans le coffre.

BeforeDestroyObjectVersion

AfterDestroyObjectVersion

les gestionnaires d'événements sont exécutés quand une version individuelle de l'objet est détruite dans le coffre.

BeforeSetObjectPermissions

AfterSetObjectPermissions

Les gestionnaires d'événements sont exécutés quand les autorisations de l'objet sont modifiées.

BeforeFileUpload

Le gestionnaire d'événements est exécuté quand l'utilisateur démarre le transfert de fichiers vers M-Files Server.

AfterFileUpload

Le gestionnaire d'événements est exécuté quand le transfert de fichiers vers le serveur est terminé.

BeforeFileDownload

AfterFileDownload

Les gestionnaires d'événements sont exécutés quand l'utilisateur charge le fichier depuis M-Files Server vers le cache local de l'ordinateur du client. Si nécessaire, ces gestionnaires d'événements peuvent être utilisés pour empêcher le transfert de certains fichiers vers les ordinateurs des utilisateurs.

BeforeCreateNewValueListItem

AfterCreateNewValueListItem

les gestionnaires d'événements sont exécutés lorsque de nouvelles valeurs sont ajoutées à une certaine liste de valeurs du coffre. Ces gestionnaires d'événements peuvent par exemple être utilisés pour s'assurer que toutes les valeurs saisies dans la liste de valeurs ont la forme spécifiée souhaitée.

BeforeLoginToVault

le gestionnaire d'événements est exécuté immédiatement avant la connexion de l'utilisateur au coffre. À ce stade, l'utilisateur a déjà été identifié dans M-Files Server, le gestionnaire d'événements n'est donc pas exécuté, par exemple, si un utilisateur qui tente de se connecter n'a pas de compte de connexion sur le serveur.

AfterLoginToVault

le gestionnaire d'événements est exécuté quand l'utilisateur s'est connecté au coffre.

BeforeLogoutFromVault

le gestionnaire d'événements est exécuté immédiatement avant la déconnexion de l'utilisateur du coffre. La déconnexion ne peut pas être interrompue avec ce gestionnaire d'événements. Le logiciel client ne réagit pas aux messages d'erreur reçus depuis ce gestionnaire d'événements.

AfterLogoutFromVault

le gestionnaire d'événements est exécuté quand l'utilisateur s'est déconnecté du coffre. La déconnexion ne peut pas être interrompue avec ce gestionnaire d'événements. Le logiciel client ne réagit pas aux messages d'erreur reçus depuis ce gestionnaire d'événements.

Coffre répliqué : AfterCheckInChanges

Les gestionnaires d'événements sont invoqués lorsque les nouvelles versions sont importées dans l'objet existant depuis le pack de contenu ou lorsqu'un conflit entre deux objets est résolu en faveur de la version du coffre d'origine. Lorsque le gestionnaire d’événements AfterCheckInChanges est invoqué, l’objet a déjà été publié. C'est pourquoi les métadonnées ou fichiers ne peuvent plus être modifiés pendant l'utilisation du gestionnaire d'événements.

Coffre répliqué : AfterCreateNewObjectFinalize

Le gestionnaire d'événements est invoqué lorsqu'un nouvel objet est importé dans le coffre depuis le pack de contenu. Lors de l’invocation du gestionnaire d’événements AfterCreateNewObjectFinalize, l’objet a déjà été publié. C'est pourquoi les métadonnées ou fichiers ne peuvent plus être modifiés pendant l'utilisation du gestionnaire d'événements.

VaultExtensionMethod

Le gestionnaire d'événements est explicitement invoqué par le client (la fameuse méthode de l'extension du coffre).

Le développeur de la méthode d'extension du coffre doit s'assurer que l'utilisateur peut être autorisé à exécuter la méthode. En d'autres termes, la méthode doit vérifier l'identité de l'utilisateur appelant et mettre fin à l'opération si celui-ci ne dispose pas des droits d’administration requis dans le coffre.

BeforeCreateLoginAccount

AfterCreateLoginAccount

BeforeCreateLoginAccount: L’événement se déclenche avant la création d’un compte de connexion de coffre dans la base de données des coffres.

AfterCreateLoginAccount: L’événement se déclenche après la création d’un compte de connexion de coffre dans la base de données des coffres.

BeforeModifyLoginAccount

AfterModifyLoginAccount

BeforeModifyLoginAccount: L’événement se déclenche avant la modification d’un compte de connexion de coffre dans la base de données des coffres.

AfterModifyLoginAccount: L’événement se déclenche après la modification d’un compte de connexion de coffre dans la base de données des coffres.

BeforeRemoveLoginAccount

AfterRemoveLoginAccount

BeforeRemoveLoginAccount: L’événement se déclenche avant le retrait d’un compte de connexion de coffre de la base de données des coffres.

AfterRemoveLoginAccount: L’événement se déclenche après le retrait d’un compte de connexion de coffre de la base de données des coffres.

BeforeCreateUserAccount

AfterCreateUserAccount

BeforeCreateUserAccount: L’événement se déclenche avant la création d’un compte d’utilisateur dans la base de données des coffres.

AfterCreateUserAccount: L’événement se déclenche après la création d’un compte d’utilisateur dans la base de données des coffres.

BeforeModifyUserAccount

AfterModifyUserAccount

BeforeModifyUserAccount: L’événement se déclenche avant la modification d’un compte d’utilisateur dans la base de données des coffres.

AfterModifyUserAccount: L’événement se déclenche après la modification d’un compte d’utilisateur dans la base de données des coffres.

BeforeRemoveUserAccount

AfterRemoveUserAccount

BeforeRemoveUserAccount: L’événement se déclenche avant le retrait d’un compte d’utilisateur de la base de données des coffres.

AfterRemoveUserAccount: L’événement se déclenche après le retrait d’un compte d’utilisateur de la base de données des coffres.

BeforeCreateUserGroup

AfterCreateUserGroup

BeforeCreateUserGroup: L’événement se déclenche avant la création d’un groupe d’utilisateurs dans la base de données des coffres.

AfterCreateUserGroup: L’événement se déclenche après la création d’un groupe d’utilisateurs dans la base de données des coffres.

BeforeModifyUserGroup

AfterModifyUserGroup

BeforeModifyUserGroup: L’événement se déclenche avant la modification d’un groupe d’utilisateurs dans la base de données des coffres.

AfterModifyUserGroup: L’événement se déclenche après la modification d’un groupe d’utilisateurs dans la base de données des coffres.

Remarque : Le gestionnaire d’événements AfterModifyUserGroup n’est pas exécuté si le groupe Tous les utilisateurs internes est modifié.

BeforeRemoveUserGroup

AfterRemoveUserGroup

BeforeRemoveUserGroup: L’événement se déclenche avant le retrait d’un groupe d’utilisateurs de la base de données des coffres.

AfterRemoveUserGroup: L’événement se déclenche après le retrait d’un groupe d’utilisateurs de la base de données des coffres.

AfterBringOnline

BeforeTakeOffline

AfterBringOnline: L’événement se déclenche une fois le coffre mis en ligne.

BeforeTakeOffline: L’événement est exécuté avant la mise hors ligne du coffre. Une exception au niveau de l'un des deux gestionnaires d'événements n'empêche pas la transition en ligne/hors ligne.

AfterCheckInChangesFinalize

L'événement se déclenche si un objet a été complètement publié (ou si un objet est immédiatement publié après sa création) une fois que toutes les opérations ayant lieu après la publication (comme n'importe quelle transition d'étape) ont été réalisées.

BeforeCreateView

AfterCreateView

BeforeCreateView: L’événement se déclenche avant qu’une nouvelle vue ne soit créée dans un coffre.

AfterCreateView: L’événement se déclenche après qu’une nouvelle vue a été créée dans un coffre.

BeforeModifyView

AfterModifyView

BeforeModifyView : l’événement se déclenche avant que les modifications effectuées sur une vue ne soient appliquées.

AfterModifyView: L’événement se déclenche après que les modifications effectuées sur une vue ont été appliquées.

BeforeDeleteView

AfterDeleteView

BeforeDeleteView: L’événement se déclenche avant qu’une vue qui est définie comme devant être supprimée ne soit réellement supprimée.

AfterDeleteView: L’événement se déclenche après la suppression d’une vue.

BeforeReturnView

Le gestionnaire d’événements se déclenche après qu’une vue a été retirée du coffre mais avant qu’elle ne soit renvoyée au client. Cela vous permet de modifier une vue, par exemple, en la filtrant avec des conditions de recherche dynamique, comme des conditions basées sur l’utilisateur courant.

BeforeUndeleteObject

AfterUndeleteObject

BeforeUndeleteObject: Le gestionnaire d’événements est déclenché avant qu’un objet ne soit restauré.

AfterUndeleteObject: Le gestionnaire d’événements est déclenché après qu’un objet a été restauré. Un script peut être utilisé pour effectuer l’opération de déverrouillage et d’autres opérations d’objet avec la version objet verrouillée.

AfterUndeleteObjectFinalize

Cet événement est déclenché après que l’opération de restauration de l’objet a été effectuée et vous pouvez travailler avec l’objet restauré.

BeforeModifyMFilesCredentials

AfterModifyMFilesCredentials

BeforeModifyMFilesCredentials: Le gestionnaire d’événements est déclenché avant que le mot de passe du compte de connexion M-Files ne soit modifié.

AfterModifyMFilesCredentials: Le gestionnaire d’événements est déclenché après que le mot de passe du compte de connexion M-Files a été modifié.

BeforeCheckinChangesFinalize

Le gestionnaire d’événements BeforeCheckinChangesFinalize se déclenche avant qu’un objet ne soit publié, mais seulement une fois que les transitions d’étape et les signatures sont terminées. Les modifications du workflow ne sont pas autorisées.

BeforeAddUserGroupMember

AfterAddUserGroupMember

BeforeAddUserGroupMember : L’événement se déclenche avant l'ajout d'un membre au groupe d’utilisateurs dans la base de données des coffres. AfterAddUserGroupMember : L’événement se déclenche après l'ajout d'un membre au groupe d’utilisateurs dans la base de données des coffres.

BeforeRemoveUserGroupMember

AfterRemoveUserGroupMember

BeforeRemoveUserGroupMember : L’événement se déclenche avant la suppression d'un membre d'un groupe d’utilisateurs dans la base de données des coffres. AfterRemoveUserGroupMember : L’événement se déclenche après la suppression d'un membre d'un groupe d’utilisateurs dans la base de données des coffres.

Gestionnaires d’événements du serveur

Cette section liste les gestionnaires d'événements qui sont déclenchés par différentes opérations réalisées sur le serveur. Ces opérations entraînent également l’exécution de l’événement correspondant dans tous les coffres en ligne du serveur.

Remarque : Une exception au niveau du gestionnaire d’événements du serveur empêche l’opération de déclenchement d’avoir lieu. Néanmoins, les exceptions au niveau du gestionnaire d’événements du serveur n’affectent pas les opérations du serveur.
Gestionnaire d'événements Variables Exécution

BeforeRunScheduledJob

AfterRunScheduledJob

le gestionnaire d'événements est exécuté quand l'une des tâches planifiées du serveur est effectuée. Ces gestionnaires d'événements peuvent être utilisés pour surveiller automatiquement l'exécution des tâches planifiées automatiques. En cas d'erreur, le gestionnaire d'événements peut automatiquement envoyer une notification électronique à l'administrateur pour faciliter la résolution du problème.

BeforeCreateLoginAccount

AfterCreateLoginAccount

BeforeCreateLoginAccount: L’événement se déclenche pour tous les coffres en ligne avant la création d'un compte de connexion sur le serveur.

AfterCreateLoginAccount: L’événement se déclenche pour tous les coffres en ligne après la création d'un compte de connexion sur le serveur.

BeforeModifyLoginAccount

AfterModifyLoginAccount

BeforeModifyLoginAccount: L’événement se déclenche pour tous les coffres en ligne avant la modification d'un compte de connexion sur le serveur.

AfterModifyLoginAccount: L’événement se déclenche pour tous les coffres en ligne après la modification d'un compte de connexion sur le serveur.

BeforeRemoveLoginAccount

AfterRemoveLoginAccount

BeforeRemoveLoginAccount: L’événement se déclenche pour tous les coffres en ligne avant le retrait d'un compte de connexion sur le serveur.

AfterRemoveLoginAccount: L’événement se déclenche pour tous les coffres en ligne après le retrait d'un compte de connexion sur le serveur.

BeforeModifyMFilesCredentials

AfterModifyMFilesCredentials

BeforeModifyMFilesCredentials: Le gestionnaire d’événements se déclenche pour tous les coffres en ligne avant la modification du mot de passe du compte de connexion M-Files.

AfterModifyMFilesCredentials: Le gestionnaire d’événements se déclenche pour tous les coffres en ligne après la modification du mot de passe du compte de connexion M-Files.