Explication des variables VBScript

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.

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.

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é.

Contient l'identification de l'utilisateur qui a effectué l'opération ayant déclenché le script.

Contient des informations sur la session de l'utilisateur qui a provoqué l'opération.

Contient l'identification unique de l'objet. Cette identification 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'identification 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'identification interne sont généralement différents lorsque l'objet a été importé d'une base de données externe.

Contient l'identification du transfert de données spécifique de l'utilisateur. L'identification du transfert de données est créée quand le transfert de données est démarré sur le serveur et, parallèlement, la même identification est donnée aux gestionnaires d'événements BeforeFileUpload et BeforeFileDownload. Lorsque le transfert des données est terminé, la même identification de transfert de données est attribuée 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".

Contient l'identification unique complète du fichier cible, composée de l'identification du fichier et de la version du fichier.

Méthode pour récupérer l'objet d'extension défini par l'application du coffre.

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

Par exemple : Déterminez 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.

Un paramètre défini par le client pour le gestionnaire des événements VaultExtensionMethod.

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

Contient l'identifiant d'utilisateur déconnecté après la déconnexion.

Contient les données du compte utilisateur dans la connexion.

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.

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."

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.

Contient les autorisations actuelles de l'objet affiché.

Identification de l'objet en cours de traitement.

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.

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).

L'objectif principal du code VBScript est de générer une nouvelle valeur et de l'affecter à une variable de sortie nommée Output, laquelle est alors enregistrée dans les métadonnées de l'objet. Si le code VBScript ne définit pas de valeur pour la variable Output, la valeur de la propriété dans les métadonnées reste inchangée.

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ées de la valeur calculée est par exemple Choisir dans la liste, la méthode SetValue est recommandée pour définir la valeur de la variable Output (voir M-Files API), par exemple comme ceci : Output.SetValue MFDatatypeLookup, 101

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).

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é.

Contient une valeur de propriété. Chaque valeur de propriété est stockée dans la variable PropertyValues comme variable de type PropertyValue. Une valeur de propriété peut être obtenue avec la méthode SearchForProperty.

Contient toutes les valeurs de la propriété courante de la version de destination (telles que Nom, Projet et Client). Chaque valeur de propriété est stockée dans la variable PropertyValues comme variable de type PropertyValue. Une valeur de propriété peut être obtenue avec la méthode SearchForProperty.

Contient les versions de l'objet exporté qui ont été importées du paquet de contenu.

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é.

Contient une description de la tâche planifiée en cours d'exécution.

Contient les informations du résultat de la tâche planifiée lorsque la tâche est terminé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.

Identification de la transition d'étape.

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.

Informations sur l'utilisateur du coffre.

Informations sur le groupe d'utilisateurs du coffre.

Contient la valeur de la liste de valeurs en cours de traitement par le gestionnaire d'événements.

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.

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" )