Mode web : référentiel des actions (fichier de configuration)

Une action représente un événement de cinématique.

Utilisée au niveau du fichier de configuration, elle est indissociable dans son fonctionnement.

Il existe aussi une notion de macro-actions. qui sont le regroupement d'actions (y compris de macro actions).

Il est possible de définir de nouvelles actions.

La non résolution d’une action stoppe irrémédiablement le processus de traitement de la cinématique et provoque la restitution complète des données telles qu’elles étaient avant le démarrage de ce processus.

Étant construites selon le même modèle, les actions présentent néanmoins des signatures différentes :

• Action sans paramètre.
• Action avec paramètres obligatoires
• Action avec paramètres obligatoires et optionnels. (les paramètres optionnels sont systématiquement situés en dernières positions).

nomAction ( )

nomAction ( [paramObligatoire+] [, paramOptionnel]* )

Description

L’action login permet à l’utilisateur de s’authentifier au sein du système d’information et ainsi d’accéder à l’ensemble des BusinessView privées. Cette action peut être automatisée par l’utilisation d’un cookie qui s’acquittera de cette tâche lors de la prochaine connexion de l’utilisateur. Cette authentification (sans l’utilisation du cookie) est maintenue jusqu’à :

• Fermeture par l’utilisateur de son navigateur (browser),
• Détection d’un time-out (période d’inactivité de l’utilisateur trop importante),
• Arrêt du serveur sur lequel est hébergé le produit en mode web.

L’action login fonctionne de paire avec l’utilisation de deux champs utilisateurs : USER et PASSWORD.

Syntaxe

login(viewRef)

Paramètre

viewRef : Le paramètre obligatoire viewRef est la référence à la View associée au Login.

Exemple

Identification de l’utilisateur scott.

url : …?cinematic=login(LOGIN)&chp:USER=scott&chp:PASSWORD=tiger

Remarque(s)

• L’action login est une solution transitoire n’offrant pas toutes les garanties de sécurité.
• Les paramètres user et password sont écrits impérativement en majuscules.

Description

L’action logout permet à l’utilisateur de redevenir anonyme. L'utilisateur qui représente l'utilisateur anonyme est l'utilisateur "GUEST".

Néanmoins, la session logique n’est pas supprimée et l’utilisateur pourra de nouveau être reconnu automatiquement lors d'une prochaine session.

Syntaxe

logout()

Exemple

Identification de l’utilisateur scott.

url : …?cinematic=logout();display(1)

Remarque(s)

• Si, à la suite d'une url qui contient l'action "logout", on se trouve sur une BusinessView privée, alors la BV privée sera affichée avec les informations liées à l'utilisateur "GUEST".
• Dès la prochaine URL, si on tente d'atteindre une BV privée, il y aura une nouvelle demande de login.
• C'est au concepteur de scénario d'imaginer s'il désire ce fonctionnement ou non. En effet, il est plutôt utile de terminer la chaîne d'action comprenant un "logout" par un "display" vers une BusinessView publique.

Description

L’action display représente l’opération minimale présente à chaque requête de cinématique et permet d’identifier la BusinessView de travail (communément appelée la BusinessView courante).

Syntaxe

display(businessViewRef)

Paramètre

businessViewRef : le paramètre obligatoire businessViewRef fait référence à l’indice de la BusinessView à qui l’on attribue le focus.

Exemple

Affichage des données associées à la BusinessView courante.

url : … ?cinematic=display(0)

Remarque(s)

• L’action display est la seule action obligatoire devant systématiquement figurer en dernière position dans la chaîne de cinématique.

Description

De part sa définition, une View est associée à un ensemble d’ordres combinant des critères de sélection, activés au niveau de la BusinessView. L’action retrieve permet d’effectuer cette sélection pour l’ensemble des View qui composent la BusinessView.

La restriction mise en place concerne la valeur de certains champs de la/les View. L’alimentation de ces critères s'accomplit selon trois modes :

• public : La valeur du critère fait référence à un paramètre passé au niveau de l’URL ayant la même dénomination. En l’absence de ce dernier, une erreur sera provoquée.

• business : La valeur du critère fait référence à un champ présent au niveau de la View mère uniquement. (correspond à la mise en place d’un maître/détail).
• value : La valeur du critère est une constante sans plus d’information sur son typage.

Syntaxe

retrieve ( businessViewRef, clefRef )

Paramètre

• businessViewRef : Le paramètre obligatoire businessViewRef fait référence à la BusinessView pour laquelle on veut appliquer une restriction sur l’ensemble de ses View.
• clefRef : Le paramètre optionnel clefRef permet de préciser qu’elle clé choisir. Si ce paramètre est omis, le système se référera à la valeur par défaut définie au niveau du fichier de configuration.

Remarque(s)

• La demande de restitution des données sans le recours préalable à l’action retrieve équivaut à la requête SQL : select * from <table>.
• Il n’est pas possible de sélectionner les critères de sélection d’une seule View indépendamment des autres.
• Dans les versions antérieures, cette action s’appelait where.
• Pour éviter d’écrouler de manière intempestive le serveur de données, un attribut fixe le nombre maximum d’enregistrements à fournir. (voir le document sur le fichier de configuration, rubrique Viewobject, attribut maxFetchSize).

Description

Une View est associée à un ensemble d’ordres de tris des données, activés au niveau de la BusinessView. L’action sort permet d’effectuer ce tri pour l’ensemble des View qui composent la BusinessView. Celle-ci rend opérationnelle l’ordre de tri mais ne l’active pas; il le sera le moment venu, décidé automatiquement par le système, pour fournir les informations requises.

Syntaxe

sort ( businessViewRef, triRef )

Paramètre

• businessViewRef : Le paramètre obligatoire businessViewRef fait référence à la BusinessView pour laquelle on veut appliquer un tri sur l’ensemble de ses View.
• triRef : Le paramètre optionnel triRef permet de préciser qu’elle clé choisir. Si ce paramètre est omis, le système se référera à la valeur par défaut définie au niveau du fichier de configuration.

Remarque(s)

• Il n’est pas possible de sélectionner les critères de tri d’une seule View indépendamment des autres.
• Dans les versions antérieures, cette action s’appelait orderby.

C'est une macro-action qui réalise retrieve() et sort(). Le fait de pouvoir appeler indépendamment retrieve() et sort() permet de changer la sélection indépendamment de l'ordre et réciproquement.

select(n,x,y) = retrieve(n,x);sort(n,y)

n : numéro de BusinessView.

x : clé de retrieve.

y : clé de sort.

C'est une macro-action qui réalise init() et display().

forward(n,x,y) = init(n,x,y);display(n)

n : numéro de BusinessView.

x : clé de retrieve.

y : clé de sort.

Description

L’action invalidate invalide « l’état de sélection » de l’objet métier manipulé pour re-prendre en considération la/les mises à jours opérées au niveau de la base de données.

Syntaxe

invalidate ( viewRef )

Paramètre

viewRef : Le paramètre obligatoire viewRef fait référence à la View pour laquelle on veut réactualiser les informations détenues.

Exemple

Réactualisation des données associées à la BusinessView courante pour la vue représentant (REP).

url : … ?cinematic=invalidate(REP);display(0)

Description

L’action propose gère les buffers de saisie jusqu’à validation et mise à jour effective des données dans la base par l’action assimilate.

Syntaxe

propose ( businessViewRef )

Paramètre

businessViewRef : Le paramètre obligatoire businessViewRef fait référence à la BusinessView de travail.

Voir également

assimilate, create, delete

Exemple

Voir action assimilate.

Remarque(s)

• L’action propose n’effectue aucun contrôle d’intégrité des données.
• Tout champ inconnu sera ignoré.

Description

L’action assimilate transpose les données de l’utilisateur dans la base de données. Ces données ayant été conditionnées auparavant par l’action propose. L’opération effectue les contrôles de validité des données et génère le cas échéant un message d’erreur pour l’ensemble des champs utilisateurs incriminés.

Syntaxe

assimilate()

Paramètre

L’action assimilate ne prend pas de paramètre. Elle manipule directement et uniquement la BusinessView courante.

Exemple

Saisie des données d’un tiers.

url : … ?cinematic=propose(0);assimilate();display(0)&chp:Sigtie=Juste& chp:Nomtie=Leblanc …

Saisie en tableau des données de plusieurs tiers.

url : … ?cinematic=propose(0);assimilate();display(0)&chp:Sigtie-1=Juste&chp:Nomtie-1=Leblanc&chp:Sigtie-2=Lagaffe&chp:Nomtie-2=Gaston …

Description

La macro action integrate fait appel à l'intervention simultanée des actions propose et assimilate.

Nous déconseillons l'utilisation de cette action qui risque d'être supprimée dans une prochaine version.

Syntaxe

integrate ( businessViewRef ) := propose(businessViewRef);assimilate()