Liste des vignettes dans Envision - Logiciel d'optimisation des stocks

Liste des vignettes disponibles dans Envision










Accueil » Ressources » Ici

Les vignettes sont les briques des tableaux de bord Envision. La présente page liste toutes les vignettes compatibles avec Envision.


Syntaxe des vignettes

La syntaxe générique des vignettes est la suivante :

show table "hello" a1c2 tomato with x, sum(y), avg(z) group by (x,a) order by (max(y), b)desc

Le premier argument après le nom de la vignette (table dans l'exemple) correspond au titre de la vignette. Le titre est suivi de la position et de la taille de la vignette au sein du tableau de bord, codées comme dans le quadrillage Excel (les lettres désignent les colonnes et les numéros les lignes). Enfin, la couleur est spécifiée, soit comme l'une des couleurs du Web soit via un triplet hexadécimal sans le signe # (par exemple FF6347 pour tomato).

  • La plupart des vignettes peuvent recevoir plusieurs arguments après le mot-clé with.
  • L'instruction group by est facultative et compatible avec plusieurs expressions. Lorsque group by est utilisé, les expressions doivent expliciter les agrégateurs sauf si elles sont déjà pré-agrégées.
  • L'instruction order by est facultative et également compatible avec plusieurs expressions. L'instruction desc peut aussi être omise, elle permet de classer par ordre décroissant.

Les expressions passées en tant qu'argument après with sont automatiquement alignées par Envision en vue de traiter les données d'entrée comme une table pour la vignette. Cette table d'entrée peut être exportée avec la syntaxe suivante :

show table "hello" a1c2 tomato export:"/mytable.tsv" with x, y, z

Les formats de fichier CSV, TSV, XLSX (Excel) et RFF (raw flat file) sont compatibles avec cette exportation. Si l'extension spécifiée pour le fichier d'exportation est inconnue, une erreur est générée.

Il est également possible d'exporter la vignette en plusieurs endroits en même temps à l'aide de plusieurs arguments export :
show table "hello" a1c2 tomato export:"/foo1.tsv" export:"/foo2.tsv" with x, y, z
En pratique, l'instruction complète d'une vignette pouvant être longue, Envision propose également une syntaxe de bloc vignette :
show table "hello" a1c2 tomato export:"/foo1.tsv" export:"/foo2.tsv" with
  x as "My Name" 
  sum(y) as "My total{$}"
  avg(z)
  group by (x,a)
  order by (max(y), b)

La couleur en tant qu'option d'exécution

La définition de la couleur incluse dans la syntaxe compacte des vignettes a un inconvénient : il est impossible de choisir la couleur en fonction du déroulement du programme. Envision offre donc la possibilité de spécifier la couleur en tant qu'option nommée :
isMonday := today() mod 7 == 0
show label "Monday is Black" color: (isMonday ? "black" : "red")
L'option color doit recevoir une valeur textuelle scalaire. Dans l'exemple ci-dessus, la couleur de la vignette change en fonction du jour de la semaine : noir (black) le lundi et rouge (red) les autres jours.

Vignette de type assert

Cette vignette est conçue pour signaler qu'une exécution a échoué si les données ne remplissent pas certaines conditions. Ces dernières peuvent être listées après le mot-clé with.

show assert "My flags" with
  count(Id) > 20 as "More than 20 items found"
  sum(Orders.1) > 20 as "More than 20 order lines found"

Vignette de type barchart

Cette vignette est conçue pour afficher un histogramme. L'expression passée après le mot-clé with doit proposer un agrégateur, une instruction group by explicite est attendue.

show barchart "Stock per Brand" unit: "$" with sum(StockOnHand * PurchasePrice) group by Brand

Les options disponibles au niveau des vignettes sont :
  • color (texte scalaire) : couleur principale des barres.
  • download (texte scalaire) : nom du fichier lorsque la vignette est téléchargée à partir du tableau de bord.
  • export (texte scalaire) : nom du fichier local dans lequel le contenu de la vignette est attendu.
  • unit (texte scalaire) : unité par défaut des valeurs numériques.

Aucune option de colonne n'est autorisée.

Vignette de type form

Cette vignette est conçue pour afficher un formulaire dans lequel les valeurs peuvent être saisies manuellement depuis le tableau de bord. Les variables à afficher dans la vignette doivent être rattachée à la table virtuelle Form.

show form "My settings" with Form.myValue as "My Value", Form.secondValue as "Second Value"
Les variables définies dans des formulaires sont toujours de type scalaire. Ce dernier est déduit de l'utilisation des variables dans le script. Il est possible de lister plusieurs variables dans un formulaire. En règle générale, nous vous suggérons d'assigner à la vignette une hauteur (le nombre de lignes couvertes) égale à N+1 où N représente le nombre de variables d'entrée Form listées après with.

Vignette de type histogram

Cette vignette est conçue pour afficher un histogramme. À la différence de la vignette barcart, les rectangles sont verticaux. Ce type de vignette ne doit recevoir qu'un seul vecteur numérique en argument.
show histogram "Quantities ordered" with Orders.Quantity
Il est possible d'utiliser une vignette histogramme pour afficher une distribution scalaire :
show histogram "Poisson Law" with poisson(3)
Si vous avez généré une prévision probabiliste de la demande, un seul article doit être sélectionné :
where Id == "123"
  show histogram "My Forecast" with same(Demand)

Les options disponibles au niveau des vignettes sont :
  • color (texte scalaire) : couleur principale des barres.
  • unit (texte scalaire) : unité par défaut des valeurs numériques.

Des options existent au niveau des colonnes.

Vignette de type label

Cette vignette est conçue pour afficher un texte dans un tableau de bord. Il s'agit de la vignette la plus simple, sans données en entrée.

show label "Hello World"

Vignette de type linechart

Cette vignette est conçue pour afficher des séries temporelles. Elle utilise en entrée des données indexées par date. Plusieurs expressions peuvent être passées en tant qu'argument après le mot-clé with.

Week.sold := sum(Orders.NetAmount)
show linechart "Week sold and purchased" unit: "$" with
  Week.sold as "Sold" color: "red"
  sum(PO.NetAmount) color: "blue"
La couleur peut être définie au niveau de la vignette — comme dans toutes les vignettes — mais il est également possible de définir la couleur de chaque ligne, comme illustré ci-dessus.

Les options disponibles au niveau des vignettes sont :
  • color (texte scalaire) : couleur principale des barres.
  • unit (texte scalaire) : unité par défaut des valeurs numériques.

L'option suivante est disponible, au niveau des colonnes :
  • color (texte scalaire) : couleur à utiliser pour la ligne associée à la colonne.

Vignette de type logo

Cette vignette est conçue pour afficher le logo d'une entreprise. La vignette affiche le fichier logo.png ou logo.jpg qui doit se trouver à la racine de votre compte Lokad. Si vous n'avez pas encore téléchargé un tel fichier, la vignette vous proposera de le faire. Les dimensions recommandées pour le logo sont 150x70px (largeur d'une colonne) ou 310x70px (largeur de deux colonnes).
show logo "My Company"

Vignette de type Markdown

Cette vignette est conçue pour afficher de la documentation contextuelle au format Markdown. Il s'agit d'un langage d'indications typographiques très simple qui permet de générer des documents lisibles sur Internet.
show markdown "Mon titre" a6h6 with """
# Partie A
## Sous-partie A.1
Liste de remarques **importantes**

* remarque 1
* remarque 2
* remarque 3

## Sous-partie A.2
# Partie B

Remarques moins importantes.
""" 

Nous vous recommandons de laisser le titre vide car la vignette titre est souvent redondante avec le titre défini dans la section Markdown, comme dans l'exemple ci-dessous :
show markdown "" with """ ... """

Vignette de type piechart

Cette vignette est conçue pour afficher un diagramme circulaire. L'expression passée après le mot-clé with doit contenir un agrégateur. Une instruction group by explicite est attendue.

show piechart "Stock per Brand{$}" with sum(StockOnHand * PurchasePrice) group by Brand

Vignette de type plot

Cette vignette trace la courbe d'une fonction « f(x)=y ».
show plot "My function" with T.X, T.Y

Les options suivantes sont disponibles au niveau de la vignette :
  • color (texte scalaire) : couleur principale des barres.
  • unit (texte scalaire) : unité par défaut des valeurs numériques.

Vignette de type summary

Cette vignette regroupe plusieurs valeurs scalaires, généralement des KPI. Chaque valeur peut être associée à un intitulé et une unité.
show summary "Key stock figures" a1b2 with
  sum(StockOnHand) as "Units on hand"
  sum(StockOnOrder) as "Units on order"
  sum((StockOnHand + StockOnOrder) * BuyPrice) as "Stock value" unit: "$"

Vignette de type table

La vignette de type table est la plus polyvalente des vignettes proposées dans Envision. Elle est conçue pour afficher un tableau, qui peut ne contenir qu'une seule case avec un indicateur unique si seul un scalaire est fourni.
show table "Top sellers" export:"/tops.tsv" export:"/copy/tops.tsv" download:"tops.csv" with
  Id display: true
  Name as "Product Name"
  sum(Orders.NetAmount) as "Sold{$}" export: false
La vignette de type table prend en charge les options d'agrégation group by et order by. Dans les deux cas, un tuple peut être fournit à la place d'une valeur individuelle.

Options au niveau des vignettes

La vignette de type table prend en charge plusieurs options définies au niveau des vignettes. Ces options sont spécifiées après la vignette, comme dans l’exemple ci-dessous :
show table "Some tile-level options" color: "red" download: "my-tile" with 123

Les options disponibles sont :

  • color (texte scalaire) : couleur principale des barres.
  • date (texte scalaire) : format de date par défaut des colonnes de dates (voir ci-dessous la spécification du format).
  • download (texte scalaire) : nom du fichier par défaut dans lequel la table est téléchargée par un utilisateur depuis le tableau de bord.
  • export (texte scalaire) : destination vers laquelle le contenu de la table est exporté dans le compte Lokad. Par exemple « export: "/foo/bar.csv". Plusieurs options export sont possibles, autant d’exportations sont effectuées.
  • numbers (texte scalaire) : format de nombre par défaut des colonnes numériques (voir ci-dessous la spécification du format).
  • precision (nombre scalaire) : nombre de décimales affichées dans toutes les colonnes numériques.
  • quotes (scalaire booléen) : si true, des guillemets sont insérés autour des données dans les fichiers CSV et TSV générés. Sa valeur par défaut est false.
  • unit (texte scalaire) : unité par défaut des valeurs numériques.

Options au niveau des colonnes

Chaque colonne peut disposer de ses propres options. Voici un exemple de la syntaxe :
show table "Some column-level options" with
  Id as "Produce ID"
  StockOnHand as "On Hand" unit: "ea"
  BuyPrice unit: "$"

Les options au niveau des colonnes sont les suivantes :
  • date (texte scalaire) : format de date de la colonne de dates (voir ci-dessous la spécification du format).
  • display (scalaire booléen) : indique si la colonne est affichée dans le tableau de bord. Sa valeur par défaut est true. L’affichage d’une colonne peut être inutile si celle-ci doit simplement être exportée vers un fichier.
  • export (scalaire booléen) : indique si la colonne est exportée vers un fichier. Sa valeur par défaut est true. L’exportation d’une colonne peut être inutile si celle-ci doit simplement être affichée dans le tableau de bord.
  • numbers (texte scalaire) : format des nombres d’une colonne numérique (voir ci-dessous la spécification du format).
  • precision (nombre scalaire) : nombre de décimales affichées dans la colonne numérique.
  • quotes (scalaire booléen) : si true, des guillemets sont insérés autour des données de la colonne dans les fichiers CSV et TSV générés. Sa valeur par défaut est false.
  • unit (texte scalaire) : unité d’affichage des valeurs numériques de la colonne.

Chaînes de format de date

La chaîne de format des dates est une mini-syntaxe qui permet de spécifier comment les dates doivent être formatées dans le titre du tableau. Par exemple :
show table "Last sold" date: "yyyy-MM-dd" with max(Orders.Date)

Les symboles possibles sont les suivants :

  • d : jour du mois de 1 à 31.
  • dd : identique à d avec le préfixe 0.
  • ddd : abréviation du jour de la semaine en anglais (ex. : Mon, Tue...)
  • dddd : nom du jour de la semaine en anglais (Monday...).
  • MM : numéro du mois 1 à 12.
  • MMM : abréviation du nom du mois en anglais (ex. : Jan, Feb, ...).
  • MMMM : nom complet du mois en anglais (June).
  • yy : deux derniers chiffres de l’année, de 00 à 99.
  • yyyy : année sur quatre chiffres.

Tout autre caractère est utilisé tel quel dans la chaîne de sortie.

Chaînes de format de nombre

La chaîne de format des nombres est une mini-syntaxe qui permet de spécifier comment les nombres doivent être formatés dans le titre du tableau. Par exemple :
show table "Total sold" number:"1,000.00" with sum(Orders.NetAmount)

La syntaxe reprend le résultat voulu :
  • le caractère après le premier 1 est le séparateur des milliers. Il n’est pas obligatoire.
  • le caractère avant les derniers 0 est le séparateur décimal. Il n’est pas obligatoire.

Affichage de valeurs uniques

Lorsqu’une vignette de type table ne contient qu’une seule colonne et qu’une seule ligne, l’affichage du tableau est ajusté à cette valeur unique.
show table "Total Stock Value" with sum(StockOnHand * BuyPrice)

Vignette de type treemap

La vignette de type treemap affiche une treemap. Les treemaps sont conçues pour mieux visualiser l'importance des différents éléments au sein d'un important volume de données. Cette vignette requiert deux arguments : tout d'abord l'étiquette, puis la valeur. Ensuite, une instruction group by est attendue.

show treemap "Stock Value" with Name, StockOnHand * PurchasePrice group by Category

La taille des cellules affichées par la treemap est proportionnelle à la somme des valeurs.