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

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

Comme pour les références d'objets dans les langages de programmation, vous pouvez utiliser la
notation à points
dans les formules. La notation par points est particulièrement utile dans les formules avec
IFF
Les instructions, car cela permet à la formule de varier en fonction du site. Par exemple, la formule suivante calcule une métrique différente dans une version de montants réels comparée à une version de plan :
Exemple : la formule calcule une métrique d'une certaine façon dans les montants réels et d'une autre façon dans les versions du plan :
IFF(this.Version.IsActuals, ACCT.ActualsValue, ACCT.PlanValue)
Par exemple, pour les navigateurs qui utilisent la virgule comme séparateur décimal :
IFF(this.Version.IsActuals; ACCT.ActualsValue; ACCT.PlanValue)
Les formules qui utilisent des propriétés de notation par points pour référencer des valeurs de dimension, des valeurs d'attribut et des périmètres doivent y faire référence à l'aide du Code pour éviter toute ambiguïté lorsque leurs noms correspondent. Si vous modifiez le Code d'une valeur de dimension, d'une valeur d'attribut ou d'un périmètre, mettez à jour vos formules pour qu'elles correspondent au Code.

Opérandes

La syntaxe des expressions basées sur des opérandes utilise la norme standardisée
this
Terme pour indiquer l'emplacement actuel d'une cellule.
Propriété
Description
this.Version
Renvoie un objet de version, qui peut être combiné avec d'autres points (
.
) propriétés telles que
this.Version.Name
. Consultez la section Types d'objets ci-dessous.
this.Level
Renvoie un objet de périmètre, qui peut être combiné avec d'autres points (
.
Propriétés de l'.
this.Account
Renvoie un objet de compte, quand peut être combiné avec d'autres points (
.
Propriétés de l'.
this.
dimension_name
Renvoie la valeur de dimension de la cellule actuelle dans la dimension spécifié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 avec des noms non-identificateurs (tels que ceux qui ont plus d'un mot dans leur nom) ne sont pas récupérables dans les formules.
this.
attribute_name
Renvoie la valeur d'attribut de la cellule actuelle dans l'attribut spécifié. 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 comportant des noms non-identificateurs (tels que ceux qui ont plus d'un mot dans leur nom) ne peuvent pas être récupérés dans les formules.
this.<stratum_code>
Renvoie
Timeperiod
du type de strate requise qui contient la coordonnée temporelle de la cellule actuelle. Si les strates demandées sont inférieures (plus fines) au statut de la cellule actuelle, cette fonction renvoie les
premières
Timeperiod
de cette strate trouvée dans le périmètre de la strate de la cellule actuelle.

Types d'objets

Les types de données représentent des objets, qui permettent à la "notation à 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 à plusieurs propriétés de la version actuelle dans un
IF
relevé.
Exemple :
IF (this.Version.Name = "Budget 2018", x, y)
Par exemple, pour les navigateurs qui utilisent la virgule comme séparateur décimal :
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 montants réels est superposée à une version de plan, la version des montants 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, telle qu'elle apparaît dans le champ
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 est la fin de la version.
Version.PositionOf
Renvoie l'ordre relatif de la période fournie au sein de la durée 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 début de la version. Cette fonction fonctionne aussi pour les périodes postérieures à la fin de la version.
Version.IsActuals
Renvoie une valeur booléenne indiquant si cette version est une version de montants réels ou non (cela inclut 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 qui contient des données).
Version.IsParent
Renvoie une valeur booléenne indiquant si cette version a des versions enfants.
Version.Parent
Renvoie la version qui est le parent de cette version.

Périmètre

Fait référence à plusieurs propriétés du périmètre actuel dans un
IF
relevé.
Exemple :
IF (this.Level.Name = "Sales", x, y)
Par exemple, pour les navigateurs qui utilisent la virgule comme séparateur décimal :
IF (this.Level.Name = "Sales"; x; y)
Propriété
Description
Level.Code
Renvoie la chaîne représentant le code du périmètre.
Level.Name
Renvoie la chaîne représentant le nom du périmètre.
Level.ShortName
Renvoie la chaîne représentant le nom abrégé du périmètre.
Level.InWorkflow
Renvoie une valeur booléenne indiquant si le périmètre est inclus dans le workflow. Pour les instances avec workflow désactivé, tous les périmètres renvoient la valeur false (faux).
Level.IsElimination
Renvoie une valeur booléenne indiquant si le périmètre est un périmètre d'élimination. Pour les instances sans la fonctionnalité Éliminations, tous les périmètres renvoient la valeur false (faux).
Level.IsTradingPartner
Renvoie une valeur booléenne indiquant si le périmètre est un périmètre Partenaire commercial d'élimination. Pour les instances sans la fonctionnalité Éliminations, tous les périmètres renvoient la valeur false (faux).
Level.Currency
Renvoie la chaîne représentant le code ISO de la devise du périmètre (par exemple,
EUR
ou
USD
).
Level.Parent
Renvoie le code du périmètre qui est le parent de ce périmètre, ou l'objet de périmètre spécial "null" si ce périmètre n'a pas de parent (périmètre racine).
Level.IsLeaf
Renvoie une valeur booléenne indiquant si le périmètre est un périmètre feuille ou non (c'est-à-dire que cette propriété renvoie true (vrai) si le périmètre n'a pas d'enfants).

Compte

Fait référence aux différentes propriétés (
pas la valeur
) du compte actuel dans un
IF
relevé.
Exemple :
IF (this.Account.IFRS_Category.Name = "Assets", 1, 0)
Par exemple, pour les navigateurs qui utilisent la virgule comme séparateur décimal :
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 "null" si ce compte n'a pas de parent (compte racine).
Account.<
attribute_name
>
Renvoie un objet de valeur de dimension associé à l'attribut spécifié. 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 comportant des noms non-identificateurs (tels que ceux qui ont plus d'un mot dans leur nom) ne peuvent pas être récupérés dans les formules.
Account.isCredit
Renvoie une valeur booléenne si le compte a uneType de soldeCRÉDIT ou pas. Notez que certains comptes (par ex. les comptes métriques) ne seront ni Débit ni Crédit.
Account.isDebit
Renvoie une valeur booléenne si le compte a uneType de soldeDÉBIT ou pas. Notez que certains comptes (par ex. les comptes métriques) 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 spécifié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 spécifié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
renvoie 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 spécifiée est une valeur de périmètre de feuille dans cette dimension.
DimensionValue
.<
attribute_code
>
Renvoie le code de valeur de l'attribut spécifié (correspondant à la valeur de dimension).
DimensionValue
.<
attribute_name
>
Renvoie la valeur de l'attribut spécifié (correspondant à la valeur de dimension).
AttributeValue
.Code
Renvoie la chaîne représentant le code de la valeur d'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 l'attribut.
AttributeValue
.Description
Renvoie la chaîne représentant la description de la valeur de l'attribut.
AttributeValue
.Parent
Renvoie le code de la valeur d'attribut 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 spécifié est une valeur de périmètre 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 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 tel qu'il apparaît dans les discriminants temporels.
Timeper
.NumberOfDays
Renvoie le nombre total de jours dans la période, inclusif.
Exemple :
IF (this.Month.NumberOfDays > 30, 1, 0)
Timeper
.Parent
Renvoie la période qui contient la période actuelle et est une strate plus élevée (moins précise) du continuum de strates. S'il n'y a pas de strate supérieure, renvoie la période actuelle.
Timeper
.StartDate
Renvoie une date représentant le premier jour de la période (identique à
Version.StartDate).
Timeper
.EndDate
Renvoie une date représentant le dernier jour de la période (identique à
Version.EndDate).
Timeper
.PositionOf(tp)
Renvoie un entier qui représente la position de la période (
tp
) dans la période source (par rapport aux autres membres de sa strate). Retours
0
si la période spécifiée (
tp
) n'est pas une strate plus petite que la
Timeper
spécifié, ou si
tp
n'est pas compris dans la
Timeper
spécifié.