Le code VBScript est édité dans la fenêtre Édition du code VBScript. Les variables suivantes peuvent être utilisées dans le code VBScript :
Nom de variable : AllowStateTransition
Type de données de variable : Boolean (voir M-Files API)
Utilisation de la variable :
La variable AllowStateTransition peut être utilisée pour autoriser ou refuser une transition d'étape automatique lors de l'exécution du script de transition d'étape automatique. Si le résultat booléen de la variable est "vrai" après la fin du script, l'objet passe à l'étape d'objet spécifiée par la variable NextStateID.
Nom de variable : CurrentUserID
Type de données de variable : Numéro (voir M-Files API)
Utilisation de la variable :
La variable CurrentUserID contient l'identifiant de l'utilisateur qui a effectué l'opération ayant déclenché le script.
Nom de variable : DisplayID
Type de données de variable : TypedValue (voir M-Files API)
Utilisation de la variable :
La variable DisplayID contient l'identifiant unique de l'objet. Cet identifiant s'affiche aux utilisateurs dans la zone des propriétés de M-Files Desktop lorsque l'objet est sélectionné dans la liste. DisplayID peut contenir à la fois des nombres et des lettres. Souvent, DisplayID est identique à l'identifiant interne de l'objet dont la valeur peut être obtenue avec la variable ObjVer. L'identifiant interne peut contenir uniquement des nombres. DisplayID et l'identifiant interne sont généralement différents lorsque l'objet a été importé d'une base de données externe.
Nom de variable : FileTransferSessionID
Type de données de variable : Numéro (voir M-Files API)
Utilisation de la variable :
La variable FileTransferSessionID contient l'identifiant du transfert de données spécifique de l'utilisateur. L'identifiant du transfert de données est créé quand le transfert de données est démarré sur le serveur et, parallèlement, le même identifiant est donné aux gestionnaires d'événements BeforeFileUpload et BeforeFileDownload. Lorsque le transfert des données est terminé, le même identifiant de transfert de données est attribué aux gestionnaires d'événements AfterFileUpload et AfterFileDownload. Ainsi, il est possible d'attacher les gestionnaires d'événements du type 'Avant' aux gestionnaires d'événements du type 'Après'.
Nom de variable : FileVer
Type de données de variable : FileVer (voir M-Files API)
Utilisation de la variable :
La variable FileVer contient l'identifiant unique complet du fichier cible, composé de l'identifiant du fichier et de la version du fichier.
Nom de variable : LoggedOutUserID
Type de données de variable : Numéro (voir M-Files API)
Utilisation de la variable :
La variable LoggedOutUserID contient l'identifiant d'utilisateur déconnecté après la déconnexion.
Nom de variable : LoginAccount
Type de données de variable : LoginAccount (voir M-Files API)
Utilisation de la variable :
La variable LoginAccount contient les données du compte utilisateur dans la connexion.
Nom de variable : MFScriptCancel
Type de données de variable : Numéro (voir M-Files API)
Utilisation de la variable :
La variable MFScriptCancel contient le code d'erreur utilisé par les scripts pour afficher les messages d'erreur aux utilisateurs. M-Files ajoute souvent des données détaillées aux messages d'erreur ; vous pouvez éviter cela avec le code d'erreur de la variable MFScriptCancel.
Exemple : Err.Raise MFScriptCancel, "C'est le message d'erreur affiché à l'utilisateur."
Nom de variable : NextStateID
Type de données de variable : Numéro (voir M-Files API)
Utilisation de la variable :
Au cours de la transition d'étape automatique, la variable NextStateID contient l'identifiant de l'étape pour laquelle la transition d'étape automatique sera effectuée. En modifiant la valeur de cette variable, vous pouvez définir l'étape suivante dans le script de transition d'étape automatique. Par défaut, l'étape cible est identique à celle définie dans l'option Étape suivante dans l'interface utilisateur.
Nom de variable : ObjectAccessControlList
Type de données de variable : AccessControlList (voir M-Files API)
Utilisation de la variable :
La variable ObjectAccessControlList contient les autorisations actuelles de l'objet affiché.
Nom de variable : ObjVer
Type de données de variable : ObjVer (voir M-Files API)
Utilisation de la variable :
La variable ObjVer contient l'identifiant unique complet de la version, se composant de l'identifiant du type d'objet, de l'identifiant interne de l'objet et de la version de l'objet.
Nom de variable : PropertyDef
Type de données de variable : PropertyDef (voir M-Files API)
Utilisation de la variable :
La variable PropertyDef contient les informations sur la valeur de propriété calculée, par exemple l'identifiant, le nom et le type de données de la définition de valeur de propriété.
Nom de variable : PropertyValue
Type de données de variable : PropertyValue (voir M-Files API)
Utilisation de la variable :
La variable PropertyValue contient la valeur de propriété affichée. Lors de la vérification de l'exactitude de la valeur de propriété, la valeur de propriété incorrecte peut être notifiée à l'utilisateur comme dans l'exemple suivant : Err.Raise MFScriptCancel, "La valeur saisie est invalide."
Nom de variable : PropertyValues
Type de données de variable : PropertyValues (voir M-Files API)
Utilisation de la variable :
La variable PropertyValues contient toutes les valeurs de la propriété courante de la version de destination (telles que le nom, le projet et le client). Chaque valeur de propriété est stockée dans PropertyValues comme variable de type PropertyValue.
Une valeur de propriété peut être obtenue avec la méthode SearchForProperty. Pour davantage d'informations, veuillez-vous reporter à la documentation de M-Files API.
Nom de variable : RestoredVersions
Type de données de variable : identifiants (voir M-Files API)
Utilisation de la variable :
la variable RestoredVersions contient les versions de l'objet exporté qui ont été importées du paquet de contenu.
Nom de variable : ScheduledJob
Type de données de variable : ScheduledJob (voir M-Files API)
Utilisation de la variable :
La variable ScheduledJob contient une description de la tâche planifiée en cours d'exécution.
Nom de variable : ScheduledJobOutputInfo
Type de données de variable : ScheduledJobOutputInfo (voir M-Files API)
Utilisation de la variable :
La variable ScheduledJobOutputInfo contient les informations du résultat de la tâche planifiée lorsque la tâche est terminée.
Nom de variable : StateID
Type de données de variable : Numéro (voir M-Files API)
Utilisation de la variable :
La variable StateID contient l'identifiant d'étape du flux de travail pouvant être utilisé pour reconnaître l'étape de processus dans les scripts liés aux flux de travail.
Nom de variable : ValueListItem
Type de données de variable : ValueListItem (voir M-Files API)
Utilisation de la variable :
La variable ValueListItem contient la valeur de la liste de valeurs en cours de traitement par le gestionnaire d'événements.
Nom de variable : Vault
Type de données de variable : Vault (voir M-Files API)
Utilisation de la variable :
La variable "Vault" représente le coffre utilisé pour exécuter le script. Avec l'identifiant, le script peut traiter le contenu du coffre de la même manière qu'avec l'interface M-Files API. En cas d'erreur, toutes les modifications apportées au coffre à travers l'entité "Vault" seront annulées.
L'utilisation de l'entité "Vault" avec des scripts comporte certaines limitations. Avec l'entité "Vault", les scripts ne peuvent pas modifier l'étape de l'objet dans lequel le script est exécuté. Le changement d'étape se rapporte au verrouillage de l'objet, à la publication de l'objet, au déverrouillage, à la suppression et à la destruction de l'objet. Ainsi, tous les autres objets verrouillés dans le script doivent être publiés lors de l'exécution du même script.
Nom de variable : VaultSharedVariables
Type de données de variable : NamedValues (voir M-Files API)
Utilisation de la variable :
La variable VaultSharedVariables est une collection de valeurs nommées qui sont stockées dans la base de données du coffre. Avec la variable, les scripts peuvent stocker leurs propres valeurs dans la base de données afin qu'elles soient également disponibles pour d'autres scripts. Les types de données autorisés pour les valeurs nommées sont des variables entières, des booléens et des chaînes.
Dans l'exemple suivant, la valeur 123 est stockée comme une valeur nommée et la valeur calculée en chiffres est alors définie comme la valeur.
VaultSharedVariables( "Message" ) = 123
Output = VaultSharedVariables( "Message" )