Catégorie Paramétrage

Description

La catégorie Paramétrage regroupe les fonctions utilisées pour écrire les formules du paramétrage de SIMAX : colonnes calculées, contrôles, automatismes, modèles d'édition. Elle est complétée par des sous-catégories : choix d'une valeur selon une condition, gestion des erreurs, informations sur le logiciel et l'utilisateur, modèles d'édition, signature d'intégrité et tableaux récapitulatifs.

Les fonctions de lecture retournent la valeur d'une colonne pour un autre enregistrement, la valeur actuelle de la colonne qui contient la formule, sa valeur précédente, sa valeur lue en base de données et la valeur lue pendant un import. D'autres retournent les bornes et les contraintes de date d'une colonne.

D'autres fonctions indiquent l'état d'un enregistrement (en création, en cours d'édition, existant dans la base, formulaire réel), gèrent les valeurs multilingues, lisent les paramètres d'une fonction externe, exécutent une formule ou une fonction externe, et déclarent des arguments nommés.

Fonctions

FonctionDescription
Signature Intégrité
SignatureIntégrité.VérifieRetourne Vrai si la signature d'intégrité est vérifiés pour tout les enregistrements en paramètre.
SignatureIntégrité.VérifieAvecDétailRetourne un tableau de valeur avec le détail de la vérification de la signature d'intégrité : Si ok, ou le type d'erreur.
Paramétrage
ColRetourne la valeur de la colonne A pour l'élément A. L'élément A peux être déterminé par l'élément B.
ColonneRetourne la valeur de la colonne A pour l'élément A. L'élément A peux être déterminé par l'élément B.
ColonneCouranteRetourne la valeur actuelle de colonne dans laquelle se trouve la formule.
ConstantRetourne la valeur et signale à SIMAX que le résultat de la formule valeur est constant. A utiliser dans les colonnes avec un modèle référence.
ContrainteDateApplique la contrainte date de la colonne sur la valeur courante ou sur la valeur passée en 2ieme paramètre.
ContrainteDateFinApplique la contrainte date de la colonne sur la valeur courante ou sur la valeur passée en 2ieme paramètre, et retourne la date de fin correspondant à la contrainte.
ContrainteMaxRetourne la valeur de la borne Maximum du modèle de la colonne
ContrainteMinRetourne la valeur de la borne Minimum du modèle de la colonne
ConvertitMultiLangueRetourne une valeur multilingue
DéclareAffecte à chaque argument nommé une valeur, exécute la formule et retourne la valeur de celle ci. La formule peux utiliser les arguments nommés.
ÉlémentSélectionnéRetourne la liste des éléments qui sont sélectionnés dans la colonne < colonne liste >
EncoursEditionRetourne si < Élément > (par défaut l'enregistrement courant) est encours d'édition dans l'IHM
EncoursEditionConsultationRetourne si < Élément > (par défaut l'enregistrement courant) est encours d'édition en consultation dans l'IHM
EncoursInitialisationRetourne Vrai si l'évaluation de cette formule est faite pendant la 1ere évaluation en création d'un enregistrement.
EnCréationRetourne si < Élément > (par défaut l'enregistrement courant) est en création
EstOmisRetourne Vrai si le paramètre n'as pas été fourni lors de l'appel de la fonction externe. Permet dans une fonctionne externe de savoir si le paramètre a été spécifier lors de l'appel et de gérer une valeur par défaut
ExécuteFonctionExterneAppel la fonction externe < Nom Fonction > en lui passant en paramètre ceux spécifiés
ExécuteFormuleRetourne la valeur retournée par l'exécution de la formule
ExisteRetourne Vrai si < Élément > (par défaut l'enregistrement courant) existe dans la base de donnée
ExportEnMémoireExporte les données dans un format d'export et mode de colonne à exporter.
FormulaireEstFilsDeRetourne Vrai si l'élément est fils de Formulaire ou égal
FormulaireRéelRetourne l'identifiant du formulaire réel de l'enregistrement de la colonne.
FormulaireRéelEnLettreRetourne libellé du formulaire réel de l'enregistrement de la colonne.
GroupeParDateRetourne une date pour trier des dates de manière logarithmique, c'est à dire par jour, par semaine puis par mois en considérant le temps écoulé par rapport à la date de référence.
IdentifiantCourantRetourne l'identifiant de l'enregistrement courant.
IntituléRetourne l'intitulé de l'élément en paramètre (ou celui encours par défaut)
MLRetourne la valeur en fonction de la langue de l'utilisateur courant.
MoiMêmeRetourne la valeur actuelle de colonne dans laquelle se trouve la formule.
MultiLangueRetourne la valeur en fonction de la langue de l'utilisateur courant.
OrigineRetourne l'identifiant de l'élément d'origine pour les actions Créer à partir de
TrouveActionSIMAXRetourne l'id unique de l'action correspondant à la phrase. Si l'action n'existe pas cela retourne 0.
ValeurBDDRetourne la valeur de la colonne depuis une lecture directe dans la base de données
ValeurBDDLuRetourne la valeur de la colonne qui a été lu dans la base de données
ValeurImportRetourne la valeur qui a été lu pour la correspondance courante. Même fonctionnement que la constante VALEURIMPORT. Même utilisation que VALEURIMPORT, mais elle peut être dans un ExécuteFormule par exemple
ValeurLangueRetourne la valeur pour une langue d'une valeur multilingue
ValeurParamètreRetourne la valeur du paramètre
ValeurPrécédenteRetourne la valeur précédente de la colonne
VPRetourne la valeur du paramètre
Tableau récapitulatif
EstFeuilleAxeVerticalRetourne Vrai si la ligne courante du tableau récapitulatif est une feuille (NiveauAxeVertical() = MaxNiveauAxeVertical())
IndiceAxeHorizontalRetourne l'indice de regroupement pour les tableaux récapitulatifs avec plusieurs calculs
MaxNiveauAxeVerticalRetourne le nombre maximum de niveau (ie le nombre d'axe vertical du tableau récapitulatif)
NiveauAxeVerticalRetourne le niveau de la ligne courante de 1 à MaxNiveauAxeVertical()
SélectionAxeHorizontalRetourne la liste des éléments qui ont été regroupé dans l'axe.
SélectionAxeVerticalRetourne la liste des éléments qui ont été regroupé dans l'axe.
SélectionCelluleRetourne la liste des éléments qui ont été regroupé dans la cellule.
TableauValeurAxeHorizontalConstruit un tableau de valeurs avec les valeurs de l'axe horizontal
TableauValeurAxeVerticalConstruit un tableau de valeurs avec les valeurs de l'axe vertical pour tableau récapitulatif et vue.
ValeurAxeHorizontalRetourne la valeur de l'axe courant (mettre <Valeur affichée> à Vrai pour avoir la valeur au format affiché)
ValeurAxeVerticalRetourne la (ou les) valeur de l'axe courant (ou celui en paramètre). Mettre <Valeur affichée> à Vrai pour avoir la valeur au format affiché
Gestion erreur
EstErreurSi la valeur est une erreur
GénèreErreurRetourne une erreur SIMAX avec le message. Si le code n'est pas spécifié et que la fonction est dans SiErreur, le code de l'erreur d'origine est automatiquement récupéré.
MessageErreurRetourne le texte de l'erreur en paramètre
SIErreurSi l'évaluation de < Formule > provoque une erreur retourne < Valeur si erreur> sinon le résultat de la < Formule >
Modèle d'édition
ImprimeEnMémoireRetourne le résultat de la fusion documentaire de l'élément (ou la liste d'élément) en utilisant le modèle d'édition fourni (ou celui défini dans le paramétrage). Une Conversion PDF peut être appliquée.
ImprimeVersImprimanteEnvoi le fichier à l'impression sur l'imprimante spécifié.
SélectionModèleEditionRetourne tous les modèles d'édition correspondant aux conditions.
Information
AdresseIPRetourne l'adresse IP courante.
AdresseMACRetourne l'adresse MAC
AvecDroitParametrageRetourne Vrai si l'utilisateur courant a les droits pour faire du paramétrage.
ChangeInformationTitreChange les informations affichées entre les crochets [] dans le titre de SIMAX par le texte en paramètre. Par défaut le nom de l'utilisateur est affiché.
EnModeConnectéRetourne Vrai si l'application fonctionne en mode connecté.
EnModeExtranetRetourne la vrai si l'utilisateur est connecté depuis le mode extranet.
EnModeWebRetourne la vrai si l'utilisateur est connecté depuis le mode web.
EnModeWindowsRetourne la vrai si l'utilisateur est connecté depuis le mode Windows.
EstAvecDroitParamétrageRetourne Vrai si l'utilisateur courant a les droits pour faire du paramétrage.
EstConnectéRetourne Vrai si l'application fonctionne en mode connecté.
EstEnProductionRetourne Vrai si la base de données est celle de production.
EstLibreOfficeInstalléRetourne Vrai si LibreOffice est détecté comme installé.
EstPDFCreatorInstalléRetourne Vrai si PDFCreator est détecté comme installé.
EstSuperviseurRetourne Vrai si l'utilisateur en paramètre (c'est l'utilisateur courant par défaut) est Superviseur.
FormulaireExtranetRetourne l'id. unique du formulaire utilisé en connexion extranet.
FormulaireExtranetEnLettreEn mode extranet retourne le nom du formulaire de la personne connecté.
GénèreAuthTokenGénère un token d'authentification pour SIMAX
IdentifiantExtranetRetourne l'id. unique de l'enregistrement connecté en extranet, par exemple l'identifiant du client si le formulaire de connexion extranet est client.
IdentifiantSessionRetourne l'identifiant numérique de la session courante
IdentifiantUtilisateurWindowsRetourne l'identifiant de l'utilisateur Windows dans le format demandé
LangueCouranteRetourne le code de la langue courante
MémoireConsomméeRetourne la mémoire consommée par SIMAX en octet
TableauImprimanteRetourne un tableau avec la liste des imprimantes du poste courant
TableauLangueRetourne le tableau des langues du paramétrage, soit les valeurs numériques soit les libellés.
UtilisateurCourantRetourne l'identifiant unique de l'utilisateur courant.
UUIDApplicationRetourne l'UUID de l'application / client SIMAX utilisé par la session
UUIDClientSIMAXRetourne l'UUID de l'application / client SIMAX utilisé par la session
ValeurUtilisateurRetourne la valeur de la colonne en utilisant l'utilisateur courant (ou celui spécifié). Effectue une sélection depuis le formulaire utilisateur.
VersionRetourne la version build du framework sous la forme 9999, par exemple 1425
VersionLangageRetourne un entier qui est la version du Langage dans la base de données partagées.
VURetourne la valeur de la colonne en utilisant l'utilisateur courant (ou celui spécifié). Effectue une sélection depuis le formulaire utilisateur.
Choix
ChoisirRetourne la valeur du Nieme élément de la liste de valeurs (n1, n2, ...).
SelonRetourne le résultat correspondant à la valeur égale à < Valeur à comparer >.
SIÉvalue la condition et retourne la valeur paramètre < Valeur si Vrai > si elle est remplie (donc à Vrai) sinon retourne le paramètre < Valeur si Faux >.
SI.ConditionsÉvalue plusieurs conditions et retourne la valeur correspondant à la première condition vraie.
SINonVideRetourne la première valeur non vide, si aucune non vide alors retourne vide.
SINonZéroRetourne la 1ere des valeurs qui n'est pas vide et qui n'est pas égale à 0 pour les numériques et les booléens , si aucun alors retourne vide