VBScript - Erläuterung der Variablen

VBScript-Code kann im Fenster VBScript-Code bearbeiten bearbeitet werden. Folgende Variablen können im VBScript-Code verwendet werden:

AllowStateTransition

Name der Variablen: AllowStateTransition

Datentyp der Variablen: Boolesch (siehe M-Files API)

Verwendung der Variablen:

Die Variable „AllowStateTransition“ kann verwendet werden, um einen automatischen Statuswechsel beim Ausführen des Skripts für automatischen Statuswechsel zuzulassen oder zu verweigern. Wenn der boolesche Wert der Variablen nach Fertigstellung des Skripts „wahr“ ist, wechselt das Objekt in den durch die Variable NextStateIDfestgelegten Objektstatus.

CurrentUserID

Name der Variablen: CurrentUserID

Datentyp der Variablen: Zahl (siehe M-Files API)

Verwendung der Variablen:

Die Variable „CurrentUserID“ enthält die ID des Benutzers, der für das Auslösen des Skripts verantwortlich ist.

DisplayID

Name der Variablen: DisplayID

Datentyp der Variablen: TypedValue (siehe „M-Files API“)

Verwendung der Variablen:

Die Variable „DisplayID“ enthält die eindeutige Objekt-ID. Diese ID wird den Benutzern im Eigenschaftsbereich von M-Files Desktop angezeigt, wenn das Objekt in der Liste ausgewählt ist. Die DisplayID kann aus Zahlen und Buchstaben bestehen. Häufig stimmt die DisplayID mit der internen ID des Objekts überein, deren Wert mit der Variablen „ObjVer“ abgerufen werden kann. Die interne ID darf nur aus Zahlen bestehen. Wenn das Objekt aus einer externen Datenbank importiert wurde, unterscheiden sich die DisplayID und die interne ID.

FileTransferSessionID

Name der Variablen: FileTransferSessionID

Datentyp der Variablen: Zahl (siehe M-Files API)

Verwendung der Variablen:

Die Variable „FileTransferSessionID“ enthält die benutzerspezifische ID für Datenübertragung. Die Datenübertragungs-ID wird erstellt, wenn die Datenübertragung auf dem Server gestartet wurde. Gleichzeitig wird dieselbe ID den Ereignishandlern „BeforeFileUpload“ und „BeforeFileDownload“ zugeordnet. Nach Abschluss der Datenübertragung wird dieselbe Datenübertragungs-ID den Ereignishandlern „AfterFileUpload“ und „AfterFileDownload“ zugewiesen. Somit können die Ereignishandler des Typs „Before“ den Ereignishandlern des Typs „After“ zugeordnet werden.

FileVer

Name der Variablen: FileVer

Datentyp der Variablen: FileVer (siehe M-Files API)

Verwendung der Variablen:

Die Variable „FileVer“ enthält die vollständige eindeutige ID der Zieldatei. Diese besteht aus der Datei-ID und der Dateiversion.

LoggedOutUserID

Name der Variablen: LoggedOutUserID

Datentyp der Variablen: Zahl (siehe M-Files API)

Verwendung der Variablen:

Die Variable „LoggedOutUserID“ enthält die ID des abgemeldeten Benutzers nach der Abmeldung.

LoginAccount

Name der Variablen: LoginAccount

Datentyp der Variablen: LoginAccount (siehe M-Files API)

Verwendung der Variablen:

Die Variable „LoginAccount“ enthält die Benutzerkontodaten für die Anmeldung.

MFScriptCancel

Name der Variablen: MFScriptCancel

Datentyp der Variablen: Zahl (siehe M-Files API)

Verwendung der Variablen:

Die Variable „MFScriptCancel“ enthält den Fehlercode, der von den Skripten verwendet wird, um Benutzern Fehlermeldungen anzuzeigen. M-Files fügt den Fehlermeldungen häufig detaillierte Daten hinzu. Dies kann mit dem Fehlercode der Variable „MFScriptCancel“ vermieden werden.

Beispiel: Err.Raise MFScriptCancel, "Das ist die dem Benutzer angezeigte Fehlermeldung."

Variable NextStateID

Name der Variablen: Variable NextStateID

Datentyp der Variablen: Zahl (siehe M-Files API)

Verwendung der Variablen:

Während des automatischen Statuswechsels enthält die Variable „NextStateID“ die ID des Status, für den der automatische Statuswechsel ausgeführt werden soll. 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

Name der Variablen: ObjectAccessControlList

Datentyp der Variablen: AccessControlList (siehe M-Files API)

Verwendung der Variablen:

Die Variable „ObjectAccessControlList“ enthält die aktuellen Berechtigungen des angezeigten Objekts.

ObjVer

Name der Variablen: ObjVer

Datentyp der Variablen: ObjVer (siehe „M-Files API“)

Verwendung der Variablen:

Die Variable „ObjVer“ 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.

PropertyDef

Name der Variablen: PropertyDef

Datentyp der Variablen: PropertyDef (siehe „M-Files API“)

Verwendung der Variablen:

Die Variable „PropertyDef“ enthält die Informationen über den berechneten Eigenschaftswert, darunter die ID der Eigenschaftswertdefinition sowie den Namen und den Datentyp.

PropertyValue

Name der Variablen: PropertyValue

Datentyp der Variablen: PropertyValue (siehe M-Files API)

Verwendung der Variablen:

Die Variable „PropertyValue“ enthält den angezeigten Eigenschaftswert. Bei der Überprüfung des Eigenschaftswerts auf Richtigkeit kann der fehlerhafte Eigenschaftswert wie in folgendem Beispiel dem Benutzer gemeldet werden: Err.Raise MFScriptCancel, "Der eingegebene Wert ist ungültig."

PropertyValues

Name der Variablen: PropertyValues

Datentyp der Variablen: PropertyValues (siehe „M-Files API“)

Verwendung der Variablen:

Die Variable „PropertyValues“ enthält alle aktuellen Eigenschaftswerte für die Zielversion (wie Name, Projekt und Kunde). Alle Eigenschaftswerte werden in PropertyValues als Variable vom Typ PropertyValue gespeichert.

Ein bestimmter Eigenschaftswert kann mit der Methode SearchForProperty abgerufen werden. Weitere Informationen finden Sie in der Dokumentation für MFiles API.

RestoredVersions

Name der Variablen: RestoredVersions

Datentyp der Variablen: IDs (siehe M-Files API)

Verwendung der Variablen:

Die Variable „RestoredVersions“ enthält Versionen des exportierten Objekts, die aus dem Inhaltspaket importiert wurden.

ScheduledJob

Name der Variablen: ScheduledJob

Datentyp der Variablen: ScheduledJob (siehe M-Files API)

Verwendung der Variablen:

Die Variable „ScheduledJob“ enthält eine Beschreibung des geplanten Auftrags, der gerade ausgeführt wird.

ScheduledJobOutputInfo

Name der Variablen: ScheduledJobOutputInfo

Datentyp der Variablen: ScheduledJobOutputInfo (siehe M-Files API)

Verwendung der Variablen:

Die Variable „ScheduledJobOutputInfo“ enthält Informationen zum Ergebnis des geplanten Auftrags, nachdem der Auftrag ausgeführt wurde.

StateID

Name der Variablen: StateID

Datentyp der Variablen: Zahl (siehe M-Files API)

Verwendung der Variablen:

Die Variable „StateID“ enthält die ID des Workflowstatus, mit deren Hilfe der Prozessstatus in Skripten für die Workflows erkannt werden kann.

ValueListItem

Name der Variablen: ValueListItem

Datentyp der Variablen: ValueListItem (siehe M-Files API)

Verwendung der Variablen:

Die Variable „ValueListItem“ enthält den Wert der Werteliste, der gerade im Ereignishandler verarbeitet wird.

Vault

Name der Variablen: Vault

Datentyp der Variablen: Vault (siehe M-Files API)

Verwendung der Variablen:

Die Variable „Vault“ 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 Dokumentenverwaltungsentität an der Dokumentenverwaltung vorgenommenen Änderungen rückgängig gemacht.

Die Verwendung der Dokumentenverwaltungsentität bei Skripten unterliegt gewissen Beschränkungen. Das Skript kann nicht mit der Dokumentenverwaltungsentität den Status des Objekts ändern, für das das Skript 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

Name der Variablen: VaultSharedVariables

Datentyp der Variablen: NamedValues (siehe M-Files API)

Verwendung der Variablen:

Die Variable „VaultSharedVariables“ ist eine Sammlung von benannten Werten, die in der Dokumentenverwaltungsdatenbank gespeichert sind. 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( "Nachricht" ) = 123

Output = VaultSharedVariables( "Nachricht" )

Anmerkung: Der Administrator muss bereits mit der VBScript-Programmiersprache vertraut sein. Anweisungen zum Schreiben des VBScript-Codes sind in M-Files oder der M-Files API-Dokumentation nicht enthalten. Die Dokumentation zur M-Files API befindet sich im Ordner Start > Alle Programme > M-Files > Dokumentation >M-Files API. Weitere Informationen über den VBScript-Code und die M-Files API erhalten Sie unter [email protected]. Anweisungen zum Erstellen von VBScript-Code sowie zur Verwendung der M-Files API erhalten Sie kostenpflichtig beim technischen Support von M-Files.