Variables VBScript disponibles

Le code VBScript est édité dans la fenêtre Édition du code VBScript, disponible sur les boîtes de dialogue suivantes : Les variables suivantes sont décrites dans le tableau suivant.
Remarque : La documentation M-Files API est disponible en ligne : M-Files API. Pour plus d’informations sur l’emploi de VBScript dans M-Files, consultez le tutoriel Comment écrire le code VBScript code pour M-Files ?.
Variable Type de donnée Mode Application
ActivityID MFilesAPI.TypedValue Entrée La seule ID de l'opération en cours de traitement. Peut servir à identifier les événements qui sont causés par une certaine opération du serveur.
AllowStateTransition Boolean Sortie 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.
CurrentTransactionID MFilesAPI.TypedValue Entrée Identification de la transaction. Si les gestionnaires des événements sont exécutés de manière récurrente (de façon à ce que celui en cours d'exécution entraîne l'exécution d'un autre), l'ID change à chaque niveau de récursivité.
CurrentUserID MFilesAPI.Number Entrée Contient l'identification de l'utilisateur qui a effectué l'opération ayant déclenché le script.
CurrentUserSessionInfo MFilesAPI.SessionInfo Entrée Contient des informations sur la session de l'utilisateur qui a provoqué l'opération.
DisplayID MFilesAPI.TypedValue Entrée Comporte l’ID 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 chiffres et des lettres. Souvent, DisplayID est identique à l'ID 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.
FileTransferSessionID MFilesAPI.Number Entrée Contient l'identification 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".
FileVer MFilesAPI.FileVer Entrée Contient l'identification unique complète du fichier cible, composée de l'identification du fichier et de la version du fichier.
GetExtensionObject (méthode) Sans objet Méthode pour récupérer l'objet d'extension défini par l'application du coffre.

Utilisez : GetExtensionObject( <nom objet> [, application GUID]), où la partie [, application GUID] est optionnelle.

Par exemple : Set CK = GetExtensionObject("M-Files.ComplianceKit", "{0CAC5452-631F-4646-AC95-4A06BFB8147E}")

Si l'application GUID n'a pas été spécifiée, l'objet d'extension est recherché à partir de toutes les applications du coffre.

GroupID MFilesAPI.Number Entrée L'identifiant du groupe d'utilisateurs cible.
Input MFilesAPI.TypedValue Entrée Un paramètre défini par le client pour le gestionnaire d'événements VaultExtensionMethod.
IsCancellable MFilesAPI.BooleanValue Entrée Généralement, les scripts peuvent annuler une opération du serveur et rétablir la transaction associée en générant une erreur dans le script. La variable IsCancellable indique si le script est autorisé à le faire.

Si la valeur de la variable est false, M-Files Server va ignorer toute erreur générée dans le script. Si le script génère une erreur alors que la valeur de la variable est false, une erreur est alors consignée dans le journal des événements de Windows et toutes les modifications apportées par le biais du script sont annulées. L’opération du serveur est alors effectuée jusqu’à ce qu’elle soit achevée.

LastUsed MFilesAPI.TypedValue Entrée Disponible uniquement si un numéro personnalisé automatique est calculé pour une propriété. La valeur d'un numéro automatique dépend généralement du calcul précédent. Par exemple, pour une numérotation séquentielle ordinaire, la valeur automatique est incrémentée par un à chaque fois. Quand vous configurez une numérotation automatique personnalisée, le résultat du calcul précédent peut être obtenu en utilisant la variable LastUsed.

Par exemple, une numérotation automatique simple incrémentant par un peut être programmée avec le simple code VBScript suivant : Output = LastUsed + 1

LoggedOutUserID MFilesAPI.Number Entrée Contient l'identifiant d'utilisateur déconnecté après la déconnexion.
LoginAccount MFilesAPI.LoginAccount Entrée Contient les données du compte utilisateur dans la connexion.
MasterTransactionID MFilesAPI.TypedValue Entrée Identification de la transaction. Si les gestionnaires des événements sont exécutés de manière récurrente (de façon à ce que celui en cours d'exécution entraîne l'exécution d'un autre), cette lD de transaction est l'ID de la première transaction.
MemberID MFilesAPI.Number Entrée L'identifiant du membre qui est ajouté à un groupe d'utilisateurs ou supprimé d'un groupe d'utilisateurs. La valeur est négative si le membre est un groupe d'utilisateurs.
MFScriptCancel MFilesAPI.Number Entrée Comporte le code d’erreur qui est utilisé par les scripts pour afficher les messages d’erreur aux utilisateurs. M-Files ajoute couramment des informations détaillées aux messages d’erreur ; cela peut être évité avec le code d’erreur de la variable MFScriptCancel.

Exemple : Err.Raise MFScriptCancel, « C'est le message d'erreur affiché à l'utilisateur. »

NextStateID MFilesAPI.Number Sortie Au cours de la transition d'étape automatique, la NextStateID variable 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.
ObjectAccessControlList MFilesAPI.ObjectAccessControlList Entrée Contient les autorisations actuelles de l'objet affiché.
ObjID MFilesAPI.ObjID Entrée Identification de l'objet en cours de traitement.
ObjVer MFilesAPI.ObjVer Entrée Contient l'identification unique complète de la version, se composant de l'identification du type d'objet, de l'identification interne de l'objet et de la version de l'objet.
Output MFilesAPI.TypedValue Sortie Disponible uniquement si un numéro personnalisé automatique est calculé pour une propriété. Lorsque le code VBScript commence à être exécuté, la variable Output contient la valeur courante de la propriété calculée (sauf pour la numérotation automatique).

Le principal objectif du code VBScript consiste généralement à créer une nouvelle valeur et à l’assigner à la Output variable, qui est ensuite stockée dans les métadonnées de l’objet. Si le code VBScript ne fixe pas la valeur de la variable Output, la valeur de la propriété dans les métadonnées reste la même.

Dans les cas simples, la valeur de la variable Output peut être définie avec une expression simple, par exemple : Output = 123

Si le type de donnée de la valeur en cours de calcul est, par exemple, Choisir dans la liste, la méthode SetValue est recommandée pour la configuration de la valeur de la variable Output (voir M-Files API), par exemple, comme suit :Output.SetValue MFDatatypeLookup, 101

ParentTransactionID MFilesAPI.TypedValue Entrée Identification de la transaction. Si les gestionnaires des événements sont exécutés de manière récurrente (de façon à ce que celui en cours d'exécution entraîne l'exécution d'un autre), cette lD de transaction est l'ID de la précédente transaction (appel).
PropertyDef MFilesAPI.PropertyDef Entrée Contient les informations sur la valeur de propriété calculée, par exemple l'identification, le nom et le type de données de la définition de valeur de propriété.
PropertyValue MFilesAPI.PropertyValue Entrée Contient une valeur de propriété. Chaque valeur de propriété est stockée dans la variable PropertyValues comme variable de type PropertyValue. Une certaine valeur de propriété peut être obtenue avec la méthode SearchForProperty.
PropertyValues MFilesAPI.PropertyValues Entrée Comporte toutes les valeurs de propriété de la version cible qui ont été touchées par l’action courante. Chaque valeur de propriété est stockée dans la variable PropertyValues comme variable de type PropertyValue. Une certaine valeur de propriété peut être obtenue avec la méthode SearchForProperty.
Remarque : Certaines définitions de propriétés ne s’affichent pas lors de l’utilisation de la variable PropertyValues dans les scripts (se reporter à Définitions de propriétés non affichées pour les scripts).
RestoredVersions MFilesAPI.IDs Entrée Contient les versions de l'objet exporté qui ont été importées du pack de contenu.
SavepointVariables MFilesAPI.NamedValues Entrée/Sortie Contenant pour les paires nom-valeur optionnelles stockées pour la durée d'une simple transaction. Le contenant retrouve automatiquement les modifications causées par les opérations du contenant ayant échoué.
ScheduledJob MFilesAPI.ScheduledJob Entrée Contient une description de la tâche planifiée en cours d'exécution.
ScheduledJobOutputInfo MFilesAPI.ScheduledJobOutputInfo Entrée Contient les informations du résultat de la tâche planifiée lorsque la tâche est terminée.
StateID MFilesAPI.Number Entrée Contient l'identifiant d'étape du workflow pouvant être utilisé pour reconnaître l'étape de processus dans les scripts liés aux workflow.
StateTransitionID MFilesAPI.Number Entrée Identification de la transition d'étape.
TransactionCache MFilesAPI.NamedValues Entrée/Sortie Contenant pour les paires nom-valeur optionnelles stockées pour la durée d'une simple transaction. Le contenant conserve toutes les modifications, même si elles ont été causées par une opération qui a été annulée ultérieurement en raison d'une erreur.
UserAccount MFilesAPI.UserAccount Entrée Informations sur l'utilisateur du coffre.
UserGroupAdmin MFilesAPI.UserGroupAdmin Entrée Informations sur le groupe d'utilisateurs du coffre.
ValueListItem MFilesAPI.ValueListItem Entrée Contient la valeur de la liste de valeurs en cours de traitement par le gestionnaire d'événements.
Vault MFilesAPI.Vault Entrée 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. Les scripts ne peuvent pas, avec l’entité Vault, 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.

VaultSharedVariables MFilesAPI.NamedValues Entrée/Sortie Collection des valeurs nommées 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" )

View MFilesAPI.View Entrée Contient la vue en cours de traitement par le gestionnaire d'événements.

Définitions de propriétés non affichées pour les scripts

Les définitions de propriétés listées dans le tableau suivant ne s’affichent pas en utilisant la variable PropertyValues dans les scripts :

Nom ID
État modifié 24
Mono-fichier 22
Supprimé 27
Supprimé par 28
Commentaire 33
Étiquette de version 29
Taille sur le serveur (cette version) 30
Taille sur le serveur (toutes versions) 31
Marqué pour archivage 32
Membres de collection (documents) 46
Membres de collection (collections de documents) 47
Groupes de classes 101
Description 41
Échéance 42
Contrôlé par 43
Affectées à 44
Marquée comme terminée par 45
Refusé par 97
Tâches de Workflow 79
Accédés par moi 81
Vue préférée 82
Modification d'objet 89
Autorisations modifiées 90
Étiquette de version modifiée 91
Commentaire de version modifié 92
État de suppression modifié 93
Conflit résolu 96
Objet modifié pour exportation 105
Version d'objet modifiée pour exportation 106

Par exemple, le morceau de script suivante donne une erreur de type "Non trouvé" :

Dim DeadlineValue
DeadlineValue = PropertyValues.SearchForProperty(42).TypedValue.DisplayValue
Conseil : Vous pouvez utiliser la méthode GetProperties pour obtenir toutes les propriétés d’un objet spécifique.