Tillgängliga händelsehanterare
Nedan ser du de tillgängliga händelsehanterarna, med variabler och förklaringar. Mer information om variabler finns i Tillgängliga VBScript-variabler.
Händelsehanterare på valvnivå
Händelsehanterarna listade i detta avsnitt initieras av åtgärder på valvnivå.
Händelsehanterare | Variabler | Utförande |
---|---|---|
BeforeSetProperties AfterSetProperties |
Händelsehanterarna utförs när egenskapsvärdena för objektet som sparats i dokumentvalvet återställs. Du kan granska egenskaperna under BeforeSetProperties innan du ställer in dem. Vi rekommenderar dock inte att du modifierar egenskaper under BeforeSetProperties eftersom de kan skrivas över när händelsehanteraren har utförts. Du kan däremot modifiera egenskaper under AfterSetProperties-händelsen. |
|
BeforeCreateNewObjectFinalize AfterCreateNewObjectFinalize |
Händelsehanterare utförs när ett nytt objekt skapas i dokumentvalvet, oavsett om det nya objektet har checkats in eller inte. När AfterCreateNewObjectFinalize-händelsehanteraren utförs kan objektet redan ha checkats in. Därför kan metadata eller filer inte längre modifieras medan händelsehanteraren jobbar och därmed passar händelsehanteraren bara för att validera ändringar. |
|
BeforeCancelCreateObject AfterCancelCreateObject |
Händelsehanterare utförs när ett objekt som aldrig har checkats in tas bort från dokumentvalvet. Utförande sker till exempel när användaren använder funktionen Ångra utcheckning för objektet eller tar bort objektet från dokumentvalvet. |
|
BeforeCheckInChanges AfterCheckInChanges |
Händelsehanterare utförs när användaren checkar in objektet. Händelsehanterare utförs inte om objektet inte modifieras. I sådana fall utförs BeforeCancelCheckOut- och AfterCancelCheckOut-händelsehanterarna. Det är fortfarande möjligt att modifiera objektet under BeforeCheckInChanges. Dessa händelsehanterare utförs även när användaren skapar ett nytt objekt med alternativet Checka in omedelbart avmarkerat och checkar in objektet utan att ändra i filen. Dessa händelsehanterare utförs inte när ett nytt objekt skapas med alternativet Checka in omedelbart aktiverat. När AfterCheckInChanges-händelsehanteraren utförs kan objektet inte längre modifieras eftersom det redan har checkats in. Därför passar händelsehanteraren bara för att validera ändringar. |
|
BeforeCancelCheckOut AfterCancelCheckOut |
Händelsehanterarna utförs när modifieringar för ett utcheckat objekt ångras med hjälp av exempelvis funktionen Ångra utcheckning. Händelsehanterarna utförs även om objektet checkas in utan några modifieringar. När AfterCancelCheckOut-händelsehanteraren utförs kan objektet inte modifieras eftersom objektet inte längre är utcheckat. |
|
AfterCancelCheckoutFinalize |
En händelse som initieras efter att åtgärden Ångra utcheckning är slutförd, vilket betyder att objektet inte längre är utcheckat. Ett script kan användas för att utföra utcheckningsåtgärden och för att utföra ytterligare objektåtgärder med den utcheckade objektversionen. |
|
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 |
Händelsehanterare utförs när ett objekt markeras som borttaget. |
|
BeforeDestroyObject AfterDestroyObject |
Händelsehanterare utförs när ett objekt förstörs i dokumentvalvet. |
|
BeforeDestroyObjectVersion AfterDestroyObjectVersion |
Händelsehanterare utförs när en enskild version av objektet förstörs i dokumentvalvet. |
|
BeforeSetObjectPermissions AfterSetObjectPermissions |
Händelsehanterare utförs när objektbehörigheterna ändras. |
|
BeforeFileUpload |
Händelsehanteraren utförs när användaren startar en filöverföring till M-Files Server. |
|
AfterFileUpload |
Händelsehanteraren utförs när filöverföringen till servern har slutförts. |
|
BeforeFileDownload AfterFileDownload |
Händelsehanterare utförs när användaren läser in en fil från M-Files Server till klientdatorns lokala cacheminne. Om det behövs kan dessa händelsehanterare användas för att förhindra att vissa filer överförs till användarens datorer. |
|
BeforeCreateNewValueListItem AfterCreateNewValueListItem |
Händelsehanterarna utförs när nya värden läggs till i en viss värdelista i dokumentvalvet. Dessa händelsehanterare kan exempelvis användas för att se till att alla värden som anges i värdelistan är i den önskade formen. |
|
BeforeLoginToVault |
Händelsehanteraren utförs omedelbart innan användaren loggar in till dokumentvalvet. I det här skedet har användaren redan identifierats mot M-Files Server, så händelsehanteraren utförs inte till exempel om en användare som försöker logga in inte har ett inloggningskonto på servern. |
|
AfterLoginToVault |
Händelsehanteraren utförs när användaren har loggat in till dokumentvalvet. |
|
BeforeLogoutFromVault |
Händelsehanteraren utförs omedelbart innan användaren loggas ut från dokumentvalvet. Det går inte att avbryta utloggningen under den här händelsehanteraren. Klientprogramvaran reagerar inte på felmeddelanden som kommer från den här händelsehanteraren. |
|
AfterLogoutFromVault |
Händelsehanteraren utförs när användaren har loggats ut från dokumentvalvet. Det går inte att avbryta utloggningen under den här händelsehanteraren. Klientprogramvaran reagerar inte på felmeddelanden som kommer från den här händelsehanteraren. |
|
Replikering: AfterCheckInChanges |
Händelsehanterarna anropas när nya versioner importeras till det befintliga objektet från innehållspaketet eller när en konflikt mellan två objekt löses till förmån för källvalvsversionen. När AfterCheckInChanges-händelsehanteraren anropas har objektet redan checkats in. Därför kan metadata eller filer inte längre modifieras medan händelsehanteraren jobbar. |
|
Replikering: AfterCreateNewObjectFinalize |
Händelsehanteraren anropas när ett nytt objekt importeras till dokumentvalvet från innehållspaketet. När AfterCreateNewObjectFinalize-händelsehanteraren anropas har objektet redan checkats in. Därför kan metadata eller filer inte längre modifieras medan händelsehanteraren jobbar. |
|
VaultExtensionMethod |
Händelsehanteraren anropas explicit av klienten (den så kallade valvtilläggsmetoden). |
|
BeforeCreateLoginAccount AfterCreateLoginAccount |
BeforeCreateLoginAccount: Händelsen initieras innan ett inloggningskonto på valvnivå skapas i valvdatabasen. AfterCreateLoginAccount: Händelsen initieras efter att ett inloggningskonto på valvnivå har skapats i valvdatabasen. |
|
BeforeModifyLoginAccount AfterModifyLoginAccount |
BeforeModifyLoginAccount: Händelsen initieras innan ett inloggningskonto på valvnivå modifieras i valvdatabasen. AfterModifyLoginAccount: Händelsen initieras efter att ett inloggningskonto på valvnivå har modifierats i valvdatabasen. |
|
BeforeRemoveLoginAccount AfterRemoveLoginAccount |
BeforeRemoveLoginAccount: Händelsen initieras innan ett inloggningskonto på valvnivå tas bort från valvdatabasen. AfterRemoveLoginAccount: Händelsen initieras efter att ett inloggningskonto på valvnivå har tagits bort från valvdatabasen. |
|
BeforeCreateUserAccount AfterCreateUserAccount |
BeforeCreateUserAccount: Händelsen initieras innan ett användarkonto skapas i valvdatabasen. AfterCreateUserAccount: Händelsen initieras efter att ett användarkonto har skapats i valvdatabasen. |
|
BeforeModifyUserAccount AfterModifyUserAccount |
BeforeModifyUserAccount: Händelsen initieras innan ett användarkonto modifieras i valvdatabasen. AfterModifyUserAccount: Händelsen initieras efter att ett användarkonto har modifierats i valvdatabasen. |
|
BeforeRemoveUserAccount AfterRemoveUserAccount |
BeforeRemoveUserAccount: Händelsen initieras innan ett användarkonto tas bort från valvdatabasen. AfterRemoveUserAccount: Händelsen initieras efter att ett användarkonto har tagits bort från valvdatabasen. |
|
BeforeCreateUserGroup AfterCreateUserGroup |
BeforeCreateUserGroup: Händelsen initieras innan en användargrupp skapas i valvdatabasen. AfterCreateUserGroup: Händelsen initieras efter att en användargrupp har skapats i valvdatabasen. |
|
BeforeModifyUserGroup AfterModifyUserGroup |
BeforeModifyUserGroup: Händelsen initieras innan en användargrupp modifieras i valvdatabasen. AfterModifyUserGroup: Händelsen initieras efter att en användargrupp har modifierats i valvdatabasen. Notera: AfterModifyUserGroup-händelsehanteraren utförs när gruppen Alla interna användare modifieras.
|
|
BeforeRemoveUserGroup AfterRemoveUserGroup |
BeforeRemoveUserGroup: Händelsen initieras innan en användargrupp tas bort från valvdatabasen. AfterRemoveUserGroup: Händelsen initieras efter att en användargrupp har tagits bort från valvdatabasen. |
|
AfterBringOnline BeforeTakeOffline |
AfterBringOnline: Händelsen initieras efter att valvet har tagits till onlineläge. BeforeTakeOffline: Händelsen utförs innan valvet tas till offlineläge. Eventuella undantag i någon av de två händelsehanterarna förhindrar inte övergången till online/offline. |
|
AfterCheckInChangesFinalize |
Händelsen initieras när ett objekt har checkats in helt (eller när ett objekt checkas in omedelbart efter att det har skapats) efter att alla åtgärder som sker efter incheckningen (till exempel tillståndsövergångar) har slutförts. |
|
BeforeCreateView AfterCreateView |
BeforeCreateView: Händelsen initieras innan en ny vy skapas i valvet. AfterCreateView: Händelsen initieras efter att en ny vy har skapats i ett valv. |
|
BeforeModifyView AfterModifyView |
BeforeModifyView: Händelsen initieras innan ändringar som har gjorts i en vy börjar att gälla. AfterModifyView: Händelsen initieras efter att ändringar som har gjorts i en vy har börjat gälla. |
|
BeforeDeleteView AfterDeleteView |
BeforeDeleteView: Händelsen initieras innan en vy som har ställts in för borttagning faktiskt tas bort. AfterDeleteView: Händelsen initieras efter att en vy har tagits bort. |
|
BeforeReturnView |
Händelsehanteraren initieras efter att en vy har hämtats från valvet men innan den returneras till klienten. Den gör att du kan modifiera en vy, till exempel genom att filtrera den med dynamiska sökvillkor, bland annat sådana som utgår ifrån den aktuella användaren. |
|
BeforeUndeleteObject AfterUndeleteObject |
BeforeUndeleteObject: Händelsehanteraren initieras innan du ångrar borttagningen av ett objekt. AfterUndeleteObject: Händelsehanteraren initieras efter att du ångrar borttagningen av ett objekt. Ett script kan användas för att utföra utcheckningsåtgärden och för att utföra ytterligare objektåtgärder med den utcheckade objektversionen. |
|
AfterUndeleteObjectFinalize |
Den här händelsen initieras efter att åtgärden för att ångra borttagningen av objektet är slutförd och du kan jobba med det objekt för vilket borttagningen har ångrats. |
|
BeforeModifyMFilesCredentials AfterModifyMFilesCredentials |
BeforeModifyMFilesCredentials: Händelsehanteraren initieras innan lösenordet till M-Files-inloggningskontot ändras. AfterModifyMFilesCredentials: Händelsehanteraren initieras efter att lösenordet till M-Files-inloggningskontot ändras. |
|
BeforeCheckinChangesFinalize |
BeforeCheckinChangesFinalize-händelsehanteraren initieras innan ett objekt checkas in, men efter att tillståndsövergångarna och signaturerna har avslutats. Arbetsflödesändringar är inte tillåtna. |
Händelsehanterare på servernivå
Detta avsnitt listar händelsehanterare som initieras av åtgärder på servernivå. Dessa åtgärder orsakar även att en motsvarande händelse utförs i alla onlinevalv på servern.
Händelsehanterare | Variabler | Utförande |
---|---|---|
BeforeRunScheduledJob AfterRunScheduledJob |
Händelsehanteraren utförs när ett av de tidsinställda jobben på servern genomförs. Dessa händelsehanterare kan användas för att automatiskt övervaka utförandet av automatiskt tidsinställda jobb. Om det uppstår fel kan händelsehanteraren automatiskt skicka ett e-postmeddelande till administratören för att lättare lösa problemet. |
|
BeforeCreateLoginAccount AfterCreateLoginAccount |
BeforeCreateLoginAccount: Händelsen initieras för alla onlinevalv innan ett inloggningskonto skapas på servern. AfterCreateLoginAccount: Händelsen initieras för alla onlinevalv efter att ett inloggningskonto har skapats på servern. |
|
BeforeModifyLoginAccount AfterModifyLoginAccount |
BeforeModifyLoginAccount: Händelsen initieras för alla onlinevalv innan ett inloggningskonto modifieras på servern. AfterModifyLoginAccount: Händelsen initieras för alla onlinevalv efter att ett inloggningskonto har modifierats på servern. |
|
BeforeRemoveLoginAccount AfterRemoveLoginAccount |
BeforeRemoveLoginAccount: Händelsen initieras för alla onlinevalv innan ett inloggningskonto har tagits bort från servern. AfterRemoveLoginAccount: Händelsen initieras för alla onlinevalv efter att ett inloggningskonto har tagits bort från servern. |
|
BeforeModifyMFilesCredentials AfterModifyMFilesCredentials |
BeforeModifyMFilesCredentials: Händelsehanteraren initieras för alla onlinevalv innan lösenordet till M-Files-inloggningskontot ändras. AfterModifyMFilesCredentials: Händelsehanteraren initieras för alla onlinevalv efter att lösenordet till M-Files-inloggningskontot har ändrats. |