> For the complete documentation index, see [llms.txt](https://documentation.efalia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.efalia.com/produit/efalia-process/developpeurs/reference-stalk.md).

# Référence STalk

## Introduction

STalk est un langage permettant l'écriture d'expressions intervenant dans plusieurs fonctionnalités de Workey : règles de comportement des opérations automatiques, règles de calcul des champs, sujet des documents, calcul des colonnes des vues créées par les utilisateurs, etc.

L'objectif de STalk est de fournir un langage suffisamment simple et bien intégré à Workey, évitant l'écriture de code Java pour spécifier les expressions souvent très simples intervenant dans les règles de gestion des processus .

STalk possède beaucoup de caractéristiques d'un langage de programmation complet, mais ne peut être considéré comme un langage dit «universel", car il ne permet pas de déclarer des structures répétitives («tant que», par exemple).

### Document de référence

Dans toutes les situations où il peut être utilisé, STalk a pour contexte un document Workey, qui constitue la source, et également la cible, de ses informations . La présence de ce document est implicite et n'a donc pas besoin d'être spécifiée dans le langage lui-même.

## Structure du langage

### Types

#### Définition

STalk est un langage typé : les objets intervenant dans une expression STalk, ainsi que le résultat de l'expression, possèdent un type reconnu par Workey. La cohérence des types utilisés est vérifiée lors de l'analyse des expressions. STalk n'oblige cependant pas à déclarer explicitement le type des objets qu'il utilise, car ils sont déduits, dans tous les cas, des types déclarés lors de la conception des formulaires.

## Objets de STalk

Une expression STalk peut faire intervenir un certain nombre d'objets, qui sont décrits ci-dessous, et retourne un résultat.

### Champs

L'intégration de STalk dans Workey se manifeste par la prise en compte des champs comme source de valeurs. On rappelle qu'un champ d'un document Workey est:

* typé (exemples : "`INTEGER`", "`SHORT`", "`BOOLEAN`", "`FLOAT`", "`DOUBLE`","`DATE`", "`STRING`")
* mono ou multi-valué (si multi-valué, le champ peut comporter plusieurs valeurs).

Une expression STalk peut faire intervenir les champs présents dans le document de reference, qui sont reconnus au moyen de leur nom interne ("designer name"). La plus simple expression STalk consiste donc en un nom de champ. Par exemple: `Montant` est une expression STalk valide si le document de référence comporte un champ appelé "`Montant`". Le type de l'expression est celui du type du champ "Montant", et l'expression sera multi-valuée si le champ "`Montant`" est déclaré multi-valué.

**Attention** : le nom des champs utilisés doit respecter les caractères majuscules et minuscules.

### Constantes

STalk reconnaît les constantes de type :

* numérique (ex : `12`, `324.75`)
* chaîne de caractères (exemple `"paiement en espèces"`)
* date (ex : `24.11.2004`)
* logique (`true`, `false`)
* la constante "valeur nulle" `?`

Attention dans le cas d'un nombre le "`?`" est vérifié si la valeur est `0`.

## Opérateurs

#### Opérateurs arithmétiques

Une expression STalk peut faire intervenir les opérateurs arithmétiques usuels :

* Addition : `+`
* Soustraction : `-`
* Multiplication : `\`
* Division : `/`

Exemples d'expressions :

* `Montant * 0.12`

Le résultat est du type du champ Montant.

* `"Type de paiement : " + "paiement en espèces"`

le résultat est une chaîne de caractères.

* `Montant - Rabais`

Le résultat est d'un type compatible avec les champs Montant et Rabais.

#### Fonctions agrégatives

* `SUM`
* `PRODUCT`
* `MINIMA`
* `MAXIMA`

Voir plus loin : "Extensions des opérateurs arithmétiques usuels" et "Fonctions agrégatives".

#### Opérateurs relationnels

Une expression STalk peut faire intervenir les opérateurs relationnels usuels:

* Plus grand que: `>`
* Plus petit que: `<`
* Égal: `=` ou `==`
* Différent: `!=`
* Plus grand ou égal : `>=`
* Plus petit ou égal: `<=`

Exemples d'expressions:

* `Montant > 10000`
* `TypeClient != "normal"`

Dans tous les cas ci-dessus, le résultat est du type Booléen (valeur `true` ou `false`)

### Opérateurs logiques

Les opérateurs logiques reconnus sont:

* Ou exclusif : `or` ou `||`
* Et : `and` ou `&&`
* Négation logique : `!`

Exemple d'expressions: `(Montant > 10000) and (TypeClient != "normal")`\
Le résultat est du type Booléen (valeur `true` ou `false`)

### Opérateurs ensemblistes

Pour les objets multi-valués, STalk reconnaît également les opérateurs ensemblistes suivants:

* Union: `union`
* Intersection: `inter`
* Différence : `minus`
* Appartient à: `in` (`A in B` retourne vrai si l'élément A est présent dans le conteneur multivalué B)

Exemples d'expressions :

* `ListeClients union ListeFournisseurs` : Retourne l'union des 2 ensembles de valeurs contenues dans les champs (obligatoirement multi-valués) ''ListeClients'' et ''ListeFournisseurs''.
* `"A" in myField`

Retourne "vrai" si la valeur "A" est présente dans le champ multivalué myField

### Parenthèses

Toute expression STalk peut comporter des parenthèses, sans restriction de niveau.

Exemples d'expressions : `(Montant + (Prime * 2) – Rabais) / 100`

## Fonctions <a href="#stalk-functions" id="stalk-functions"></a>

STalk reconnaît un certain nombre de fonctions, décrites dans les tableaux ci-dessous. Les lignes vertes (de `charAt` à `trim`) sont les fonctions de manipulation de chaîne de caractères ; les lignes rouges (de `maxima` à `sum`) sont les fonctions d'aggrégation de données.VariablesL'utilisation de variables est permise dans STalk. Une variable se déclare au moyen d'une assignation de valeur, en utilisant l'opérateur d'assignement : =, suivi d'une expression STalk.Par exemple : `MyShare := Montant / 2`L'expression ci-dessus :déclare une variable nommée MySharedétermine le type de cette variable comme étant celui de l'expression à droite de l'opérateur d'assignementcalcule l'expression et renseigne la variable à cette valeurLe type de la variable est donc déterminé, mais n'a pas besoin d'être explicité. Naturellement, une variable peut intervenir dans des phrases subséquentes.Par exemple : `(MyShare > 100) and (MyShare < 200)`Il faut éviter de nommer une variable du même nom qu'un champ du document de référence, ou du même nom qu'une fonction connue de STalk.PhrasesUne expression STalk peut comporter plusieurs phrases, séparées par des points-virgule.Par exemple :MyShare := Montant / 2;GoodThing := (MyShare > 100) and (MyShare < 200);Le résultat de l'expression est alors le résultat de la dernière phrase.Structures conditionnellesUne condition s'exprime, classiquement, par une structure de type if (condition) expression1 else expression2, où "condition" désigne une expression STalk de type booléen, et "expression1", "expression2" deux expressions STalk quelconques, la clause "else" étant optionelle.Exemples:if (MyShare < 1000) Remain := Montant – MyShare;if (Remain > 0) "Il m'en reste";else "Il ne reste rien";if (Type == "1") TT := 160;else if (Type == "2") TT := 30;else TT := 60;Exemples d'utilisationConcaténation : `Text := "Le document de type: " + documentType() + " est dans l'état: " + state()`Valeur initiale d'un champ : `now();`Valeur calculée d'un champ : `Montant – Rabais`Sujet d'un document : `"Affaire suivie par : " + userName()`Règle de contrôle pour une opération automatique : `Montant > 10000`Contenu d'une colonne dans une vue : `if ( Solde > 0 ) "green.gif" else "red.gif"`Extensions des opérateurs arithmetiques usuelsLes principaux opérateurs arithmétiques (+, -, \*, /) prennent en compte les conteneurs multi-valuésCas de deux conteneurs multi-valuésPour autant que les deux conteneurs A et B aient le même nombre de valeurs, l'expression A op B retourne un conteneur de même cardinalité dans lequel la i-ème valeur est égale à la i-ème valeur de A op i-ème valeur de B, avec op = +, -, \* ou /.Par exemple, si le champ Prix comporte 3 valeurs (10 , 12, 20) et le champ Qty 3 valeurs (1, 3, 2), l'expression Prix \* Qty retourne les valeurs (10, 36, 40).Cas d'un conteneur multi-valué et un conteneur mono-valuéSi A est multi-valué et B mono-valué , l'expression A op B retourne un conteneur de même cardinalité que A dans lequel la i-ème valeur est égale à la i-ème valeur de A op valeur de B, avec op = +, -, \* ou /. Par exemple, si le champ Prix comporte 3 valeurs (10 , 12, 20) et le champ Rabais la valeur 0.1, l'expression Prix \* Rabais retourne les valeurs (1, 1.2, 2).Fonctions agrégativesCes nouvelles fonctions calculent un agrégat sur un conteneur multivalué .sumSi A est multi-valué, `sum(A)` retourne la somme des valeurs de A Par exemple, si le champ Qty comporte 3 valeurs (1, 3, 2), `sum(Qty)` retourne 6. Si le champ Prix comporte 3 valeurs (10 , 12, 20), `sum(Prix*Qty)` retourne 86 .productSi A est multi-valué, `product(A)` retourne le produit des valeurs de A Par exemple, si le champ Qty comporte 3 valeurs (1, 3, 2), `product(Qty)` retourne 6.minimaSi A est multi-valué, `minima(A)` retourne le minimum des valeurs de A Par exemple, si le champ Qty comporte 3 valeurs (1, 3, 2), `minima(Qty)` retourne 1.maximaSi A est multi-valué, `maxima(A)` retourne le maximum des valeurs de A Par exemple, si le champ Qty comporte 3 valeurs (1, 3, 2), `maxima(Qty)` retourne 3.Fonctions particulièresLa fonction `text`Cette fonction a pour but de produire une chaîne de caractères en mettant en forme une valeur de type quelconque. La syntaxe est : `text (valeur, format)`Paramètres`valeur` : conteneur de type quelconque, typiquement un nom de champ du document`format` : chaîne de caractères représentant le format à appliquer à la valeur (Voir annexe).La fonction `text(container, syntaxe)` est applicable sur un container multivalué : elle est appliquée à chaque valeur de ce container.Par exemple, si "my\_names' est une variable multivaluée contenant des identificateurs d'acteurs : "dn=foo ; dn=bar",alors `text (my_names, "shortLdapName")` retourne une variable multivaluée contenant: "foo;bar"Par exemple: `text (Date_remise, "EEE, d MMM yyyy")`Si le champ Date\_remise est du type "date" et contient la date du 24 novembre 1947, et pour une localisation française, la fonction text retourne : "Lun., 24.11.1947"Implémentations actuelles**Type "Date"**&#x50;our une valeur de type "Date", les formats autorisés sont ceux de la classe Java "Format", fournis en annexe. La "localisation" s'effectue automatiquement en fonction de la langue de l'utilisateur.**Type "Text"**&#x50;our une valeur de type "Text", le seul format actuellement implémenté est "shortLdapName" . Si la valeur contient un nom complet Ldap (dn), ce format le convertit en un nom court. Exemple : `text ("cn=Tutti,ou=Frutti,ou=AnRutti", "shortLdapName")` retourne "Tutti".**Autres types**Non encore implémentés, mais le premier candidat est le formatage "monétaire" pour les champs numériques.**Note**: En raison de la présence de cette fonction "text", la fonction "userName()" retourne maintenant le dn complet de l'acteur courant, et non plus le "short name". Il faut donc appliquer la fonction "text" pour obtenir le même résultat : `text (userName (), "shortLdapName")`Formatage des duréesUne durée est un nombre entier, exprimé en millisecondes. La fonction `timeFormat` permet de formater une durée en une chaîne de caractères. La formule `timeFormat (entier, format)` retourne le nombre `entier` représentant la durée, formaté par la chaîne de caractères `format`.Paramètres**entierformat** peut contenir les caractères réservés suivants :L'occurrence de ces caractères dans format est remplacée par la valeur de la composante correspondante dans la chaîne formatée construite. Tout autre caractère n'est pas interprété et figurera tel quel dans la chaîne résultante.Par exemple, une heure et demie et 32 secondes correspond à 5432 secondes, donc 5432000 millisecondes.`timeFormat(5432000, "HH'h' mm'm' ss's'")` affichera : "`1h 30m 32s`"Si on a deux dates, par exemple `Date_debut=28/02/2022` et `Date_fin=04/03/2022` la formule suivante pourra être appliquée :`timeFormat(Date_fin - Date_debut, "d' jours'");` affichera : "`4 jours`"Les caractères réservés peuvent être répétés consécutivement pour préciser le nombre minimal de chiffres affichés pour une zone : le nombre de caractères est le nombre minimal de chiffres, des zéros étant affichés en préfixe pour compléter.Par exemple, `timeFormat (3600001, "HH'h' mm'm' ss's' SSS'ms'")` affichera : "`01h 00m 00s 001ms`".Pour utiliser le caractère " dans le format, il faut le faire précéder du caractère `\`. Par exemple, `timeFormat (3600000, "HHh MMʼ SS\"")` affichera : "`01h 00ʼ 00"`".Formats de présentation des donnéesCe paragraphe présente les possibilités de présentation (et de saisie) des données dans les champs de formulaires. Workey pouvant opérer dans un contexte international, cette présentation pourra être personnalisée pour chaque pays.Champs de type "date"Les champs de type Date peuvent être représentés en utilisant un format. Ce format est très complet, il est celui de la classe Java DateFormat et est présenté en annexe . Il doit être renseigné dans le champ "Format" de la boîte de dialogue.Par défaut, le réglage d'usine est "`dd/MM/yyyy`", qui correspond à la syntaxe francophone et permet d'entrer sans problème "`14/7/1789`". (qui sera corrigé à l'affichage en "`14/07/1789`" ).Cas particulier pour les datesL'exemple donné est la saisie d'une chaîne "`33/33/33`" pour un format "`dd/MM/yyyy`".En fait, il y a 2 mécanismes mis en cause dans cet exemple.La syntaxe "`yyyy`" provoque la saisie littérale de l'année. Ainsi "`33`" est interprété comme l'an 33 après JC. L'utilisateur doit saisir "`2006`" et non pas "`06`" s'il veut indiquer l'année 2006. Si on veut une complémentation automatique de la date, il faut utiliser une syntaxe "`yy`" , comme "`dd/MM/yy`". Dans ce cas, "`06`" est interprété comme `2006`.Le mode par défaut pour la saisie des dates est le mode dit "astucieux". Dans ce mode, Workey va activer des règles astucieuses pour interpréter la saisie.Comme il sait bien qu'une année n'a que 12 mois, il va interpréter le nombre "`33`", spécifié pour le mois, comme "24 + 9 mois", c'est à dire 2 ans et 9 mois. De même, il va interpréter le nombre "`33`" pour un jour comme étant "33" le nombre de jours du mois courant" plus un mois. Par exemple, "`29/02/2006`" sera ré-interprété comme "`01/03/2006`".En application des 2 principes énoncés, la saisie de "`33/33/33`" pour un format "`dd/MM/yyyy`" donnera:le dernier "33" sera interprété comme "33 après JC"le "33" du milieu sera interprété comme "9" et l'année convertie en "35"le premier "33" sera interprété comme "30", "3" jours étant affectés au mois suivant, qui devient "10"La date saisie est donc le 3 octobre de l'an de grâce 35 après JC.Il est suggéré d'adopter le mode "non astucieux" qui refusera la saisie de la date de l'exemple. Donc soit utiliser une syntaxe "`yyyy`" et dans ce cas il est nécessaire de faire un contrôle postérieur sur la date. Workey pourrait proposer par défaut un contrôle du type "l'année ne peut être inférieure à 1900". Un contrôle STalk sur le champ est également possible. Soit opter pour une syntaxe "`yy`".Format monétaireC'est le format qui sera sélectionné par Workey si un code de pays a été sélectionné et en l'absence d'un format spécifiquement donné.La manière de représenter les nombres dans une monnaie sera adaptée aux règles de ce pays. Outre le choix de symboles monétaires différents, la manière de séparer les parties décimales, de regrouper les milliers et millions, de placer le symbole monétaire en préfixe ou en suffixe, varient d'un pays à l'autre. Par exemple, le nombre 1525.75 sera représenté dans un format monétaire "1 525,75 €" en France (noter l'espace entre le 1 et le 5), et "Sfr. 1525.75" en Suisse.Par exemple, le choix du code "FR", représentant la France, affiche le nombre 3 sous la forme "3,00 €".Choix du nombre de décimalesCe choix n'est évidemment possible que pour les champs de type "Numérique". Il revient à adopter les conventions du pays spécifié pour l'affichage des nombres (choix des séparateurs) et à fixer la nombre de décimales affichées à la valeur choisieChoix d'une structureLa manière la plus complète de formater un nombre est de spécifier une structure complète. Par exemple, la structure "`#,#00.0#`" spécifie un minimum de deux chiffres décimaux, un chiffre décimal au moins et au maximum deux. Elle affichera le nombre 1234.56 sous la forme "1,234.56". L'annexe III fournit une documentation complète de la syntaxe de ces structures.PrécisionsLa localisation joue le premier rôle dans les formats: c'est elle qui détermine les symboles utilisés dans le format. par exemple, si la localisation est "fr", le symbole utilisé pour séparer la parie décimale est la virgule, celui pour grouper les milliers est l'espace.cette localisation est renseignée automatiquement par Workey qui ne fait que lire le paramètre de langue dans la configuration du poste de l'utilisateur;cette localisation peut être changée pour un champ particulier en choisissant un pays "monétaire" dans l'onglet "apparence";les symboles utilisés pour définir un format particulier ne sont pas pris littéralement, mais sont interprétés selon cette localisation; par exemple, dans le format "`#,##0.##`", la virgule représente la séparation des milliers (donc un espace si la localisation est "`fr`"), et le point la séparation décimale (donc la virgule si la localisation est "fr");pour obtenir un format affichant des pour-cents, "`#.00%`", par exemple (attention, le nombre est multiplié par 100 avant l'affichage)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.efalia.com/produit/efalia-process/developpeurs/reference-stalk.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
