Käytettävissä olevat VBScript-muuttujat

VBScript-koodia muokataan Muokkaa VBScript-koodia -ikkunassa, joka voidaan avata seuraavilta välilehdiltä: Käytettävissä olevat muuttujat on kuvattu seuraavassa taulukossa.
Huomaa: Kun kehität uusia laajennuksia tai muokkaat olemassa olevia, suosittelemme korvaamaan VBScriptin sisällön Vault Application Framework (VAF) -yhteensopivalla koodilla. Näin varmistat yhteensopivuuden myös jatkossa. Katso lisätietoja VAF-kehityksen hyödyistä VBScriptiin verrattuna M-Files Developer Portalin kohdasta The Vault Application Framework.
Huomaa: M-FilesAPI -dokumentaatio on saatavilla verkossa: M-Files API.
Muuttuja Tietotyyppi Tila Käyttö
ActivityID MFilesAPI.TypedValue Sisään Suoritettavan toiminnon yksilöllinen tunniste. Voidaan käyttää tunnistamaan, mitä tapahtumia tietty palvelintoiminto aiheuttaa.
AllowStateTransition Boolean Ulos Voidaan käyttää sallimaan tai estämään automaattinen tilasiirtymä suoritettaessa automaattisen tilasiirtymän komentosarja.
CurrentTransactionID MFilesAPI.TypedValue Sisään Tapahtuman ID-tunniste. Jos tapahtumakäsittelijät suoritetaan rekursiivisesti (yhden suorittaminen aiheuttaa toisen suorittamisen), ID muuttuu jokaisella rekursiotasolla.
CurrentUserID MFilesAPI.Number Sisään Sisältää sen käyttäjän ID:n, jonka tekemän toiminnon seurauksena komentosarjaa suoritetaan.
CurrentUserSessionInfo MFilesAPI.SessionInfo Sisään Sisältää tietoa toiminnon aiheuttaneen käyttäjän kirjautumisistunnosta.
DisplayID MFilesAPI.TypedValue Sisään Sisältää kohteen yksilöllisen ID-tunnisteen. Tämä tunniste näytetään kohteen metatietokortilla, kun kohde on valittuna listausalueella. DisplayID voi sisältää numeroiden lisäksi myös kirjaimia. Usein DisplayID on sama kuin kohteen ns. sisäinen ID, jonka arvo on saatavilla ObjVer-muuttujan kautta. Kohteen sisäinen ID on kuitenkin aina numero. DisplayID eroaa kohteen sisäisestä ID:stä yleensä silloin, kun kohde on tuotu ulkoisesta tietokannasta.
FileTransferSessionID MFilesAPI.Number Sisään Sisältää käyttäjäkohtaisen tiedonsiirtotunnisteen. Tiedonsiirtotunniste muodostetaan, kun tiedonsiirtoa ollaan käynnistämässä palvelimella ja samassa yhteydessä tämä sama tiedonsiirtotunniste annetaan BeforeFileUpload ja BeforeFileDownload-tapahtumakäsittelijöille. Myöhemmin, kun tiedonsiirto on päättynyt, annetaan sama tiedonsiirtotunniste AfterFileUpload ja AfterFileDownload-tapahtumakäsittelijöille. Tiedonsiirtotunnisteen avulla on siis mahdollista liittää Before-tyyppiset tapahtumakäsittelijät yhteen After-tyyppisten tapahtumakäsittelijöiden kanssa.
FileVer MFilesAPI.FileVer Sisään Sisältää kohdetiedoston täydellisen yksikäsitteisen tunnisteen, joka koostuu tiedoston ID:stä ja tiedoston versionumerosta.
GetExtensionObject (metodi) Ei käytettävissä Metodi varastosovelluksella määritetyn laajennuksen hakemiseen.

Käyttö: GetExtensionObject( <kohteen nimi> [, sovelluksen GUID]), jossa osa [, sovelluksen GUID] on valinnainen.

Esim. Set CK = GetExtensionObject("M-Files.ComplianceKit", "{0CAC5452-631F-4646-AC95-4A06BFB8147E}")

Jos sovelluksen GUID-tunnistetta ei ole määritetty, laajennusta haetaan varaston kaikista sovelluksista.
GroupID MFilesAPI.Number Sisään Kohdekäyttäjäryhmän ID-tunniste.
Input MFilesAPI.TypedValue Sisään Asiakkaan määrittämä VaultExtensionMethod-tapahtumakäsittelijän parametri.
IsCancellable MFilesAPI.BooleanValue Sisään Normaalisti komentosarjat voivat peruuttaa palvelintoiminnon ja palauttaa siihen liittyvän tapahtuman tuottamalla virheen komentosarjassa. IsCancellable-muuttuja määrittää, milloin komentosarja saa tehdä näin.

Jos muuttujan arvo on false, M-Files Server ohittaa kaikki komentosarjassa tuotetut virheet. Jos komentosarja kuitenkin tuottaa virheen arvon muuttujan ollessa false, virhe kirjataan Windowsin tapahtumakirjanpitoon ja kaikki komentosarjan tekemät muutokset peruutetaan. Palvelintoiminto siirtyy sitten suoritukseen.
LastUsed MFilesAPI.TypedValue Sisään Käytettävissä vain, jos ominaisuudelle on laskettavana mukautettu automaattinen numerointi. Automaattisen numeroinnin arvo määräytyy yleensä edellisen laskennan mukaan. Esimerkiksi tavallisessa juoksevassa numeroinnissa automaattinen arvo kasvaa joka kerta yhdellä. Mukautettua automaattista numerointia muodostettaessa edellisen laskentakerran tulos on käytettävissä LastUsed-muuttujan kautta.

Esimerkiksi yksinkertainen joka kerta yhdellä kasvava automaattinen numerointi voitaisiin toteuttaa seuraavalla VBScript-koodilla: Output = LastUsed + 1
LoggedOutUserID MFilesAPI.Number Sisään Sisältää uloskirjautumisen jälkeen uloskirjautuneen käyttäjän ID:n.
LoginAccount MFilesAPI.LoginAccount Sisään Sisältää kirjautumistilanteessa käyttäjän käyttäjätilin tiedot.
MasterTransactionID MFilesAPI.TypedValue Sisään Tapahtuman ID-tunniste. Jos tapahtumakäsittelijät suoritetaan rekursiivisesti (yhden suorittaminen aiheuttaa toisen suorittamisen), tapahtuman ID on ensimmäisen tapahtuman ID.
MemberID MFilesAPI.Number Sisään Käyttäjäryhmään lisätyn tai käyttäjäryhmästä poistetun jäsenen ID-tunniste. Arvo on negatiivinen, jos jäsen on käyttäjäryhmä.
MFScriptCancel MFilesAPI.Number Sisään Sisältää virhekoodin, jota komentosarjat käyttävät näyttääkseen virheilmoituksia käyttäjille. M-Files lisää usein yksityiskohtaista tietoa virheilmoituksiin, mikä voidaan estää MFScriptCancel-muuttujan virhekoodilla.

Esimerkiksi: Err.Raise MFScriptCancel, "This is the error message shown to the user."
NextStateID MFilesAPI.Number Ulos Automaattisen tilasiirtymän aikana NextStateID-niminen muuttuja sisältää automaattista tilasiirtymää suoritettaessa sen tilan tunnisteen, johon automaattinen tilasiirtymä suoritetaan. Muuttamalla tämän muuttujan arvoa voidaan automaattisen tilasiirtymän komentosarjassa määrittää seuraava tila. Oletuksena kohdetila on sama kuin käyttöliittymässä asetettu Seuraava tila.
ObjectAccessControlList MFilesAPI.ObjectAccessControlList Sisään Sisältää tarkasteltavana olevan kohteen nykyiset suojausasetukset.
ObjID MFilesAPI.ObjID Sisään Käsiteltävänä olevan kohteen ID-tunniste.
ObjVer MFilesAPI.ObjVer Sisään Sisältää kohdeversion täydellisen yksikäsitteisen tunnisteen, joka koostuu kohdetyypin ID:stä, kohteen sisäisestä ID:stä ja kohteen versionumerosta.
Output MFilesAPI.TypedValue Ulos Käytettävissä vain, jos ominaisuudelle on laskettavana mukautettu automaattinen numerointi. VBScript-koodin suorituksen alussa Output-muuttuja sisältää laskettavan ominaisuusarvon tämänhetkisen arvon (ei kuitenkaan automaattisessa numeroinnissa).

VBScript-koodin pääasiallinen tarkoitus on yleensä luoda uusi arvo ja nimetä se Output-muuttujalle, joka sitten tallennetaan kohteen metatietoihin. Ellei VBScript-koodi määritä Output-muuttujan arvoa, metatietojen ominaisuusarvo pysyy samana.

Output-muuttujan arvon voi yksinkertaisissa tapauksissa asettaa suoralla sijoituslauseella, esimerkiksi seuraavasti: Output = 123

Jos laskettavan arvon tietotyyppi on esimerkiksi Valitse listasta, SetValue-metodia suositellaan muuttujan Output arvon määrittämiseen (katso M-Files API), esimerkiksi seuraavasti: Output.SetValue MFDatatypeLookup, 101
ParentTransactionID MFilesAPI.TypedValue Sisään Tapahtuman ID-tunniste. Jos tapahtumakäsittelijät suoritetaan rekursiivisesti (yhden suorittaminen aiheuttaa toisen suorittamisen), tämän tapahtuman ID on edellisen (kutsuvan) tapahtuman ID.
PropertyDef MFilesAPI.PropertyDef Sisään Sisältää laskettavana olevan ominaisuusmäärittelyn tiedot, kuten ominaisuusmäärittelyn ID:n, nimen ja tietotyypin.
PropertyValue MFilesAPI.PropertyValue Sisään Sisältää ominaisuusarvon. Jokainen ominaisuusarvo, joka on tallennettu muuttujaan PropertyValues tyypin PropertyValue muuttujana. Tietyn ominaisuusarvon voi etsiä kokoelmasta käyttäen SearchForProperty-metodia.
PropertyValues MFilesAPI.PropertyValues Sisään Sisältää kaikki kohdeversion ominaisuusarvot, jotka koskivat nykyistä toimintaa. Jokainen ominaisuusarvo, joka on tallennettu muuttujaan PropertyValues tyypin PropertyValue muuttujana. Tietyn ominaisuusarvon voi etsiä kokoelmasta käyttäen SearchForProperty-metodia.
Huomaa: Joitakin ominaisuusmäärittelyjä ei näytetä silloin, kun käytetään PropertyValues -muuttujaa komentosarjoissa (katso Ominaisuusmäärittelyt, joita ei näytetä komentosarjoille).
RestoredVersions MFilesAPI.IDs Sisään Sisältää viedyn kohteen kohdeversiot, jotka tuotiin sisältöpaketista.
SavepointVariables MFilesAPI.NamedValues Sisään/Ulos Säilö valinnaisille nimi-arvopareille, jotka on tallennettu yhden tapahtuman keston ajaksi. Säilö palauttaa automaattisesti säilön sisäiset, epäonnistuneiden operaatioiden aiheuttamat muutokset.
ScheduledJob MFilesAPI.ScheduledJob Sisään Sisältää suorituksessa olevan ajastetun työn kuvauksen.
ScheduledJobOutputInfo MFilesAPI.ScheduledJobOutputInfo Sisään Sisältää ajastetun työn suorittamisen jälkeen tietoa ajastetun työn lopputuloksesta.
StateID MFilesAPI.Number Sisään Sisältää työnkulun tilan tunnisteen, jonka avulla työnkulkuihin liittyvissä komentosarjoissa voidaan yksikäsitteisesti tunnistaa käsiteltävä tila.
StateTransitionID MFilesAPI.Number Sisään Tilasiirtymän ID-tunniste.
TransactionCache MFilesAPI.NamedValues Sisään/Ulos Säilö valinnaisille nimi-arvopareille, jotka on tallennettu yhden tapahtuman keston ajaksi. Säilö säilyttää kaikki muutokset, vaikka ne olisivat myöhemmin virheen vuoksi peruutetun toiminnon aiheuttamia.
UserAccount MFilesAPI.UserAccount Sisään Varaston käyttäjän tiedot.
UserGroupAdmin MFilesAPI.UserGroupAdmin Sisään Varaston käyttäjäryhmän tiedot.
ValueListItem MFilesAPI.ValueListItem Sisään Sisältää arvolistan arvon, jota tapahtumakäsittelijässä ollaan käsittelemässä.
Vault MFilesAPI.Vault Sisään Edustaa dokumenttivarastoa, jonka puitteissa komentosarjaa ollaan suorittamassa. Muuttujan kautta komentosarja pystyy käsittelemään dokumenttivaraston sisältöä samalla tavalla kuin on mahdollista M-Files API -rajapinnan avulla. Virhetilanteessa kaikki Vault-olion kautta dokumenttivarastolle tehdyt muutokset perutaan.

Olion Vault käyttöön komentosarjoissa liittyy myös joitakin rajoituksia. Komentosarjat eivät pysty Vault-olion kautta muuttamaan sen objektin tilaa, jolle komentosarjaa ollaan suorittamassa. Tilan muuttamiseksi lasketaan kohteen varaaminen muokattavaksi, kohteen palauttaminen muokkauksesta, muokkausvarauksen peruminen sekä kohteen poistaminen ja tuhoaminen. Lisäksi kaikki komentosarjassa muokattavaksi varatut muut kohteet pitää saman komentosarjansuorituksen aikana myös palauttaa muokkauksesta.
VaultSharedVariables MFilesAPI.NamedValues Sisään/Ulos Kokoelma nimettyjä arvoja, jotka tallennetaan dokumenttivaraston tietokantaan. Muuttujan avulla komentosarjat voivat tallentaa omia arvojaan tietokantaan siten, että ne ovat kaikkien muidenkin komentosarjojen käytettävissä. Sallittuja tietotyyppejä nimetyille arvoille ovat kokonaislukumuuttujat, totuusarvot ja merkkijonot.

Seuraava esimerkki tallentaa arvon 123 nimetyksi arvoksi ja asettaa sen jälkeen numeroperustaisen lasketun arvon arvoksi.

VaultSharedVariables( "Message" ) = 123

Output = VaultSharedVariables( "Message" )
View MFilesAPI.View Sisään Sisältää näkymän, jota tapahtumakäsittelijässä ollaan käsittelemässä.

Ominaisuusmäärittelyt, joita ei näytetä komentosarjoille

Seuraavassa taulukossa lueteltuja ominaisuusmäärittelyjä ei näytetä silloin, kun käytetään PropertyValues -muuttujaa komentosarjoissa:

ID Nimi
24 Tila muuttunut
22 Yksi tiedosto
27 Poistettu
28 Poistanut
33 Kommentti
29 Versioleima
30 Koko palvelimella (tämä versio)
31 Koko palvelimella (kaikki versiot)
32 Merkitty arkistoitavaksi
46 Kokoelman jäsenet (dokumentit)
47 Kokoelman jäsenet (dokumenttikokoelmat)
101 Luokkaryhmät
41 Tehtävänannon kuvaus
42 Määräpäivä
43 Seuraaja
44 Tehtävän suorittajat
45 Merkitty valmiiksi
97 Hylännyt
79 Työnkulun tehtävänanto
81 Käytössäni viimeksi
82 Suosikkinäkymä
89 Kohde muuttunut
90 Suojausasetuksia muutettu
91 Versioleima muuttunut
92 Versiokommentti muuttunut
93 Poistotila muuttunut
96 Ristiriita ratkaistu
105 Kohde muutettu vientiä varten
106 Kohdeversio muutettu vientiä varten

Esimerkiksi seuraava komentosarjan osa aiheuttaa ”Ei löytynyt” -virheen:

Dim DeadlineValue
DeadlineValue = PropertyValues.SearchForProperty(42).TypedValue.DisplayValue
Vihje: Voit hakea tietyn kohteen kaikki ominaisuudet käyttämällä GetProperties -menetelmää.