Encodage d’URL

Assurez-vous d’encoder la valeur du paramètre lorsque celui-ci est transmis au tableau de bord lors de l’exécution. Le codage garantit que les caractères non valides sont remplacés par le signe % suivi de leur équivalent hexadécimal.

<scheme>://<yourURL>/apps/dashboards/<id>#param=Main%20Street

Gardez à l’esprit les points suivants pour transmettre un paramètre URL sous forme de liste de valeurs séparées par une virgule :

• Encodez chaque valeur séparément.

  Correct

  param=Main%20Street,Broadway%20Avenue

  Faux N’encodez pas la virgule utilisée pour séparer les valeurs.

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

• N’ajoutez pas d’espace entre les valeurs.

  Correct

  param=Main%20Street,Broadway%20Avenue

  Incorrect

  param=Main%20Street, Broadway%20Avenue

Types de paramètres URL

Il existe cinq types de paramètres URL : catégorie, numérique, date, entité, et géométrie. Pour plus d’informations sur les types d’actions que peuvent déclencher les différents types de paramètres, reportez-vous à la rubrique Configurer des actions sur les paramètres URL.

Paramètre de catégorie

Vous pouvez utiliser un paramètre de catégorie pour appliquer une action de filtre sur un ou plusieurs éléments. Lors de la conception, déterminez le nom du paramètre, si les entrées seront de type chaîne ou chiffre et si les requêtes de filtre incluront ou excluront les valeurs transmises.

Lors de l’exécution, les paramètres de catégorie acceptent une valeur unique ou plusieurs valeurs séparées par une virgule. N’utilisez pas d’espace après la virgule.

Lorsqu’une valeur unique est transmise, la requête utilise l’opérateur comparatif égal à ou non égal à pour filtrer les éléments cibles. Lorsque plusieurs valeurs sont transmises, les opérateurs logiques IN et NOT IN sont utilisés.

Paramètres numériques

Vous pouvez utiliser des paramètres numériques pour appliquer une action de filtre sur un ou plusieurs éléments cibles. Lors de la conception, déterminez le nom du paramètre et si les valeurs en entrée attendues sont une valeur unique ou deux valeurs représentant une plage. Lorsqu’une valeur unique est utilisée, le paramètre est configuré de façon à appliquer l’un des opérateurs de comparaison suivants :

• égaux
• différent de
• moins de
• inférieur ou égal à
• supérieur à
• supérieur ou égal à

Lors de l’exécution, les paramètres numériques sont transmis sous forme de valeur unique ou de deux valeurs séparées par une virgule.

Paramètres de date

Vous pouvez utiliser des paramètres de date pour appliquer une action de filtre sur un ou plusieurs éléments cibles. Lors de la conception, déterminez le nom du paramètre et si les valeurs en entrée attendues sont de type chaîne de date au format ISO 8601 ou Epoch UNIX

Vous pouvez configurer les paramètres de date afin de traiter une valeur unique ou deux valeurs représentant une plage de dates. Lorsqu’une valeur unique est utilisée, le paramètre est configuré de façon à appliquer l’un des opérateurs de comparaison suivants :

• is
• n’est pas
• est avant
• est ou est avant
• est après
• est ou est après

Lors de l’exécution, les paramètres de date sont transmis sous forme de valeur unique ou de deux valeurs séparées par une virgule. Lorsqu’un paramètre de date est au format Epoch UNIX, il doit s’agir d’un entier 32 bits signé. Lorsqu’il s’agit d’une chaîne, les dates doivent avoir le format AAAA-MM-JJ ou AAAAMMJJ. Les dates sont saisies d’après le calendrier grégorien et exprimées en années, mois et jours.

• AAAA : année exprimée par quatre chiffres (AAAA)
• MM : mois de l’année exprimé par deux chiffres (de 01 à 12)
• JJ : jour du mois exprimé par deux chiffres (de 01 à 31)

Une partie heure peut également être indiquée avec la date. Les heures sont entrées au format 24 heures et exprimées en heures, minutes et secondes. Vous pouvez leur appliquer le format hh:mm:ss ou hhmmss. Si la partie heure n’est pas indiquée avec la date, la totalité de la journée comprise entre 00:00:00 et 23:59:59 est utilisée.

• hh : l’heure avec ajout de zéro entre 00 et 24
• mm : les minutes avec ajout de zéro entre 00 et 59
• ss : les secondes avec ajout de zéro entre 00 et 59

Si elle est spécifiée, la partie heure est séparée de la partie date par un espace ou un T majuscule. Les exemples suivants sont des dates valides transmises sous forme de chaînes :

Lorsque des dates sont transmises à un tableau de bord au moment de l’exécution, leur composant temporel est censé être spécifié dans le fuseau horaire local, c’est-à-dire le fuseau horaire de l’ordinateur ou de l’appareil sur lequel s’exécute le navigateur. Pour davantage de contrôle, vous pouvez également exprimer l’heure en temps universel coordonné (UTC) ou selon un décalage par rapport au temps UTC. Pour indiquer que l’heure est exprimée en temps UTC, ajoutez la lettre Z directement après l’heure sans espace. La lettre Z désigne le fuseau horaire UTC sans décalage. Un décalage par rapport à l’heure UTC est ajouté à l’heure sous la forme ±hh:mm, ±hhmm, ou ±hh.

Lors de la construction de filtres à partir de paramètres de date, les tableaux de bord examinent la source des données de l’élément cible pour obtenir les informations de fuseau horaire. S’il en trouve, des requêtes sont envoyées dans ce fuseau horaire. Si aucune information de fuseau horaire n’est trouvée, la source des données cible est supposée être le temps UTC. Dans les deux cas, le tableau de bord peut devoir convertir l’heure en entrée pour correspondre à celle de la cible.

Paramètres d’entité

Les paramètres d’entité permettent de transmettre un ou plusieurs identifiants d’entité à un tableau de bord. Ils peuvent être utilisés pour filtrer les éléments du tableau de bord ou pour appliquer des actions d’emplacement (Zoom, Pan (Déplacement), Show pop-up (Afficher la fenêtre contextuelle) et Flash (Faire clignoter)) aux cartes du tableau de bord.

Lors de la conception, déterminez le nom du paramètre et sélectionnez une source de données. Le champ de l’identifiant unique de la source des données doit être identifié. Ne pas sélectionner un champ contenant des valeurs non uniques entraîne un comportement inattendu lors de l’exécution.

Lors de l’exécution, veillez à encoder dans l’URL les identifiants d’entités si les valeurs dans la couche cible sont des chaînes. Vous pouvez transmettre plusieurs ID d’entité en les séparant par une virgule, par exemple #asset=1240,1241,1242. N’utilisez pas d’espace après les virgules.

Paramètres de géométrie

Il existe deux types de paramètres de géométrie : point et étendue. Lorsque le type est point, les paramètres de géométrie sont utilisés pour zoomer, déplacer, ou faire clignoter un emplacement sur une ou plusieurs cartes du tableau de bord. Lorsque le type est étendue, vous pouvez utiliser les paramètres de géométrie pour définir l’étendue de la carte d’un tableau de bord ou filtrer ses autres éléments. Lors de la conception, déterminez le nom du paramètre et sélectionnez le type de géométrie avant de configurer des actions.

Lors de l’exécution, toutes les coordonnées de géométrie sont transmises sous forme de valeurs séparées par des virgules du système de coordonnées géographiques World Geodetic System 1984 (WGS84). Pour les paramètres de point, le format est x,y. Pour les paramètres d’étendue, le format est leftX,leftY,rightX,rightY. Dans tous les cas, aucun espace n’est toléré après la virgule.

Changer de langue

Un paramètre URL, appelé paramètre régional, et intégré aux tableaux de bord permet de changer les formats numériques, de langue et de date pour afficher du contenu. Ajoutez le paramètre #locale=<language code> à la fin de l’URL du tableau de bord. Le paramètre intégré peut être utilisé avec n’importe quel autre paramètre URL configuré par l’auteur. Les paramètres URL devant être séparés à l’aide du caractère &.

La table suivante répertorie les codes de langue pris en charge :

Voici une liste de langues pour définir le format de nombre et de date :

L’URL suivante indique comment définir la langue français suisse :

<scheme>://<yourURL>/apps/dashboards/4f539791b2f1418cb5403891f1a7be50#locale=fr-ch