| Nimi | Tietotyyppi | Tila | Muuttujan käyttötarkoitus |
|---|---|---|---|
| ActivityID | MFilesAPI.TypedValue | In |
Suoritettava toiminnon yksilöllinen tunniste. Voidaan käyttää tunnistamaan, mitä tapahtumia tietty palvelintoiminto aiheuttaa. |
| AllowStateTransition | Boolen haku | Out | Voidaan käyttää sallimaan tai estämään automaattinen tilasiirtymä suoritettaessa automaattisen tilasiirtymän komentosarja. |
| CurrentTransactionID | MFilesAPI.TypedValue | In |
Tapahtuman ID-tunniste. Jos tapahtumakäsittelijät suoritetaan rekursiivisesti (yhden suorittaminen aiheuttaa toisen suorittamisen), ID muuttuu jokaisella rekursiotasolla. |
| CurrentUserID | MFilesAPI.Number | In | Sisältää sen käyttäjän ID:n, jonka tekemän toiminnon seurauksena komentosarjaa suoritetaan. |
| CurrentUserSessionInfo | MFilesAPI.SessionInfo | In |
Sisältää tietoa toiminnon aiheuttaneen käyttäjän kirjautumisistunnosta. |
| DisplayID | MFilesAPI.TypedValue | In | Sisältää kohteen yksikäsitteisen tunnisteen (ID:n). Tämä ID näkyy käyttäjille M-Files Desktopin ominaisuusalueella, kun kohde on valittuna listauksessa. 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 | In | Sisältää käyttäjäkohtaisen tiedonsiirtotunnisteen. Tiedonsiirtotunniste muodostetaan, kun tiedonsiirtoa ollaan käynnistämässä palvelimella. Samassa yhteydessä tämä sama tiedonsiirtotunniste annetaan BeforeFileUpload- ja BeforeFileDownload-tapahtumakäsittelijöille. Myöhemmin, kun tiedonsiirto on päättynyt, sama tiedonsiirtotunniste annetaan 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 | In | Sisältää kohdetiedoston täydellisen yksikäsitteisen tunnisteen, joka koostuu tiedoston ID:stä ja tiedoston versionumerosta. |
| GetExtensionObject | (Metodi) | Ei tilaa | Metodi varastosovelluksella määritetyn laajennuksen hakemiseen. Käyttö: GetExtensionObject( <kohteen nimi> [, sovelluksen GUID]), jossa [, 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. |
| Input | MFilesAPI.TypedValue | In |
Asiakasohjelmistolla määritetty parametri VaultExtensionMethod-tapahtumakäsittelijälle. |
| LastUsed | MFilesAPI.TypedValue | In |
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 VBScript-koodin 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 | In | Sisältää uloskirjautumisen jälkeen uloskirjautuneen käyttäjän ID:n. |
| LoginAccount | MFilesAPI.LoginAccount | In | Sisältää kirjautumistilanteessa käyttäjän käyttäjätilin tiedot. |
| MasterTransactionID | MFilesAPI.TypedValue | In |
Tapahtuman ID-tunniste. Jos tapahtumakäsittelijät suoritetaan rekursiivisesti (yhden suorittaminen aiheuttaa toisen suorittamisen), tapahtuman ID on ensimmäisen tapahtuman ID. |
| MFScriptCancel | MFilesAPI.Number | In |
Sisältää virhekoodin, jonka avulla komentosarjat voivat näyttää käyttäjille selkeitä virheilmoituksia. Tavallisesti M-Files saattaa lisätä virheilmoituksiin tarkennuksia, jotka MFScriptCancel-muuttujan sisältämän virhekoodin avulla voidaan estää. Esimerkiksi: Err.Raise MFScriptCancel, "This is the error message shown to the user." |
| NextStateID | MFilesAPI.Number | Out | 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 | In | Sisältää tarkasteltavana olevan kohteen nykyiset suojausasetukset. |
| ObjID | MFilesAPI.ObjID | In |
Käsiteltävänä olevan kohteen ID-tunniste. |
| ObjVer | MFilesAPI.ObjVer | In | Sisältää kohdeversion täydellisen yksikäsitteisen tunnisteen, joka koostuu kohdetyypin ID:stä, kohteen sisäisestä ID:stä ja kohteen versionumerosta. |
| Output | MFilesAPI.TypedValue | Out |
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äätarkoituksena on yleensä muodostaa uusi haluttu arvo ja asettaa se Output-muuttujan uudeksi arvoksi, jolloin se tallentuu kohteen metatietoihin. Mikäli VBScript-koodi ei aseta Output-muuttujan arvoa, laskettavan ominaisuuden arvo kohteen metatiedoissa ei muutu. Output-muuttujan arvon voi yksinkertaisissa tapauksissa asettaa suoralla sijoituslauseella, esimerkiksi seuraavasti: Output = 123 Mikäli laskettavan ominaisuuden tietotyyppi on esimerkiksi Valitse listasta, on suositeltavaa asettaa Output-muuttujan arvo käyttämällä sen SetValue-metodia (ks. M-Files API) esimerkiksi seuraavasti: Output.SetValue MFDatatypeLookup, 101 |
| ParentTransactionID | MFilesAPI.TypedValue | In |
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 | In | Sisältää laskettavana olevan ominaisuusmäärittelyn tiedot, kuten ominaisuusmäärittelyn ID:n, nimen ja tietotyypin. |
| PropertyValue | MFilesAPI.PropertyValue | In | Sisältää ominaisuusarvon. Kukin ominaisuusarvo on PropertyValues-muuttujassa PropertyValue-tyyppisenä muuttujana. Tietyn ominaisuusarvon voi hakea käyttämällä SearchForProperty-metodia. |
| PropertyValues | MFilesAPI.PropertyValues | In | Sisältää kohdeversion kaikki tämänhetkiset ominaisuusarvot (esim. Nimi, Projekti ja Asiakas). Kukin ominaisuusarvo on PropertyValues-muuttujassa PropertyValue-tyyppisenä muuttujana. Tietyn ominaisuusarvon voi hakea käyttämällä SearchForProperty-metodia. |
| RestoredVersions | MFilesAPI.IDs | In | Sisältää viedyn kohteen kohdeversiot, jotka tuotiin sisältöpaketista. |
| SavepointVariables | MFilesAPI.NamedValues | In/Out | 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 | In | Sisältää suorituksessa olevan ajastetun työn kuvauksen. |
| ScheduledJobOutputInfo | MFilesAPI.ScheduledJobOutputInfo | In | Sisältää ajastetun työn suorittamisen jälkeen tietoa ajastetun työn lopputuloksesta. |
| StateID | MFilesAPI.Number | In | Sisältää työnkulun tilan tunnisteen, jonka avulla työnkulkuihin liittyvissä komentosarjoissa voidaan yksikäsitteisesti tunnistaa käsiteltävä tila. |
| StateTransitionID | MFilesAPI.Number | In |
Tilasiirtymän ID-tunniste. |
| TransactionCache | MFilesAPI.NamedValues | In/Out |
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 | In |
Varaston käyttäjän tiedot. |
| UserGroupAdmin | MFilesAPI.UserGroupAdmin | In | Varaston käyttäjäryhmän tiedot. |
| ValueListItem | MFilesAPI.ValueListItem | In | Sisältää arvolistan arvon, jota tapahtumakäsittelijässä ollaan käsittelemässä. |
| Vault | MFilesAPI.Vault | In |
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. Vault-olion 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 | In/Out |
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" ) |