Variables d'environnement (interface utilisateur graphique)
Les programmes externes configurés via les boutons de la barre d'outils Utilisateur permettent d'accéder aux variables d'environnement. Lors de l'utilisation de ces variables, les noms doivent être en majuscules ou le client PTC RV&S ne les reconnaît pas.
La liste suivante affiche les variables d'environnement associées à chaque type de fenêtre ouverte :
Tout
Si une fenêtre comporte une connexion au serveur, les variables suivantes seront définies.
MKSSI_WINDOW
MKSSI_HOST
MKSSI_PORT
MKSSI_USER
Si aucune fenêtre ou vue n'est active :
MKSSI_WINDOW=none
Si une fenêtre est active :
MKSSI_WINDOW=[archive|document|item|items|project|projecthistory|sandbox]
Dans le cas contraire, la valeur est définie sur une valeur spécifique à la fenêtre :
MKSSI_WINDOW=archive
Si la fenêtre active est une fenêtre différente :
MKSSI_WINDOW=unknown
Par exemple, une fenêtre Modifications de projet qui ne produit aucune variable d'environnement spécifique :
MKSSI_WINDOW=unknown
 |
Pour les valeurs none et unknown, aucune autre variable n'est définie.
|
Dans la mesure où PTC RV&S prend en charge plusieurs connexions serveur, vous devez spécifier les variables d'environnement suivantes lors de l'exécution d'une opération de ligne de commande à partir de la barre d'outils :
si <command> --host=$MKSSI_HOST --port=$MKSSI_PORT --user=$MKSSI_USER
Document
La configuration est la même que pour le type de fenêtre Eléments et les variables de révision suivantes doivent être ajoutées :
MKSSI_REVISION_NAME=<revision name>
Par exemple, 1.2.
MKSSI_REVISION_DATE=<revision date>
Par exemple, Mon Mar 26 14:53:35
Si le champ Modification significative depuis la révision de l'élément est défini sur true pour l'élément correspondant :
MKSSI_REVISION_DELTA=true
|
|
Les variables MKSSI_REVISION_NAME, MKSSI_REVISION_DATE et MKSSI_REVISION_DELTA entraînent l'exportation des informations de l'élément racine. Si l'élément n'est pas révisé ou s'il ne comporte aucun historique de révision, aucune variable n'est exportée. La fenêtre affichée par l'option de menu > exporte les mêmes variables que la fenêtre Modifier l'élément.
|
Elément
Pour une fenêtre Détails de l'élément ouverte :
MKSSI_NISSUE=<1>
MKSSI_ISSUE=<ID of selected item>
MKSSI_ISSUE0=<same ID as MKSSI_ISSUE>
MKSSI_REVISION_NAME=<revision name>
Par exemple, 1.2
MKSSI_REVISION_DATE=<revision date>
Par exemple, Mon Mar 26 14:53:35
Si le champ Modification significative depuis la révision de l'élément est défini sur true pour l'élément correspondant :
MKSSI_REVISION_DELTA=true
|
|
Si l'élément n'est pas révisé ou s'il ne comporte aucun historique de révision, aucune variable n'est exportée.
|
Modifier l'élément
Pour une fenêtre Modifier l'élémentouverte :
MKSSI_ISSUE=<ID of item open for edit>
MKSSI_ISSUE0=<same ID as MKSSI_ISSUE>
MKSSI_REVISION_NAME=<revision name>
Par exemple, 1.2
MKSSI_REVISION_DATE=<revision date>
Par exemple, Mon Mar 26 14:53:35
Si le champ Modification significative depuis la révision de l'élément est défini sur true pour l'élément correspondant :
MKSSI_REVISION_DELTA=true
|
|
Si l'élément n'est pas révisé ou s'il ne comporte aucun historique de révision, aucune variable n'est exportée.
|
Eléments
Pour une fenêtre Elémentsouverte :
MKSSI_NISSUE=<number of MKSSI_ISSUE objects>MKSSI_ISSUE[x]=<ID of selected item>
Lorsque la valeur de [x] commence à 0 et augmente avec chaque élément sélectionné.
MKSSI_QUERY=<current query for Items window>or
MKSSI_QUERY=<queryCreatorName>:<queryName>or
MKSSI_QUERYDEFINITION=<queryDefinition>
MKSSI_NFIELD=<number of columns in view>
MKSSI_FIELD[x]=<display name of each field displayed as columns
in the view>
Configuration de colonne pour une fenêtre Eléments ouverte :
MKSSI_NFIELD=<number of visible fields>
MKSSI_FIELD[x]=<name of each visible field>
Lorsque la valeur de [x] est comprise entre 1 et MKSSI_NFIELD.
MKSSI_FIELD[x]_WIDTH=<width of each visible field>
Lorsque la valeur de [x] est comprise entre 1 et MKSSI_NFIELD.
MKSSI_SORTFIELD=<name of the field that the view is sorted by>
MKSSI_SORTASCENDING=[true|false]
true si la vue est triée dans l'ordre croissant ; false si la vue est triée dans l'ordre décroissant.
Relations
Pour une fenêtre Relations ouverte :
MKSSI_NISSUE=<number of MKSSI_ISSUE objects>
MKSSI_ISSUE[x]=<ID of selected item>
Lorsque la valeur de [x] commence à 0 et augmente avec chaque élément sélectionné.
MKSSI_REVISION_NAME[x]=<revision name>
Par exemple, 1.2
MKSSI_REVISION_DATE[x]=<revision date>
Par exemple, Mon Mar 26 14:53:35
Si le champ Modification significative depuis la révision de l'élément est défini sur true pour l'élément correspondant :
MKSSI_REVISION_DELTA[x]=true
|
|
Les variables MKSSI_REVISION_NAME[x], MKSSI_REVISION_DATE[x] et MKSSI_REVISION_DELTA[x] exportent les informations de révision des éléments sélectionnés uniquement. La valeur de [x] commence à 0 et prend en charge les intervalles si l'élément MKSSI_ISSUE[x] correspondant n'est pas révisé. Si un élément n'est pas révisé ou ne comporte pas d'historique de révision, aucune variable spécifique à la révision n'est exportée.
|
Historique de membre
Pour une fenêtre Historique de membre ouverte :
MKSSI_FILE=<pathname-relative to project/sandbox of archive>
Si la fenêtre a été ouverte à partir d'une sandbox :
MKSSI_WORKINGFILE=<full-path-to-working-file>
MKSSI_SANDBOX=<full-path-to-sandbox>
MKSSI_PROJECT_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name#Subproject Name>
|
|
MKSSI_WORKINGFILE n'est pas défini si le fichier de travail n'existe pas.
|
Si la fenêtre a été ouverte à partir d'un projet :
MKSSI_PROJECT=<server-path-to-project>
MKSSI_PROJECT_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name#Subproject Name>
Si le projet/la sandbox était une variante :
MKSSI_VARIANT=<variantName>
Si le projet/la sandbox était une build :
MKSSI_BUILD=<buildNumber>
Si des révisions ont été sélectionnées :
MKSSI_REVISION=<highest revision in selection>
MKSSI_REVISION[x]=<1.2>
Autrement dit, il existe n variables entre MKSSI_REVISION1 et MKSSI_REVISION[x] contenant chaque numéro de révision sélectionné.
Projet
Pour une fenêtre Projet ouverte :
MKSSI_FILE=<server-side-project-path>
MKSSI_NMEMBER=<number of MKSSI_MEMBER[x] entries>
MKSSI_NSUBPROJECT=<number of MKSSI_SUBPROJECT[x] entries>
MKSSI_PROJECT_CONFIG_PATH=<project-configuration-path-
in-the form #/Project Name>
Si un membre est sélectionné, les variables suivantes s'appliquent :
MKSSI_MEMBER[x]=<path-relative-to-project>
MKSSI_MEMBER_PROJECT[x]=<server-side-project/subproject-path>
MKSSI_MEMBER[x]_PROJECT_CONFIG_PATH=<project-configuration-path-
in-the form #/Project Name#Subproject Name>
Si un sous-projet est sélectionné, les variables suivantes s'appliquent :
MKSSI_SUBPROJECT[x]=<path-relative-to-project>
MKSSI_SUBPROJECT_PROJECT[x]=<server-side-project/subproject-path>
MKSSI_SUBPROJECT[x]_CONFIG_PATH=<subproject-configuration-path-
in-the-form #/Project Name#Subproject Name>
Autrement dit, si n membres et m sous-projets sont sélectionnés, n occurrences de MKSSI_MEMBER sont numérotées de 1 à n et le nombre n est également transmis à MKSSI_NMEMBER. Il existe de plus des occurrences de MKSSI_SUBPROJECT numérotées de 1 à m, et le nombre m est transmis àMKSSI_NSUBPROJECT.
Si un sous-répertoire est sélectionné, il convient de procéder comme s'il était développé de manière récursive (seuls les répertoires et non les sous-projets) et tous les membres sont sélectionnés.
Dans la mesure où un membre donné n'est peut-être pas situé dans le projet de niveau supérieur ouvert dans la vue, chaque variable de MKSSI_MEMBER et MKSS_SUBPROJECT a une entrée correspondante pour MKSSI_MEMBER_PROJECT[x] et MKSSI_SUBPROJECT_PROJECT[x]. Par conséquent, chaque variable MEMBER/SUBPROJECT est relative à son entrée PROJECT correspondante et non au niveau supérieur indiqué dans MKSSI_FILE.
Par exemple :
i=1
while [ $i -le $MKSSI_NMEMBER ]
do
eval si command -P\${MKSSI_MEMBER_PROJECT$i}\${MKSSI_MEMBER$i}
let i=i+1
done
|
|
Si définies, les variables d'environnement MKSSI_VARIANT et MKSSI_BUILD sont également exportées lors de l'appel d'une si command avec les options --devpath et --projectrevision.
|
Historique de projet
Pour une fenêtre Historique de projet ouverte :
MKSSI_FILE=<server-side-project-path>
MKSSI_PROJECT_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name>
|
|
MKSSI_REVISION[x] est défini de la même manière qu'un historique de membre.
|
Sandbox
Pour une fenêtre Sandbox ouverte :
MKSSI_FILE=<full-path-to-sandbox>
MKSSI_NMEMBER=<number of MKSSI_MEMBER objects>
MKSSI_NSUBPROJECT=<number of MKSSI_SUBPROJECT objects>
MKSSI_PROJECT_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name>
Si un membre est sélectionné dans la fenêtre Sandbox :
MKSSI_MEMBER[x]_PROJECT_CONFIG_PATH=<project-configuration-path-
in-the-form #/Project Name#Subproject Name>
Si un sous-projet est sélectionné dans la fenêtre Sandbox :
MKSSI_SUBPROJECT[x]_CONFIG_PATH=<subproject-configuration-path-
in-the-form #/Project Name#Subproject Name>
MKSSI_SUBSANDBOX[x]=<local-Sandbox-path-of-the-currently-selected-
subsandbox-in-the-form C:\Sandbox Location\Project1\project.pj>
MKSSI_SUBSANDBOX[x]_PARENT=<local-Sandbox-path-of-the-parent-for-the-
currently-selected-subsandbox>
|
|
La variable MKSSI_MEMBER[x]= prend les mêmes paramètres que pour une fenêtre de projet. La variable correspondante MKSSI_MEMBER[x]_SANDBOX est également telle que décrite dans un projet. Le cas échéant, MKSSI_VARIANT et MKSSI_BUILD sont également définies.
La variable d'environnement de MKSSI_SUBPROJECT[x] est remplacée par MKSSI_SUBPROJECT[x]_CONFIG_PATH. La variable d'environnement de MKSSI_SUBPROJECT[x]_SANDBOX est remplacée par MKSSI_SUBSANDBOX[x] et MKSSI_SUBSANDBOX[x]_PARENT.
|
Projet enregistré
Pour une vue Projet enregistré ouverte :
MKSSI_PROJECT[x]_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name>
MKSSI_SUBPROJECT[x]_CONFIG_PATH=<subproject-configuration-path-
in-the-form #/Project Name#Subproject Name>
Sandbox enregistrée
Pour une vue Sandbox enregistrée ouverte :
MKSSI_PROJECT[x]_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name>
MKSSI_SUBPROJECT[x]_CONFIG_PATH=<subproject-configuration-path-
in-the-form #/Project Name#Subproject Name>
MKSSI_SUBSANDBOX[x]=<local-Sandbox-path-of-the-currently-selected-
subsandbox-in-the-form C:\Sandbox Location\Project1\project.pj>