URL-Parameter

Dashboards können durch die effektive Verwendung von URL-Parametern verbessert werden. Ein URL-Parameter ist eine Eigenschaft, die der Konfiguration des Dashboards von dessen Autor hinzugefügt wird, und zum Auslösen von Aktionen verwendet werden kann. Dadurch ermöglichen URL-Parameter die Darstellung des Dashboards in der vorgegebenen Weise. URL-Parameter sind auch nützlich, wenn ein Dashboard in eine andere App eingebettet wird. In diesem Szenario können Sie mit der Hosting-App die aktuelle Ansicht des Dashboards ändern.

Hinweis:

Mit Ausnahme des integrierten Parameters für das Gebietsschema führt eine Änderung der Parameter eines Dashboards zur Laufzeit in den meisten modernen Browsern nicht dazu, dass es erneut geladen wird.

Ein URL-Parameter ist ein Name/Wert-Paar. In jedem Parameter werden der Name und der Wert durch ein Gleichzeichen (=) getrennt. Zur Laufzeit können Sie einen Parameter mithilfe eines Fragezeichens (?), gefolgt von dem Parameter, an das Ende der URL eines Dashboards anhängen.

Eine Dashboard-URL, die einen Parameter enthält, kann beispielsweise folgendermaßen lauten: <scheme>://<yourPortalUrl>/apps/opsdashboard/index.html#/<id>?param=value.

Fügen Sie bei mehreren Parametern jeweils ein kaufmännisches Und-Zeichen (&) zu deren Trennung hinzu: <scheme>://<yourPortalUrl>/apps/opsdashboard/index.html#/<id>?param=value&param2=value2

Tipp:

Die Reihenfolge der Parameter ist nicht relevant. param=value&param2=value2 und param2=value2&param=value führen beispielsweise zum selben Ergebnis.

Parameternamen bestehen aus alphanumerischen ASCII-Zeichen. Bindestriche (-) und Unterstriche ( _ ) sind ebenfalls zulässig, und zwar an jeder Stelle, ausgenommen an der ersten. Ungültige Zeichen werden beim Entwurf mit einer Validierungswarnung blockiert. Es empfiehlt sich, lange Parameternamen zu vermeiden.

Hinweis:

Einige Parameternamen sind für die interne Verwendung reserviert, z. B. mode und edit. Wenn Sie beim Erstellen eines Parameters einen reservierten Namen verwenden, tritt die Validierungswarnung Bereits verwendet auf.

Vorsicht:

Für die Interaktion zwischen Dashboard-Elementen werden sowohl URL-Parameter als auch Auswahlen verwendet. Werden sie für dieselben Elemente verwendet, können Sie im Widerspruch zueinander stehen und unerwartete Fehler verursachen. Lassen Sie beim Entwerfen der Interaktionen des Dashboards Vorsicht walten.

URL-Codierung

Codieren Sie den Wert eines Parameters, wenn Sie ihn an ein Dashboard übergeben. Durch die Codierung wird sichergestellt, dass ungültige Zeichen durch "%" gefolgt von ihrem entsprechenden Dezimalwert ersetzt werden.

Die Übergabe des Wertes "Main Street" über einen URL-Parameter erfolgt beispielsweise wie folgt:

<scheme>://<yourPortalUrl>/apps/opsdashboard/index.html#/<id>?param=Main%20Street

Beachten Sie Folgendes, wenn Sie einen URL-Parameter als Liste mit kommagetrennten Werten übergeben:

• Codieren Sie jeden Wert getrennt.

  Richtig

  ?param=Main%20Street,Broadway%20Avenue

  Falsch. Codieren Sie nicht das Komma, das zum Trennen von Werten verwendet wird.

  ?param=Main%20Street%2CBroadway%20Avenue

• Fügen Sie keine Leerzeichen zwischen Werten ein.

  Richtig

  ?param=Main%20Street,Broadway%20Avenue

  Falsch

  ?param=Main%20Street, Broadway%20Avenue

Typen von URL-Parametern

Es gibt fünf Typen von URL-Parametern: "Kategorie", "Numerisch", "Datum", "Feature" und "Geometrie". Informationen zu den Aktionstypen, die von den verschiedenen Parametertypen ausgelöst werden können, finden Sie unter Konfigurieren von Aktionen für URL-Parameter.

Kategorieparameter

Sie können einen Kategorieparameter verwenden, um eine Filteraktion auf ein oder mehrere Elemente anzuwenden. Legen Sie beim Entwurf den Namen des Parameters fest, und geben Sie an, ob Eingaben vom Typ "Zeichenfolge" oder "Zahl" sind und ob Filterabfragen die übergebenen Werte ein- oder ausschließen.

Zur Laufzeit akzeptieren Kategorieparameter entweder einen einzelnen Wert oder mehrere durch ein Komma getrennte Werte. Fügen Sie keine Leerstelle nach dem Komma ein.

Wird ein einzelner Wert übergeben, verwendet die Hintergrundabfrage den Vergleichsoperator "gleich" oder "ungleich", um die Zielelemente zu filtern. Werden mehrere Werte übergeben, werden die logischen Operatoren "IN" oder "NOT IN" verwendet.

Beispiele

Die folgende Tabelle enthält Hinweise dazu, ob der Kategorieparameter für eine Zeichenfolge oder eine Zahl konfiguriert wurde:

Parameter	Hinweis
?status=DAMAGED	Zeichenfolge
?status=DAMAGED,DESTROYED	Zeichenfolge mit mehreren Werten
?category=1	Zahl
?category=1,2	Zahl mit mehreren Werten

Beispiele für Sonderfälle

Datenkategorien werden nicht immer festgelegt, oder sind im Fall von Zeichenfolgen möglicherweise leer. Demzufolge unterstützen Parameter die folgenden vier Sonderfälle:

• ((null))
• ((notnull))
• ((empty))
• ((notempty))

Parameter	Hinweis
?status=((null))	Filter für Werte, die NULL sind
?status=((notnull)	Filter für Werte, die NICHT NULL sind
?status=((empty))	Filter für Werte, die leer sind
?status=((notempty))	Filter für Werte, die nicht leer sind
?status=DAMAGED,((null))	Filter für Werte, die übergeben wurden ODER NULL sind
?status=DAMAGED,DESTROYED,((null))	Filter für mehrere Werte, die übergeben wurden ODER NULL sind

Numerische Parameter

Sie können numerische Parameter verwenden, um eine Filteraktion auf ein oder mehrere Zielelemente anzuwenden. Legen Sie beim Entwurf den Namen des Parameters fest, und geben Sie an, ob die erwarteten Eingabewerte einzelne Werte oder zwei Werte sein sollen, die einen Bereich darstellen. Bei Verwendung eines einzelnen Wertes wird der Parameter für die Anwendung eines der folgenden Vergleichsparameter konfiguriert:

• gleich
• ungleich
• kleiner als
• kleiner als oder gleich
• größer als
• größer als oder gleich

Tipp:

Wenn Sie eine genauere Steuerung als die des Bereichswerttyps wünschen, erstellen Sie zwei einzelne numerische Parameter, und wenden Sie die Filterbedingung (Operator) an, die Ihren Anforderungen entspricht. Zur Laufzeit werden die einzelnen Parameter mit einem logischen UND-Operator kombiniert, wenn ein Filter auf die Zielelemente angewendet wird.

Zur Laufzeit werden numerische Parameter als einzelner Wert oder als zwei durch ein Komma getrennte Werte übergeben.

Beispiele

Die folgende Tabelle enthält Hinweise dazu, ob der numerische Parameter für einen einzelnen Wert oder einen Bereich konfiguriert wurde:

Parameter	Hinweis
?meas=10	Einzelner Wert
?meas=10,15	Bereich

Beispiele für Sonderfälle

Numerische Werte in Daten werden nicht immer festgelegt. Demzufolge unterstützen numerische Parameter zwei Sonderfälle: ((null)) und ((notnull)). Sie können diese Beschriftungen für Sonderfälle in Workflows für einzelne Werte und in Workflows für numerische Bereiche verwenden.

Parameter	Hinweis
?meas=((null))	Einzelner Datumswert oder numerischer Bereich. Filter für Werte, die NULL sind
?meas=((notnull))	Einzelner Datumswert oder numerischer Bereich. Filter für Werte, die NICHT NULL sind
?meas=10,((null))	Einzelwert. Filter für einen Wert ODER für Werte, die NULL sind
?meas=10,15,((null))	Numerischer Bereich. Filter für Zahlen in einem Bereich ODER für Werte, die NULL sind

Ein weiterer spezieller Fall liegt vor, wenn ein numerischer Parameter einen Bereich erwartet, zur Laufzeit jedoch nur ein einzelner Wert bereitgestellt wird.

Parameter	Hinweis
?meas=,10	Offen links. Werte, die kleiner oder gleich diesem Wert sind, werden gefiltert.
?meas=10,	Offen rechts. Werte, die größer oder gleich diesem Wert sind, werden gefiltert.
?meas=10	Offen rechts. Werte, die größer oder gleich diesem Wert sind, werden gefiltert.
?meas=10,((null))	Offen rechts. Filterwerte, die größer oder gleich diesem Wert ODER NULL sind

Datumsparameter

Sie können Datumsparameter verwenden, um eine Filteraktion auf ein oder mehrere Zielelemente anzuwenden. Legen Sie beim Entwurf den Namen des Parameters fest, und geben Sie an, ob die erwarteten Eingabewerte ISO 8601-Datumszeichenfolgen oder UNIX Epoch sein sollen.

Sie können Datumsparameter für die Verarbeitung eines einzelnen Wertes oder zweier Werte konfigurieren, die einen Datumsbereich darstellen. Bei Verwendung eines einzelnen Wertes wird der Parameter für die Anwendung eines der folgenden Vergleichsparameter konfiguriert:

• ist
• ist nicht
• ist vor
• ist oder ist vor
• ist nach
• ist oder ist nach

Tipp:

Wenn Sie eine genauere Steuerung als die des Bereichswerttyps wünschen, erstellen Sie zwei einzelne Datum-Parameter, und wenden Sie die Filterbedingung (Operator) an, die Ihren Anforderungen entspricht. Zur Laufzeit werden die einzelnen Datumsparameter mit einem logischen UND-Operator kombiniert, wenn ein Filter auf die Zielelemente angewendet wird.

Zur Laufzeit werden Datum-Parameter als ein einzelner Wert oder als zwei durch ein Komma getrennte Werte übergeben. Wenn ein Datumsparameter vom Typ "UNIX Epoch" ist, muss es sich um einen ganzzahligen 32-Bit-Wert mit Vorzeichen handeln. Handelt es sich um eine Zeichenfolge, müssen Datumsangaben als JJJJ-MM-TT oder JJJJMMTT formatiert werden. Datumsangaben werden gemäß dem gregorianischen Kalender eingegeben und bestehen aus Jahres-, Monats- und Tagesangaben.

• JJJJ: Vierstellige Jahresangabe (JJJJ)
• MM: Zweistellige Monatsangabe des Jahres (01 bis 12)
• DD: Zweistellige Tagesangabe (01 bis 31)

Tipp:

Die Liste der von Datumsparametern unterstützten Datumsformate unterscheidet sich von der, die vom Reihendiagramm zum Analysieren von Datumsangaben unterstützt wird.

Eine Uhrzeit kann auch in eine Datumsangabe einbezogen werden. Uhrzeitangaben werden im 24-Stunden-Format eingegeben und bestehen aus Stunden-, Minuten- und Sekundenangaben. Sie können sie als hh:mm:ss oder hhmmss formatieren. Wenn die Datumsangabe keine Uhrzeit enthält, wird der vollständige Tag zwischen 00:00:00 und 23:59:59 impliziert.

• hh: Eine mit Nullen aufgefüllte Stundenangabe zwischen 00 und 24
• mm: Eine mit Nullen aufgefüllte Minutenangabe zwischen 00 und 59
• ss: Eine mit Nullen aufgefüllte Sekundenangabe zwischen 00 und 59

Falls die Uhrzeit angegeben ist, wird sie durch eine Leerstelle oder den Großbuchstaben "T" von der Datumsangabe getrennt. Bei den folgenden Datumsangaben handelt es sich um gültige Datumsangaben, die als Zeichenfolgen übergeben werden:

Datum	Hinweis
31.10.2018	Nur Datum
20181031	Nur Datum (alternatives Format)
2018-10-31T23:14:42	Durch T getrennte Datums- und Uhrzeitangabe
20181031T231442	Durch T getrennte Datums- und Uhrzeitangabe (alternatives Format)
2018-10-31 23:14:42	Durch eine Leerstelle getrennte Datums- und Uhrzeitangabe
20181031 231442	Durch eine Leerstelle getrennte Datums- und Uhrzeitangabe (alternatives Format)

Tipp:

Es wird empfohlen, Datums- und Uhrzeitangaben durch den Großbuchstaben "T" zu trennen. Wenn Sie eine Leerstelle verwenden, sollten Sie diese codieren.

Wenn Datumsangaben zur Laufzeit an ein Dashboard übergeben werden, wird vorausgesetzt, dass deren Zeitkomponente in der lokalen Zeitzone – also der Zeitzone des Computers bzw. des Geräts, auf dem der Browser ausgeführt wird – angegeben wird. Zur besseren Steuerung können Sie die Zeit auch in koordinierter Weltzeit (Coordinated Universal Time, UTC) oder als Versatz gegenüber UTC angeben. Um anzugeben, dass die Uhrzeit in UTC vorliegt, fügen Sie direkt nach der Zeitangabe den Buchstaben "Z" ohne Leerstelle ein. Das "Z" ist der Zonenbezeichner für den UTC-Versatz von Null. Ein Versatz von UTC wird der Zeitangabe im Format "±hh:mm", "±hhmm" oder "±hh" angehängt.

Datum	Hinweis
2018-10-31T23:14:42Z	UTC
2018-10-31T23:14:42+01:00	Eine Stunde vor UTC
2018-10-31T23:14:42+0100	Eine Stunde vor UTC
2018-10-31T23:14:42+01	Eine Stunde vor UTC
2018-10-31T23:14:42-05:00	Fünf Stunden hinter UTC
2018-10-31T23:14:42-0500	Fünf Stunden hinter UTC
2018-10-31T23:14:42-05	Fünf Stunden hinter UTC

Beim Erstellen von Filtern aus Datum-Parametern überprüfen Dashboards die Datenquelle des Zielelements auf Zeitzoneninformationen. Wenn sie gefunden werden, werden Abfragen in dieser Zeitzone gesendet. Wenn keine Zeitzoneninformationen gefunden werden, wird vorausgesetzt, dass es sich bei der Zieldatenquelle um eine UTC-Datenquelle handelt. In beiden Fällen muss das Dashboard möglicherweise Eingabezeiten konvertieren, sodass diese denen des Ziels entsprechen.

Tipp:

Wenn ein Dashboard einen Datumsparameter in einem Format empfängt, das es nicht erkennt, wird dieser zur Laufzeit ignoriert.

Beispiele

Die folgende Tabelle enthält Hinweise dazu, ob der Datumsparameter für ein einzelnes Datum oder einen Datumsbereich konfiguriert wurde: Hier finden Sie Beispiele für UNIX Epoch- und Datumszeichenfolgen.

Parameter	Hinweis
?created=1541027682	Einzelner Wert unter Verwendung von UNIX Epoch
?created=2018-10-31	Einzelner Wert unter Verwendung der Datumszeichenfolge, vollständiger Tag impliziert
?created=2018-10-31T23:14:42	Einzelner Wert unter Verwendung der Datumszeichenfolge mit Uhrzeit, Lokale Zeitzone impliziert.
?created=2018-10-31T23:14:42Z	Einzelner Wert unter Verwendung der Datumszeichenfolge mit Uhrzeit in UTC

Beispiele für Sonderfälle

Datumswerte werden nicht immer festgelegt. Demzufolge unterstützen Datum-Parameter zwei Sonderfälle: ((null)) und ((notnull)). Diese Beschriftungen für Sonderfälle können in Workflows für einzelne Werte und in Workflows für Datumsbereiche verwendet werden.

Parameter	Hinweis
?created=((null))	Einzelner Datumswert oder Datumsbereich. Filter für NULL-Datumsangaben
?created=((notnull))	Einzelner Datumswert oder Datumsbereich. Filter für Datumsangaben, die NICHT NULL sind
?created=2018-10-31,((null))	Einzelner Datumswert. Filter für 31. Oktober ODER für Datumsangaben, die NULL sind
?created=2018-10-31,2018-11-05,((null))	Datumsbereich. Filter für Datumsangaben in einem Bereich ODER für Datumsangaben, die NULL sind

Ein weiterer Sonderfall liegt vor, wenn ein Datum-Parameter einen Bereich erwartet, zur Laufzeit jedoch nur ein einzelner Wert bereitgestellt wird.

Parameter	Hinweis
?created=,2018-10-31	Offen links. Datumsangaben, die auf das aktuelle Datum fallen oder davor liegen, werden gefiltert.
?created=2018-10-31,	Offen rechts. Datumsangaben, die auf das aktuelle Datum fallen oder danach liegen, werden gefiltert.
?created=2018-10-31,((null))	Offen rechts. Filter für Datumsangaben, die auf das aktuelle Datum fallen oder danach liegen ODER für Datumsangaben, die NULL sind

Feature-Parameter

Feature-Parameter werden verwendet, um mindestens eine Feature-ID an ein Dashboard zu übergeben. Sie können herangezogen werden, um die Elemente von Dashboards zu filtern oder um Positionsaktionen – Zoomen, Schwenken, Pop-up anzeigen, Feature verfolgen und Flash – auf die Karten des Dashboards anzuwenden.

Legen Sie beim Entwurf den Namen des Parameters fest, und wählen Sie eine Datenquelle aus. Das eindeutige ID-Feld der Datenquelle muss identifiziert werden. Wenn die Auswahl eines Feldes, das nicht eindeutige Werte enthält, nicht erfolgreich ist, führt dies zur Laufzeit zu unerwartetem Verhalten.

Tipp:

Enthält die ausgewählte Datenquelle Polygone, kann sie verwendet werden, um räumliche Filter auf Zielelemente anzuwenden.

Stellen Sie sicher, dass Sie zur Laufzeit eine URL-Codierung für Feature-IDs durchführen, wenn die Werte im Ziel-Layer Zeichenfolgen sind. Mehrere Feature-IDs können übergeben werden, indem sie durch Kommas getrennt werden, z. B. ?asset=1240,1241,1242. Fügen Sie keine Leerstelle nach dem Komma ein.

Tipp:

Wenn ein Feature-Parameter für die Durchführung der Aktion "Feature verfolgen" konfiguriert ist, wird nur eine ID erwartet. Werden mehrere Werte übergeben, wird nur eines der Features verfolgt. Das verfolgte Feature gibt nicht unbedingt die Reihenfolge der übergebenen IDs wieder.

Beispiele

Parameter	Hinweis
?id=11033	Einzelner Wert
?id=11033,23034,34035	Mehrere Werte

Geometrieparameter

Es gibt zwei Typen von Geometrieparametern: Punkt und Ausdehnung. Wenn der Typ "Punkt" lautet, werden Geometrieparameter verwendet, um auf einer oder mehreren Karten des Dashboards auf eine Position zu zoomen, auf sie zu schwenken oder sie aufblinken zu lassen. Lautet der Typ "Ausdehnung", können Sie mithilfe von Geometrieparametern die Kartenausdehnungen eines Dashboards festlegen oder die anderen Elemente filtern. Geben Sie beim Entwurf den Namen des Parameters an, und wählen Sie den Geometrietyp aus, bevor Sie Aktionen konfigurieren.

Zur Laufzeit werden alle Geometriekoordinaten als kommagetrennte WGS84-Werte (World Geodetic System 1984) übergeben. Das Format für Punktparameter lautet x,y. Das Format für Ausdehnungsparameter lautet leftX,leftY,rightX,rightY. In allen Fällen ist nach dem Komma keine Leerstelle vorhanden.

Beispiele

Parameter	Hinweis
?pt=-75.6971931,45.4215296	Geometrieparameter erwartet einen Punkt
?ext=-80.6,40.6,-70.7,47.7	Geometrieparameter erwartet eine Ausdehnung

Ändern des Gebietsschemas

Dashboards verfügen über einen integrierten URL-Parameter, das Gebietsschema, über den bei der Anzeige von Inhalten die Sprache sowie das Zahlen- und Datumsformat angepasst werden. Fügen Sie den ?locale=<language code>-Parameter an das Ende der Dashboard-URL an. Dieser integrierte Parameter kann zusammen mit jedem vom Autor konfigurierten URL-Parameter verwendet werden, indem mehrere URL-Parameter durch ein kaufmännisches Und-Zeichen (&) getrennt werden.

In der folgenden Tabelle sind die unterstützten Sprachcodes aufgeführt:

Sprachcode	Sprache
ar	Arabisch
bs	Bosnisch
ca	Katalanisch
cs	Tschechisch
da	Dänisch
de	Deutsch
el	Griechisch
en	Englisch
es	Spanisch
et	Estnisch
fi	Finnisch
fr	Französisch
he	Hebräisch
hr	Kroatisch
hu	Ungarisch
id	Indonesisch
it	Italienisch
ja	Japanisch
ko	Koreanisch
lt	Litauisch
lv	Lettisch
nb	Norwegisches Bokmål
nl	Niederländisch
pl	Polnisch
pt-br	Portugiesisch (Brasilien)
pt-pt	Portugiesisch (Portugal)
ro	Rumänisch
ru	Russisch
sl	Slowenisch
sr	Serbisch
sv	Schwedisch
th	Thailändisch
tr	Türkisch
uk	Ukrainisch
vi	Vietnamesisch
zh-cn	Chinesisch (vereinfacht)
zh-hk	Chinesisch (traditionell, Hongkong)
zh-tw	Chinesisch (traditionell, Taiwan)

Bei Verwendung des Sprachcodes für Englisch, Spanisch, Französisch, Deutsch und Italienisch können Sie auch die folgenden Gebietsschemata mit dem jeweiligen Zahlen- und Datumsformat verwenden:

Gebietsschema	Zahlen- und Datumsformat
en-au	Englisch (Australien)
en-ca	Englisch (Kanada)
en-gb	Englisch (Großbritannien)
es-es	Spanisch (Spanien)
es-mx	Spanisch (Mexiko)
fr-ch	Französisch (Schweiz)
de-ch	Deutsch (Schweiz)
it-ch	Italienisch (Schweiz)

Die folgende URL ist ein Beispiel für die Angabe des Gebietsschemas Französisch:

https://<yourPortalUrl>/apps/opsdashboard/index.html#/4f539791b2f1418cb5403891f1a7be50?locale=fr