Événements
Lors d’une session utilisateur du Client Web ALM, le Client Web déclenche des événements au fur et à mesure que l’utilisateur lance des actions. Vous pouvez placer du code dans ces événements pour personnaliser l’exécution des actions utilisateur associées.
Le tableau suivant décrit le moment où chaque événement est déclenché et ce que vous pouvez réaliser en modifiant l’événement :
Événement | Description |
---|---|
Nouveau |
Cet événement est déclenché lorsqu’une entité est ajoutée au Client Web. Vous pouvez ajouter du code à cet événement pour effectuer une action lorsqu’un nouvel objet est ajouté. Syntaxe : <entity>_New Pour des exemples, voir Exemple : Ajouter un modèle à un champ mémo. |
MoveTo |
Cet événement est déclenché lorsqu’un utilisateur déplace le focus d’un objet à un autre. Vous pouvez ajouter du code à cet événement pour effectuer des actions lorsque l’utilisateur déplace le focus. Syntaxe : <entity>_MoveTo Pour des exemples, voir Exemple : Présenter une liste de champs dynamique. |
FieldCanChange |
Cet événement est déclenché avant que Client Web ne modifie une valeur de champ, pour déterminer si le champ peut être modifié. Il renvoie true ou false. Vous pouvez ajouter du code à cet événement pour empêcher la modification d’un champ dans des cas particuliers. Syntaxe : <entité>_FieldCanChange(fieldName, newValue) où fieldName est le nom du champ, newValue est la nouvelle valeur du champ. Pour des exemples, voir Exemple : Valider un champ. |
FieldChange |
Cet événement est déclenché lorsque la valeur du champ spécifié change. Chaque modification de valeur déclenche l’événement FieldChange lorsque le champ perd le focus. Vous pouvez ajouter du code à cet événement pour effectuer une action lorsque la valeur d’un champ donné est modifiée. Syntaxe : <entité>_FieldChange(fieldName) où fieldName est le nom du champ. Pour des exemples, voir Exemple : Modifier un champ basé sur un autre champ. |
CanPost |
Cet événement est déclenché avant que le Client Web ne mette à jour une entité, pour vérifier si l’entité peut être mise à jour. Il renvoie true ou false. Vous pouvez ajouter du code à cet événement pour empêcher la mise à jour d’une entité dans des cas particuliers. Syntaxe : <entity>_CanPost Pour des exemples, voir Exemple : Valider si une entité peut être mise à jour dans des cas spécifiques. |
CanDelete |
Cet événement est déclenché avant que le Client Web ne supprime une entité, pour vérifier si l’entité peut être supprimée. Il renvoie true ou false. Syntaxe : <entité>_CanDelete(entity) |
AfterPost |
Cet événement est déclenché après la mise à jour d’une entité dans le Client Web. Une fois publiés, les champs de projet ne doivent plus être modifiés, car les nouvelles valeurs ne sont pas stockées dans la base de données. Syntaxe : <entity>_AfterPost |
CanAddTests |
Cet événement est déclenché avant que Client Web ajoute des tests à une campagne de test, pour vérifier si les tests spécifiés peuvent être ajoutés. Il renvoie true ou false. Syntaxe : TestSet_CanAddTests(tests) où Tests est un tableau d’ID de test. |
CanRemoveTests |
Cet événement est déclenché avant que le Client Web supprime des tests d’une campagne de test, pour vérifier si les tests spécifiés peuvent être supprimés. Il renvoie true ou false. Syntaxe : TestSet_CanRemoveTests(tests) où Tests est un tableau d’ID de test. |
RunTestsManually |
Cet événement est déclenché lorsque l’utilisateur clique sur le bouton Exécuter avec l’exécuteur manuel pour exécuter des tests dans le module Labo de tests. Syntaxe : RunTestsManually(tests) où tests est un tableau d’ID d’instance de test. Disponible pour : Script du module Labo de tests uniquement, à partir de la version 24.1 P1 |
DefaultResult |
Cet événement est utilisé pour déterminer la valeur de retour par défaut des événements ALM, FieldCanChange par exemple. Tous les événements ALM appellent cet événement (sauf si l’utilisateur l’omet explicitement) pour déterminer la valeur de retour par défaut. DefaultResult peut être utilisé pour remplacer rapidement les valeurs de retour par défaut de tous les événements ALM. Disponibles dans : Nœud Script commun Syntaxe : DefaultResult |
CanLogin |
Cet événement est déclenché pour vérifier si l’utilisateur spécifié peut se connecter au projet spécifié. Il renvoie true ou false. Syntaxe : CanLogin(domainName, projectName, userName) où domainName est le nom de domaine. projectName est le nom du projet. userName est le nom d’utilisateur. Disponible dans : nœud Script commun |
CanLogout |
Cet événement est déclenché pour vérifier si l’utilisateur actuel peut se déconnecter du projet en cours. Il renvoie true ou false. Syntaxe : CanLogout Disponibles dans : Nœud Script commun, à partir de la version 24.1 P1 |
ActionCanExecute |
Cet événement est déclenché avant qu’Client Web n’effectue une action initiée par l’utilisateur, pour vérifier que l’action peut être exécutée. Vous pouvez ajouter du code à cet événement pour effectuer des actions lorsque l’utilisateur a initié une action donnée ou pour empêcher l’exécution de l’action dans certains cas. Disponible dans : nœud Script commun Syntaxe : ActionCanExecute(actionName) où actionName est l’action initiée par l’utilisateur. Le nom d’une action système est au format <entité>.<nom de l’action>. Par exemple, Defect.DeleteDefect. Pour plus d’informations sur les noms d’actions système pris en charge, voir Actions système prises en charge. Les actions définies par l’utilisateur qui sont déclenchées par des boutons définis par l’utilisateur suivent le format UserDefinedActions.<nom de l’action>. Par exemple, UserDefinedActions.Calculator. Pour des exemples, voir Exemple : Empêcher les utilisateurs d’effectuer une action. |
CanEnterModule |
Cet événement est déclenché avant qu’un utilisateur n’accède ou ne passe à un module dans le client Web. Il renvoie true ou false. Syntaxe : CanEnterModule(moduleName) où moduleName est le nom du module ALM. Disponible dans : nœud Script commun |
EnterModule |
Cet événement est déclenché lorsque l’utilisateur accède ou passe à un module dans le Client Web. Il est également déclenché lorsque l’utilisateur se connecte au client Web. Syntaxe : EnterModule Disponible dans : nœud Script commun |
ExitModule |
Cet événement est déclenché lorsqu’un utilisateur quitte un module dans le Client Web. Syntaxe : ExitModule Disponible dans : nœud Script commun |
DialogBox |
Cet événement est déclenché lorsqu’une boîte de dialogue est ouverte ou fermée. Syntaxe : DialogBox(dialogBoxName, isOpen) où dialogBoxName est le nom de la boîte de dialogue. isOpen indique si la boîte de dialogue est ouverte. Disponible dans : nœud Script commun |
CanCustomize |
Cet événement est déclenché lorsqu’un utilisateur tente d’ouvrir la fenêtre Flux de travail, afin de vérifier s’il peut personnaliser les scripts de flux de travail du projet. Il renvoie true ou false. Syntaxe : CanCustomize(domainName, projectName, userName) où domainName est le nom de domaine. projectName est le nom du projet. userName est le nom de l’utilisateur. Disponible dans : nœud Script commun |
Attachment_New |
Cet événement est déclenché lorsqu’une pièce jointe est ajoutée au Client Web, afin de vérifier si celle-ci peut être ouverte. Il renvoie true ou false. Syntaxe :Attachment_New(attachment) Disponible dans : nœud Script commun |
Attachment_CanPost |
Cet événement est déclenché avant que le client Web ne mette à jour une pièce jointe, afin de vérifier si celle-ci peut être mise à jour. Il renvoie true ou false. Syntaxe : Attachment_CanPost(attachment) Disponible dans : nœud Script commun |
Attachment_CanDelete |
Cet événement est déclenché avant que le client Web ne supprime une pièce jointe, afin de vérifier si celle-ci peut être supprimée. Il renvoie true ou false. Syntaxe : Attachment_CanDelete(attachment) Disponible dans : nœud Script commun |
GetDetailsPageName |
Cet événement est déclenché par le Client Web pour récupérer le nom de la page (onglet) dont le numéro d’index est spécifié sous PageNum dans les boîtes de dialogue suivantes :
Vous pouvez ajouter du code à cet événement pour personnaliser les noms des onglets de la boîte de dialogue Détails. Syntaxe : GetDetailsPageName(pageName, pageNum) où pageName est le nom de la page (onglet) par défaut (par exemple, Page 1). pageNum est le numéro de page (onglet). Disponible dans : nœud Script commun Pour des exemples, voir Exemple : Modifier les noms des onglets de la boîte de dialogue Détails de l’entité. |
Fonction partagée |
Vous pouvez définir des constantes ou des fonctions globales dans l’événement SharedFunction.
Si un script appelle l’événement SharedFunction et modifie les constantes ou variables de cet événement, les modifications prennent effet uniquement dans ce script et uniquement dans l’exécution en cours. Pour des exemples, voir Exemple : Personnaliser les champs de la boîte de dialogue Nouvelle anomalie. |