URL-Links des Windchill RV&S Clients
Sie können URL-Links des Windchill RV&S Clients in clientgenerierten E-Mail-Benachrichtigungen senden, sodass Empfänger auf die Links klicken und die zugeordneten Elemente in verschiedenen GUI-Ansichten des Windchill RV&S Clients öffnen können. Sie können die URL-Links auch in Berichte einschließen und über andere URL-Adressen wie Webseiten, Internet Explorer und das Windows-Menü > starten.
|
|
URL-Links des Windchill RV&S Clients werden auf allen Windows-Plattformen unterstützt, die vom Windchill RV&S Client unterstützt werden. Die aktuellsten Unterstützungsinformationen für Produktplattformen finden Sie im englischen Dokument Windchill RV&S Supported Platforms. |
Wichtige Hinweise
• Windchill RV&S Client URLs enthalten den Protokollnamen integrity://, der beim Windows-Betriebssystem auf jedem Client-Rechner registriert sein muss. Die Registrierung erfolgt automatisch, wenn Sie den Windchill RV&S Client installieren.
Wenn mehrere Installationen des
Windchill RV&S Clients auf einem Rechner installiert sind, wird das Protokoll standardmäßig beim letzten installierten Client registriert und zum Öffnen von
Windchill RV&S Client URLs verwendet. Sie können das Protokoll bei einem anderen Client auf demselben Rechner registrieren (oder die Option deaktivieren). Schalten Sie dazu im Fensterbereich
Allgemein des Client-Dialogfensters
Einstellungskonfiguration die Option
Dieser Windchill RV&S Client antwortet auf Windchill RV&S URL-Links. um. Weitere Informationen finden Sie unter
Allgemeine Einstellungen.
|
|
Von Windchill RV&S Client und Windchill RV&S Server generierte E-Mail-Benachrichtigungen enthalten standardmäßig Windchill RV&S Client URLs, die im Windchill RV&S Administration Client durch die Eigenschaft mksis.includeIntegrityGUILinks gesteuert werden. Weitere Informationen finden Sie im Thema zu E-Mail-Benachrichtigungen oder wenden Sie sich an Ihren Administrator.
|
• Windchill RV&S Client URLs verwenden ein benutzerdefiniertes Protokoll, das von Microsoft Outlook nicht erkannt wird. Deshalb werden jedes Mal, wenn Sie auf einen URL-Link des
Windchill RV&S Clients klicken, die Standardeingabeaufforderungen der Microsoft Office Outlook-Sicherheitswarnung angezeigt, in denen Sie gefragt werden, ob Sie fortfahren möchten. Klicken Sie im Dialogfenster auf
Ja, um die
Windchill RV&S Client URL aufzurufen. Alternativ können Sie das Dialogfenster für das Protokoll
integrity:// vollständig deaktivieren, indem Sie einen Registrierungseintrag im Betriebssystem erstellen. Weitere Informationen dazu finden Sie im Artikel
CS121955 im
PTC eSupport Portal.
• Um Windchill RV&S Client URLs in Rich-Text-Feldern zu verwenden, muss das URL-Präfix integrity zur Eigenschaft mksis.im.validURLPrefixes auf dem Windchill RV&S Server hinzugefügt werden.
• Wenn Sie ein Client Service Pack installieren, wird das Windchill RV&S Protokoll nur automatisch installiert, wenn es derzeit nicht bei dem Client registriert ist. Wenn Sie das Protokoll für einen Client deaktivieren und später ein Service Pack auf denselben Client anwenden, wird das Protokoll möglicherweise auf dem Client erneut aktiviert.
• Das Windchill RV&S Protokoll wird automatisch deinstalliert, und seine Registrierungseinträge werden entfernt, wenn Sie den Windchill RV&S Client deinstallieren. Wenn das Protokoll jedoch bei einem anderen Client registriert ist (im Falle mehrerer Clients auf einem einzelnen Rechner), werden die Registrierungseinträge nicht entfernt.
URL-Syntax des Windchill RV&S Clients
Die Syntax der Windchill RV&S Client URL ist wie folgt:
integrity://<server>:<port>/<app>/<command>?selection=<id>
&<option1>=<value1>&<option2>=<value2>
Dabei gilt:
• integrity:// ist das Windchill RV&S URL-Protokoll, das bei Windows registriert ist
• server ist der Hostname des Rechners, auf dem der Windchill RV&S Server installiert ist
|
|
Der Hostname kann basierend auf von Ihrem Administrator definierten Werten bestimmt werden.
|
• port ist die Portnummer des Rechners, auf dem der Windchill RV&S Server installiert ist
• app ist die Abkürzung für die domänenspezifische Windchill RV&S Anwendung, z.B. im=Workflows und Dokumente, si=Konfigurationsverwaltung
• command ist der Name des CLI-Befehls und der entsprechenden Ansicht, die aufgerufen werden soll, z.B. viewissue (weitere Information finden Sie unter Unterstützte Ansichten, Befehle und Befehlsoptionen)
• selection=id ist die Windchill RV&S Element-ID, die für den Befehl erforderlich ist (kann eine komma- oder leerzeichengetrennte Liste von Werten sein, wobei Leerzeichen mit %20 URL-kodiert werden, z.B. selection=12345%2023456%203456)
• option=value ist eine beliebige Anzahl von zusätzlichen Einstellungen (entspricht CLI-Befehlsoptionen (mehrere Werteoptionen als kommagetrennte Liste definieren))
|
|
Kodierung ist für die Werte der Befehlsoptionen erforderlich. Weitere Informationen finden Sie unter Anforderungen und Hinweise zur URL-Kodierung.
|
E-Mail-Benachrichtigungen mit URL-Links des Windchill RV&S Clients senden und empfangen
Sie können E-Mail-Benachrichtigungen mit Windchill RV&S Client URLs erstellen, indem Sie in einem sichtbaren Feld der GUI oder Weboberfläche auf einen hervorgehobenen Benutzernamen klicken. Dadurch wird die Standard-E-Mail-Anwendung mit einer neuen Nachricht, die an den ausgewählten Benutzer adressiert ist, geöffnet.
Der E-Mail-Betreff ist eine kurze Beschreibung des Elements, und der Text enthält zwei Hyperlinks. Der erste Hyperlink öffnet das jeweilige Element in der Windchill RV&S Weboberfläche, und der zweite Hyperlink öffnet dasselbe Element in der Windchill RV&S Client GUI. Klicken Sie z.B. auf Benutzer jriley in der Kopfzeile der Ansicht "Elementdetail" des Elements 1234, um eine E-Mail mit den folgenden Links zu generieren:
WEB: http://jriley.abcfinancial.com:7001/im/issues?selection=1234
GUI: url:integrity://jriley.abcfinancial.com:7001/im/viewissue?selection=1234
|
|
Je nach E-Mail-Anwendung ist der URL-Link des Windchill RV&S Clients möglicherweise erst aktiv oder klickbar, wenn der Empfänger die E-Mail-Benachrichtigung erhält.
|
Wenn Sie E-Mails in einer historischen Ansicht generieren, werden in den E-Mail-Betreff und -Text Stand-von-Datum und -Uhrzeit eingefügt, die der historischen Ansicht entsprechen. Klicken Sie z.B. auf der Registerkarte "Verlauf" des Elements 1234 auf Benutzer jriley am July 9, 2012 4:15:25 PM EST, um eine E-Mail-Benachrichtigung mit den folgenden Links zu generieren:
WEB: http://jriley.abcfinancial.com:7001/im/issues?selection=1234&asOf=20120709T211525Z
GUI: url:integrity://jriley.abcfinancial.com:7001/im/viewissue?selection=1234&asOf=20120709T211525Z
Der Datums- und Zeitstempel ist im ISO-Basisformat 8601 in der koordinierten Weltzeit (UTC, Coordinated Universal Time) und als vollständiges Datum und Uhrzeit mit einem Zeitzonen-Designator angegeben, z.B.:
YYYYMMddThhmmssZ
Dabei gilt:
• YYYYMMdd Jahreszahl vierstellig, Monats- und Tageszahl zweistellig (für Monate und Tage, die nur eine Ziffer umfassen, ist eine führende Null erforderlich)
• T trennt das Datum von der Uhrzeit
• hhmmss Stunden, Minuten und Sekunden zweistellig (für Stunden, Minuten und Sekunden, die nur eine Ziffer umfassen, ist eine führende Null erforderlich)
• Z ist der Zeitzonen-Designator für den UTC-Offset von Null
|
|
Die Uhrzeit wird von 00:00:00 Uhr bis einschließlich 23:59:59 Uhr im 24-stündigen Format angegeben, z.B. ist eine URL, die sich auf die Uhrzeit 13:56:45 Uhr bezieht, identisch mit derjenigen für 1:56:45 PM.
Die Uhrzeit wird außerdem basierend auf der lokalen Zeit des Absenders angegeben. Wenn sich der Empfänger in einer anderen Zeitzone als der Absender befindet, wird das Element in der lokalen Zeitzone angezeigt, sobald auf den Link geklickt und das Element geöffnet wird.
|
Wenn Sie E-Mail-Benachrichtigungen mit URL-Links des Windchill RV&S Clients erhalten, beachten Sie Folgendes:
• In Microsoft Outlook-E-Mail-Clients wird die Windchill RV&S Client URL als klickbarer Link angezeigt.
• In Microsoft Outlook Web werden klickbare GUI-Links in keinem Browser unterstützt.
• In Lotus Notes-E-Mail-Clients wird die Windchill RV&S Client URL als einfacher Text angezeigt, der nicht klickbar ist. Sie können den Text in einen Browser oder das Windows-Dialogfenster > kopieren, um dieselbe Ansicht zu öffnen, die beim Klicken auf einen Link im Microsoft Outlook-Client geöffnet wird.
Revisionsinformationen für Windchill RV&S Elemente in clientgenerierter E-Mail
Wenn die Elementrevisionierung aktiviert ist, liefert Windchill RV&S auch erweiterte Zusammenfassungsinformationen in E-Mails, die vom Windchill RV&S Client generiert werden, wenn Sie auf einen Benutzernamen-Link klicken. Wenn Sie in einem historischen Element auf einen Benutzernamen-Link klicken, enthält der Betreff der clientgenerierten E-Mail Revisionsinformation für das Element in folgendem Format:
Typ <Element-ID>: Elementzusammenfassung [Revisionsinformationen] mit Stand von Stand-von-Datum
Wenn die Elementrevisionierung aktiviert ist, enthält der Text der clientgenerierten E-Mails Folgendes:
Mit Stand von: [Revisionsinformationen] Stand-von-Datum
Um den historischen Kontext für ein Windchill RV&S Element anzuzeigen, navigieren Sie zur Registerkarte Verlauf, und klicken Sie auf den Zeitstempel-Link, damit das erforderliche Datum das historische Element öffnet. Anschließend können Sie eine E-Mail-Nachricht über das historische Windchill RV&S Element öffnen, indem Sie auf einen Benutzernamen-Link klicken (z.B. Zugewiesener Benutzer, Geändert von oder Erstellt von).
|
|
Revisionsinformationen für das Element sind nicht in der clientgenerierten E-Mail enthalten, wenn Sie auf einen Link im Elementverlauf klicken oder in einem Element arbeiten, in dem die erste Revision nicht festgelegt wurde.
|
Wenn die Elementrevisionierung nicht aktiviert ist, erstellt Windchill RV&S das Standardformat für die generierte E-Mail.
Unterstützte Ansichten, Befehle und Befehlsoptionen
In der folgenden Tabelle werden die GUI-Ansichten des Windchill RV&S Clients und entsprechenden CLI-Befehle und Befehlsoptionen beschrieben, die in Windchill RV&S Client URLs unterstützt werden:
|
GUI-Ansicht des Windchill RV&S Clients
|
CLI-Befehl/Unterstützte Optionen
|
URL-Beispiele
|
|
Ansicht "Elemente"
|
im issues--query--queryDefinition--fields--sortField--sortAscending--nosortAscending
|
So öffnen Sie ein Element in der Windchill RV&S Client GUI in der Ansicht "Elemente":
integrity://localhost:9001/im/issues?query=MyQuery&fields=Summary%2cPriority&sortField=Priority&sortAscending
|
|
Ansicht "Elementdetail"
|
im viewissue--asof
|
So öffnen Sie ein Element in der Windchill RV&S Client GUI in der Ansicht "Elementdetail":
integrity://localhost:9001/im/viewissue? selection=1234
So öffnen Sie ein Element in der Windchill RV&S Client GUI in der historischen Ansicht "Elementdetail":
integrity://localhost:9001/im/viewissue?selection=1234&asOf=20120730T190323Z
|
|
Dokumentansicht
|
im viewsegment--asof--fields--outlineColumns
|
So öffnen Sie ein Dokument in der Windchill RV&S Client GUI in der Dokumentansicht:
integrity://localhost:9001/im/viewsegment?selection=1234&fields=Category%2cText
|
|
Ansicht "Beziehungen"
|
im relationships--asof--fields
|
So öffnen Sie ein Dokument in der Windchill RV&S Client GUI in der Ansicht "Beziehungen":
integrity://localhost:9001/im/relationships?selection=1234&fields=ID%2cType%2cState%2cSummary
|
|
Quellverfolgungs-Viewer
|
im viewsourcetraces--project--asof--devpath--scmHost--scmPort--fields--projectrevision--revision--sortField--sortAscending--nosortAscending
|
So öffnen Sie den Quellverfolgungs-Viewer für das Mitglied im normalen Projekt/Unterprojekt:
integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=c%3a%2fproject.pj& revision=1.0
So öffnen Sie den Quellverfolgungs-Viewer für das Mitglied im Varianten-Unterprojekt:
integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=c%3A%2Fproject.pj&devpath=TestDevPath&revision=1.0
oder
integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=%23c%3A%2F%23d%3DTestDevPath&revision=1.0
So öffnen Sie den Quellverfolgungs-Viewer für das Mitglied im Build-Projekt/-Unterprojekt:
integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=c%3A%2Fproject.pj&projectrevision=1.0&revision=1.0
oder
integrity://localhost:9001/si/viewsourcetraces?selection=code.java&project=%23c%3A%2F%23b%3D1.0&revision=1.0
|
|
Quellprojekt
|
si viewproject--project--devpath--projectrevision--filtersubs--nofiltersubs
|
So öffnen Sie die Windchill RV&S Client GUI in der Ansicht "Quellprojekt", wobei die leeren Unterprojekte herausgefiltert sind:
integrity://localhost:9001/si/viewproject?project=%2FTestProject%2Fproject.pj&filtersubs
|
|
Quellmitgliedsverlauf
|
si viewhistory--project--devpath--projectrevision
|
So öffnen Sie die Windchill RV&S Client GUI in der Ansicht "Quellmitgliedsverlauf":
integrity://localhost:9001/si/viewhistory?selection=source.java&project=%2FTestProject%2Fproject.pj
|
|
Änderungspaket
|
si viewcp
|
So öffnen Sie die Windchill RV&S Client GUI in der Ansicht "Änderungspaket":
integrity://localhost:9001/si/viewcp?selection=1234%3A1
|
|
Dashboard
|
im rundashboard--fieldFilter
|
So öffnen Sie die Windchill RV&S Client GUI und führen ein angegebenes Dashboard aus:
integrity://localhost:9001/im/rundashboard?selection=%22My%20Dashboard%22
|
|
Dashboard-Namen, die Leerzeichen enthalten, müssen mit Anführungszeichen URL-kodiert werden.
|
|
|
Bericht
|
im runreport--fieldFilter--asOf--issues--query--param--[no]substituteParams
|
So öffnen Sie die Windchill RV&S Client GUI und führen einen angegebenen Bericht aus:
integrity://localhost:9001/im/runreport?selection=%22My%20Report%22
|
|
Berichtsnamen, die Leerzeichen enthalten, müssen mit Anführungszeichen URL-kodiert werden.
|
|
Beachten Sie außerdem Folgendes zu den Befehlsoptionen --project, --tvigui und --notvigui:
• Die Option --project unterstützt die Syntaxen "Quellkonfigurationspfad" und "Flacher Pfad". Indem Sie die Syntax "Quellkonfigurationspfad" mit der Option --project verwenden, können Sie Variantenprojekte und Build-Projekte ohne Verwendung der Optionen --devpath und --projectrevision angeben.
Anstatt z.B. die zwei Optionen
project=c%3A%2Fproject.pj&devpath=TestDevPath
anzugeben, können Sie nur die folgende Option angeben
project=%23c%3A%2F%23d%3DTestDevPath
Weitere Informationen zu diesen Syntaxen finden Sie in der Man-Page options der CLI-Man-Pages unter "Konfigurationsverwaltungsprojekte angeben".
• Die Optionen --tvigui und --notvigui sind für alle unterstützten Befehle verfügbar. Diese Optionen steuern, ob die Windchill RV&S Client URL den angegebenen Befehl innerhalb der Benutzeroberfläche mit Ansicht im Registerformat (TVI, Tabbed View Interface), d.h. der Client-Ansicht mit vollständiger Unterstützung für Ansichtssätze, oder der unverankerten Ansicht startet.
◦ Wenn --tvigui nicht angegeben ist, wird der Befehl in der TVI-GUI gestartet. Das bedeutet: Die Windchill RV&S Client GUI wird mithilfe des aktuellen Ansichtssatzes des Benutzers geöffnet, und die Ansichtssatz-Konfiguration steuert, ob der Befehl in einer unverankerten oder gedockten Ansicht geöffnet wird.
◦ Wenn --notvigui angegeben ist, wird der Befehl in der unverankerten Ansicht gestartet (die TVI-GUI wird nicht gestartet).
Alle vom System generierten Windchill RV&S Client URLs werden auf --tvigui festgelegt. Integrity kann so geändert werden, dass eigenständige URLs (--notvigui) generiert werden. Ihr Administrator muss jedoch die Trigger-Skripte anpassen, die E-Mail-Benachrichtigungen generieren.
Anforderungen und Hinweise zur URL-Kodierung
Wenn Sie Windchill RV&S Client URLs erstellen, ist die Kodierung nur für die Werte der Befehlsoptionen erforderlich. (Kodieren Sie nicht die gesamte URL.)
Windchill RV&S geht davon aus, dass alle eingehenden
Windchill RV&S Client URLs nach RFC 1738 kodiert werden, um sicherzustellen, dass alle URL-Daten in und von UTF-8 konvertiert werden können. Gemäß den Empfehlungen des WWW Consortium verwendet die gesamte Kodierung und Dekodierung das UTF-8-Kodierungsschema, um maximale Kompatibilität sicherzustellen. Ein Leerzeichen wird z.B. als
%20 kodiert. Weitere Informationen finden Sie unter
http://docs.oracle.com/javase/8/docs/api/java/net/URLEncoder.html.
Alle unzulässigen Zeichen werden mit einem Prozentzeichen (%) kodiert, gefolgt von der zweistelligen hexadezimalen Darstellung des ISO-Latin-Codepunkts für das Zeichen.
Nachfolgend finden Sie Beispiele für Windchill RV&S Client URLs mit kodierten Optionen:
• integrity://localhost:9001/im/viewissue?selection=12345&asof=%222012-01-01%2014%3a01%3a00%20z%22
wobei 2012-01-01 12:01:00 z kodiert ist
• integrity://localhost:9001/si/viewproject?project=%2FTestProject%2Fproject.pj
wobei /TestProject/project.pj kodiert ist
• integrity://localhost:9001/im/viewissue?selection=12345&asof=jwWiki%20%e3%82%a2%e3%83%bc%e3%83%86%e3%82%a3%e3
• %82%af%e3%83%ab
wobei asof=jwWiki アーティクル kodiert ist
Wenn Sie benutzerdefinierte Trigger-Skripte oder Aktionen schreiben, die Windchill RV&S Client URLs generieren, empfiehlt PTC die Verwendung von Standardbibliotheken wie java.net.Encoder, um die Werte von Befehlsoptionen in der URL zu kodieren. Sie können z.B. eine Kodierung ausführen, indem Sie die Java-Kodierungsklasse aufrufen.
java.net.URLEncoder.encode(some_URL, "UTF-8")
Diese Kodierungsklasse entspricht RFC 1738 (URL-Spezifikation) und garantiert, dass die
Windchill RV&S Client URL beim Start des
Windchill RV&S Clients richtig dekodiert wird. Weitere Informationen finden Sie unter
http://www.rfc-editor.org/rfc/rfc1738.txt.
Die Trigger-Skriptdatei changePackageNotification.js verwendet diese Java-Klasse, um die Befehlsoptionen in ihren Windchill RV&S Client URLs zu kodieren. Dies wird im folgenden Beispiel gezeigt:
/**
* Return a URL-encoded string version of the argument passed in.
*/
function urlEncode(arg)
{
try {
return java.net.URLEncoder.encode(arg,"UTF-8");
} catch (err) {
// Fall-through
}
// If UTF-8 failed, just use the default encoding.
return java.net.URLEncoder.encode(arg);
}
In der folgenden Tabelle werden die Anforderungen und Hinweise zur Kodierung der Werte für die Befehlsoptionen in Windchill RV&S Client URLs beschrieben:
|
Zeichentypen
|
Anforderungen/Hinweise zur Kodierung
|
|
ASCII-Steuerzeichen
|
Alle Zeichen innerhalb des Bereichs 00-1F bis 7F müssen kodiert werden.
|
|
Reservierte Zeichen
|
Die folgenden Sonderzeichen sind reserviert:
• Dollarzeichen ($) Kodierung %24
• Und-Zeichen (\&) Kodierung %26
• Pluszeichen (+) Kodierung %2B
• Komma (,) Kodierung %2C
• Schrägstrich (/) Kodierung %2F
• Doppelpunkt (:) Kodierung %3A
• Semikolon (\;) Kodierung %3B
• Gleichheitszeichen (=) Kodierung %3D
• Fragezeichen (?) Kodierung %3F
• At-Zeichen (@) Kodierung %40
|
|
Unsichere Zeichen
|
Einige Sonderzeichen können innerhalb von URLs missverstanden werden. Sie könnten z.B. inkompatibel oder unzuverlässig sein. PTC empfiehlt, die folgenden Zeichen zu kodieren:
• Leerzeichen ( ) Kodierung %20 (insbesondere mehrere Leerzeichen)
• Anführungszeichen („“) Kodierung %22
• Kleiner-als-Zeichen (\<) Kodierung %3C
• Größer-als-Zeichen (\>) Kodierung %3E
• Nummernzeichen (#) Kodierung %23
• Prozent (%) Kodierung %25
• Geschweifte Klammer links ({) Kodierung %7B
• Geschweifte Klammer rechts (}) Kodierung %7D
• Senkrechter Strich (|) Kodierung %7C
• Umgekehrter Schrägstrich (\) Kodierung %5C
• Caret-Zeichen (^) Kodierung %5E
• Tilde (~) Kodierung %7E
• Eckige Klammer links ([) Kodierung %5B
• Eckige Klammer rechts (]) Kodierung %5D
• Graviszeichen (') Kodierung %60
|
|
Nicht-ASCII-Zeichen
|
Alle Nicht-ASCII-Zeichen müssen kodiert werden. Das schließt die gesamte obere Hälfte des ISO-Latin-Zeichensatzes 80-FF hexadezimal ein.
|
|
Unicode-Zeichen
|
Alle Unicode-Zeichen müssen kodiert werden. Das schließt alles oberhalb von FF ein.
|
