.. _flow-params:

Définition des paramètres de flux
=================================

.. index:: Paramètre de flux

Les :term:`paramètres de flux <paramètre de flux>` sont des propriétés
des flux définis, au même titre que son nom, ses partenaires de départs
et d'arrivée, etc. Leurs valeurs sont saisis lors de la :ref:`définition
d'un flux <flow-edit-create>`.

Cet écran permet à l'administrateur de définir des paramètres
additionnels, qui peuvent ensuite être utilisés lors de l'évaluation des
modèles de flux :

- pour paramétrer les tâches à exécuter avant et après le transfert
  (par exemple les codepage de départ et d'arrivée pour le transcodage)
- pour déterminer si une règle/tâche doit être utilisée pour le flux
  pour lequel le modèle est évalué

.. note::

   Les paramètres de flux peuvent toujours être définis dans Waarp
   Manager.

   En revanche, ils ne sont appliqués par les moniteurs Waarp R66 que
   si le modèle de flux les utilise.

Les paramètres de flux ont les propriétés suivantes :

Nom
  Nom du paramètre.

  Il ne peut être composé que de caractères alphanumériques et
  d'underscores ("_"). Il est utilisé comme identifiant du paramètre
  dans les modèles de flux.
Libellé
  Label qui apparaît devant le champs de saisie dans le formulaire de
  définition des flux
Type
  Type du paramètre. Trois types sont actuellement définis :

  - ``Texte`` : la valeur est une chaîne de caractère
  - ``Nombre`` : la valeur est un nombre
  - ``Choix`` : la valeur doit être sélectionnée dans une liste de
    valeurs possible définie par l'administrateur.

Liste de choix (pour le type ``Choix``)
  La liste des valeurs disponibles pour ce paramètre. L'utilisateur qui
  défini un flux devra choisir une valeur parmi cette liste.
Valeur par défaut
  La valeur donnée au paramètre lors de la définition du flux si
  l'utilisateur n'en saisi pas une différente.
Obligatoire
  Indique si le paramètre doit être renseigné ou s'il peut être laissé
  vide.
Visible
  Indique si le paramètre est visible sur l'écran de définition des flux.




.. _flow-param-list:

Liste des paramètres de flux
----------------------------

L'index de cette section affiche la liste des paramètres de flux définis
(:numref:`fig-flow-param-list`).

.. _fig-flow-param-list:
.. figure:: ../../_static/img/flow_param_list.png
   :align: center

   Liste des paramètres de flux

En regard de chaque ligne, les boutons d'action permettent les actions
suivantes :

- Changer l'ordre d'affichage des paramètres
- :ref:`Éditer un paramètre <flow-param-edit-create>`
- :ref:`Supprimer un paramètre <flow-param-delete>`

De même, cet écran donne accès au formulaire de
:ref:`création d'un nouveau paramètre <flow-param-edit-create>`.




.. _flow-param-edit-create:

Édition/Création d'un paramètre de flux
---------------------------------------

L'écran d'édition permet d'éditer la plupart des informations
d'un paramètre de flux (:numref:`fig-flow-param-edit-text2`).

Les propriétés éditables sont celles présentées ci-dessus.

.. _fig-flow-param-edit-text2:
.. figure:: ../../_static/img/flow_param_edit_text.png
   :align: center

   Édition/Création d'un paramètre de flux de type texte

Le nom et le label sont les seuls champs obligatoires.


.. warning::

   Quand le nom d'un paramètre de flux est modifié, les modèles de flux
   qui utilisent ce paramètre doivent être mis à jour pour utiliser le
   nouveau nom.


Si le paramètre est de type ``Choix``, un champ additionnel s'affiche
pour saisir la liste des choix possibles
(:numref:`fig-flow-param-edit-choice`).

.. _fig-flow-param-edit-choice:
.. figure:: ../../_static/img/flow_param_edit_choice.png
   :align: center

   Édition/Création d'un paramètre de flux de type choix



.. _flow-param-delete:

Suppression des paramètres
--------------------------

Depuis la liste des paramètres de flux, il est possible de supprimer un
paramètre. Une confirmation est demandée à l'utilisateur.

La suppression d'un paramètre a les impacts suivants :

* Les flux pour lesquels le paramètre a une valeur conservent cette
  valeur jusqu'à ce qu'ils soient édités, ou quel les règles du flux
  soient re-générées ;
* Les modèles de flux qui utilisent ce paramètre doivent être édités
  pour ne plus utiliser le paramètre.
  Leur évaluation ne provoque cependant pas d'erreur : le paramètre
  la valeur "chaîne de caractère vide".
