SAINET apis and documentation (stable/4.8.x)

PopupMenus

Les PopupMenus permettent d’ajouter des actions contextuelles sur des entrées dans une tâche de saisie, des lignes d’une grille dans une tâche de vue, etc …

Ces actions facilitent l’accès aux différentes fonctionnalités liées aux différentes entrées.

PopupMenus

  • Task (PopupGroup) - Les PopupMenus définis dans cet éléments seront attachés et disponibles uniquement sur cette tâche.
  • Table (PopupGroup) - Les PopupMenus définis dans cet éléments seront attachés et disponibles uniquement sur cette table. Ils seront par contre sur toutes les tâches utilisant cette table.
  • GridView (PopupGroup) - Les PopupMenus définis dans cet éléments seront attachés et disponibles uniquement sur cette grille.
  • DataPage (PopupGroup) - Les PopupMenus définis dans cet éléments seront attachés et disponibles uniquement sur cette page.

PopupGroup

Attributs:

  • ID * {string} -

Eléments:

PopupMenu

Attributs:

  • ID * {string} -

Eléments:

PopupMenuSubMenu

Attributs:

  • ID * {string} -
  • Label * {string} -
  • Icon * {string} -
  • Scope {PopupMenuScope} - Valeurs possibles:
    • AllVisibleRecords -
    • SingleRecord -
    • SelectedRecords -
  • Visible {string} -

Eléments:

PopupMenuSubMenuItem

Attributs:

  • ID * {string} -
  • Label * {string} -
  • Scope {PopupMenuScope} - Valeurs possibles:
    • AllVisibleRecords -
    • SingleRecord -
    • SelectedRecords -
  • Visible {string} -
  • MobileVisible {string} -
  • ScriptOnClick {string} -
  • ActionID {string} -
  • Type {PopupMenuItemType} - Valeurs possibles:
    • Notification -
    • Script -
  • NotificationID {string} -
  • NotificationSource {string} -
  • RemoteTask {string} -
  • RemoteArguments {string} -
  • MandatoryAccessTask {string} -
  • MandatoryAccessRights {string} -

PopupMenuItem

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.
  • 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.
  • ImageLimit {integer} -
  • IsMainPicture {boolean} -
  • ImageSource {string} -
  • 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.