Käytettävissä olevat tapahtumakäsittelijät

Alta löydät käytettävissä olevat tapahtumakäsittelijät muuttujineen sekä selityksineen. Katso lisätietoja muuttujista kohdasta Käytettävissä olevat VBScript-muuttujat.

Varastotason tapahtumakäsittelijät

Tässä osiossa luetellut tapahtumakäsittelijät aktivoituvat varastotason toiminnoista.

Huomaa: Poikkeus tapahtumakäsittelijässä estää aktivoivan toiminnon toteuttamisen.
Tapahtumakäsittelijä Muuttujat Suoritus

BeforeSetProperties

AfterSetProperties

Tapahtumakäsittelijät suoritetaan, kun dokumenttivarastoon tallennetun kohteen ominaisuusarvot asetetaan uudelleen. Ominaisuudet voidaan tarkastaa BeforeSetProperties-tapahtuman aikana, ennen kuin ne on asetettu. Ominaisuuksien muokkaamista ei kuitenkaan suositella BeforeSetProperties-tapahtuman aikana, sillä niiden päälle saatetaan kirjoittaa, kun tapahtumakäsittelijä on suoritettu. Toisaalta ominaisuuksia voidaan muokata AfterSetProperties-tapahtuman aikana.

BeforeCreateNewObjectFinalize

AfterCreateNewObjectFinalize

Tapahtumakäsittelijät suoritetaan, kun uusi kohde luodaan dokumenttivarastoon, olipa uusi kohde palautettu muokkauksesta tai ei. Kun AfterCreateNewObjectFinalize-tapahtumakäsittelijää suoritetaan, kohde on jo voitu palauttaa muokkauksesta. Tästä syystä metatietoja tai tiedostoja ei voi enää muokata tapahtumakäsittelijän toiminnan aikana. Tämän vuoksi tapahtumakäsittelijä soveltuu ainoastaan muutosten validointiin.

BeforeCancelCreateObject

AfterCancelCreateObject

Tapahtumakäsittelijät suoritetaan, kun dokumenttivarastosta poistetaan sellainen kohde, jota ei ole kertaakaan palautettu muokkauksesta. Suoritus tapahtuu esimerkiksi silloin, kun käyttäjä suorittaa tällaiselle kohteelle ”Peru muokkaus” -toiminnon tai poistaa kohteen dokumenttivarastosta.

BeforeCheckInChanges

AfterCheckInChanges

Tapahtumakäsittelijät suoritetaan, kun käyttäjä palauttaa kohteen muokkauksesta. Tapahtumakäsittelijöitä ei suoriteta, ellei kohdetta ole muokattu. Siinä tapauksessa suoritetaan tapahtumakäsittelijät BeforeCancelCheckOut ja AfterCancelCheckOut. Kohdetta voi yhä muokata BeforeCheckInChanges-tapahtuman aikana. Nämä tapahtumakäsittelijät suoritetaan, kun käyttäjä luo uuden kohteen valitsematta Palauta muokkauksesta heti -vaihtoehtoa ja palauttaa kohteen muokkauksesta tekemättä tiedostoon mitään muutoksia. Näitä tapahtumakäsittelijöitä ei suoriteta, kun uusi kohde luodaan Palauta muokkauksesta heti -toiminto valittuna. Kun tapahtumakäsittelijää AfterCheckInChanges suoritetaan, kohteeseen ei enää voi tehdä muutoksia, koska kohde on palautettu muokkauksesta. Tämän vuoksi tapahtumakäsittelijä soveltuu ainoastaan muutosten validointiin.

BeforeCancelCheckOut

AfterCancelCheckOut

Tapahtumakäsittelijät suoritetaan, kun muokattavaksi varattuun kohteeseen tehdyt muutokset perutaan esimerkiksi Peru muokkaus -toiminnolla. Tapahtumakäsittelijät suoritetaan myös, jos kohde palautetaan muokkauksesta ilman, että kohteeseen on tehty mitään muutoksia. Tapahtumakäsittelijän AfterCancelCheckOut suorituksen aikana kohteeseen ei enää voi tehdä muutoksia, koska kohde ei ole enää varattu muokattavaksi.

AfterCancelCheckoutFinalize

Tapahtuma, joka on aktivoitu muokkauksen perumistoiminnon suorittamisen jälkeen, jolloin kohdetta ei ole enää varattu muokattavaksi. Komentosarjaa voidaan käyttää muokkaukseen varauksen suorittamiseen sekä muiden kohdetoimintojen suorittamiseen muokattavaksi varatulla kohdeversiolla.

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

Tapahtumakäsittelijät suoritetaan, kun kohde merkitään poistetuksi.

BeforeDestroyObject

AfterDestroyObject

Tapahtumakäsittelijät suoritetaan, kun kohde tuhotaan dokumenttivarastosta.

BeforeDestroyObjectVersion

AfterDestroyObjectVersion

Tapahtumakäsittelijät suoritetaan, kun kohteen yksittäinen versio tuhotaan dokumenttivarastosta.

BeforeSetObjectPermissions

AfterSetObjectPermissions

Tapahtumakäsittelijät suoritetaan, kun kohteen suojausasetukset muuttuvat.

BeforeFileUpload

Tapahtumakäsittelijä suoritetaan, kun käyttäjä aloittaa tiedostonsiirron M-Files Server -palvelimelle.

AfterFileUpload

Tapahtumakäsittelijä suoritetaan, kun tiedostonsiirto palvelimelle on valmistunut.

BeforeFileDownload

AfterFileDownload

Tapahtumakäsittelijät suoritetaan, kun käyttäjä lataa tiedoston M-Files Server -palvelimelta asiakaskoneen paikalliseen välimuistiin. Näiden tapahtumakäsittelijöiden avulla voidaan tarvittaessa estää joidenkin tiedostojen siirto käyttäjien koneille.

BeforeCreateNewValueListItem

AfterCreateNewValueListItem

Tapahtumakäsittelijät suoritetaan, kun dokumenttivaraston johonkin arvolistaan lisätään uusia arvoja. Näiden tapahtumakäsittelijöiden avulla voidaan esimerkiksi varmistaa, että kaikki arvolistaan syötettävät arvot ovat halutulla tavalla määrämuotoisia.

BeforeLoginToVault

Tapahtumakäsittelijä suoritetaan juuri ennen kuin käyttäjä kirjataan sisään dokumenttivarastoon. Tässä vaiheessa käyttäjä on jo tunnistettu M-Files Server -palvelinta vasten, joten tapahtumakäsittelijää ei suoriteta esimerkiksi silloin, jos kirjautumista yrittävällä käyttäjällä ei ole käyttäjätiliä palvelimella.

AfterLoginToVault

Tapahtumakäsittelijä suoritetaan, kun käyttäjä on kirjautunut onnistuneesti sisään dokumenttivarastoon.

BeforeLogoutFromVault

Tapahtumakäsittelijä suoritetaan juuri ennen kuin käyttäjä kirjataan ulos dokumenttivarastosta. Uloskirjautumista ei voi keskeyttää tämän tapahtumakäsittelijän aikana. Asiakasohjelmisto ei myöskään reagoi tästä tapahtumakäsittelijästä peräisin oleviin virheilmoituksiin.

AfterLogoutFromVault

Tapahtumakäsittelijä suoritetaan, kun käyttäjä on kirjattu ulos dokumenttivarastosta. Uloskirjautumista ei voi keskeyttää tämän tapahtumakäsittelijän aikana. Asiakasohjelmisto ei myöskään reagoi tästä tapahtumakäsittelijästä peräisin oleviin virheilmoituksiin.

Replikointi: AfterCheckInChanges

Tapahtumakäsittelijät suoritetaan, kun sisältöpaketista tuodaan olemassa olevalle kohteelle uusia versioita tai ristiriita ratkaistaan kahden kohteen välillä lähdevaraston version hyväksi. Kun tapahtumakäsittelijä AfterCheckInChanges suoritetaan, kohde on jo palautettu muokkauksesta. Tästä syystä metatietoja tai tiedostoja ei voi enää muokata tapahtumakäsittelijän toiminnan aikana.

Replikointi: AfterCreateNewObjectFinalize

Tapahtumakäsittelijä suoritetaan, kun sisältöpaketista tuodaan uusi kohde dokumenttivarastoon. Kun tapahtumakäsittelijää AfterCreateNewObjectFinalize suoritetaan, kohde on jo palautettu muokkauksesta. Tästä syystä metatietoja tai tiedostoja ei voi enää muokata tapahtumakäsittelijän toiminnan aikana.

VaultExtensionMethod

Tapahtumakäsittelijä kutsutaan erillisellä pyynnöllä (niin kutsuttu varastonlaajennusmetodi).

Varastonlaajennusmetodin kehittäjän on varmistettava, että käyttäjälle voidaan antaa lupa suorittaa metodi. Toisin sanoen metodin pitäisi tarkistaa kutsuvan käyttäjän identiteetti ja katkaista yhteys, jos käyttäjällä ei ole tarvittavia järjestelmänvalvojan oikeuksia varastoon.

BeforeCreateLoginAccount

AfterCreateLoginAccount

BeforeCreateLoginAccount: Tapahtuma aktivoituu, ennen kuin luodaan varastotason käyttäjätili varaston tietokantaan.

AfterCreateLoginAccount: Tapahtuma aktivoituu sen jälkeen, kun on luotu varastotason käyttäjätili varaston tietokantaan.

BeforeModifyLoginAccount

AfterModifyLoginAccount

BeforeModifyLoginAccount: Tapahtuma aktivoituu, ennen kuin muokataan varastotason käyttäjätiliä varaston tietokannassa.

AfterModifyLoginAccount: Tapahtuma aktivoituu sen jälkeen, kun on muokattu varastotason käyttäjätiliä varaston tietokannassa.

BeforeRemoveLoginAccount

AfterRemoveLoginAccount

BeforeRemoveLoginAccount: Tapahtuma aktivoituu, ennen kuin varastotason käyttäjätili poistetaan varaston tietokannasta.

AfterRemoveLoginAccount: Tapahtuma aktivoituu sen jälkeen, kun varastotason käyttäjätili on poistettu varaston tietokannasta.

BeforeCreateUserAccount

AfterCreateUserAccount

BeforeCreateUserAccount: Tapahtuma aktivoituu, ennen kuin luodaan käyttäjä varaston tietokantaan.

AfterCreateUserAccount: Tapahtuma aktivoituu sen jälkeen, kun on luotu käyttäjä varaston tietokantaan.

BeforeModifyUserAccount

AfterModifyUserAccount

BeforeModifyUserAccount: Tapahtuma aktivoituu, ennen kuin muokataan käyttäjää varaston tietokannassa.

AfterModifyUserAccount: Tapahtuma aktivoituu sen jälkeen, kun on muokattu käyttäjää varaston tietokannassa.

BeforeRemoveUserAccount

AfterRemoveUserAccount

BeforeRemoveUserAccount: Tapahtuma aktivoituu, ennen kuin käyttäjä poistetaan varaston tietokannasta.

AfterRemoveUserAccount: Tapahtuma aktivoituu sen jälkeen, kun käyttäjä on poistettu varaston tietokannasta.

BeforeCreateUserGroup

AfterCreateUserGroup

BeforeCreateUserGroup: Tapahtuma aktivoituu, ennen kuin luodaan käyttäjäryhmä varaston tietokantaan.

AfterCreateUserGroup: Tapahtuma aktivoituu sen jälkeen, kun on luotu käyttäjäryhmä varaston tietokantaan.

BeforeModifyUserGroup

AfterModifyUserGroup

BeforeModifyUserGroup: Tapahtuma aktivoituu, ennen kuin muokataan käyttäjäryhmää varaston tietokannassa.

AfterModifyUserGroup: Tapahtuma aktivoituu sen jälkeen, kun käyttäjäryhmää on muokattu varaston tietokannassa.

Huomaa: AfterModifyUserGroup-tapahtumakäsittelijää ei suoriteta silloin, kun muokataan Kaikki sisäiset käyttäjät -ryhmää.

BeforeRemoveUserGroup

AfterRemoveUserGroup

BeforeRemoveUserGroup: Tapahtuma aktivoituu, ennen kuin käyttäjäryhmä poistetaan varaston tietokannasta.

AfterRemoveUserGroup: Tapahtuma aktivoituu sen jälkeen, kun käyttäjäryhmä on poistettu varaston tietokannasta.

AfterBringOnline

BeforeTakeOffline

AfterBringOnline:: Tapahtuma aktivoituu sen jälkeen, kun varasto on otettu käyttöön (online).

BeforeTakeOffline:: Tapahtuma suoritetaan, ennen kuin varasto otetaan pois käytöstä (offline). Kummassakaan tapahtumakäsittelijässä oleva poikkeus ei estä käyttöön ottamista / käytöstä pois ottamista.

AfterCheckInChangesFinalize

Tapahtuma aktivoituu, kun palauta muokkauksesta -toiminto ja kaikki muokkauksesta palauttamisen jälkeiset toiminnot on suoritettu. Tapahtuma aktivoituu myös silloin, kun kohde palautetaan muokkauksesta heti sen luomisen jälkeen.

Jos kohteen palauttaminen muokkauksesta käynnistää automaattisten tilasiirtymien sarjan, AfterCheckInChangesFinalize aktivoituu ensimmäisen siirtymän jälkeen.

BeforeCreateView

AfterCreateView

BeforeCreateView:: Tapahtuma aktivoituu ennen uuden varastonäkymän luomista.

AfterCreateView:: Tapahtuma aktivoituu uuden varastonäkymän luomisen jälkeen.

BeforeModifyView

AfterModifyView

BeforeModifyView: Tapahtuma aktivoituu ennen näkymään tehtyjen muutosten voimaantuloa.

AfterModifyView:: Tapahtuma aktivoituu näkymään tehtyjen muutosten voimaantulon jälkeen.

BeforeDeleteView

AfterDeleteView

BeforeDeleteView:: Tapahtuma aktivoituu ennen poistettavaksi määritetyn näkymän varsinaista poistamista.

AfterDeleteView:: Tapahtuma aktivoituu näkymän poistamisen jälkeen.

BeforeReturnView

Tämä tapahtumakäsittelijä aktivoituu, kun näkymä on haettu varastosta, mutta ennen sen palauttamista asiakkaalle. Sen avulla voit muokata näkymää esimerkiksi suodattamalla sitä dynaamisilla, esimerkiksi nykyiseen käyttäjään perustuvilla hakuehdoilla.

BeforeUndeleteObject

AfterUndeleteObject

BeforeUndeleteObject:: Tapahtumakäsittelijä aktivoituu, ennen kuin kohteen poisto perutaan.

AfterUndeleteObject:: Tapahtumakäsittelijä aktivoituu sen jälkeen, kun kohteen poisto on peruttu. Komentosarjaa voidaan käyttää muokkaukseen varauksen suorittamiseen sekä muiden kohdetoimintojen suorittamiseen muokattavaksi varatulla kohdeversiolla.

AfterUndeleteObjectFinalize

Tämä tapahtuma aktivoituu sen jälkeen, kun kohteen poiston kumoaminen on suoritettu ja pystyt työskentelemään kohteella, jonka poisto on peruttu.

BeforeModifyMFilesCredentials

AfterModifyMFilesCredentials

BeforeModifyMFilesCredentials: Tapahtumakäsittelijä aktivoituu, ennen kuin M-Files-käyttäjätilin salasanaa muutetaan.

AfterModifyMFilesCredentials:: Tapahtumakäsittelijä aktivoituu M-Files-käyttäjätilin salasanan muuttamisen jälkeen.

BeforeCheckinChangesFinalize

Tapahtumakäsittelijä BeforeCheckinChangesFinalize aktivoituu ennen kohteen palauttamista muokkauksesta, mutta vasta sen jälkeen, kun tilasiirtymät ja allekirjoitukset on viimeistelty. Työnkulun muutokset eivät ole sallittuja.

BeforeAddUserGroupMember

AfterAddUserGroupMember

BeforeAddUserGroupMember: Tapahtuma aktivoituu ennen AddMemberToUserGroup-API-kutsua.

AfterAddUserGroupMember: Tapahtuma aktivoituu AddMemberToUserGroup-API-kutsun jälkeen.

BeforeRemoveUserGroupMember

AfterRemoveUserGroupMember

BeforeRemoveUserGroupMember: Tapahtuma aktivoituu ennen RemoveMemberFromUserGroup-API-kutsua.

AfterRemoveUserGroupMember: Tapahtuma aktivoituu RemoveMemberFromUserGroup-API-kutsun jälkeen.

Palvelintason tapahtumakäsittelijät

Tässä osiossa luetellaan tapahtumakäsittelijät, jotka aktivoituvat palvelintason toimintojen perusteella. Nämä toiminnot aiheuttavat myös vastaavan tapahtuman toteuttamisen kaikissa palvelimen online-varastoissa.

Huomaa: Poikkeus palvelintason tapahtumankäsittelijässä estää aktivoitavan toiminnan toteutumisen, vaikka kaikki varastotason tapahtumankäsittelijäpoikkeukset eivät vaikuta palvelintason toimintoihin.
Tapahtumakäsittelijä Muuttujat Suoritus

BeforeRunScheduledJob

AfterRunScheduledJob

Tapahtumakäsittelijä suoritetaan, kun jokin palvelimen ajastetuista töistä suoritetaan. Näiden tapahtumakäsittelijöiden avulla on mahdollista esimerkiksi valvoa automaattisesti ajastettujen töiden suoritusta. Virhetilanteessa tapahtumakäsittelijä voi esimerkiksi lähettää järjestelmänvalvojalle automaattisesti sähköpostiviestin, jolloin ongelmatilanteeseen voidaan helposti puuttua.

BeforeCreateLoginAccount

AfterCreateLoginAccount

BeforeCreateLoginAccount: Tapahtuma aktivoituu kaikille käyttöön otetuille online-varastoille, ennen kuin käyttäjätili on luotu palvelimelle.

AfterCreateLoginAccount: Tapahtuma aktivoituu kaikille käyttöön otetuille online-varastoille sen jälkeen, kun käyttäjätili on luotu palvelimelle.

BeforeModifyLoginAccount

AfterModifyLoginAccount

BeforeModifyLoginAccount: Tapahtuma aktivoituu kaikille käyttöön otetuille online-varastoille, ennen kuin käyttäjätiliä on muokattu palvelimella.

AfterModifyLoginAccount: Tapahtuma aktivoituu kaikille käyttöön otetuille online-varastoille sen jälkeen, kun käyttäjätiliä on muokattu palvelimella.

BeforeRemoveLoginAccount

AfterRemoveLoginAccount

BeforeRemoveLoginAccount: Tapahtuma aktivoituu kaikille käyttöön otetuille online-varastoille, ennen kuin käyttäjätili on poistettu palvelimelta.

AfterRemoveLoginAccount: Tapahtuma aktivoituu kaikille käyttöön otetuille online-varastoille sen jälkeen, kun käyttäjätili on poistettu palvelimelta.

BeforeModifyMFilesCredentials

AfterModifyMFilesCredentials

BeforeModifyMFilesCredentials: Tapahtumakäsittelijä aktivoituu kaikille käyttöön otetuille online-varastoille, ennen kuin M-Files-käyttäjätilin salasanaa muutetaan.

AfterModifyMFilesCredentials: Tapahtumakäsittelijä aktivoituu kaikille käyttöön otetuille online-varastoille sen jälkeen, kun M-Files-käyttäjätilin salasana on muutettu.