Denna version av användarhandledningen gäller för uppdateringen maj 2020 och tidigare. För det senaste innehållet, besök vår engelska användarhandledning.
Tillgängliga VBScript-variabler
VBScript-kod redigeras i fönstret Redigera VBScript-kod som finns i följande dialogrutor: De tillgängliga variablerna beskrivs i tabellen nedan.
Notera: Dokumentationen om M-Files API finns på www.m-files.com/api/documentation/latest. Mer information om att använda VBScript
i M-Files finns i Hur skriver jag VBScript-kod för M-Files-syften?-självstudierna.
| Variabel | Datatyp | Läge | Användning |
|---|---|---|---|
| ActivityID | MFilesAPI.TypedValue | In | Unikt ID för den åtgärd som behandlas. Kan användas för att identifiera vilka händelser som orsakas av en viss serveråtgärd. |
| AllowStateTransition | Boolean | Ut | Kan användas för att godkänna eller neka automatisk tillståndsövergång när scriptet för den automatiska tillståndsövergången körs. |
| CurrentTransactionID | MFilesAPI.TypedValue | In | ID för transaktionen. Om händelsehanterare utförs rekursivt (så att en händelse som utförs leder till att en annan händelse utförs) ändras ID:t på rekursiv nivå. |
| CurrentUserID | MFilesAPI.Number | In | Innehåller ID:t för den användare som utför åtgärden som initierar scriptet. |
| CurrentUserSessionInfo | MFilesAPI.SessionInfo | In | Innehåller information om inloggningssessionen för den användare som orsakade åtgärden. |
| DisplayID | MFilesAPI.TypedValue | In | Innehåller objektets unika ID. Användare ser detta ID i egenskapsområdet för M-Files Desktop när objektet är markerat i listan. DisplayID kan innehålla både siffror och bokstäver. Ofta är DisplayID samma som objektets interna ID vars värde kan hämtas med ObjVer-variabeln. Ett internt ID kan bara innehålla siffror. DisplayID och det interna ID:t är vanligtvis olika när objektet har importerats från en extern databas. |
| FileTransferSessionID | MFilesAPI.Number | In | Innehåller identifieraren för överföring av användarspecifika data. Identifieraren för dataöverföring skapas när dataöverföringen startas på servern och samma identifierare samtidigt ges till BeforeFileUpload och BeforeFileDownload-händelsehanterare. När dataöverföringen är klar ges samma identifierare för dataöverföring till AfterFileUpload och AfterFileDownload-händelsehanterare. Det gör att du kan ansluta händelsehanterare av typen Före till händelsehanterare av typen Efter. |
| FileVer | MFilesAPI.FileVer | In | Innehåller det fullständiga unika ID:t för målfilen, vilket består av fil-ID och filversion. |
| GetExtensionObject | (metod) | Inte tillämpligt | En metod för att hämta filtilläggsobjektet som definieras av valvprogrammet. Använd: GetExtensionObject( <objektnamn> [, program-GUID]), där delen [, program-GUID] är valfri. Till exempel: Set CK = GetExtensionObject("M-Files.ComplianceKit", "{0CAC5452-631F-4646-AC95-4A06BFB8147E}") Om program-GUID inte har angetts eftersöks filtilläggsobjektet i alla program i valvet. |
| Input | MFilesAPI.TypedValue | In | En klientdefinierad parameter för VaultExtensionMethod-händelsehanterare. |
| IsCancellable | MFilesAPI.BooleanValue | In | Normalt sett kan script avbryta en serveråtgärd och återställa den associerade transaktionen genom att skapa ett fel i scriptet. IsCancellable-variabeln anger om scriptet är tillåtet att göra detta. Om värdet för variablerna är false kommer M-Files Server att ignorera alla fel som skapas i scriptet. Men om scriptet skapar ett fel medan värdet för variablerna är false skrivs ett fel i Windows-händelseloggen och alla ändringar som görs via scriptet återkallas. Serveråtgärden slutförs sedan. |
| LastUsed | MFilesAPI.TypedValue | In | Endast tillgänglig om ett anpassat automatiskt nummer beräknas för en egenskap. Värdet för ett automatiskt nummer är vanligtvis beroende av den föregående beräkningen. I vanlig löpande numrering till exempel ökar det automatiska värdet med ett i taget. När du ställer in anpassad löpande numrering kan resten av de föregående beräkningarna hämtas med hjälp av LastUsed-variabeln. Exempelvis skulle enkel automatisk numrering som ökar med ett kunna implementeras med följande enkla VBScript-kod: Output = LastUsed + 1 |
| LoggedOutUserID | MFilesAPI.Number | In | Innehåller det utloggade användar-ID:t efter utloggning. |
| LoginAccount | MFilesAPI.LoginAccount | In | Innehåller användarkontodata vid inloggning. |
| MasterTransactionID | MFilesAPI.TypedValue | In | ID för transaktionen. Om händelsehanterare utförs rekursivt (så att en händelse som utförs leder till att en annan händelse utförs) är detta transaktions-ID den första transaktionens ID. |
| MFScriptCancel | MFilesAPI.Number | In | Innehåller den felkod som används av scripten för att visa felmeddelanden för användare. M-Files lägger ofta till detaljerade data i felmeddelanden, men detta kan förhindras med felkoden för MFScriptCancel-variabeln. Exempel: Err.Raise MFScriptCancel, ”Det här är det felmeddelande som visas för användaren.” |
| NextStateID | MFilesAPI.Number | Ut | Under den automatiska tillståndsövergången innehåller NextStateID-variabeln ID:t för det tillstånd som den automatiska tillståndsövergången ska utföras för. Genom att ändra värdet för den här variabeln kan du definiera nästa tillstånd i scriptet för den automatiska tillståndsövergången. Som standard är måltillståndet samma som ställts in i alternativet Nästa tillstånd i användargränssnittet. |
| ObjectAccessControlList | MFilesAPI.ObjectAccessControlList | In | Innehåller aktuella behörigheter för det visade objektet. |
| ObjID | MFilesAPI.ObjID | In | ID för det objekt som behandlas. |
| ObjVer | MFilesAPI.ObjVer | In | Innehåller fullständigt ID för målversionen, vilket består av ID för objekttypen, objektets interna ID samt objektversion. |
| Output | MFilesAPI.TypedValue | Ut | Endast tillgänglig om ett anpassat automatiskt nummer beräknas för en egenskap. När VBScript-kod börjar köras innehåller Output-variabeln det aktuella värdet för den egenskap som beräknas (men inte för automatisk numrering). Huvudsyftet med VBScript-kod är vanligtvis att skapa ett nytt värde och tilldela det till Output-variabeln som sedan lagras i objektets metadata. Om VBScript-koden inte anger värdet för Output-variabeln ändras inte egenskapsvärdet i metadata. Värdet för utmatningsvariabeln kan, i enkla fall, ställas in med en enkel sats, till exempel: Output = 123 Om datatypen för värdet som beräknas är Välj från lista blir den SetValue-metod som rekommenderas för att ställa in värdet för Output-variabeln (se M-Files API), till exempel enligt följande: Output.SetValue MFDatatypeLookup, 101 |
| ParentTransactionID | MFilesAPI.TypedValue | In | ID för transaktionen. Om händelsehanterare utförs rekursivt (så att en händelse som utförs leder till att en annan händelse utförs) är detta transaktions-ID för den föregående (anropande) transaktionen. |
| PropertyDef | MFilesAPI.PropertyDef | In | Innehåller information om det egenskapsvärde som beräknas, till exempel egenskapsvärdets definitions-ID, namn och datatyp. |
| PropertyValue | MFilesAPI.PropertyValue | In | Innehåller ett egenskapsvärde. Varje egenskapsvärde lagras i PropertyValues-variabeln som en variabel av typen PropertyValue. Ett visst egenskapsvärde kan hämtas med SearchForProperty-metoden. |
| PropertyValues | MFilesAPI.PropertyValues | In | Innehåller målversionens alla egenskapsvärden som påverkats av den aktuella åtgärden. Varje egenskapsvärde lagras i PropertyValues-variabeln som en variabel av typen PropertyValue. Ett visst egenskapsvärde kan hämtas med SearchForProperty-metoden. Notera: Vissa egenskapsdefinitioner visas inte vid användning av PropertyValues-variabeln i script (se Egenskapsdefinitioner visas inte för scripts). |
| RestoredVersions | MFilesAPI.IDs | In | Innehåller objektversioner av det exporterade objektet som importerats från innehållspaketet. |
| SavepointVariables | MFilesAPI.NamedValues | In/ut | En behållare för valfria namn-värde-par som lagras under en enskild transaktion. Behållaren återkallar automatiskt de modifieringar som orsakats av misslyckade åtgärder i den. |
| ScheduledJob | MFilesAPI.ScheduledJob | In | Innehåller en beskrivning av det schemalagda jobbet som utförs. |
| ScheduledJobOutputInfo | MFilesAPI.ScheduledJobOutputInfo | In | Innehåller information om det schemalagda jobbets resultat när det har utförts. |
| StateID | MFilesAPI.Number | In | Innehåller identifieraren för arbetsflödestillståndet, vilken kan användas för att känna igen processtillståndet i script som rör arbetsflödena. |
| StateTransitionID | MFilesAPI.Number | In | ID för tillståndsövergången. |
| TransactionCache | MFilesAPI.NamedValues | In/ut | En behållare för valfria namn-värde-par som lagras under en enskild transaktion. Behållaren bevarar alla modifieringar, även om de orsakats av en åtgärd som senare avbröts på grund av ett fel. |
| UserAccount | MFilesAPI.UserAccount | In | Information om valvanvändare. |
| UserGroupAdmin | MFilesAPI.UserGroupAdmin | In | Information om valvanvändargrupper. |
| ValueListItem | MFilesAPI.ValueListItem | In | Innehåller värdelistvärdet som behandlas i händelsehanteraren. |
| Vault | MFilesAPI.Vault | In | Representerar det dokumentvalv som används för att köra scriptet. Med identifieraren kan scriptet hantera dokumentvalvets innehåll på samma sätt som det går att göra med M-Files API-användargränssnittet. I en felsituation kommer alla ändringar som har gjorts i dokumentvalvet genom Vault-disken att avbrytas.
Att använda Vault-disken med script innebär vissa begränsningar. Scripten kan inte genom Vault-disken ändra tillståndet för de objekt som scriptet körs till. Tillståndsändringen gäller för att checka ut objektet, checka in objektet, ångra utcheckning samt ta bort och förstöra objektet. Dessutom måste alla andra objekt som checkas ut i scriptet checkas in medan samma script körs. |
| VaultSharedVariables | MFilesAPI.NamedValues | In/ut | En samling namngivna värden som lagras i dokumentvalvets databas. Med variabeln kan scripten lagra sina egna värden i databasen så att de också finns tillgängliga för andra script. Tillåtna datatyper för de namngivna värdena är heltalsvariabler, booleska variabler och strängar. I följande exempel lagras värdet 123 som ett namngivet värde och det nummerbaserade beräknade värdet ställs sedan in som värdet. VaultSharedVariables( "Message" ) = 123 Output = VaultSharedVariables( "Message" ) |
| View | MFilesAPI.View | In | Innehåller den vy som behandlas i händelsehanteraren. |
Egenskapsdefinitioner visas inte för scripts
Egenskapsdefinitionerna listade i tabellen nedan visas inte vid användning av PropertyValues-variabeln i scripts:
| Namn | ID |
|---|---|
| Status ändrad | 24 |
| En fil | 22 |
| Borttagen | 27 |
| Borttagen av | 28 |
| Kommentar | 33 |
| Versionsetikett | 29 |
| Storlek på servern (den här versionen) | 30 |
| Storlek på servern (alla versioner) | 31 |
| Markerad för arkivering | 32 |
| Samlingsmedlemmar (dokument) | 46 |
| Samlingsmedlemmar (dokumentsamlingar) | 47 |
| Klassgrupper | 101 |
| Beskrivning av uppgiften | 41 |
| Tidsgräns | 42 |
| Övervakas av | 43 |
| Tilldelad | 44 |
| Markerad som slutförd av | 45 |
| Markerad som avvisad av | 97 |
| Arbetsflödesuppgift | 79 |
| Har använts av mig | 81 |
| Favoritvy | 82 |
| Objektet har ändrats | 89 |
| Behörigheter har ändrats | 90 |
| Versionsetikett har ändrats | 91 |
| Versionskommentar har ändrats | 92 |
| Borttagningsstatus har ändrats | 93 |
| Konflikten har lösts | 96 |
| Objekt har ändrats för export | 105 |
| Objektversion har ändrats för export | 106 |
Till exempel, följande del av scriptresultaten i ett ”kunde inte hittas”-fel:
Dim DeadlineValue DeadlineValue = PropertyValues.SearchForProperty(42).TypedValue.DisplayValue
Tips: Du kan använda GetProperties metoden för att få egenskaperna för ett specifikt objekt.