Guide de référence des attributs Ant

Cette rubrique décrit les attributs des tâches Ant de génération d'équipe Jazz.

Le tableau ci-après décrit les attributs de la tâche Ant de génération d'équipe Jazz

Attribut Description

activityId

Identificateur unique de l'activité de génération. L'ID d'activité envoyé à completeBuildActivity se trouve dans une propriété définie par la tâche startBuildActivity. Définissez la valeur de l'attribut activityId en utilisant la commande de substitution de valeur de propriété ${}.

activityIdProperty

Stocke l'ID unique d'une activité nouvellement démarrée. Requis uniquement si le demandeur a l'intention d'effectuer cette activité de manière explicite à l'aide de la tâche completeBuildActivity ou que cette activité est utilisée comme parent pour les activités enfant.

autoComplete

Pour la tâche startTeamBuild, indique si la génération doit être effectuée automatiquement. La valeur par défaut est "true". Si cet attribut a la valeur true, vous devez utiliser le paramètre -listener com.ibm.team.build.ant.listener.TeamBuildListener au lancement d'Ant.

Pour la tâche startBuildActivity, indique si l'activité doit être effectuée automatiquement dans l'un des cas suivants : l'activité parent est terminée, la prochaine activité d'homologue commence ou la génération est terminée. La valeur par défaut est false.

buildDefinitionId

Pour la tâche getNextTeamBuildRequest, spécifie un ID définition de génération permettant de rechercher les demandes en attente. Si l'ID définition de génération n'est pas pris en charge par le moteur de génération spécifié, aucune demande n'est extraite.

Pour la tâche requestTeamBuild, identificateur de la définition de génération à utiliser.

Pour la tâche startTeamBuild, définition de génération de la génération à démarrer. Requis si requestUUID n'est pas spécifié.

buildDefinitionIdProperty

Stocke l'ID définition de la génération de la prochaine demande de génération pour le moteur spécifié. Il n'est défini que si une demande est extraite pour le moteur spécifié. Ne s'applique pas si buildDefinitionId est spécifié.

buildLabel

Libellé de génération généré par le moteur de génération Jazz . Par exemple, 20080215-1234.

buildLabelPrefix

Spécifie un préfixe pour le libellé de génération, tel que I pour l'intégration. Si vous définissez cette propriété dans votre définition de génération ou votre moteur de génération, la valeur précède le libellé généré par le moteur de génération Jazz . Par exemple, I20080215-1234.

buildResultUUID

Identificateur unique universel du résultat de génération à mettre à jour. La valeur de cet attribut est généralement ${buildResultUUID} car la propriété est intégrée lors de l'utilisation du moteur de génération Jazz.

Pour la tâche completeBuild, identificateur unique universel du résultat de génération à obtenir.

Pour la tâche teamAccept, résultat de génération à mettre à jour avec les informations de l'instantané. L'instantané peut être utilisé pour recréer l'espace de travail de génération ultérieurement.

Pour la tâche teamFetch, ce résultat de génération est mis à jour avec les informations de l'espace de travail de génération. Cela permet de recréer l'espace de travail de génération ultérieurement à partir du résultat de génération. Cet attribut doit être défini sur au plus un appel de cette tâche par génération. Les résultats de génération ne peuvent pas être associés à plusieurs espaces de travail. Cette tâche génère une exception si le résultat de génération est déjà associé à un espace de travail.

Pour la tâche waitForTeamBuild, identificateur unique universel du résultat de génération attendu. Cela est précisé en général lorsque la génération a été initialisée par {@link StartBuildTask}, ce qui retourne l'uuid de résultat de la génération dans la propriété spécifiée par l'attribut resultUUIDProperty.

buildNotNecessary

True si la génération n'était pas nécessaire. Par exemple, aucune génération n'est requise si la source n'a pas été modifiée depuis la génération précédente. N'utilisez cet attribut que dans un script Ant qui contrôle l'intégralité du cycle de vie de la génération.

buildStateProperty

Propriété permettant d'enregistrer l'état de la génération une fois que la tâche n'attend plus. Définie uniquement si la génération est passée à l'un des états attendus spécifiés.

buildStatusProperty

La propriété est affectée de l'état de la génération, à savoir OK, INFO, AVERTISSEMENT ou ERREUR.

changeSetFile

Fichier à utiliser pour stocker les ensembles de modifications sérialisés.

changesAcceptedProperty

Stocke le nombre d'ensembles de modifications acceptés. La propriété n'est définie que si au moins un ensemble de modifications est accepté.

componentMap

Chemin d'accès à un fichier qui contient des informations de mappage des noms de package aux composants.

Chemin d'accès à un fichier qui contient des informations de mappage des noms de package aux composants. Le nom de package doit correspondre au package de la classe de la suite de tests.

componentName

Composant spécifique à associer à cette contribution.

contentType

Type d'artefact. Si cet attribut n'est pas spécifié, il prend la valeur application/inconnu.

Pour la tâche filePublisher, type de l'artefact. Si l'attribut n'est pas indiqué, la valeur par défaut est application/inconnu.

Pour la tâche logPublisher, type de l'artefact. Si l'attribut n'est pas indiqué, la valeur par défaut est texte/normal.

contributionTypeId

ID type de contribution étendu de cette contribution.

characterEncoding

Codage de caractères utilisé dans le fichier d'artefacts. Il doit s'agir d'un nom compatible IANA. Par défaut, il s'agit du codage par défaut de la plateforme actuelle. Pour plus d'informations, voir IANA List of Character Set Names.

deletePropertiesFile

Chemin d'accès à un fichier de propriétés. Ce fichier de propriétés spécifie les propriétés qui doivent être omises lorsque la génération est exécutée. Les propriétés doivent exister dans la définition de génération. Ce chemin d'accès peut être un chemin d'accès relatif par rapport au répertoire de base du fichier de génération ou un chemin d'accès complet.

deleteAllowed

Indique si le résultat de la génération peut être supprimé.

destination

Répertoire locale où sont stockés les fichiers extraits.

engineId

Pour la tâche getNextTeamBuildRequest, identificateur de lu moteur de génération pour lequel la prochaine demande de génération doit être extraite.

Pour la tâche startTeamBuild, identificateur de lu moteur de génération qui exécute la génération. Requis uniquement si requestUUID n'est pas spécifié.

failOnError

Si la valeur est true (valeur par défaut), la tâche échoue en cas d'erreur. Si la valeur est false, certaines erreurs sont ignorées et la tâche est effectuée.

filePath

Pour les tâches qui ont besoin d'un fichier en entrée, spécifie le chemin d'accès à un fichier. Il peut s'agir d'un chemin d'accès absolu ou d'un chemin d'accès relatif par rapport au répertoire de base du fichier de génération.

Chemin d'accès au journal XML ou chemin d'accès à un répertoire contenant des journaux XML. Ce chemin d'accès peut être un chemin d'accès relatif par rapport au répertoire de base du fichier de génération ou un chemin d'accès complet.

Pour la tâche jdtCompileLogPublisher, chemin d'accès au fichier journal du compilateur JDT ou répertoire des fichiers à publier.

Pour la tâche filePublisher, chemin d'accès au fichier ou au répertoire de fichiers à publier.

Pour la tâche workItemPublisher, chemin d'accès à une sortie de fichier d'ensemble de modifications de la tâche teamAccept ou à un fichier d'élément de travail. Un fichier d'élément de travail contient un ID élément de travail par ligne. Ce chemin d'accès peut être un chemin d'accès relatif par rapport au répertoire de base du fichier de génération ou un chemin d'accès absolu.

Pour mstestLogPublisher, chemin d'accès au journal TRX XML ou chemin d'accès à un répertoire contenant des journaux TRX XML. Ce chemin d'accès peut être un chemin d'accès relatif par rapport au répertoire de base du fichier de génération ou un chemin d'accès complet.

inputFileType

Pour la tâche workItemPublisher, cette option indique si l'attribut filePath indique un fichier d'ensemble de modifications ou un fichier d'élément de travail. Les valeurs valides sont CHANGESET et WORKITEM. Si cet attribut n'est pas indiqué, la tâche suppose que l'attribut filePath fait référence à un fichier d'ensemble de modifications.

interval

Délai entre les contrôles pour déterminer si la génération est à l'état requis. Cette valeur est exprimée en secondes et doit être supérieure à zéro et inférieure ou égale à la valeur du délai d'attente. Par défaut, un contrôle est effectué toutes les 30 secondes.

label

Libellé à utiliser pour la génération.

Pour la tâche startBuildActivity, libellé qui décrit l'activité de génération. S'il n'est pas spécifié, la valeur d'activityID est utilisée comme libellé.

LocalFilePath

Chemin d'accès à un fichier local utilisé pour déterminer la taille de fichier du lien publié.

mayFailPattern

Sous-chaîne d'un nom de classe d'une suite de tests. Tout nom de classe de suite de tests qui contient le modèle est autorisé à échouer sans que la génération globale échoue. Le modèle est une simple chaîne et non une expression standard. S'il n'est pas spécifié, un échec de la suite de tests entraîne l'échec de la génération.

overridePropertiesFile

Chemin d'accès à un fichier de propriétés. Ce fichier de propriétés peut ajouter de nouvelles propriétés ou remplacer des propriétés existantes dans la définition de génération. Ce chemin d'accès peut être un chemin d'accès relatif par rapport au répertoire de base du fichier de génération ou un chemin d'accès complet.

outputPropertiesFile

Spécifie un fichier de sortie qui sera créé pour contenir une propriété pour chaque répertoire sous sourceDirectory. Ce fichier de propriétés contient les chemins d'accès aux dossiers et les horodatages qui décrivent l'heure de modification de chacun des dossiers dans sourceDirectory. La valeur de chaque propriété correspond à l'heure de sa dernière modification en heure GMT. Le fichier est formaté comme fichier de propriétés Java. Par exemple :

  • com.ibm.team.scm.admin.service=200803060309
  • com.ibm.team.scm.client=200803060309
  • com.ibm.team.scm.feature.server=200803060309

parentActivityID

Identificateur d'une activité existante à utiliser comme parent. Une activité possédant cette identificateur doit exister et ne doit pas être terminée.

password

Mot de passe de l'ID utilisateur ; chaîne de longueur nulle par défaut, s'il n'est pas spécifié.

passwordFile

Fichier de mots de passe à utiliser pour la connexion. Vous pouvez créer un fichier de mots de passe approprié en appelant le moteur de génération Jazz avec l'argument -createPasswordFile. Vous ne pouvez spécifier qu'un fichier de mots de passe.

pdeBuild

Si la valeur est true, le diffuseur de publications interprète la structure des répertoires de journaux comme générée par la génération pde. Un répertoire de plug-ins doit apparaître dans la hiérarchie sous le chemin d'accès aux fichiers (filePath) indiqué. Le diffuseur de publications regroupe les packages par plug-in.

rawOutputPropertiesFile

Chemin d'accès à un fichier de propriétés. Ce chemin d'accès peut être un chemin d'accès relatif par rapport au répertoire de base du fichier de génération ou un chemin d'accès complet. Ce fichier de propriétés contient les ID internes des versions de référence et des dossiers qui décrivent les dernières versions de référence de chacun des dossiers du répertoire source ("sourceDirectory)

requestUUID

Spécifie une demande de génération existante à utiliser au démarrage de la génération. Si cet attribut est spécifié, buildDefinitionID et engineID ne peuvent pas l'être.

Pour la tâche waitForTeamBuild, identificateur unique universel de la demande de génération attendue. Cela est précisé en général lorsque la génération a été demandée par {@link RequestBuildTask}, ce qui retourne l'uuid de demande de la génération dans la propriété spécifiée par l'attribut requestUUIDProperty.

requestUUIDFile

Chemin d'accès au fichier dans lequel l'identificateur unique universel de la prochaine demande de génération doit être stocké pour le moteur de génération spécifié. Ce chemin d'accès peut être un chemin d'accès relatif par rapport au répertoire de base du fichier de génération ou un chemin d'accès complet. Le fichier est formaté au format java.util.Properties et contient une propriété dont le nom est spécifié par requestUUIDProperty.

requestUUIDProperty

Stocke l'identificateur unique universel de la demande de génération extraite. Défini uniquement si une demande est détectée.

repositoryAddress

Adresse du référentiel d'équipe à utiliser. La valeur de cet attribut est généralement ${repositoryAddress} car cette propriété est intégrée lors de l'utilisation du moteur de génération Jazz.

resultUUIDFile

Fichier à utiliser pour stocker le résultat de génération. Ce chemin d'accès peut être un chemin d'accès relatif par rapport au répertoire de base du fichier de génération ou un chemin d'accès complet. Le fichier est formaté au format java.util.Properties et contient une propriété dont le nom est spécifié par l'attribut resultUUIDProperty.

resultUUIDProperty

Propriété permettant de stocker l'identificateur unique universel du résultat de génération.

snapshotName

Nom d'un instantané créé dans l'espace de travail.

snapshotUUIDProperty

Fournit un nom de propriété pour accéder à l'UUID de l'image instantanée créée.

sourceDirectory

Pour la tâche pluginOrganizer, répertoire source à utiliser. Il doit contenir des répertoires de plug-ins et de fonctions.

Pour la tâche teamLastModified, emplacement de répertoire sur le système de fichiers local. La valeur de l'attribut sourceDirectory doit correspondre à la racine de l'espace de travail du référentiel Jazz. Par exemple, si la tâche teamFetch extrait dans c:\fetched , l'attribut sourceDirectory de teamLastModified doit être c:\fetched. Cette tâche n'est pas compatible avec l'utilitaire de ligne de commande scmtools.

statesToWaitFor

Liste de noms d'état de génération séparés par des virgule. Les valeurs par défaut sont COMPLETED et INCOMPLETE. Les valeurs valides sont les suivantes :
  • NOT_STARTED : une génération demandée n'a pas commencé. Elle est dite en attente.
  • IN_PROGRESS : la génération est en cours.
  • COMPLETED : la génération s'est déroulée normalement, mais elle peut contenir des erreurs.
  • CANCELED : la demande de génération est annulée avant le début de la génération.
  • INCOMPLETE : la génération ne s'est pas déroulée normalement. Elle est dite abandonnée.

status

Statut à définir dans IBuildResultContribution. Les valeurs admises sont OK, ERREUR, et AVERTISSEMENT.

balises

Définit les balises du résultat de la génération. Les balises dans la chaîne sont séparées par une virgule ou un espace.

targetDirectory

Répertoire dans lequel le contenu doit être déplacé.

délai d'expiration

Délai maximal pendant lequel la tâche attend sur la génération. Cette valeur est exprimée en secondes et doit être supérieure à zéro. La valeur par défaut est d'attendre indéfiniment.

timestampFormat

Format d'horodatage, tel que http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html. La valeur par défaut est yyyyMMddHHmm.

url

URL du lien

userId

ID utilisateur à utiliser.

verbose

Spécifie une sortie de message plus importante. La valeur par défaut est false.

workspaceUUID

Pour la tâche teamAccept, identificateur unique universel de l'espace de travail dans lequel les modifications doivent être acceptées.

Pour la tâche teamFetch, identificateur unique universel de l'espace de travail source de l'extraction.

Pour la tâche teamLastModified, identificateur unique universel du contexte d'espace de travail à utiliser.

S'il existe plusieurs espaces de travail de même nom, il se peut que vous deviez utiliser cet attribut au lieu de workspaceName.

workspaceName

Pour la tâche teamAccept, nom de l'espace de travail dans lequel les modifications doivent être acceptées.

Pour la tâche teamFetch, nom de l'espace de travail source de l'extraction.

Pour la tâche teamLastModified, nom de l'espace de travail à utiliser.


Commentaires en retour

Etes-vous satisfait ? Vous pouvez faire part de vos commentaires à l'adresse Jazz.net (enregistrement requis) : Commentaire dans les forums ou soumettre un bogue