Le contrôle Progress Steps

On parlait du Progress Steps il y a quelques semaines (ici exactement) et on s’est dit qu’un guide de démarrage peut être utile.

gif

Pour rappel :

Ce contrôle pour smartforms permet de présenter une barre d’avancement graphique sur le formulaire (sans passer par le viewflow). Les étapes peuvent être récupérées automatiquement de la modélisation K2 ou définies manuellement. La dernière mise à jour à permis de rajouter un tooltip sur chacune des étapes utilisant la description de l’activité.

Dans l’usage : Le PS (Progress Steps hein, dans cette période d’élection, nous respectons le pluralisme) est plutôt simple à installer, l’archive en téléchargement propose un fichier exécutable. Le contrôle s’ajoute dans une vue ou un formulaire et se configure de deux manières.

La configuration automatique
En se basant sur un nom (ou ID) de workflow (format “NomProjet\NomProcess”), le PS présente automatiquement les étapes en fonction des SmartForms Client Events. J’insiste, Smartforms Client Event. Les autres client events ne sont pas (très bien) supportés. Aussi, il est possible :

  • d’inclure automatiquement tous (ou manuellement certains) Server Events (≠ Client Event) ;
  • d’exclure manuellement des Smartforms Client Event ;
  • de définir le nom de la première étape.

Remarques : L’ordre des étapes est lié aux ID des activités du processus, c’est à dire un ordre chronologique de conception (≠ de l’ordre de séquencement du workflow : attention à l’ajout d’une étape entre deux étapes existantes). L’affichage n’est pas adapté pour présenter des étapes en parallèles et/ou conditionnelles.   Les droits de View sur le processus sont nécessaires pour afficher le contenu correctement.

De plus, comme mentionné plus haut, la description d’une activité est présentée comme tooltip de l’étape. Enfin, K2 utilise le paramètre SN (ou SerialNo) pour connaître l’étape en cours, essayez de ne pas changer de nom.

La configuration manuelle
Le PS peut aussi présenter des étapes depuis un SmartObject. Ce dernier doit présenter une structure particulière (l’archive en téléchargement propose un package avec ce SmartObject, déployé dans le répertorie Reusable Components/Data). Le SmO doit présenter les colonnes suivantes :

  • Module : permet de lier des étapes à un workflow, pour cela la valeur du Module doit être la même. Le smartobject fournit dans le package permet de gérer le contenu de plusieurs PS.
  • State : permet de présenter l’étape en cours, en fonction du State. En effet, la configuration manuelle impose d’avoir un state par étape dans le PS (plusieurs formulaires sont supportés).
  • Label : permet de définir le nom de l’étape.
  • Description : permet de définir le tooltip de l’étape.
  • URL : permet de rediriger vers une URL lors du clic sur une étape.
  • Sort : permet d’ordonner les étapes d’un même Module.

En Image

ProgressSteps
Le contrôle se trouve sous l’onglet Custom Controls. Il peut être ajouté dans des vues et des formulaires.
ProgressSteps
Voici les propriétés du Progress Steps, décrites plus haut dans cet article.

Conclusion

La version automatique est plus simple que la version manuelle mais implique que le processus respecte les remarques citées plus haut. La version manuelle permet plus de souplesse et de maîtrise du contenu du Progress Steps. Personnellement, c’est la deuxième option que je recommande (pour le coté évolutif et maintenable), mais je suis ouvert à toutes les remarques dans les commentaires : )

C’est tout pour cette fois, cheers !

benjamin

Technical Specialist @t K2 France ----- Twitter : @benjaminbertram ----- LinkedIn : Benjamin Bertram

One thought to “Le contrôle Progress Steps”

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.