Manuel de l'utilisateur › Rapports › Types de rapports › Présentation des livrets › Création d'un livret › Création des livrets au format RTF › Balises de livret et d'exportation de contrat › Livrets paramétrés › Syntaxe des paramètres de livret

Syntaxe des paramètres de livret

La syntaxe d'un modèle de livret est similaire à celle de la transmission de paramètres aux rapports au format libre.

Commentaires sur la syntaxe :

• Le nom du paramètre sera issu d'une liste de noms, MAJUSCULES, prédéfinie - ils ne seront pas en texte libre (seuls les paramètres au format libre sont en texte libre).
• La valeur du paramètre sera du texte libre (utilisation du mot clé VALUE) ou une valeur contextuelle (utilisation du mot clé CONTEXT_VALUE). En l'absence de contexte de contrat, les valeurs contextuelles ne sont pas transmises.
• La valeur est sensible à la casse.
• Lors de la transmission de plusieurs valeurs pour un même paramètre pour lequel la sélection multiple n'a pas été définie ou lors d'une transmission en double pour un même paramètre, la dernière valeur apparaissant dans le modèle est transmise.
• Si aucune valeur n'est transmise (absence du mot clé VALUE ou <<VALUE=>>), le livret transmet la valeur null. La valeur de filtre initiale est ainsi supprimée comme si elle ne figurait pas dans le rapport favori (similaire à All).
• Passer un nom de paramètre qui n'existe pas n'a aucun effet (ceci est important pour le format libre dans un groupe).
• Les valeurs de paramètre sont fusionnées avec le filtre favori initial lorsque les paramètres du livret sont prioritaires sur le filtre initial. De cette manière, si nous transmettons un paramètre à un filtre qui existe déjà dans le rapport, le filtre utilise le paramètre du livret.
• Pour définir la sélection multiple ou des caractères génériques, le mot clé SELECT_TYPE doit être utilisé pour la déclaration. Les valeurs suivantes sont disponibles : MULTI, WILDCARD ou SINGLE (la valeur par défaut est SINGLE en cas de non définition).
• Sélection multiple de ressources/groupes de ressources. Désormais l'utilisateur ne peut sélectionner qu'un seul type : ressources ou groupes de ressources. Les utilisateurs doivent déclarer le type utilisé dans le paramètre à l'aide du mot clé IS_GROUP. Les valeurs sont YES ou NO (la valeur par défaut est NO en cas de non définition).
• Lors de la définition d'une sélection multiple, l'utilisateur doit définir le chemin complet de l'entité et utiliser le séparateur / (voir l'exemple de syntaxe des paramètres de livret ci-dessus). Lors de la sélection de plusieurs métriques, l'utilisateur peut ne pas définir le chemin complet s'il a défini un contexte de contrat car ce dernier permettra de retrouver les informations requises.
• Les favoris composés et de groupe ont la même syntaxe que le paramètre Normal. Pour les rapports composés, les valeurs des paramètres sont transmises à chaque série. Pour les groupes de rapports, une valeur est transmise à chaque membre du groupe (rapports au format libre également). Si le groupe contient des rapports composés, les valeurs des paramètres sont transmises à chaque série de chaque membre.

Exemple de syntaxe des paramètres de livret

<<BEGIN_FAVORITE=Normal favorite name>>

<<BEGIN_PARAMETER>>
<<NAME=AGGREGATION>><<VALUE=Sum>>
<<END_PARAMETER>>

<<BEGIN_PARAMETER>>
<<NAME=CONTRACT>><<CONTEXT_VALUE=SLA_NAME>>
<<END_PARAMETER>>

<<BEGIN_PARAMETER>>
<<NAME=SERVICE>><<VALUE=Service 1>>
<<END_PARAMETER>>

<<BEGIN_PARAMETER>>
<<NAME=RESOURCE>><<IS_GROUP=NO>><<VALUE=Resource 1>>
<<END_PARAMETER>>

<<BEGIN_PARAMETER>>
<<NAME=metric >>
<<SELECT_TYPE=MULTI>>
<<VALUE=Contract Party/Contract/metric 1>>
<<VALUE=Contract Party/Contract/metric 2>>
<<VALUE=Contract Party/Contract/metric 3>>
<<END_PARAMETER>>

<<NAME>>
<<CHART>>
<<DATA>>
<< END_FAVORITE>>