A propos des étapes

Une étape est le composant d'un projet. Lorsque le projet est exécuté comme un travail, chaque étape est exécutée dans l'ordre. Une étape contient une ou plusieurs commandes et possède des propriétés d'étape qui affectent son comportement.

Remarque : Vous devez purger régulièrement les anciens travaux. En effet, dans le cas d'un grand nombre de lignes de journal pour une seule étape, les performances du moteur, de l'agent et de la base de données s'en retrouvent affectées en raison du coût du processus d'E-S. En outre, il se peut que les lignes de journal ne s'affichent pas correctement lorsque le nombre de lignes de journal est supérieur à 5000 pour une seule étape. Pour garantir le bon affichage des lignes de journal, vous pouvez aussi réduire les résultats d'étape ou rediriger ceux-ci vers un fichier distinct.

A propos du panneau Etapes

Onglet Détails

Les propriétés d'étape spécifient comment exécuter une étape, gérer son résultat et poursuivre une fois l'étape terminée. Une étape peut également exécuter un autre projet ou une autre bibliothèque.

Pour consulter les propriétés d'étape, sélectionnez une étape au sein d'un projet. L'onglet Détails s'affiche par défaut. Il affiche les propriétés de l'étape.

Si une propriété d'étape n'est pas définie de façon explicite, sa valeur est celle du projet. Les propriétés définies pour une étape remplacent les valeurs héritées.

Les propriétés de l'étape incluent les éléments suivants :
Nom
Nom de l'étape. Il est utilisé comme libellé pour l'étape dans le système ainsi que dans le journal.
Actif
Indique si l'étape est exécutée. Par défaut, une étape est définie sur Activé. Sélectionnez Désactivé pour empêcher l'exécution de l'étape. Une étape désactivée n'est pas disponible pour exécution dans un travail.
Répertoire
Définit l'emplacement de l'exécution des commandes d'étape. Le système crée automatiquement un répertoire unique pour chaque travail. La zone Répertoire fournit un chemin approprié pour exécuter les commandes dans les répertoires créés par votre projet pendant un travail. (Build Forge ne crée pas les répertoires mentionnés dans la zone Répertoire.)
Chemin d'accès
Indique si Répertoire est un chemin absolu ou relatif.
  • Relatif : les commandes d'étape sont exécutées dans un chemin généré en ajoutant les répertoires du serveur, du projet, du travail et de l'étape.
  • Absolu : les commandes d'étape sont exécutées dans un chemin généré en ajoutant les répertoires du serveur et de l'étape. Cette option vous permet d'accéder aux répertoires qui ne se situent pas dans la structure du répertoire du projet. Exemple: elle peut être utilisée pour lancer des applications installées de manière permanente sur le serveur.
Type d'étape
Détermine la méthode d'exécution de l'étape. Cette propriété affecte le contenu de la commande et celui du projet indiqué dans la propriété Encapsulé, si indiqué.
  • Régulier : l'étape est exécutée une seule fois.
  • Conditionnel : l'étape est exécutée une seule fois si l'expression figurant dans la propriété Condition est définie sur true. La sélection de la propriété Conditionnel entraîne l'affichage des propriétés Condition, Else Inline et Commande Else. Si la propriété Condition est définie sur false, Commande et Encapsulé ne sont pas exécutés. Sinon, les propriétés Commande Else et Else Inline sont exécutées si elles sont indiquées.
  • Boucle while : l'étape peut être exécutée plusieurs fois. Elle est exécutée jusqu'à ce que l'expression figurant dans la propriété Condition soit définie sur false ou jusqu'à ce que le nombre maximal d'itérations soit atteint. Lorsque vous sélectionnez Boucle while, les propriétés Condition et Itérations max s'affichent.

    Le sélecteur est évalué pour chaque itération de la boucle while afin de déterminer le serveur à utiliser pour l'itération.

Encapsulé
Indique un projet ou une bibliothèque à exécuter de manière encapsulée avec le projet en cours. Les étapes du projet ou de la bibliothèque sont exécutées à l'aide de l'environnement et de la plupart des propriétés du projet actuel. Cependant, le système utilise le sélecteur de projet encapsulé en tant que sélecteur par défaut pour la mise en ligne. Le comportement est le même que lorsque les étapes du projet indiqué sont copiées après l'étape actuelle.
Accès
Sélectionnez un groupe d'accès pour définir les utilisateurs autorisés à utiliser l'étape. Vous pouvez utiliser cette propriété pour restreindre l'accès à certaines étapes du projet. Lorsqu'un utilisateur non-membre du groupe d'accès pour une étape exécute le projet contenant l'étape, cette dernière est ignorée.

Si vous choisissez la valeur par défaut du projet, l'étape hérite des propriétés d'accès du projet.

Fournisseur d'étapes
Implémentation de l'exécution de commande d'étape. Le fournisseur d'étapes par défaut est MJC Step Provider. Il fournit le comportement existant prévu de l'exécution du texte de commande sur la machine d'agent de noeud final.
Itérations max
Uniquement affiché si le type d'étape est défini sur Boucle while. Indique le nombre maximal de fois où l'étape peut être exécutée dans une boucle. La valeur par défaut imposée par le système est 100. L'étape s'affiche comme ayant abouti (réussie) dans le journal des étapes. L'option Etape d'échec si le maximum est atteint vous permet de faire échouer l'étape lorsque la propriété Itérations max est atteinte.

Lorsque des travaux sont exécutés, la variable accessible en lecture seule BF_ITERATION contient le nombre d'itérations entrées avec succès. Si un travail est arrêté puis redémarré, il est redémarré à l'itération indiquée dans BF_ITERATION.

Etape d'échec si le maximum est atteint
Si Oui, une étape Boucle while échoue lorsque la propriété Itérations max est atteinte. Si Non, l'étape aboutit.
Else Inline
Uniquement affiché si le type d'étape est Conditionnel. Indique un projet à exécuter de manière encapsulée si la condition indiquée est fausse. La valeur par défaut est Non.
Commande

Une ou plusieurs commandes. Les commandes peuvent être des commandes du système d'exploitation, des commandes dot ou une combinaison des deux. Voir Mode d'exécution des étapes.

Condition
Affiché uniquement si vous avez sélectionné le type d'étape Conditionnel ou Boucle while.
  • Conditionnel : la commande est exécutée si la condition est définie sur true.
  • Boucle while : la commande peut être exécutée à plusieurs reprises, tant que la condition est définie sur true. Vous pouvez définir la limite à l'aide de la propriété Itérations max.

Une condition peut être une fonction ou une commande à exécuter sur la ressource serveur sélectionnée.

  • Une fonction, si utilisée, doit être placée au début de la zone Condition. Elle est définie par le moteur Build Forge. Elle n'est pas envoyée à la ressource serveur. Pour obtenir une liste des fonctions ainsi que des instructions relatives à leur utilisation, voir Fonctions conditionnelles.
  • Une commande est exécutée sur le serveur sélectionné. Toute commande utilisée ici doit être valide dans l'environnement shell de l'agent. Le code retour d'exécution détermine si la condition aboutit ou échoue.

Les variables Build Forge du projet sont disponibles pour l'utilisation dans une expression de condition. Voir Interprétation des variables dans les étapes pour plus d'informations sur la manière dont les variables peuvent être exprimées et sont définies.

Commande Else
Affiché uniquement si vous avez sélectionné le type d'étape Conditionnel. Indique une commande à exécuter si la condition est définie sur false.
Environnement

Indique un environnement à appliquer avant d'exécuter les commandes. Les valeurs de cet environnement remplacent toutes les valeurs héritées des environnements du serveur et du projet, ainsi que des variables de l'étape.

Sélecteur
Indique un sélecteur à utiliser pour choisir un serveur pour cette étape. Si ce paramètre reste sur Par défaut, l'étape s'exécute sur le serveur déterminé par le sélecteur du projet.
Diffusion
Si cette case est cochée, l'étape est exécutée sur tous les serveurs correspondant au sélecteur actuel (le sélecteur de l'étape si indiqué, sinon le sélecteur du projet). Lors de la phase d'exécution, le système remplace une étape de diffusion par une série d'étapes, une par serveur et les exécute en série ou en parallèle, tout dépend de la propriété Exécuter de l'étape de diffusion.

Comportement d'étape de diffusion lors du redémarrage : lorsqu'une étape de diffusion est redémarrée, la diffusion n'est pas effectuée. Ce paramètre s'applique uniquement au nouveaux démarrages de l'étape. Au redémarrage, le moteur sélectionne un serveur aléatoire unique pour l'étape.

Délai d'attente en minutes
Spécifie le nombre de minutes pendant lequel le système attend que la commande actuelle produise une sortie (la valeur par défaut est de 5 minutes). Une valeur de 0 signifie que l'étape n'arrive pas à expiration si l'étape se connecte correctement à l'agent. Si la valeur de délai d'attente est atteinte, le système échoue. Le projet échoue également, à moins que l'étape soit définie sur Continuer après échec.
Résultat
La propriété Résultat indique si le système a jugé que l'étape a abouti ou échoué. Utilisez la valeur par défaut du Code de sortie pour déterminer la réussite basée sur un code de sortie par l'interpréteur de commande. Vous pouvez également choisir un filtre de journal qui examine le résultat de la commande. Pour sélectionner un filtre de journal, vous devez tout d'abord le créer.
En cas d'échec
Indique si le travail doit être poursuivi ou arrêté si l'étape échoue. Par défaut, le système arrête le travail.
Unité d'exécution
Si Oui, l'étape est exécutée en parallèle avec d'autres étapes. Définissez cette propriété sur Oui pour permettre l'exécution de cette étape (exécution de l'étape en parallèle avec d'autres étapes). Définissez la propriété sur Non pour éviter l'exécution. Définissez la propriété Associer pour séparer les blocs conçus avec des unités d'exécution des étapes. Le premier ensemble d'étapes doit être terminé avant que le prochain ensemble d'étapes amorcées suivant l'étape Associer puisse commencer.
Notification de réussite
Indique le groupe d'accès à notifier si l'étape aboutit.
Chaînage sur réussite
Indique un projet à exécuter si l'étape en cours aboutit. (Une étape présentant l'état "Warning (Avertisement)" est considérée comme une réussite et lance un chaînage sur réussite).
Attente de réussite
Si coché, le système interrompt le projet en cours jusqu'à l'aboutissement du projet chaîné sur réussite. Si cette étape (ou son projet) est annulée, le projet chaîné est lui aussi annulé. S'il n'est pas contrôlé, le projet chaîné est démarré de manière asynchrone et le projet en cours passe à l'étape suivante.
Notification d'échec
Indique le groupe d'accès à notifier si l'étape échoue.
Chaînage sur échec
Indique un projet à exécuter en cas d'échec de l'étape en cours. (Une étape paramétrée sur Continue on failure (Poursuivre en cas d'échec) est considérée comme un échec et lance un des chaînages sur échec affectés à cette étape.)
Attente d'échec
Si cette case est cochée, le système suspend le projet en cours jusqu'à l'aboutissement du projet chaîné sur échec. Si cette étape (ou son projet) est annulée, le projet chaîné est lui aussi annulé.

Onglet Notes

L'onglet Notes contient une liste horodatée de notes effectuées à propos de l'étape. Vous créez des notes manuellement. Les modifications apportées à l'étape elle-même ne sont pas enregistrées automatiquement. L'onglet affiche le nombre actuel de notes, par exemple Notes (2).

Pour ajouter une note, procédez comme suit :
  1. Cliquez sur l'onglet Notes.
  2. Ecrivez la nouvelle note dans la zone de texte.
  3. Cliquez sur Soumettre.
Pour éditer une note, procédez comme suit :
  1. Cliquez sur l'onglet Notes.
  2. Cliquez sur l'icône Editer Icône Editer en regard de la note à éditer. Effectuez vos modifications.
  3. Cliquez sur Soumettre.
Pour supprimer une note, procédez comme suit :
  1. Cliquez sur l'onglet Notes.
  2. Cliquez sur l'icône Corbeille Icône Corbeille. Une invite vous demande si vous êtes sûr de vouloir supprimer la note.
  3. Cliquez sur OK.

Feedback