SAINET apis and documentation

Fichiers et Structures

dashboards

Le noeud de base du fichier de configuration. Il regroupe tous les dashboards déclarés pour la chaîne.

<dashboards>
  <dashboard id="ADR_GENERIC" label="Tableau de bord">
    <visual>
      <dashboardSize>FullScreen</dashboardSize>
      <align>Center</align>
    </visual>
    <group id="1" column="0" row="0" width="18" height="12">
      <config>
        <label>Dossiers et journal de bord</label>
      </config>
      <!-- ================== Tuiles de filtre ===================== -->
      <tile id="DOSSIERS_SELECTION" type="Filter" presentation="Icon" row="0" column="0" width="9" height="6">
        <config>
          <label>Mes dossiers</label>
          <taskId>ADR02</taskId>
          <gridId>ADR02_MSP_SYNTHESE</gridId>
        </config>
        <action type="Task">
          <taskId>ADRX2</taskId>
        </action>
      </tile>
      <!-- ================ Tuiles de grille ======================= -->
      <tile id="JOURNAL_BORD" type="Grid" presentation="Icon" row="0" column="9" width="9" height="3">
        <config>
          <label>Journal de bord</label>
          <taskId>ADR40</taskId>
          <gridId>ADR40_DERNIERES_SAISIES</gridId>
          <filterId>ADR40_DERNIERES_SAISIES</filterId>
          <filteredBy>
            <tileId>DOSSIERS_SELECTION</tileId>
            <filterValue>ADRHIS.NODOSS : $ADRDOS.ID_PK</filterValue>
          </filteredBy>
        </config>
        <action type="Task" />
      </tile>
      <tile id="TASKS" type="Grid" presentation="Icon" row="3" column="9" width="9" height="3">
        <config>
          <label>Rappel des tâches</label>
          <taskId>ADR40</taskId>
          <gridId>ADR40_PROCHAIN_RAPPELS</gridId>
          <filterId>ADR40_PROCHAIN_RAPPELS</filterId>
          <filteredBy>
            <tileId>DOSSIERS_SELECTION</tileId>
            <filterValue>ADRHIS.NODOSS : $ADRDOS.ID_PK</filterValue>
          </filteredBy>
        </config>
        <action type="Task" />
      </tile>
      <!-- =============== Tuiles de planning ======== -->
      <tile id="PLANNING" type="Agenda" presentation="ByConfig" row="6" column="0" width="15" height="4">
        <config>
          <label>Planning de la semaine</label>
          <taskId>GTP40</taskId>
          <gridId>GTPEV_DASHBOARD</gridId>
          <filterId>GTPEV_DASHBOARD_WEEK_REFERENT</filterId>
          <agendaConfig>GTPEV_SectionSemaine.chv</agendaConfig>
          <filteredBy>
            <tileId>DOSSIERS_SELECTION</tileId>
            <filterValue>GTPEVT.STATECLIENT: $ADRDOS.ID_PK</filterValue>
          </filteredBy>
        </config>
        <action type="Notification">
          <notification>GTP40_OPEN_MONTH</notification>
        </action>
      </tile>
      <!-- ======================= Events et suivi ================= -->
      <tile id="NEW_EVENT" type="Task" presentation="Icon" row="6" column="15" width="3" height="2">
        <config>
          <label>Nouvelle entrée journal</label>
          <taskId>ADR40</taskId>
          <filteredBy>
            <tileId>DOSSIERS_SELECTION</tileId>
            <visibleOnFilter>VisibleOnNoFilter</visibleOnFilter>
            <visibleOnFilter>VisibleOnMultipleValues</visibleOnFilter>
          </filteredBy>
        </config>
        <visual>
          <titlePosition>Bottom</titlePosition>
          <showIcon>1</showIcon>
          <icon>Grid 60x60.png</icon>
          <iconShading>Monochrome</iconShading>
          <iconColor>base4</iconColor>
          <useSecondaryIcon>false</useSecondaryIcon>
          <backgroundType>Color</backgroundType>
          <backgroundColor>white</backgroundColor>
          <backgroundAlpha>0.9</backgroundAlpha>
        </visual>
        <action type="Notification">
          <notification>ADR40_NEW_EVENT</notification>
        </action>
      </tile>
    </group>
  </dashboard>
</dashboards>
  • dashboard (Dashboard) - Un dashboard est le descripteur de l’écran de dashboard affiché à l’utilisateur. Plusieurs dashboards peuvent être disponibles mais seul un dashboard est affiché à la fois à l’écran. Il n’existe pas de relations directe entre les dashboards.

Dashboard

Un dashboard est le descripteur de l’écran de dashboard affiché à l’utilisateur. Plusieurs dashboards peuvent être disponibles mais seul un dashboard est affiché à la fois à l’écran. Il n’existe pas de relations directe entre les dashboards.

Attributs:

  • id * {string} -
  • label * {string} -
  • width {positiveInteger} -
  • height {positiveInteger} -

Eléments:

  • visual {1-1} (VisualConfig) - Configuration visuelle du dashboard. Les différentes options permettent de personnaliser l’affichage de celui-ci.
  • group {1-∞} (Group) - Groupe de tuiles. Un groupe permet d’afficher un titre et de regrouper les tuiles similaires afin de les placer plus facilement à l’écran. Le système affiche des marges spéciales autour des groupes de façon à proposer à l’utilisateur un visuel cohérent pour l’aider à se repérer sur le bureau. Tout comme dans les tâches, il est également possible de n’utiliser qu’un seul groupe contenant toutes les tuiles. Chaque groupe réinitialise l’origine (0,0) des tuiles qu’il contient en haut à gauche du groupe.

VisualConfig

Configuration visuelle du dashboard. Les différentes options permettent de personnaliser l’affichage de celui-ci.

Eléments:

  • backgroundColor {0-1} (HtmlColor) - Couleur de fond du dashboard. Cette couleur doit être au format hexadécimal HTML (#023C50 par exemple).

  • backgroundAlpha {0-1} (xs:string) - Transparence de la couleur de fond. 1 signifie opaque et 0 signifie transparent complet. Sous le fond du dashboard s’affiche le fond d’écran du bureau de l’utilisateur.

  • dashboardSize {0-1} (VisualConfigSize) - Valeurs possibles:

    • FullScreen - Affichage plein-écran. Le dashboard couvre le bureau SAINet en entier. La barre de menu ainsi que la barre de navigation à gauche ne sont pas couvertes.

  • align {0-1} (VisualConfigAlignment) - Valeurs possibles:

    • Center - Positionnement du dashboard au centre du bureau de l’utilisateur.

  • gridUnitRatio {0-1} (xs:float) -

Group

Groupe de tuiles. Un groupe permet d’afficher un titre et de regrouper les tuiles similaires afin de les placer plus facilement à l’écran. Le système affiche des marges spéciales autour des groupes de façon à proposer à l’utilisateur un visuel cohérent pour l’aider à se repérer sur le bureau. Tout comme dans les tâches, il est également possible de n’utiliser qu’un seul groupe contenant toutes les tuiles. Chaque groupe réinitialise l’origine (0,0) des tuiles qu’il contient en haut à gauche du groupe.

Attributs:

  • id * {string} - Identifiant du groupe. Celui-ci doit être unique dans le dashboard.
  • column * {integer} - Colonne de début du groupe. Les colonnes sont numérotées à partir de zéro et font une largeur identique aux lignes, qui est définie par le paramètre DASHBOARD_SQUARE_UNIT retourné par les propriétés client. Cette largeur fait 64 pixels par défaut.
  • row * {integer} - Ligne de début du groupe. Les lignes sont numérotées à partir de zéro et font une largeur identique aux colonnes, qui est définie par le paramètre DASHBOARD_SQUARE_UNIT retourné par les propriétés client. Cette hauteur fait 64 pixels par défaut.
  • width * {integer} - Largeur du groupe en nombre de colonnes.
  • height * {integer} - Hauteur du group en nombre de lignes.

Eléments:

  • config {0-1} (GroupConfig) - Paramètres d’un groupe.
  • tile {1-∞} (Tile) - Une tuile est une case rectangulaire affichange de l’information et/ou permettant de lancer des tâches ou des notifications. Chaque tuile possède une configuration technique permettant de définir comment les données sont récupérées si il y a lieu d’être, une configuration visuelle permettant au paramétreur d’apporter une touche cohérente par rapport au produit qu’il propose, et une configuration d’action qui définit ce qu’il se passe lorsque l’utilisateur clique sur une tuile.

GroupConfig

Paramètres d’un groupe.

Eléments:

  • label {0-1} (xs:string) - Libellé du groupe. Celui-ci est affiché au dessus du groupe.

Tile

Une tuile est une case rectangulaire affichange de l’information et/ou permettant de lancer des tâches ou des notifications. Chaque tuile possède une configuration technique permettant de définir comment les données sont récupérées si il y a lieu d’être, une configuration visuelle permettant au paramétreur d’apporter une touche cohérente par rapport au produit qu’il propose, et une configuration d’action qui définit ce qu’il se passe lorsque l’utilisateur clique sur une tuile.

Attributs:

  • id * {string} - Identifiant de la tuile. Cet identifiant doit être unique dans un dashboard.
  • type * {TileType} - Valeurs possibles:
    • Task - Une tuile de type Task est un lanceur permettant de lancer une tâche SAINet.
    • Grid - Une tuile de type grid permet d’avoir un rendu autour d’une ou plusieurs lignes de donnéés. L’attribut présentation peut prendre trois valeurs : soit Grid qui affiche une grille en colonnes, soit TodoList qui affiche les entrées sous forme de liste à points, soit Gallery qui fait défiler les informations de la ligne.
    • Agenda - Une tuile de type agenda permet d’afficher un planning ou un historyViewer. Ce type de tuile n’a qu’une seule présentation. La définition de ce qu’elle affiche dépend de sa configuration. Par exemple,
    <tile type="Agenda" id="PLANNING_DU_JOUR" column="0" row="0" width="4" height="4">
  <config>
    <taskId>ADR02</taskId>
    <gridId>ADR02_MSP_MAIN_GRID</gridId>
    <filterId>ADR02_REFERENT_FILTER</filterId>
    <agendaConfig>PlanificationAssuresSemaine</agendaConfig>
  </config>
</tile>
    • Graph - Une tuile de type graph permet d’afficher un graphique. Ce type de tuile n’a qu’une seule présentation. La définition de ce qu’elle affiche dépend de sa configuration. Par exemple,
    <tile type="Graph" id="PLANNING_DU_JOUR" column="0" row="0" width="4" height="4">
  <config>
    <taskId>ADR02</taskId>
    <gridId>ADR02_MSP_MAIN_GRID</gridId>
    <filterId>ADR02_REFERENT_FILTER</filterId>
    <graphConfig>PlanificationAssuresGraph</graphConfig>
  </config>
</tile>
    • Filter - Une tuile de type Filter permet de proposer à l’utilisateur sous forme de liste multi-selectionnable ou non, d’appliquer un filtre global simple à une partie ou à toutes les tuiles qu’il voit sur son dashboard. Par exemple,
    <tile type="Filter" id="ASSURES_FILTER" column="0" row="0" width="4" height="4">
  <config>
    <taskId>ADR02</taskId>
    <gridId>ADR02_MSP_ASSURES</gridId>
    <filterId>ADR02_REFERENT_FILTER</filterId>
    <multiselection>true</multiselection>
    <noDataText>Pas d'assuré</noDataText>
  </config>
</tile>
    • Title - Une tuile de type Titre permet d’afficher un titre, potentiellement dynamique en fonction d’une autre tuile de filtre. Par exemple,
    <tile type="Title" id="TITRE" presentation="Largest" row="0" column="0" width="19" height="2">
  <config>
    <label>Dashboard $REGIMM.DLABEL</label>
    <shortLabel>$REGIMM.DLABEL</shortLabel>
    <veryShortLabel>Dashboard</veryShortLabel>
    <filteredBy><!-- cas particulier, pour que la tuile soit mise  jour quand le filtre change -->
      <tileId>IMMEUBLE_SELECTION</tileId>
    </filteredBy>
  </config>
</tile>
  • presentation * {TilePresentation} - Valeurs possibles:
    • Icon - Concerne les tuiles de type ‘Task’. Présentation classique (Windows 10), affiche l’icône de la tâche ou de la table, avec le texte de la tuile en dessous.
    • IconAndValues - Concerne les tuiles de type ‘Task’. En plus de l’icône de la tâche, affiche à droite de l’icône une liste des 3-4 premières entrées, selon la place disponible.
    • IconsAndValues - Concerne les tuiles de type ‘Task’. Affiche les premiers éléments du navigateur sous forme de liste avec les icônes des records.
    • NotesImagesAndValues - Concerne les tuiles de type ‘Task’. Affiche les premiers éléments du navigateur sous forme de liste avec l’image de la note attachée à chaque record si elle existe.
    • LargeNotesImages - Concerne les tuiles de type ‘Task’. Affiche les notes des premiers éléments du navigateur sous forme de “tuiles” dans la tuile. Si un seul record est présent l’image prend par défaut tout l’espace de la tuile.
    • Small - Pour les tuiles de type Title, affiche le texte en petit, prenant environ 1/3 de la hauteur de la tuile.
    • Medium - Pour les tuiles de type Title, affiche le texte en moyen, prenant environ 1/2 de la hauteur de la tuile.
    • Large - Pour les tuiles de type Title, affiche le texte en grand, prenant environ 2/3 de la hauteur de la tuile.
    • Huge - Pour les tuiles de type Title, affiche le texte en grand, prenant environ toute la hauteur de la tuile.
    • Grid - Pour les tuiles de type Grid, affiche les données sous forme de grille en colonnes.
    • TodoList - Pour les tuiles de type Grid, affiche les données sous forme de liste à points.
    • Gallery - Pour les tuiles de type Grid, affiche les données sous forme de gallerie qui fait défiler les informations de la ligne.
    • ByConfig -
  • column * {integer} - Colonne de début du groupe. Les colonnes sont numérotées à partir de zéro et font une largeur identique aux lignes, qui est définie par le paramètre DASHBOARD_SQUARE_UNIT retourné par les propriétés client. Cette largeur fait 64 pixels par défaut.
  • row * {integer} - Ligne de début du groupe. Les lignes sont numérotées à partir de zéro et font une largeur identique aux colonnes, qui est définie par le paramètre DASHBOARD_SQUARE_UNIT retourné par les propriétés client. Cette hauteur fait 64 pixels par défaut.
  • width * {integer} - Largeur du groupe en nombre de colonnes.
  • height * {integer} - Hauteur du group en nombre de lignes.

Eléments:

  • config {1-1} (TileConfig) - Le noeud config contient les paramètres de configuration des données qui sont affichées dans les tuiles. La plupart des propriétés X de valeur Y sont définies sous la forme <X>Y</X>.
  • visual {1-1} (TileVisual) - Configuration des paramètres d’affichage de la tuile.
  • action {0-1} (TileAction) - Configuration de l’action à lancer lorsque l’utilisateur clique sur la tuile. Par défaut, aucune action n’est lancée.

TileConfig

Le noeud config contient les paramètres de configuration des données qui sont affichées dans les tuiles. La plupart des propriétés X de valeur Y sont définies sous la forme <X>Y</X>.

Eléments:

  • label {1-1} (xs:string) - Texte de la tuile
  • shortLabel {0-1} (xs:string) - Texte raccourci de la tuile. Celui-ci est affiché si le texte venant de l’attribut label ne rentre pas en largeur dans la tuile.
  • veryShortLabel {0-1} (xs:string) - Texte raccourci de la tuile. Celui-ci est affiché si ni le texte venant de l’attribut label ni celui venant de shortLabel ne rentrent en largeur dans la tuile.
  • taskId {1-1} (xs:string) - Identifiant de la tâche associée aux données de la tuile. Dans le cas d’une tuile affichant une grille, la tâche sur laquelle l’appel doit s’effectuer pour récupérer les données. Dans le cas d’une tuile de raccourcis, la tâche devant s’ouvrir.
  • gridId {0-1} (xs:string) - Identifiant de la grille de données qui doit être affichée dans le cas de tuiles de type Grid ou Filter. Dans le cas de tuiles avec une action de type Task, cette grille sera utilisée pour redéfinir la grille de la tâche lancée.
  • formatterId {0-1} (xs:string) - Identifiant du formatteur de données le cas de tuiles de type Grid.
  • filterId {0-1} (xs:string) - Identifiant du filtre à appliquer sur la récupération des données affichées dans la tuile dans le cas de tuiles de type Grid ou Filter. Dans le cas de tuiles avec une action de type Task, ce filtre sera utilisée pour redéfinir le filtre de la tâche lancée.
  • initialSelection {0-1} (InitialSelectionType) - Permet de pré-sélectionner un élément à l’ouverture dans les tuiles de filtre dynamique.
  • agendaConfig {0-1} (xs:string) - Identifiant de la configuration d’historyViewer à utiliser pour afficher les données dans une tuile de type Agenda.
  • graphConfig {0-1} (xs:string) - Identifiant de la configuration d’agenda à utiliser pour afficher les données dans une tuile de type Graph.
  • filteredBy {0-1} (FilteredByConfig) - Configuration du filtre entre les tuiles. Ceci permet d’utiliser la sélection d’une ou plusieurs tuiles de type Filter afin de définir un filtre supplémentaire sur les données affichées dans la tuile. Par exemple, en supposant que la tuile DOSSIERS_SELECTION soit une tuile de filtre avec une grille sur ADRDOS, il est possible de filtrer les entrées de journal pour n’afficher que les entrées correspondant à un enregistrement sélectionné dans cette dernière.
<filteredBy>
  <tileId>DOSSIERS_SELECTION</tileId>
  <filterValue>ADRHIS.NODOSS : $ADRDOS.ID_PK</filterValue>
</filteredBy>

FilteredByConfig

Configuration du filtre entre les tuiles. Ceci permet d’utiliser la sélection d’une ou plusieurs tuiles de type Filter afin de définir un filtre supplémentaire sur les données affichées dans la tuile. Par exemple, en supposant que la tuile DOSSIERS_SELECTION soit une tuile de filtre avec une grille sur ADRDOS, il est possible de filtrer les entrées de journal pour n’afficher que les entrées correspondant à un enregistrement sélectionné dans cette dernière.

<filteredBy>
  <tileId>DOSSIERS_SELECTION</tileId>
  <filterValue>ADRHIS.NODOSS : $ADRDOS.ID_PK</filterValue>
</filteredBy>

Eléments:

  • tileId {1-1} (xs:string) - Identifiant de la tuile de filtre à utiliser pour créer le filtre.
  • filterValue {0-1} (xs:string) - Valeur sous la forme TABLEID.DATAFIELDID : $OTHERTABLEID.DATAFIELDID
  • visibleOnFilter {0-1} (FilteredByDisplay) - Valeurs possibles:
    • VisibleOnNoFilter - Tuile visible uniquement si aucun filtre n’est appliqué dessus. Une tuile de ce type permet de cacher une grande tuile générale pour afficher deux plus petites tuiles lorsqu’un filtre est appliqué par exemple.
    • VisibleOnSingleValue - Tuile visible uniquement lorsqu’une valeur a été sélectionnée dans la tuile de filtre. Si aucune valeur ou plusieurs valeurs sont sélectionnées, la tuile n’apparaîtra pas.
    • VisibleOnMultipleValues - Tuile uniquement visible lorsque plusieurs valeurs sont sélectionnées dans la tuile de filtre.

TileVisual

Configuration des paramètres d’affichage de la tuile.

Eléments:

  • titlePosition {0-1} (TitlePosition) - Valeurs possibles:

    • Bottom -
    • Middle -
    • Top -

  • titleAlign {0-1} (TitleAlign) - Valeurs possibles:

    • Left -
    • Middle -
    • Right -

  • titleOffset {0-1} (xs:integer) -

  • titleColor {0-1} (HtmlColor) -

  • titleFontName {0-1} (xs:string) -

  • titleFontSize {0-1} (xs:integer) -

  • backgroundImage {0-1} (IconFile) -

  • useSecondaryIcon {0-1} (xs:string) -

  • iconShading {0-1} (IconShading) - Valeurs possibles:

    • Monochrome - L’icône présentée suit le style “Windows 10” avec une icône monochrome au style simplifié et plat. L’icône est récupérée dans le répertoire Mono png icons.
    • Normal - L’icône présentée suit le style “Windows 7” avec une icône colorée au style 3D. L’icône est récupérée dans le répertoire Highres png icons ainsi que les autres dossiers System images.

  • iconColor {0-1} (HtmlColor) -

  • maxWidth {0-1} (xs:string) - Largeur maximale de l’icône dans la tuile en fraction de la largeur de la tuile. Par défaut l’icône prend sa taille native, il est possible de gérer les écrans plus petits (tailles de DASHBOARD_SQUARE_UNITS personnalisées) avec cet attribut. La valeur doit être entre 0 et 1.

  • maxHeight {0-1} (xs:string) - Hauteur maximale de l’icône dans la tuile en fraction de la hauteur de la tuile. Par défaut l’icône prend sa taille native, il est possible de gérer les écrans plus petits (tailles de DASHBOARD_SQUARE_UNITS personnalisées) avec cet attribut. La valeur doit être entre 0 et 1.

  • showIcon {0-1} (xs:string) - Définit si l’icône est affichée ou pas.

  • icon {0-1} (TileIcon) -

  • backgroundType {0-1} (BackgroundType) - Valeurs possibles:

    • None - Aucun fond. La tuile sera transparente.
    • Color - Fond coloré. La couleur est définie par la propriété backgroundColor.
    • Image - Image de fond. L’image à afficher est définie par la propriété backgroundImage.

  • backgroundColor {0-1} (HtmlColor) -

  • backgroundAlpha {0-1} (xs:string) -

TileAction

Configuration de l’action à lancer lorsque l’utilisateur clique sur la tuile. Par défaut, aucune action n’est lancée.

Attributs:

  • type {TileActionType} - Valeurs possibles:
    • Notification - Lance une notification lorsque la tuile est cliquée. Les notifications doivent exister ou être définies entièrement dans la configuration de la tuile.
    • Task - La tuile définie dans la configuration de la tuile est exécutée avec de manière optionelle le filtre défini dans filterId et une grille personnalisée définie dans gridId de la configuration de la tuile.
    • None - La tuile ne fait aucune action. Utilisé typiquement dans les tuiles de grille qui affichent simplement de l’information

Eléments:

  • taskId {0-1} (TaskIdentifier) - Pour les actions de type Task, spécifie quelle tâche est ouverte lors du clic sur la tuile. Si pas spécifié, c’est le taskId du noeud config qui sera utilisé.
  • filterId {0-1} (xs:string) - Pour les actions de type Task, spécifie quel filtre est appliqué sur le navigateur de la tâche ouverte. Le filtre doit exister.
  • notification {0-1} (xs:string) - Pour les actions de type Notification, spécifie l’identifiant de la notification à appeler lorsque l’utilisateur clique sur la tuile.
  • notificationSource {0-1} (NotificationType) - Pour les actions de type Notification, spécifie le type de notification. Remote ou Local.
  • notificationArguments {0-1} (xs:string) - Pour les actions de type Notification en source Remote, spécifie les arguments qui seront transmis avec la notification.
  • notificationTask {0-1} (xs:string) - Pour les actions de type Notification en source Remote, spécifie la tâche qui sera utilisée

DataField

Attributs:

  • ID * {string} - Identifiant du datafield. Cet identifiant correspond à l’identifiant en base de données. Cet identifiant doit être unique au sein d’une même table. Les datafields de clé doivent se terminer par _PK par convention.
  • Source * {DataFieldSource} - Spécifie la source de données du datafield. Valeurs possibles:
    • DataBaseDirect - Le datafield est stocké dans une colonne de la base de données. Il s’agit du stockage normal de données dans les tables standard et les entêtes de dossier.
    • DataBaseDossier - Le datafield est stocké dans la table des champs de dossier. Aucune colonne spécifique au datafield n’est nécessaire dans la base de données. Il s’agit du stockage standard dans les tables de type dossier.
    • TaskOnly - Le datafield n’est pas stocké automatiquement. Par défaut, le serveur ne rempli pas les champs issus de datafields de ce type. Les valeurs sont envoyées lors de la validation mais ne sont pas sauvegardés par le système.
  • Format * {DataFieldFormat} - Format des données stockées au travers du datafield. Valeurs possibles:
    • String - Chaine de caractères simple.
    • MultiLineString - Chaîne de caractères sur plusieurs lignes. Il s’agit d’un des types de données qui peuvent être présentés sur plusieurs lignes.
    • Script - Chaîne de caractères sur plusieurs lignes représentant un script saisi par l’utilisateur. Il s’agit d’un des types de données qui peuvent être présentés sur plusieurs lignes.
    • Integer - Nombre entier
    • Financial - Nombre décimal stocké sans perte de précision en base de données
    • Float - Nombre à virgule flottante. Ce format ne doit pas être utilisé pour des calculs financiers
    • Year - Nombre entier représentant une année
    • Date - Date
    • DateTime - Date et heure
    • Time - Heure
    • Boolean - Booléen
    • ByForeignKey - Le format de ce datafield est calculé à partir du champ vers lequel il est lié. Doit préciser un attribut TableName.
    • Percentage - Nombre à virgule flottante représentant un pourcentage
    • Enum - Élément de combo. Doit préciser un attribut EnumName.
    • List - Liste d’éléments sélectionnés à partir d’une autre table ou d’un Enum. Doit préciser un attribut TableName pour lier à une table. Doit préciser un attribut EnumName pour lier à une combo. Si l’attribut DisplayColumn est précisé, le champ affiche la valeur indiqué dans la colonne spécifiée de la grille de selection dans le cas d’un TableName. Dans le cas d’un Enum, la displayColumn doit être Label.
    • GEDDocument - Lien vers un document stocké en base de données.
    • GEDImage - Lien vers une image stockée en base de données.
    • GPSCoordinates - Coordonnées GPS.
    • File - Fichier sur le disque. Ce format est utilisé en règle générale sur un champ TaskOnly pour permettre à l’utilisateur d’uploader un document.
    • Filter - Filtre de données. Utilisé principalement sur un champ TaskOnly dans les tâches de vue, de liste et de traitement. Doit définir un attribut FilterName pointant vers un filtre existant dans le paramétrage.
    • PrintSettings - Configuration d’impression. Utilisé principalement sur un champ TaskOnly dans les tâches de liste afin de permettre à l’utilisateur de configurer le format de sortie du document.
    • PagesAndFields - Sélecteur de page et champs. Seulement utilisé par le datafield global SELECT_PAGES_AND_FIELDS.
  • InternLabel {string} - Libellé interne pour le développeur. Si aucune redéfinition n’est effectuée dans les fichiers de propriétés, ce libellé est affiché à l’utilisateur.
  • InternDescription {string} - Description interne pour le développeur. Ce texte n’est jamais affiché à l’utilisateur.
  • IsKey {boolean} - Attribut obligatoire pour les datafields faisant partie de la clé. Ces datafields doivent se terminer par le suffixe _PK.
  • IsHeader {boolean} - Si true, ce DataField fera partie du titre de l’écran (au-dessus du premier groupe). Le titre est généré dans l’ordre de définition des DataFields.
  • IsTitle {boolean} - Déprécié: préférer l’utilisation de l’attribut Title dans la Page du TasksAndFields. Si true, ce DataField fera partie du titre dans le navigateur de page. Le titre est généré dans l’ordre de définition des DataFields.
  • Importance {DataFieldImportance} - Valeurs possibles:
    • 0 - Le field n’est pas obligatoire pour validation.
    • 1 - Le field est obligatoire pour la validation de l’entrée. S’il n’est pas spécifié lors de la validation, une étoile apparaît à côté du champ.
    • 2 - Le field est obligatoire pour la validation de l’entrée. Une étoile est toujours affichée lors de la saisie.
  • TableName {string} - Spécifie la table vers laquelle les données stockées dans le datafield pointent. Cet attribut est obligatoire si le format du datafield est ByForeignKey.
  • FilterName {string} - Spécifie le filtre à appliquer. Est obligatoire si le format du datafield est Filter.
  • PlaceHolder {string} - Spécifie le placeholder affiché dans le champ qui pointe vers ce datafield. Il est également possible d’internationaliser la valeur dans les properties en spécifiant une entrée datafieldId.PlaceHolder
  • EnumName {string} - Spécifie l’identifiant de la combo liée au datafield. Cet attribut n’est valide que sur les datafields de type Enum. Les valeurs possibles sont soit une combo définie dans les fichiers de combo. Il est également possible d’utiliser la valeur ByDataFieldName afin d’utiliser automatiquement la combo ayant le même identifiant que le datafield. La valeur ByTaskAndFieldName permet également d’utiliser automatiquement la combo ayant le même identifiant que la tâche et le champ utilisant le datafield.
  • GridView {string} - Pour les champs pointant sur une autre table, spécifie la grille de données utilisée afin de récupérer les valeurs. Cet attribut ne peut être utilisé que pour les formats ByForeignKey, List et Filter et doit faire référence à une grille existante dans le paramétrage.
  • MaxLength {integer} - Spécifie la longueur maximale du contenu du champ. Cette valeur doit être prise en compte lors de la création des colonnes en base de données. Si l’attribut AllowMultipleLanguages est activé, le contenu en base doit également être plus long que la longueur définie ici (MaxLength*nombre de langues). Pour les types Enum, la longueur doit permettre de stocker tous les identifiants de la combo.
  • AllowMultipleLanguages {boolean} - Spécifie si l’utilisateur peut saisir des valeurs par langue dans les champs liés à ce datafield. Si activé, le client riche active les fonctionnalités de saisie multilingue et les rendus affichent la valeur définie dans la langue de l’utilisateur courant.
  • NbDecimals {integer} - Nombre de décimales stockées et présentées. Par défaut, les datafields de type Financial utilisent 2 chiffres décimaux. Cet attribut n’est valide que sur les datafields de type Financial et Percentage.
  • SortIndex {string} - Tri par défaut dans les grilles. Si aucun filtre ne redéfini d’ordre, le système insère le datafield à la position définie dans le filtre. Si un ordre est défini dans le filtre, cet attribut est ignoré. Par exemple, si un datafield de la table affichée dans la grille défini un attribut SortIndex avec la valeur 1 DESC, le client va ajouter automatiquement ce datafield comme tri par défaut.
  • SpecialMask {string} - Masque de saisie. Si aucun masque n’est spécifié, toutes les valeurs possibles pour le champ peuvent être entrées. Avec un masque de saisie, le format des données peut être forcé. Les masques sont définis sous la forme 999.9999.9999.99 par exemple si l’on veut permettre à l’utilisateur de saisir un identifiant sous la forme '3 chiffres, un point (ajouté automatiquement), 4 chiffres, un point, 4 chiffres, un point et finalement 2 chiffres. Certains formats plus complexes sont gérés directement par le système. Ceux-ci sont BVRMask, Phone et Mail. La documentation complète sur les masques est disponible ici: http://docwiki.embarcadero.com/Libraries/XE2/en/System.MaskUtils.TEditMask
  • StoreMaskCharsInDataBase {boolean} - Indique si les caractères du masque (SpecialMask) doivent être stockés en base de donnée (true par défaut).
  • SpecialRegExp {string} - Masque de saisie avancé. Cet attribut peut être utilisé si le masque de saisie “SpecialMask” n’est pas suffisamment souple. Les expressions régulières doivent être saisie au format standard PCRE.
  • DefaultValue {string} - Valeur par défaut lors de l’ouverture de la tâche ou lors de la création d’une nouvelle entrée. La valeur peut être soit en dur, soit faire référence à un script ou à une variable de script.
  • PermanentValue {string} - Valeur forcée du champ. À la différence d’un DefaultValue, la valeur ne peut pas être modifiée par l’utilisateur. La valeur peut être soit en dur, soit faire référence à un script ou à une variable de script.
  • EnableRichText {boolean} - Active les fonctionnalités de présentation dans les champs de saisie MultiLineString. Ces fonctionnalités permettent de modifier le style du texte, d’ajouter du gras, italique, … Dans ces champs il est important de prendre en compte la longueur des données de formatage qui sont insérées par le champ.
  • CanBeUsedForFilter {boolean} - Permet d’afficher ou masquer de champ dans les filtres qui sont de type ByDataFields ou ByDataFieldsAndGridView. Par défaut, cette valeur vaut true.
  • CanBeUsedForSelection {boolean} - Permet d’afficher ou masquer le champ dans les selections de champs des vues de dossier. A noter que si un field pointe vers un datafield TaskOnly, il n’apparaitra pas même si cet attribut est true Par défaut, cette valeur vaut true.
  • CanBeUsedForOperations {boolean} -
  • ForeignKeyField {string} - Permet de préciser quelle colonne doit être utilisée comme clé étrangère dans la grille ouverte pour la sélection lorsque l’utilisateur clique sur le bouton ‘Choisir’ dans un filtre (uniquement pour les champs au format ByForeignKey). Par défaut, le système va récupérer la première colonne dont le datafield contient _PK. Si cette valeur est précisée, la colonne précisée sera utilisée.
  • StrictForeignKey {boolean} -
  • Presentation {DataFieldPresentation} - Type de présentation du champ à l’écran. Valeurs possibles:
    • Link - Présentation sous forme d’hyperlien cliquable par l’utilisateur. Aucune donnée ne peut être saisie.
    • Memo - Présentation du champ de saisie sous forme de champ de saisie multiligne extensible.
    • Button - Présentation sous forme de bouton cliquable par l’utilisateur. Aucune donnée ne peut être saisie.
    • RadioButton - Présentation de la combo sous forme de liste à puces (radio button) sélectionnables.
    • FileName - Présentation sous forme de sélection de fichier avec hyperlien ouvrant une fenêtre de sélection.
    • Image - Présentation sous forme d’image. Aucune donnée ne peut être saisie.
    • CheckBox - Présentation de la combo ou du booléen sous forme de case à cocher.
    • Edit - Présentation par défaut d’un champ de saisie.
    • Icon - Présentation de la combo sous forme d’icone pouvant être sélectionnée. Fonctionne sur le web uniquemenent. L’icone est récupérée dans le champ Icon de la combo.
    • Mail - Un champ de type mail vérifie le format entré par l’utilisateur afin de garantir qu’il respecte le format général d’une adresse mail. Il permet également directement d’ouvrir l’application mail par défaut de l’appareil en cliquant sur la petite icône associée. Cette fonctionnalité est actuellement seulement disponible sur les devices mobiles.
    • Phone - Ce champ est géré à travers la librairie de gestion des indicatifs téléphoniques par pays. Ceci permet de garantir que le format de tous les téléphones sont bien formattés et préfixés de la même et bonne manière en fonction du pays. Cette fonctionnalité est actuellement seulement disponible sur les devices mobiles.
  • SingleOnAllRecords {boolean} - Pour les formats booléens, force une seule valeur à être active au travers de toutes les entrées présentes. Ceci permet l’activation d’une seule valeur à la fois au travers de la solution, étendant la fonctionnalité d’un bouton radio.
  • Existence {string} -
  • Silo {string} - Le silo permet de stocker les dernières valeurs saisies par l’utilisateur dans le champ. La valeur peut être soit un booléen true/false pour activer ou désactiver la fonctionnalité, soit un identifiant permettant de stocker l’historique de plusieurs champs dans un seul silo partagé, par exemple lorsque plusieurs champs sont destinés à recevoir les mêmes valeurs.
  • ScriptOnClick {string} - Lorsque l’utilisateur clique sur le champ, le script spécifié par la valeur de l’attribut sera appellé. Il pourra modifier les valeurs de l’écran ou effectuer des actions telles que télécharger un fichier ou poser des questions à l’utilisateur. Le script à appeler peut être soit inclu dans l’attribut pour des scripts simples, soit faire référence à un fichier de script dans le paramétrage ainsi qu’un libellé pour les scripts plus complexes.
  • NotificationOnClick {string} - Lorsque l’utilisateur clique sur le champ, la notification spécifiée par la valeur de l’attribut sera appellée
  • NotificationType {NotificationType} - Spécifie le type de notification à appeler dans le cas d’un NotificationOnClick. Valeurs possibles:
    • Local -
    • Remote -
  • RemoteTask {string} - Dans le cas d’un NotificationOnClick de type Remote, la tâche spécifiée sera utilisée pour l’appel.
  • RemoteArguments {string} - Dans le cas d’un NotificationOnClick de type Remote, les arguments spécifiés seront passés à la tâche lors de l’appel.
  • ShowDays {boolean} - Pour les champs de date, permet de définir si les jours doivent être affichés. Si cet attribut est à false, seul le mois et l’année peuvent être saisis. Par défaut, les jours sont affichés pour les formats date.
  • ShowSeconds {boolean} - Pour les champs de date, permet de définir si les secondes doivent être affichés. Par défaut, seules les heures et minutes sont affichées pour les formats de date avec heure.
  • Supremum {boolean} - Pour les champs au format Date sans affichage des jours, précise que le jour ajouté en interne doit être le dernier jour du mois et non pas le premier jour du mois. N’a aucun impact sur les autres types de champ ni sur les champs de date où le jour peut être précisé par l’utilisateur.
  • DisplayCode {EnumDisplayCode} - Spécifie le type d’affichage des éléments de la combo. Cet attribut n’est valide que sur les datafields de type Enum. Valeurs possibles:
    • CodeOnly - Affiche uniquement l’identifiant des éléments de la combo.
    • TextOnly - Affiche uniquement le texte des éléments de la combo.
    • CodeAndText - Valeur par défaut. Affiche à la fois l’identifiant de la combo et le texte.
  • DocumentTemplate {string} - Pour les boutons de document, spécifie le template qui doit être utilisé afin de générer le document qui sera ouvert à l’utilisateur. Le template doit exister dans UNI94 ou dans le paramétrage sinon l’utilisateur rencontrera une erreur lors de l’utilisation.
  • DocumentApplication {DocumentApplication} - Pour les boutons de document, spécifie l’application qui sera utilisée pour ouvrir le template. Cet attribut permet également de définir l’icône qui est présente sur le bouton. Valeurs possibles:
    • Word -
    • Excel -
  • DocumentPrintLanguage {string} - Pour les boutons de document, permet de définir la langue du document à récupérer pour générer le document présenté à l’utilisateur. Par défaut, la langue de l’utilisateur est utilisée. Cet attribut permet de définir la langue du document par exemple en fonction de la langue de la société ou du client pour lequel le document doit être généré.
  • BoolPresentInFilter {BooleanFilterPresence} - Permet de spécifier comment le filtre doit être généré par rapport à la valeur du boolean. Par défaut, cette valeur est PresentIfTrue, ce qui signifie que le prédicat est ajouté au filtre seulement si la checkbox et cochée. Valeurs possibles:
    • PresentIfTrue -
    • PresentIfFalse -
    • Always -
  • ShowDocumentSaveBtn {boolean} -
  • KeepDocumentVersions {boolean} -
  • AutoSaveDocument {boolean} -
  • ScriptLanguage {FormatScriptLanguage} - Pour les champs au format Script, permet de définir le langage utilisé afin d’activer la coloration syntaxique. Aucune vérification des données saisies n’est effectuée lorsqu’un langage est défini. Valeurs possibles:
    • JavaScript -
    • Script -
    • XML -
  • Protected {boolean} - Active le masquage des données saisies. Les données sont envoyées et récupérées normalement, seul l’affichage est impacté. Ainsi un traitement supplémentaire devrait être prévu si le champ contient un mot de passe ou autres données ne devant pas pouvoir être récupérées.
  • FileType {string} - Pour les champs au format “File”, permet de définir quels formats de fichier peuvent être sélectionnés dans l’explorateur de fichiers. Le format de cet attribut doit correspondre aux valeurs attendues par l’explorateur Windows. Par exemple HTML files (*.html)|*.htm;*.html ou BVR (*.xml,*.V11)|*.xml;*.V11|ZIP (*.zip)|*.zip.
  • ImageLimit {integer} -
  • IsMainPicture {boolean} -
  • ImageSource {string} - Image à afficher. L’image peut provenir de “Task images” ou “Highres png icons”. Il est possible également d’insérer l’image sous forme de matrice binaire avec le format suivant: bit:rows:columns:data.
  • bit => format de l’image. Pour l’instant seul ‘bit’ est supporté en noir/blanc (QR-Code).
  • rows => nombre de lignes du tableau data.
  • columns => nombre de colonnes du tableau data.
  • data => suite de 0 (blanc) et 1 (noir) correspondant aux nombre de lignes puis de colonnes indiquées. Exemple: bit:2x3:110000 (1ère ligne noire, 2ème et 3ème lignes blanches)
  • Generic {boolean} - Pour les champs Button dans les tâches présentées en HistoryViewer, affiche le champ sur l’HistoryViewer. Permet de présenter des fonctionnalités liées aux événements affichés dans l’historique, en passant par les attributs ScriptOnClick ou CallOnClick par exemple.