Verfügbare VBScript-Variablen
| Variable | Datentyp | Modus | Verwendung |
|---|---|---|---|
| ActivityID | MFilesAPI.TypedValue | Eingehend | Die eindeutige ID des Vorgangs, der durchgeführt wird. Kann dazu verwendet werden, zu bestimmen, welche Ereignisse durch einen bestimmten Servervorgang hervorgerufen werden. |
| AllowStateTransition | Boolean | Ausg. | Kann verwendet werden, um einen automatischen Statuswechsel beim Ausführen des Skripts für automatische Statuswechsel zuzulassen oder zu verweigern. |
| CurrentTransactionID | MFilesAPI.TypedValue | Eingehend | Die ID der Transaktion. Falls der Ereignishandler rekursiv ausgeführt wird (d.h. ein Ereignis löst die Ausführung eines anderen aus), ändert sich die ID auf jeder Rekursionsebene. |
| CurrentUserID | MFilesAPI.Number | Eingehend | Enthält die ID des Benutzers, der für das Auslösen des Skripts verantwortlich ist. |
| CurrentUserSessionInfo | MFilesAPI.SessionInfo | Eingehend | Enthält Information über die Sitzung des Benutzers, der diesen Vorgang veranlasst hat. |
| DisplayID | MFilesAPI.TypedValue | Eingehend | Enthält die eindeutige ID des Objekts. Die ID wird Benutzern im Eigenschaftenbereich von M-Files Desktop angezeigt, wenn das Objekt in der Liste ausgewählt wird. DisplayID kann aus Zahlen und Buchstaben bestehen. Häufig stimmt die DisplayID mit der internen ID des Objekts überein, deren Wert abgerufen werden kann unter Verwendung der ObjVer festgelegten Objektstatus. Die interne ID darf nur aus Zahlen bestehen. DisplayID und die interne ID ist in der Regel unterschiedlich, wenn das Objekt aus einer externen Datenbank importiert wurde. |
| FileTransferSessionID | MFilesAPI.Number | Eingehend | Enthält die benutzerspezifische ID für die Datenübertragung. Die Datenübertragungs-ID wird erstellt, wenn die Datenübertragung auf dem Server gestartet wurde. Gleichzeitig wird dieselbe ID den BeforeFileUpload und BeforeFileDownload Ereignishandler. Nach Abschluss der Datenübertragung wird dieselbe Datenübertragungs-ID den AfterFileUpload und AfterFileDownload Ereignishandler. Somit können die Ereignishandler des Typs „Before“ den Ereignishandlern des Typs „After“ zugeordnet werden. |
| FileVer | MFilesAPI.FileVer | Eingehend | Enthält die vollständige eindeutige ID der Zieldatei. Diese besteht aus der Datei-ID und der Dateiversion. |
| GetExtensionObject | (Methode) | N/Z | Eine Methode zum Abrufen des Erweiterungsobjekts, das durch die Dokumentenverwaltungsanwendung definiert wird. Verwendung: GetExtensionObject( <Objektname> [, Anwendungs-GUID]), wobei der Teil [, Anwendungs-GUID] optional ist. Beispiel: Set CK = GetExtensionObject("M-Files.ComplianceKit", "{0CAC5452-631F-4646-AC95-4A06BFB8147E}") Falls die Anwendungs-GUID nicht festgelegt wurde, wird das Erweiterungsobjekt in allen Anwendungen der Dokumentenverwaltung gesucht. |
| GroupID | MFilesAPI.Number | Eingehend | Die ID der Zielbenutzergruppe. |
| Input | MFilesAPI.TypedValue | Eingehend | Ein kundendefinierter Parameter für den VaultExtensionMethod Ereignishandler. |
| IsCancellable | MFilesAPI.BooleanValue | Eingehend | Normalerweise können Skripte einen Servervorgang abbrechen und die damit im Zusammenhang stehenden Transaktion rückgängig machen, wenn ein Fehler im Skript auftritt. Die IsCancellable Variable legt fest, ob das Skript diesen Vorgang ausführen darf. Falls der Wert der Variable false ist, ignoriert M-Files Server jegliche Fehler, die vom Skript verursacht werden. Falls im Skript ein Fehler auftritt, während der Variablenwert false lautet, wird ein Fehler im Windows-Ereignisprotokoll eingetragen und alle Änderungen, die über das Skript ausgeführt wurden, werden rückgängig gemacht. Der Server fährt fort und schließt den Vorgang ab. |
| LastUsed | MFilesAPI.TypedValue | Eingehend | Nur verfügbar, falls ein benutzerdefinierte automatische Nummer als Eigenschaft berechnet wird. Der Wert einer automatischen Nummer hängt in der Regel von der vorangehenden Berechnung ab. Bei einer gewöhnlichen aufeinanderfolgenden Nummerierung wird der Wert beispielsweise jedes Mal um 1 vergrößert. Beim Konfigurieren von benutzerdefinierten automatischen Nummern kann das Ergebnis der vorhergehenden Berechnung mit der LastUsed Variable. Eine einfache automatische Nummerierung mit einer Erhöhung um den Wert 1 kann beispielsweise mit dem folgenden einfachen VBScript-Code durchgeführt werden: Output = LastUsed + 1 |
| LoggedOutUserID | MFilesAPI.Number | Eingehend | Enthält die Benutzer-ID nach der Abmeldung. |
| LoginAccount | MFilesAPI.LoginAccount | Eingehend | Enthält die Benutzerkontodaten bei der Anmeldung. |
| MasterTransactionID | MFilesAPI.TypedValue | Eingehend | Die ID der Transaktion. Falls die Ereignishandler rekursiv ausgeführt werden (d.h. ein Ereignis löst die Ausführung eines anderen aus), ist die Transaktions-ID die ID der ersten Transaktion. |
| MemberID | MFilesAPI.Number | Eingehend | Die ID des Mitglieds, das zu einer Benutzergruppe hinzugefügt oder aus einer Benutzergruppe entfernt wird. Der Wert ist negativ, wenn das Mitglied eine Benutzergruppe ist. |
| MFScriptCancel | MFilesAPI.Number | Eingehend | Enthält den Fehlercode, der von den Skripten dazu verwendet wird, eine Fehlernachricht für die Benutzer anzuzeigen. M-Files fügt Fehlermeldungen oft detaillierte Daten hinzu. Dies kann mit dem Fehlercode der MFScriptCancel Variable vermieden werden. Beispiel: Err.Raise MFScriptCancel, "Die ist die Fehlermeldung, die dem Benutzer angezeigt wird". |
| NextStateID | MFilesAPI.Number | Ausg. | Während des automatischen Statuswechsels enthält die NextStateID Variable die ID des Status, für den der automatische Statuswechsel durchgeführt wird. Durch eine Änderung des Wertes dieser Variablen können Sie den nächsten Status im Skript für den automatischen Statuswechsel festlegen. Standardmäßig entspricht der Zielstatus dem Status, der über die Benutzeroberfläche für die Option Nächster Status festgelegt wurde. |
| ObjectAccessControlList | MFilesAPI.ObjectAccessControlList | Eingehend | Enthält die aktuellen Berechtigungen des betrachteten Objekts. |
| ObjID | MFilesAPI.ObjID | Eingehend | Die ID des bearbeiteten Objekts. |
| ObjVer | MFilesAPI.ObjVer | Eingehend | Enthält die vollständige eindeutige ID der Zielversion, die aus der ID des Objekttyps, der internen ID des Objekts sowie der Version des Objekts besteht. |
| Output | MFilesAPI.TypedValue | Ausg. | Nur verfügbar, falls ein benutzerdefinierte automatische Nummer als Eigenschaft berechnet wird. Zu Beginn der Ausführung des VBScript-Codes, enthält die Variable Output (mit Ausnahme automatischer Nummerierungen) den aktuellen Wert der berechneten Eigenschaft. Hauptzweck des VBScript-Codes besteht normalerweise darin, einen neuen Wert zu erstellen und diesen Wert der Variable Output zuzuweisen, die dann in den Metadaten des Objekts gespeichert wird. Falls der VBScript-Code den Wert der Output Variablen nicht definiert, bleibt der Eigenschaftenwert in den Metadaten unverändert. In einfachen Fällen kann der Wert der Output-Variable wie im folgenden Beispiel mit einer einfachen Anweisung festgelegt werden: Output = 123 Falls der Datentyp des errechneten Werts Aus Liste auswählen stammt, wird die SetValue Methode für das Einstellen des Werts der Output Variable empfohlen (siehe M-Files Programmierschnittstelle und kann beispielsweise wie folgt aussehen: Output.SetValue MFDatatypeLookup, 101 |
| ParentTransactionID | MFilesAPI.TypedValue | Eingehend | Die ID der Transaktion. Falls die Ereignishandler rekursiv ausgeführt werden (d.h. ein Ereignis löst die Ausführung eines anderen aus), ist die Transaktions-ID die ID der vorherigen (aufrufenden) Transaktion. |
| PropertyDef | MFilesAPI.PropertyDef | Eingehend | Enthält die Informationen über den berechneten Eigenschaftswert, darunter die ID der Eigenschaftswertdefinition sowie den Namen und den Datentyp. |
| PropertyValue | MFilesAPI.PropertyValue | Eingehend | Enthält einen Eigenschaftswert. Jeder Eigenschaftswert wird gespeichert in der PropertyValues Variablen als eine Variable des Typs PropertyValue stehen. Eine bestimmter Eigenschaftswert kann abgerufen werden mittels der SearchForProperty Methode. |
| PropertyValues | MFilesAPI.PropertyValues | Eingehend | Enthält alle Eigenschaftswerte der Zielversion, die von der aktuellen Aktion betroffen wird. Jeder Eigenschaftswert wird gespeichert in der Variablen PropertyValues als eine Variable des Typs PropertyValue stehen. Eine bestimmter Eigenschaftswert kann abgerufen werden mittels der SearchForProperty Methode. Hinweis: Einige Eigenschaftsdefinitionen werden nicht dargestellt, wenn die PropertyValues Variable in Scripts eingesetzt wird (siehe Eigenschaftsdefinitionen, die für Scripts nicht angezeigt werden.). |
| RestoredVersions | MFilesAPI.IDs | Eingehend | Enthält Versionen des exportierten Objekts, die aus dem Inhaltspaket importiert wurden. |
| SavepointVariables | MFilesAPI.NamedValues | Eing./Ausg. | Ein Container für optionale Namenwertpaare, die für eine einzelne Transaktion gespeichert werden. Der Container macht die Änderungen automatisch rückgängig, die von fehlgeschlagenen Vorgängen im Container hervorgerufen worden sind. |
| ScheduledJob | MFilesAPI.ScheduledJob | Eingehend | Enthält eine Beschreibung des geplanten Auftrags, der gerade ausgeführt wird. |
| ScheduledJobOutputInfo | MFilesAPI.ScheduledJobOutputInfo | Eingehend | Enthält Informationen zum Ergebnis des geplanten Auftrags, nachdem der Auftrag ausgeführt wurde. |
| StateID | MFilesAPI.Number | Eingehend | Enthält die ID des Workflowstatus, mit deren Hilfe der Prozessstatus in Skripten für die Workflows erkannt werden kann. |
| StateTransitionID | MFilesAPI.Number | Eingehend | Die ID des Statuswechsels. |
| TransactionCache | MFilesAPI.NamedValues | Eing./Ausg. | Ein Container für optionale Namenwertpaare, die für eine einzelne Transaktion gespeichert werden. Der Container behält alle Änderungen zurück, sogar dann, wenn sie durch einen fehlerhaften Vorgang hervorgerufen wurden, der zu einem Abbruch führte. |
| UserAccount | MFilesAPI.UserAccount | Eingehend | Dokumentenverwaltung Benutzerinformation |
| UserGroupAdmin | MFilesAPI.UserGroupAdmin | Eingehend | Dokumentenverwaltung Benutzergruppeninformation |
| ValueListItem | MFilesAPI.ValueListItem | Eingehend | Enthält den Wert der Werteliste, der gerade im Ereignishandler verarbeitet wird. |
| Vault | MFilesAPI.Vault | Eingehend | Steht für die Dokumentenverwaltung, die beim Ausführen des Skripts verwendet wird. Mit der ID kann das Skript die Inhalte der Dokumentenverwaltung auf dieselbe Weise verwenden, wie dies mit der M-Files API möglich ist. Wenn ein Fehler auftritt, werden alle durch die Entität Vault an der Dokumentenverwaltung vorgenommenen Änderungen rückgängig gemacht.
Die Verwendung der Entität Vault bei Skripten unterliegt gewissen Beschränkungen. Die Skripte können über die Entität Vault den Status des Objekts nicht ändern, dessen Script ausgeführt wird. Der Statuswechsel bezieht sich auf das Aus- und Einchecken des Objekts, das Rückgängigmachen des Auscheckvorgangs und das Löschen und dauerhafte Löschen des Objekts. Außerdem müssen alle anderen im Skript ausgecheckten Objekte eingecheckt werden, während das Skript ausgeführt wird. |
| VaultSharedVariables | MFilesAPI.NamedValues | Eing./Ausg. | Eine Sammlung von benannten Werten, die in der Dokumentenverwaltungsdatenbank gespeichert werden. Mit der Variablen können die Skripte ihre eigenen Werte in der Datenbank speichern, so dass diese auch für andere Skripte verfügbar sind. Die zulässigen Datentypen für benannte Werte sind ganzzahlige Variablen, boolesche Werte und Zeichenfolgen. Im folgenden Beispiel wird der Wert „123“ als benannter Wert gespeichert, und der zahlenbasierte berechnete Wert wird dann als Wert festgelegt. VaultSharedVariables( "Message" ) = 123 Output = VaultSharedVariables( "Message" ) |
| View | MFilesAPI.View | Eingehend | Enthält die Ansicht, die gerade im Ereignishandler verarbeitet wird. |
Eigenschaftsdefinitionen, die für Scripts nicht angezeigt werden.
Die Eigenschaftsdefinitionen, die in der nachfolgenden Tabelle aufgelistet sind, werden bei Benutzung der PropertyValues Variable in den Skripten nicht angezeigt:
| ID | Name |
|---|---|
| 24 | Status geändert |
| 22 | Einzeldatei |
| 27 | Gelöscht |
| 28 | Gelöscht von |
| 33 | Kommentar |
| 29 | Versionsbezeichnung |
| 30 | Größe auf dem Server (diese Version) |
| 31 | Größe auf dem Server (alle Versionen) |
| 32 | Zur Archivierung markiert |
| 46 | Mitglieder der Sammlung (Dokumente) |
| 47 | Mitglieder der Sammlung (Dokumentensammlungen) |
| 101 | Klassengruppen |
| 41 | Beschreibung der Aufgabenzuweisung |
| 42 | Endtermin |
| 43 | Überwacht von |
| 44 | Zugewiesen zu |
| 45 | Als abgeschlossen gekennzeichnet von |
| 97 | Markieren als abgelehnt durch |
| 79 | Workflow-Zuweisung |
| 81 | Zugriff durch den aktuellen Benutzer |
| 82 | Favoritenansicht |
| 89 | Objekt geändert |
| 90 | Berechtigungen geändert |
| 91 | Versionsbezeichnung geändert |
| 92 | Versionskommentar geändert |
| 93 | Löschstatus geändert |
| 96 | Konflikt gelöst |
| 105 | Objekt für Export geändert |
| 106 | Objektversion für Export geändert |
Folgender Script-Teil resultiert beispielsweise in einem „Nicht gefunden“ Fehler:
Dim DeadlineValue DeadlineValue = PropertyValues.SearchForProperty(42).TypedValue.DisplayValue