Spécification d’une valeur de propriété automatique à l’aide de VBScript

La création de valeurs automatiques personnalisées et de valeurs calculées peut être programmée avec les propriétés communes de M-Files API et VBScript (« Microsoft Visual Basic Scripting Edition »). Cette rubrique donne des instructions sur la manière d'utiliser VBScript avec des valeurs automatiques. Pour le guide utilisateur et la référence de langue VBScript, consultez l’article VBScript MSDN.

Remarque : Lorsque vous développez de nouvelles extensions ou que vous modifiez des extensions existantes, nous vous recommandons de remplacer le contenu VBScript par du code compatible Vault Application Framework (VAF) afin d'assurer la compatibilité future. Pour plus d’informations sur les avantages du développement VAF par rapport à VBScript, reportez-vous à The Vault Application Framework dans M-Files Developer Portal.

Le code VBScript d’une valeur calculée est exécuté à chaque fois qu’une valeur de propriété est modifiée. Le code VBScript sert au calcul d’une valeur automatique. Après quoi, le résultat du calcul doit être assigné à une variable dénommée Output. Cette valeur est stockée comme valeur de la propriété dans les métadonnées de l'objet.

Le code VBScript le plus simple pour générer une valeur automatique ressemble donc à ceci :

Output = "Valeur automatique"

Habituellement, une valeur automatique utilise d'autres propriétés d'objet, par exemple, en les concaténant. Le code VBScript peut utiliser les valeurs des propriétés et les informations de base du même ou d'un autre objet avec ces variables VBScript :

  • CurrentUserID
  • DisplayID
  • LastUsed
  • MFScriptCancel
  • ObjVer
  • Output
  • PropertyDef
  • PropertyValues
  • Vault
  • VaultSharedVariables
Pour la description des variables, consultez Variables VBScript disponibles.
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).

Réalisez les étapes suivantes pour utiliser VBScript pour le calcul d’une valeur automatique d’une propriété :

  1. Ouvrez M-Files Admin.
  2. Dans l'arborescence de gauche, déployez une connexion au serveur M-Files.
  3. Déployez Coffres.
  4. Déployez un coffre.
  5. Déployez Structure des Métadonnées (Vue Classique), puis sélectionnez Définitions de propriétés.
    Résultat :La liste des définitions de propriétés s’ouvre dans le volet de droite.
  6. Double-cliquez sur la définition de propriété que vous souhaitez éditer.
    Résultat :La boîte de dialogue Propriétés de la Propriété s’ouvre.
  7. Rendez-vous sur l’onglet Valeurs Automatiques.
    Résultat :L’onglet Valeurs Automatiques s’ouvre.
  8. Sélectionnez soit :
    • Numérotation automatique personnalisée (VBScript) : Sélectionnez cette option si vous souhaitez définir la numérotation automatique à l’aide de VBScript.
      ou
    • Valeur calculée (VBScript) : Sélectionnez cette option si vous souhaitez définir tout autre type de valeur automatique à l’aide de VBScript.
  9. Cliquez sur Éditer le code.
    Résultat :La fenêtre Edition du Code VBScript s’ouvre.
  10. Spécifiez le code VBScript pour le calcul de la valeur automatique. Consultez Spécification d’une valeur de propriété automatique à l’aide de VBScript pour obtenir les instructions.
    Exemple :Le code suivant génère une valeur automatique pour la propriété "Intitulé de proposition" en utilisant le numéro de proposition et les informations client dans les métadonnées de l'objet. L'identifiant de la propriété Numéro de proposition est 1156 et l'identifiant de la propriété Client est 1288. Si un document a le numéro de proposition 5577 et le client est ESTT, le code ci-dessous génère la chaîne de caractères suivante pour l'intitulé de la proposition : "Proposal #5577 / ESTT". 
    Option Explicit

' Get proposal number.

Dim szNumber
szNumber = PropertyValues.SearchForProperty( 1156 ).TypedValue.DisplayValue

' Get customer.

Dim szCustomer
szCustomer = PropertyValues.SearchForProperty( 1288 ).TypedValue.DisplayValue

' Create proposal title.

Dim szName
szName = "Proposal #" & szNumber & " / " & szCustomer

' Set result.

Output = szName
  11. Fermez la fenêtre Edition du Code VbScript une fois que vous avez fini.
  12. De retour dans la boîte de dialogue Propriétés de la Propriété, cliquez sur OK afin de sauvegarder vos modifications et fermer la boîte de dialogue Propriétés de la Propriété.
La propriété sélectionnée dispose désormais d’une valeur automatique qui est calculée par le code VBScript que vous avez spécifié.