Liens URL du client PTC RV&S
Vous pouvez envoyer des liens URL du client PTC RV&S dans les notifications par e-mail générées par le client, et permettre ainsi aux destinataires de cliquer sur ces liens et d'ouvrir les éléments associés dans plusieurs vues de l'interface utilisateur graphique du client PTC RV&S. Vous pouvez également inclure les liens URL dans les rapports et les lancer à partir d'autres emplacements URL, comme les pages Web, Internet Explorer et le menu Windows > .
 |
Les liens URL du client PTC RV&S sont pris en charge sur toutes les plateformes Windows compatibles avec le client PTC RV&S. Pour obtenir les informations actualisées sur les plateformes prises en charge par les produits, consultez PTC Release Advisor.
|
Considérations clés
• Les URL du client PTC RV&S contiennent le nom du protocole integrity://, qui doit être enregistré auprès du système d'exploitation Windows sur chaque machine client. L'enregistrement est exécuté automatiquement lors de l'installation du client PTC RV&S.
Si le client PTC RV&S est installé plusieurs fois sur une même machine, le protocole est enregistré par défaut auprès du dernier client installé et est utilisé pour ouvrir les URL du client PTC RV&S. Vous pouvez enregistrer le protocole auprès de la même machine avec un client différent (ou désactiver l'option) dans le volet Général de la boîte de dialogue Configuration des préférences du client en activant/désactivant l'option Ce client PTC RV&S répondra aux liens URL PTC RV&S.. Pour plus d'informations, consultez la section Préférences générales.
|
|
Par défaut, les notifications par e-mail générées par le client PTC RV&S et le serveur PTC RV&S incluent les URL du client PTC RV&S, contrôlées dans le Client d'administration PTC RV&S par la propriété mksis.includeIntegrityGUILinks. Pour plus d'informations, consultez la rubrique relative aux notifications par e-mail ou contactez votre administrateur.
|
• Les URL du client PTC RV&S utilisent un protocole personnalisé non reconnu par Microsoft Outlook. Par conséquent, chaque fois que vous cliquez sur un lient URL du client PTC RV&S, la note de sécurité standard de Microsoft Office Outlook s'affiche pour vous demander si vous souhaitez continuer. Cliquez sur Oui dans la boîte de dialogue pour appeler l'URL du client PTC RV&S. Vous pouvez également entièrement désactiver la boîte de dialogue du protocole integrity:// en créant une entrée de registre dans le système d'exploitation. Pour plus d'informations, consultez l'article CS121955 du PTC eSupport Portal.
• Pour utiliser les URL du client PTC RV&S dans les champs de texte enrichi, le préfixe d'URL integrity doit être ajouté à la propriété mksis.im.validURLPrefixes sur le serveur PTC RV&S.
• Lors de l'installation du service pack du client, le protocole PTC RV&S ne s'installe automatiquement que s'il n'est pas enregistré auprès de ce client. Par conséquent, si vous désactivez le protocole pour un client puis appliquez un service pack à ce même client, le protocole peut être réactivé.
• Le protocole PTC RV&S se désinstalle automatiquement et ses entrées de registre sont supprimées lorsque vous désinstallez le client PTC RV&S. Toutefois, si le protocole est enregistré auprès d'un client différent (dans le cas où une même machine comporte plusieurs clients), les entrées de registre ne sont pas supprimées.
Syntaxe de l'URL du client PTC RV&S
La syntaxe de l'URL du client PTC RV&S se présente comme suit :
integrity://<server>:<port>/<app>/<command>?selection=<id>
&<option1>=<value1>&<option2>=<value2>
où :
• integrity:// correspond au protocole de l'URL PTC RV&S enregistré sous Windows ;
• server correspond au nom d'hôte de la machine sur laquelle le serveur PTC RV&S est installé ;
|
|
Le nom d'hôte peut être déterminé en fonction des valeurs définies par votre administrateur.
|
• port correspond au numéro de port de la machine sur laquelle le serveur PTC RV&S est installé ;
• app est l'abréviation de l'application PTC RV&S spécifique au domaine. Par exemple, im=Processus et documents, si=Gestion de configurations, extended-web-ui=Interface Web actualisée.
• command est le nom de la commande de la CLI et de la vue correspondante à appeler, par ex., viewissue (pour plus d'informations, consultez la section Vues, commandes et options de commande prises en charge) ;
• selection=id correspond à l'ID de l'élément PTC RV&S nécessaire à la commande (peut être une liste de valeurs séparées par une virgule ou une espace, les espaces étant représentées dans l'URL par %20. Par exemple, selection=12345%2023456%203456) ;
• option=value correspond à un nombre arbitraire de paramètres supplémentaires (correspond aux options de commande de la CLI (définir les options à valeurs multiples sous forme de liste séparée par une virgule)).
|
|
Un codage est requis pour les valeurs des options de commande. Pour plus d'informations, consultez la rubrique Considérations et exigences de codage des URL.
|
Envoi et réception de notifications par e-mail comportant des liens URL de client PTC RV&S
Vous pouvez créer des notifications par e-mail comportant des URL du client PTC RV&S en cliquant sur un nom d'utilisateur mis en surbrillance dans n'importe quel champ visible de l'interface utilisateur graphique ou de l'interface Web. L'application de messagerie par défaut s'ouvre et affiche un nouveau message adressé à l'utilisateur que vous avez sélectionné.
L'objet de l'e-mail est une courte description de l'élément et le corps contient deux liens hypertexte. Le premier lien ouvre l'élément correspondant dans l'interface Web de PTC RV&S et le second ouvre le même élément dans l'interface utilisateur graphique du client PTC RV&S. Par exemple, cliquez sur l'utilisateur jriley dans l'en-tête de la vue Détails d'éléments de l'élément 1234 pour générer un e-mail contenant les liens suivants :
WEB: https://jriley.abcfinancial.com:7001/im/issues?selection=1234
REFRESHED WEB: https://jriley.abcfinancial.com:7001/extended-web-ui/items/item/1234
GUI: url:integrity://jriley.abcfinancial.com:7001/im/viewissue?selection=1234
|
|
En fonction de votre application de messagerie, il est possible que vous ne puissiez pas cliquer sur le lien URL du client PTC RV&S ou qu'il ne soit pas actif avant que le destinataire ne reçoive la notification par e-mail.
|
Lorsque vous générez un e-mail à partir d'une vue d'historique, l'objet et le corps de l'e-mail comportent l'heure et la date "A partir de" correspondant à la vue d'historique. Par exemple, dans l'onglet Historique de l'élément 1234, cliquez sur l'utilisateur jriley du July 9, 2012 9:15:25 PM EST pour générer une notification par e-mail contenant les liens suivants :
WEB: https://jriley.abcfinancial.com:7001/im/issues?selection=1234&asOf=20120709T211525Z
REFRESHED WEB: https://jriley.abcfinancial.com:7001/extended-web-ui/items/item/1234?asof=2012-07-09T21:15:25Z
GUI: url:integrity://jriley.abcfinancial.com:7001/im/viewissue?selection=1234&asOf=20120709T211525Z
L'horodatage et la date "A partir de" sont au format de base ISO 8601 et exprimés en temps universel coordonné (UTC). Ils sont spécifiés en tant que date et heure complètes et comportent un indicateur de fuseau horaire, par exemple :
AAAAMMjjThhmmssZ
où :
• AAAAMMjj représente respectivement l'année (4 chiffres), le mois et le jour (2 chiffres) (un 0 doit précéder les jours et mois à chiffre unique) ;
• T permet de séparer la date de l'heure ;
• hhmmss représente respectivement l'heure, les minutes et les secondes (2 chiffres) (un 0 doit précéder les heures, minutes et secondes à chiffre unique) ;
• Z correspond à l'indicateur de fuseau horaire UTC (décalage de zéro).
|
|
L'heure est définie au format 24 heures (00:00:00 à 23:59:59 inclus). Par exemple, une URL qui fait référence à 13:56:45 est identique à une URL faisant référence à 1:56:45 PM.
En outre, l'heure est spécifiée en fonction de l'heure locale de l'expéditeur. Si le destinataire se trouve dans un fuseau horaire différent de l'expéditeur, l'élément ouvert via le lien s'affiche dans le fuseau horaire local.
|
Lorsque vous recevez des notifications par e-mail contenant des liens URL du client PTC RV&S, notez les points suivants :
• Dans les clients de messagerie Microsoft Outlook, l'URL du client PTC RV&S apparaît sous la forme d'un lien cliquable.
• Dans l'interface Web de Microsoft Outlook, les liens cliquables de l'interface utilisateur client ne sont pris en charge par aucun navigateur.
• Dans les clients de messagerie Lotus Notes, l'URL du client PTC RV&S apparaît sous la forme d'un texte brut non cliquable. Vous pouvez copier le texte dans un navigateur ou dans la boîte de dialogue Windows > pour ouvrir la même vue que si vous aviez cliqué sur un lien d'un client Microsoft Outlook.
Informations de révision de l'élément PTC RV&S dans un e-mail généré par le client
Si la révision d'élément est activée, PTC RV&S fournit également des informations de résumé améliorées dans les e-mails générés depuis le client PTC RV&S lorsque vous cliquez sur un lien de nom d'utilisateur. Lorsque vous cliquez sur un lien de nom d'utilisateur dans un élément d'historique, le champ d'objet de l'e-mail généré par le client inclut les informations de révision des éléments au format suivant :
Type <ID d'élément> : Résumé de l'élément [informations de révision] à partir de date
En outre, lorsque la révision de l'élément est activée, le corps de texte de l'e-mail généré par le client inclut :
A partir de : [informations de révision] date
Pour afficher le contexte historique d'un élément PTC RV&S, accédez à l'onglet Historique et cliquez sur le lien d'horodatage de la date requise pour ouvrir l'élément d'historique. Vous pouvez ensuite ouvrir un e-mail à partir de l'élément d'historique PTC RV&S en cliquant sur un lien de nom d'utilisateur (par exemple, les utilisateurs relatifs aux champs Utilisateur affecté, Modifié par ou Créé par).
|
|
Les informations de révision des éléments ne figurent pas dans le message électronique généré par le client lorsque vous cliquez sur un lien dans l'historique d'élément, ou si vous travaillez à partir d'un élément pour lequel la première révision n'a pas été définie.
|
Si la révision d'élément n'est pas activée, PTC RV&S crée le format standard de l'e-mail généré.
Vues, commandes et options de commande prises en charge
Le tableau suivant décrit les vues de l'interface utilisateur graphique du client PTC RV&S ainsi que les commandes et options de commande de la CLI correspondantes prises en charge dans les URL du client PTC RV&S :
|
Vue de l'interface utilisateur graphique du client PTC RV&S
|
Commandes de la CLI / Options prises en charge
|
Exemples d'URL de l'interface Web de première génération
|
Exemples d'URL de l'interface Web actualisée
|
||||
|---|---|---|---|---|---|---|---|
|
Vue Eléments
|
im issues--query--queryDefinition--fields--sortField--sortAscending--nosortAscending
|
Pour ouvrir un élément dans l'interface utilisateur graphique du client PTC RV&S dans la vue Eléments :
integrity://localhost:9001/im/issues?query=MyQuery&fields=Summary%2cPriority&sortField=Priority&sortAscending
|
Pour ouvrir un élément dans la vue Eléments de l'interface Web actualisée :
integrity://localhost:9001/extended-web-ui/items?query=MyQuery&fields=Summary%2cPriority&sortField=Priority&sortAscending
Les caractères spéciaux suivants ne sont pas pris en charge dans la définition de requête :
• signe plus (+)
• signe égal (=)
• deux-points (:)
• point-virgule (;)
• arobase (@)
• esperluette (&)
• point d'interrogation (?)
• signe dollar ($)
• virgule (,)
• barre oblique (/)
• étoile (*)
• point d'exclamation (!)
• guillemet simple (')
• crochet ouvrant ([)
• crochet fermant (])
• parenthèse ouvrante (
• parenthèse fermante )
• accolade ouvrante ({)
• accolade fermante (})
|
||||
|
Vue Détails d'éléments
|
im viewissue--asof
|
Pour ouvrir un élément dans l'interface utilisateur graphique du client PTC RV&S dans la vue Détails d'éléments :
integrity://localhost:9001/im/viewissue? selection=1234
Pour ouvrir un élément dans l'interface utilisateur graphique du client PTC RV&S dans la vue d'historique Détails d'éléments :
integrity://localhost:9001/im/viewissue?selection=1234&asOf=20120730T190323Z
|
Pour ouvrir un élément dans la vue Détail d'éléments de l'interface Web actualisée :
integrity://localhost:9001/extended-web-ui/items/item/1234
Pour ouvrir un élément dans la vue d'historique Détail d'éléments de l'interface Web actualisée :
integrity://localhost:9001/extended-web-ui/items/item/1234?asOf=20120730T190323Z
|
||||
|
Vue Document
|
im viewsegment--asof--fields--outlineColumns
|
Pour ouvrir un document dans l'interface utilisateur graphique du client PTC RV&S dans la vue Document :
integrity://localhost:9001/im/viewsegment?selection=1234&fields=Category%2cText
|
Pour ouvrir un document dans la vue DocStudio de l'interface Web actualisée :
integrity://localhost:9001/extended-web-ui/doc-workspace/doc/1234?fields=Category%2cText
|
||||
|
Vue Relations
|
im relationships--asof--fields
|
Pour ouvrir un document dans l'interface utilisateur graphique du client PTC RV&S dans la vue Relations :
integrity://localhost:9001/im/relationships?selection=1234&fields=ID%2cType%2cState%2cSummary
|
Pour ouvrir un document dans la vue Relations de l'interface Web actualisée :
integrity://localhost:9001/extended-web-ui/relationships/item/1234?fields=ID,Type,State,Summary
|
||||
|
Visualiseur de trace source
|
im viewsourcetraces--project--asof--devpath--scmHost--scmPort--fields--projectrevision--revision--sortField--sortAscending--nosortAscending
|
Pour ouvrir le visualiseur de trace source pour le membre d'un projet/sous-projet normal :
integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=c%3a%2fproject.pj& revision=1.0
Pour ouvrir le visualiseur de trace source pour le membre d'un sous-projet variant :
integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=c%3A%2Fproject.pj&devpath=TestDevPath&revision=1.0
ou
integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=%23c%3A%2F%23d%3DTestDevPath&revision=1.0
Pour ouvrir le visualiseur de trace source pour le membre d'un projet/sous-projet figé :
integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=c%3A%2Fproject.pj&projectrevision=1.0&revision=1.0
ou
integrity://localhost:9001/si/viewsourcetraces?selection=code.java&project=%23c%3A%2F%23b%3D1.0&revision=1.0
|
La fonctionnalité Gestion de configurations n'est pas prise en charge dans l'interface Web actualisée
|
||||
|
Projet source
|
si viewproject--project--devpath--projectrevision--filtersubs--nofiltersubs
|
Pour ouvrir l'interface utilisateur graphique du client PTC RV&S dans la vue Projet source comportant des sous-projets vides filtrées :
integrity://localhost:9001/si/viewproject?project=%2FTestProject%2Fproject.pj&filtersubs
|
La fonctionnalité Gestion de configurations n'est pas prise en charge dans l'interface Web actualisée
|
||||
|
Historique de membre source
|
si viewhistory--project--devpath--projectrevision
|
Pour ouvrir l'interface utilisateur graphique du client PTC RV&S dans la vue Historique de membre source :
integrity://localhost:9001/si/viewhistory?selection=source.java&project=%2FTestProject%2Fproject.pj
|
La fonctionnalité Gestion de configurations n'est pas prise en charge dans l'interface Web actualisée
|
||||
|
Lot de modifications
|
si viewcp
|
Pour ouvrir l'interface utilisateur graphique du client PTC RV&S dans la vue Lot de modifications :
integrity://localhost:9001/si/viewcp?selection=1234%3A1
|
La fonctionnalité Gestion de configurations n'est pas prise en charge dans l'interface Web actualisée
|
||||
|
Tableau de bord
|
im rundashboard--fieldFilter
|
Pour ouvrir l'interface utilisateur graphique du client PTC RV&S et exécuter un tableau de bord spécifié :
integrity://localhost:9001/im/rundashboard?selection=%22My%20Dashboard%22
|
Pour exécuter un tableau de bord spécifié dans l'interface Web actualisée :
https://ppuwsv-alm18t.ptcnet.ptc.com:1340/extended-web-ui/dashboards/run?selection=__id121
|
||||
|
Rapport
|
im runreport--fieldFilter--asOf--issues--query--param--[no]substituteParams
|
Pour ouvrir l'interface utilisateur graphique du client PTC RV&S et exécuter un rapport spécifié :
integrity://localhost:9001/im/runreport?selection=%22My%20Report%22
|
Pour exécuter un rapport spécifié dans l'interface Web actualisée :
https://ppuwsv-alm18t.ptcnet.ptc.com:1340/extended-web-ui/reports/run?selection=12345
|
||||
|
Graphique
|
im runchart--fieldFilter--query
|
Pour ouvrir l'interface utilisateur graphique du client PTC RV&S et exécuter un graphique spécifié :
integrity://localhost:9001/im/runchart?selection=%22My%20Chart%22
|
Pour exécuter un graphique spécifié dans l'interface Web actualisée :
https://ppuwsv-alm18t.ptcnet.ptc.com:1340/extended-web-ui/charts/run?selection=__id158
|
|
|
Si la propriété mksis.im.enableautomaticredirectiontoRWI est définie sur true, toutes les URL pointant vers l'interface Web de première génération sont redirigées vers l'interface Web actualisée.
|
En outre, notez les points suivants concernant les options de commande --project, --tviguiet --notvigui :
• L'option --project prend en charge les syntaxes de chemin de configuration source et de chemin à plat. En utilisant la syntaxe de chemin de configuration source avec l'option --project, vous pouvez spécifier les projets variants et figés sans utiliser les options --devpath et --projectrevision.
Par exemple, au lieu de spécifier les deux options,
project=c%3A%2Fproject.pj&devpath=TestDevPath
vous pouvez spécifier une option unique
project=%23c%3A%2F%23d%3DTestDevPath
Pour plus d'informations sur ces syntaxes, consultez la section "Spécification de projets de gestion de configuration" de la page de manuel options des Pages de manuel de la CLI.
• Les options --tvigui et --notvigui sont disponibles pour toutes les commandes prises en charge. Ces options contrôlent si l'URL du client PTC RV&S lance la commande spécifiée dans l'interface à onglets, qui correspond à la vue client prenant entièrement en charge les jeux de vues, ou dans la vue flottante.
◦ Si l'option --tvigui n'est pas spécifiée, la commande lance l'interface utilisateur graphique à onglets. En d'autres termes, l'interface utilisateur graphique du client PTC RV&S s'ouvre en utilisant le jeu de vues actuel de l'utilisateur et la configuration du jeu de vues contrôle l'ouverture de la commande dans une vue flottante ou ancrée.
◦ Si l'option --notvigui est spécifiée, la commande se lance dans la vue flottante, (l'interface utilisateur graphique à onglets n'est pas lancée).
|
|
Pour plus d'informations sur les jeux de vues, consultez la section Présentations des jeux de vues (interface utilisateur graphique).
|
Toutes les URL de client PTC RV&S générées par le système sont définies sur --tvigui. Integrity peut être modifié pour générer des URL autonomes (--notvigui). Toutefois, votre administrateur doit personnaliser les scripts de déclenchement qui génèrent les notifications par e-mail.