Passer au contenu principal
Adaptive Planning
Dernière mise à jour : 2023-06-23
Référence : notation par points pour les propriétés

Référence : notation par points pour les propriétés

Tout comme les références d’objets dans les langues de programmation, vous pouvez utiliser
la notation par points
dans les formules. La notation par points est particulièrement utile dans les formules avec
IFF
relevés, car cela permet à la formule de varier en fonction de l’emplacement actuel. À titre d’exemple, la formule suivante calcule un indicateur différemment dans une version de chiffres réels que dans une version de plan :
Exemple : la formule calcule un indicateur d’une façon dans les chiffres réels et d’une autre façon dans les versions de plan :
IFF(this.Version.IsActuals, ACCT.ActualsValue, ACCT.PlanValue)
Exemple : pour les navigateurs qui utilisent des virgules pour les décimales :
IFF(this.Version.IsActuals; ACCT.ActualsValue; ACCT.PlanValue)
Les formules utilisant des propriétés de la notation par points pour référencer les valeurs de dimension, les valeurs d’attributs et les niveaux doivent y faire référence à l’aide d’un code pour éviter toute confusion lorsque leurs noms correspondent. Si vous modifiez le Code d’une valeur de dimension, d’une valeur d’attribut ou d’un niveau, mettez à jour vos formules pour qu’elles correspondent au Code.

Opérandes

La syntaxe de l'expression d'opérandes utilise la syntaxe normalisée
this
Terme pour indiquer l’emplacement actuel d’une cellule.
Propriété
Description
this.Version
Renvoie un objet version, qui peut être combiné avec un point supplémentaire (
.
) des propriétés telles que
this.Version.Name
. Faites référence aux types d'objets ci-dessous.
this.Level
Renvoie un objet de niveau, qui peut être combiné avec un point supplémentaire (
.
).
this.Account
Renvoie un objet de compte, lorsqu’il peut être combiné avec un point supplémentaire (
.
).
this.
dimension_name
Renvoie la valeur de dimension de la cellule actuelle dans la dimension indiquée. Si la cellule actuelle n’a pas de valeur pour la dimension spécifiée, renvoie un objet vide (vide). Cette propriété n’est accessible que si la dimension a un nom qui est un identifiant légal (commence par un caractère autre qu’un chiffre et ne comprend que des lettres, des chiffres et le tiret bas). Les dimensions aux noms qui ne sont pas des identifiants (par exemple, celles dont le nom comporte plus d’un mot) ne peuvent pas être récupérées dans une formule.
this.
attribute_name
Renvoie la valeur d’attribut de la cellule actuelle dans l’attribut précisé. Si la cellule actuelle n’a pas de valeur pour l’attribut spécifié, renvoie un objet vide. Cette propriété n’est accessible que si l’attribut a un nom qui est un identifiant légal (commence par un caractère autre qu’un chiffre et ne comprend que des lettres, des chiffres et le tiret bas). Les attributs avec des noms qui ne sont pas des identifiants (par exemple, ceux qui comportent plusieurs mots dans leur nom) ne sont pas récupérables dans une formule.
this.<stratum_code>
Retourne
Timeperiod
du type de strate demandé qui contient la coordonnée de temps de la cellule actuelle. Si la strate demandée est inférieure au statut de la cellule actuelle (plus précise que), cette fonction renvoie la
première valeur
Timeperiod
de cette strate trouvée dans le champ d’application de la strate de la cellule actuelle.

Types d'objets

Les types de données représentent des objets, qui permettent à la « notation par points » d’accéder aux propriétés de ces objets. Les propriétés d’objet disponibles sont les suivantes :

Version

Fait référence à diverses propriétés de la version actuelle dans un
IF
relevé.
Exemple :
IF (this.Version.Name = "Budget 2018", x, y)
Exemple : pour les navigateurs qui utilisent des virgules pour les décimales :
IF (this.Version.Name = "Budget 2018"; x; y)
Propriété
Description
Version.Name
Renvoie la chaîne représentant le nom de la version. Si une cellule de chiffres réels est superposée sur une version de plan, la version des chiffres réels est considérée comme la version de la cellule.
Version.ShortName
Renvoie la chaîne représentant le nom abrégé de la version.
Version.Description
Renvoie la chaîne représentant la description de la version.
Version.Type
Renvoie une chaîne représentant le type de la version, tel que renvoyé dans la section
exportVersions
API. Renvoie l’un des éléments suivants :
PLANNING, ACTUALS, VERSION_FOLDER, JOURNAL_ENTRY
.
Version.StartDate
Renvoie une valeur de date représentant le premier jour de la période qui est le début de la version.
Version.EndDate
Renvoie une valeur de date représentant le dernier jour de la période qui correspond à la fin de la version.
Version.PositionOf
Renvoie l’ordre relatif de la période temporelle fournie dans l’ensemble de la version. La séquence initiale commence par 0 (et non 1), et le numéro d’ordre peut être négatif si la période est antérieure au début de la version. Cette fonction fonctionne également avec une période qui dépasse la fin de la version.
Version.IsActuals
Renvoie une valeur booléenne indiquant si cette version est une version des chiffres réels ou non (y compris les types)
ACTUALS
,
SUBACTUALS
, et
JOURNAL_ENTRY
).
Version.IsGroup
Renvoie une valeur booléenne indiquant si cette version est un groupe de versions (et non une version contenant des données).
Version.IsParent
Renvoie une valeur booléenne indiquant si cette version comporte des versions enfants.
Version.Parent
Renvoie la version qui est le parent de cette version.

Niveau

Fait référence à diverses propriétés du niveau actuel dans un
IF
relevé.
Exemple :
IF (this.Level.Name = "Sales", x, y)
Exemple : pour les navigateurs qui utilisent des virgules pour les décimales :
IF (this.Level.Name = "Sales"; x; y)
Propriété
Description
Level.Code
Renvoie la chaîne représentant le code du niveau.
Level.Name
Renvoie la chaîne représentant le nom du niveau.
Level.ShortName
Renvoie la chaîne représentant le nom abrégé du niveau.
Level.InWorkflow
Renvoie une valeur booléenne indiquant si le niveau est inclus dans le flux des travaux. Pour les instances pour lesquelles le flux des travaux est désactivé, tous les niveaux renvoient des valeurs fausses.
Level.IsElimination
Renvoie une valeur booléenne indiquant si le niveau est un niveau d’élimination. Pour les instances sans la fonctionnalité Éliminations, tous les niveaux renvoient la valeur Faux.
Level.IsTradingPartner
Renvoie une valeur booléenne indiquant si le niveau est un niveau de partenaire commercial d’élimination. Pour les instances sans la fonctionnalité Éliminations, tous les niveaux renvoient la valeur Faux.
Level.Currency
Renvoie la chaîne représentant le code de devise ISO du niveau (par exemple,
EUR
ou
USD
).
Level.Parent
Retourne le niveau code qui est le parent de ce niveau, ou l’objet de niveau spécial « nul » si ce niveau n’a pas de parent (le niveau racine).
Level.IsLeaf
Renvoie une valeur booléenne indiquant si le niveau est un niveau feuille ou non (c’est-à-dire que cette propriété renvoie la valeur Vrai si le niveau n’a pas d’enfants).

Compte

Fait référence aux différentes propriétés (
et non à la valeur
) du compte actuel dans un
IF
relevé.
Exemple :
IF (this.Account.IFRS_Category.Name = "Assets", 1, 0)
Exemple : pour les navigateurs qui utilisent des virgules comme décimales :
IF (this.Account.IFRS_Category.Name = "Assets"; 1; 0)
Propriété
Description
Account.Code
Renvoie la chaîne représentant le code du compte.
Account.Name
Renvoie la chaîne représentant le nom du compte.
Account.ShortName
Renvoie la chaîne représentant le nom abrégé du compte.
Account.Description
Renvoie la chaîne représentant la description du compte.
Account.Parent
Renvoie un compte qui est le parent de ce compte, ou l’objet de compte spécial « nul » si ce compte n’a pas de parent (un compte racine).
Account.<
attribute_name
>
Renvoie un objet de valeur de dimension associé à l'attribut indiqué. Cette propriété n’est accessible que si l’attribut a un nom qui est un identifiant légal (commence par un caractère autre qu’un chiffre et ne comprend que des lettres, des chiffres et le tiret bas). Les attributs avec des noms qui ne sont pas des identifiants (par exemple, ceux qui comportent plusieurs mots dans leur nom) ne sont pas récupérables dans une formule.
Account.isCredit
Renvoie une valeur booléenne si le compte a uneBalanceType deCritère ou non. Notez que certains comptes (par exemple, Comptes Indicateurs) ne seront ni Débit ni Crédit.
Account.isDebit
Renvoie une valeur booléenne si le compte a uneBalanceType deDÉbit ou non. Notez que certains comptes (par exemple, Comptes Indicateurs) ne seront ni Débit ni Crédit.

Dimensions et attributs

Propriété
Description
DimensionValue
.Code
Renvoie la chaîne représentant le code de la valeur de dimension dans la dimension indiquée.
Exemple :
IF (this.Region.Code = "East01", 1, 0)
DimensionValue
.Name
Renvoie la chaîne représentant le nom de la valeur de dimension dans la dimension indiquée.
Exemple :
IF (this.Region.Name = "East", 1, 0)
DimensionValue
.ShortName
Renvoie la chaîne représentant le nom abrégé de la valeur de dimension.
DimensionValue
.Description
Renvoie la chaîne représentant la description de la valeur de dimension.
DimensionValue
.Parent
Renvoie la valeur de dimension qui est le parent de cette valeur, ou l’objet vide spécial si cette valeur n’a pas de parent dans la dimension (par exemple, le « parent » est la racine de la dimension elle-même).
Exemple :
this.DimensionValue.Parent.Name
renverrait le nom du parent pour cette valeur de dimension.
DimensionValue
.IsLeaf
Renvoie une valeur booléenne indiquant si la valeur de dimension dans la dimension indiquée est une valeur de feuille dans cette dimension.
DimensionValue
.<
attribute_code
>
Renvoie le code de valeur de l’attribut indiqué (qui correspond à la valeur de dimension).
DimensionValue
.<
attribute_name
>
Renvoie la valeur de l’attribut indiqué (qui correspond à la valeur de dimension).
AttributeValue
.Code
Renvoie la chaîne représentant le code de la valeur de l'attribut.
AttributeValue
.Name
Renvoie la chaîne représentant le nom de la valeur de l'attribut.
AttributeValue
.ShortName
Renvoie la chaîne représentant le nom abrégé de la valeur de l'attribut.
AttributeValue
.Description
Renvoie la chaîne représentant la description de la valeur de l'attribut.
AttributeValue
.Parent
Retourne la valeur de l’attribut code qui est le parent de cette valeur, ou l’objet vide spécial si cette valeur n’a pas de parent dans la dimension (par exemple, le « parent » est la racine de la dimension elle-même).
AttributeValue
.IsLeaf
Renvoie une valeur booléenne pour indiquer si la valeur d’attribut dans l’attribut précisé est une valeur de feuille dans cet attribut.

Période

Une période représente une période particulière de toute strate de temps configurée. Les types de données de période temporelle ne peuvent être comparés à aucun autre type de données.
Exemples :
IF (this.Month.NumberOfDays > 30, 1, 0) IF (this.Year.PositionOf (this.Month) > 6, "Past sixth month", "Not") IF (this.Quarter.PositionOf (this.Week) = 1, "First week of qtr", "Not")
Propriété
Description
Timeper
.Code
Renvoie le code de la période. Cela correspondra à la façon dont la période est définie dans les discriminants de temps.
Timeper
.NumberOfDays
Renvoie le nombre total de jours dans la période temporelle, inclusivement.
Exemple :
IF (this.Month.NumberOfDays > 30, 1, 0)
Timeper
.Parent
Renvoie la période qui contient la période temporelle actuelle et qui est une strate plus élevée (cosseuse) dans la strate continue. S’il n’y a pas de strate supérieure, renvoie la période temporelle actuelle.
Timeper
.StartDate
Renvoie une date qui représente le premier jour de la période temporelle (identique à
Version.StartDate).
Timeper
.EndDate
Renvoie une date qui représente le dernier jour de la période (identique à
Version.EndDate).
Timeper
.PositionOf(tp)
Renvoie un nombre entier qui représente la position de la période temporelle (
tp
) dans la période source (par rapport aux autres membres de sa strate). Retours
0
si la période temporelle est précisée (
tp
) n’est pas une strate plus petite que la
Timeper
précisé, ou si
tp
n’est pas compris dans la section
Timeper
précisée.