Les scripts de votre site peuvent être exécutés à l'aide de l'action Exécution de script dans le panneau Automations. Cela vous permet d'exécuter manuellement des scripts à partir d'un document, d'une feuille de calcul ou d'une présentation.
La fonctionnalité de script est incluse dans Customize Workiva. Pour utiliser la fonctionnalité « Scripting », votre espace de travail doit disposer de l'option « Personnaliser Workiva/Scripting » activée, et les utilisateurs devront disposer des rôles « Scripting » appropriés ainsi que des autorisations d'accès aux fichiers nécessaires.
Exigences
- Workiva Scripting doit être activé pour votre espace de travail. En savoir plus sur Workiva Scripting.
- Les scripts ne peuvent être exécutés que dans l'espace de travail où ils sont hébergés. En savoir plus.
- Seuls les propriétaires de fichiers peuvent créer une automatisation.
- Le rôle d'éditeur de script est nécessaire pour créer des scripts.
Créez votre automatisation
Pour créer un automatisme à partir d'un fichier que vous possédez :
- À partir de Home, ouvrez un document, une présentation ou une feuille de calcul.
- Dans la barre latérale de droite, cliquez sur l'icône en forme d'éclair « Automations ».
- Cliquez sur + ou Créer une nouvelle automatisation pour ajouter une nouvelle automatisation.
- Dans le menu déroulant Automation trigger, sélectionnez Manual Execution.
- (Facultatif) Permettez à d’autres utilisateurs d’exécuter manuellement cette automatisation en saisissant leurs noms et en les sélectionnant dans le champ « When run is selected » ( ) de la section « ».
- Sous Action details, sélectionnez Execute script.
- Saisissez l'identifiant « », qui se trouve à la fin de l'URL du script , dans le champ « Identifiant du script » de la page .
- (Facultatif) Sélectionnez la feuille de calcul et la section contenant les données d'entrée du script.
- Cliquez sur Créer pour terminer.
Exécutez et gérez votre automatisation
Votre nouvelle automatisation apparaîtra comme "Active" dans le panneau Automations. En tant que propriétaire du fichier, vous pouvez effectuer plusieurs actions à partir du menu déroulant :
- Exécuter: Exécute manuellement le script de l'automatisation.
- Modifier : Mettre à jour les détails de l'automatisation, tels que ses critères de déclenchement.
- Désactiver/Activer: Permet de déterminer si un automatisme est disponible pour être exécuté.
- Voir l'activité: Ouvrir le journal d'activité de l'automatisation.
- Supprimer: Supprime définitivement l'automatisation du fichier.
Note: Pour éviter les doubles exécutions, l'option Run est désactivée pendant 20 secondes entre les clics.
Informations reçues par votre script
Lorsqu'un automatisme s'exécute, il envoie des informations que le script lit sous forme de variables d'environnement :
- DOCUMENT_ID: L'ID du document dans lequel l'automatisation est exécutée.
- INPUT_SHEET_ID: Le WURL de la feuille de calcul utilisée pour gérer les paramètres d'entrée de l'automatisme.
- INPUT_RESOURCE_ID: Le WURL de la section dans la feuille de calcul mentionnée ci-dessus.
- INPUT_SPREADSHEET_ID: L'ID de la feuille de calcul mentionnée ci-dessus.
- INPUT_SPREADSHEET_SHEET_ID: L'ID de la section dans la feuille de calcul susmentionnée.
Une WURL est une URL propriétaire, spécifique à Workiva, qui contient l'identifiant et d'autres informations relatives à la feuille de calcul ou à la section.
Pour récupérer les identifiants à partir des paramètres, utilisez ce script :
# Bienvenue dans Workiva Scripting import requests import json import os DOCUMENT_ID = os.getenv('DOCUMENT_ID') SPREADSHEET_ID = os.getenv('INPUT_SPREADSHEET_ID') SHEET_ID = os.getenv('INPUT_SPREADSHEET_SHEET_ID') print("Paramètres bruts :") print(os.environ) print("") print("ID réels :") print(DOCUMENT_ID) print(SPREADSHEET_ID) print(SHEET_ID) Remarque : l’automatisation n’envoie actuellement aucun identifiant de l’API publique Workiva — tel que l’ID client ou la clé secrète — au script. Il se peut que vous deviez coder ces informations d'identification directement dans le script.
FAQ
Puis-je exécuter un script hébergé dans un autre espace de travail, une autre organisation ou une autre région (APAC, CA, UE ou États-Unis) ?
Les automatisations Workiva ne peuvent exécuter que les scripts situés dans le même espace de travail que le fichier. Pour exécuter un script dans un autre espace de travail, une autre organisation ou une autre région, utilisez le connecteur Workiva Scripting disponible à l'adresse ou l'API Workiva Scripting disponible à l'adresse .
Lorsque vous utilisez l'API de script, créez l'autorisation API dans l'espace de travail qui héberge le script cible. La subvention nécessite l'utilisation de script:execute ; si l'intégration récupère l'état d'exécution, les journaux ou les résultats, elle nécessite également l'utilisation de script:read . Pour savoir comment créer ou mettre à jour une autorisation d'API, consultez la page « » (Configuration de l'API Workiva) à l'adresse .
Puis-je envoyer des entrées/paramètres lors de l'exécution du script ?
Pour l'instant, la fonction d'automatisation n'autorise pas les entrées d'exécution qui sont envoyées au script lorsque celui-ci est exécuté.
Quelles sont les métadonnées envoyées à l'exécution d'un script à partir d'une automatisation ? L'identifiant de l'espace de travail est-il envoyé ?
Lorsqu'un script est exécuté à partir d'un processus d'automatisation, les paramètres suivants sont envoyés :
- DOCUMENT_ID: L'ID du document dans lequel l'automatisation est exécutée.
- INPUT_SHEET_ID: Le WURL de la feuille de calcul utilisée pour gérer les paramètres d'entrée de l'automatisme.
- INPUT_RESOURCE_ID : L'URL de la section dans la feuille de calcul « input ».
- INPUT_SPREADSHEET_ID : L'identifiant de la feuille de calcul « input ».
- INPUT_SPREADSHEET_SHEET_ID : L'identifiant de la feuille dans la feuille de calcul « input ».
Pour plus d'informations, consultez la page d'assistance de Workiva : . Exécuter des scripts à l'aide d'automatisations : .
Comment puis-je accéder aux informations d'identification des systèmes Workiva et non Workiva à partir de l'exécution du script ?
Lorsqu'un script est exécuté à partir d'un automate, la seule option consiste à coder en dur les informations d'identification dans le code lui-même.
Le même script peut-il être exécuté simultanément à partir de deux fichiers ou plus ?
Oui, un script peut être exécuté simultanément à partir du même fichier ou de plusieurs fichiers.