FinancialsWidgetUtil : inclus dans le champ d’application

L’API FinancialsWidgetUtil peut être utilisée pour personnaliser les widgets dans la section Finances de Espace de travail du projet et Planification stratégique Espace de travail.

Les widgets suivants sont disponibles dans Espace de travail du projet et Planification stratégique Espace de travail par défaut.

• Budget
• Estimation à l'achèvement
• Coût planifié
• Coût réel à ce jour

L’API FinancialsWidgetUtil peut être utilisée pour ajouter des widgets enfants qui affichent des valeurs pour une période ou un type de dépense spécifié.

Figure 1. Section Finances dans Espace de travail du projet

Dans cet exemple de Espace de travail du projet, le widget Coût planifié a des widgets enfants qui affichent les valeurs CapEx et OpEx, tandis que le widget Budget n’a aucun widget enfant.

Pour utiliser cette API, créez un widget enfant avec l’un des widgets financiers disponibles comme parent. Utilisez les méthodes de cette API dans le champ Script de l’enregistrement du widget enfant.

L’API FinancialsWidgetUtil nécessite l’application Financials Core (sn_invst_pln), ainsi que l’application (sn_apw_advanced) ou Espace de travail du projet l’application Planification stratégique (sn_pw). Cette API est fournie dans l’espace de noms sn_invst_pln .

FinancialsWidgetUtil : FinancialsWidgetUtil(GlideRecord investmentGr, Object timeScope, String expenseType)

Instancie un objet FinancialsWidgetUtil .

Cet objet est utilisé pour obtenir des valeurs agrégées telles que le budget et le coût planifié d’un investissement.

Tableau 1. Paramètres

Nom	Type	Description
investmentGr	GlideRecord	Investissement pour lequel obtenir les valeurs agrégées. Situé dans la table Investissement [sn_invst_pln_invst_investment].
timeScope	Objet	Objet contenant les périodes fiscales à utiliser comme dates de début et de fin pour l’agrégation. { "startFiscalPeriodSysId": "String", "endFiscalPeriodSysId": "String" }
timeScope.startFiscalPeriodSysId	Chaîne	Sys_id de la période fiscale à utiliser comme date de début pour l’agrégation. Situé dans la table Période fiscale [fiscal_period].
timeScope.endFiscalPeriodSysId	Chaîne	Sys_id de la période fiscale à utiliser comme date de fin pour l’agrégation. Situé dans la table Période fiscale [fiscal_period].
Type de dépense	Chaîne	Facultatif. Type de dépense à inclure dans l’agrégation, comme les frais d’investissement (CapEx) ou les frais d’exploitation (OpEx). Valeurs valides : Capex Opex

Cet exemple instancie un objet FinancialsWidgetUtil qui peut être utilisé pour renvoyer des valeurs agrégées pour un investissement où le type de dépense est CapEx et la période est context.timeScope.

var context = JSON.parse(context);
var investment = context.investment;
(function initializeFWU() {
   var invGr = new GlideRecord('sn_invst_pln_invst_investment');
   if (invGr.get(investment.sys_id)) {
      var capexCost = new sn_invst_pln.FinancialsWidgetUtil(invGr, context.timeScope, 'capex');
   }
})();

FinancialsWidgetUtil : getActuals()

Renvoie le coût réel de tous les éléments de planification et de travail liés à un investissement.

Pour utiliser cette méthode, créez un widget enfant avec l’icône Coût réel à ce jour en tant que parent. Utilisez cette méthode dans le champ Script de l’enregistrement de widget enfant.

Coût réel renvoyé par cette méthode correspond à la période et au type de dépense spécifiés lors de l’instanciation de l’objet FinancialsWidgetUtil .

Tableau 2. Paramètres

Nom	Type	Description
Aucun

Tableau 3. Renvoie

Type	Description
Objet	Objet contenant la valeur d’affichage et la valeur du coût réel. { "displayValue": "String", "value": Number }
<Object>.displayValue	Valeur d’affichage du coût réel, telle que 1,00 000 $. Type de données : chaîne
<Object>.Valeur	Valeur du coût réel, telle que 1 000. Type de données : nombre

Cet exemple ajoute un widget enfant au widget Coût réel à ce jour qui affiche le coût réel pour OpEx uniquement.

var context = JSON.parse(context);
var investment = context.investment;
(function getCost() {
   var invGr = new GlideRecord('sn_invst_pln_invst_investment');
   if (invGr.get(investment.sys_id)) {
      var opexCost = new sn_invst_pln.FinancialsWidgetUtil(invGr, context.timeScope, 'opex').getActuals();
      return {
         displayValue: PPMCurrencyHelper.getFormattedAmountWithCurrency(opexCost.value),
         value: opexCost.value
      };
   }
})();

FinancialsWidgetUtil : getBudget()

Renvoie le budget de tous les éléments de planification et de travail liés à un investissement.

Pour utiliser cette méthode, créez un widget enfant avec l’icône Budget en tant que parent. Utilisez cette méthode dans le champ Script de l’enregistrement de widget enfant.

Le budget renvoyé par cette méthode correspond à la période et au type de dépense spécifiés lors de l’instanciation de l’objet FinancialsWidgetUtil .

Tableau 4. Paramètres

Nom	Type	Description
Aucun

Tableau 5. Renvoie

Type	Description
Objet	Objet contenant la valeur d’affichage et la valeur du budget. { "displayValue": "String", "value": Number }
<Object>.displayValue	Valeur d’affichage du budget, par exemple 2,50 000 $. Type de données : chaîne
<Object>.Valeur	Valeur du budget, par exemple 2 500. Type de données : nombre

Cet exemple ajoute un widget enfant au widget Budget qui affiche uniquement le budget pour OpEx.

var context = JSON.parse(context);
var investment = context.investment;
(function getCost() {
   var invGr = new GlideRecord('sn_invst_pln_invst_investment');
   if (invGr.get(investment.sys_id)) {
      var opexCost = new sn_invst_pln.FinancialsWidgetUtil(invGr, context.timeScope, 'opex').getBudget();
      return {
         displayValue: PPMCurrencyHelper.getFormattedAmountWithCurrency(opexCost.value),
         value: opexCost.value
      };
   }
})();

FinancialsWidgetUtil : getEAC()

Renvoie la valeur d’estimation à l’achèvement (CAE) de tous les éléments de planification et de travail liés à un investissement.

Pour utiliser cette méthode, créez un widget enfant avec l’icône Estimation à l’achèvement en tant que parent. Utilisez cette méthode dans le champ Script de l’enregistrement de widget enfant.

Valeur CAE renvoyé par cette méthode correspond à la période et au type de dépense spécifiés lors de l’instanciation de l’objet FinancialsWidgetUtil .

Tableau 6. Paramètres

Nom	Type	Description
Aucun

Tableau 7. Renvoie

Type	Description
Objet	Objet contenant la valeur d’affichage et la valeur pour le CAE. { "displayValue": "String", "value": Number }
<Object>.displayValue	Valeur d’affichage du CAE, par exemple 2,38 000 $. Type de données : chaîne
<Object>.Valeur	Valeur du CAE, telle que 2380. Type de données : nombre

Cet exemple ajoute un widget enfant au widget Estimation à l’achèvement qui affiche le CAE pour OpEx uniquement.

var context = JSON.parse(context);
var investment = context.investment;
(function getCost() {
   var invGr = new GlideRecord('sn_invst_pln_invst_investment');
   if (invGr.get(investment.sys_id)) {
      var opexCost = new sn_invst_pln.FinancialsWidgetUtil(invGr, context.timeScope, 'opex').getEAC();
      return {
         displayValue: PPMCurrencyHelper.getFormattedAmountWithCurrency(opexCost.value),
         value: opexCost.value
      };
   }
})();

FinancialsWidgetUtil : getPlannedCost()

Renvoie le coût planifié pour tous les éléments de planification et de travail liés à un investissement.

Pour utiliser cette méthode, créez un widget enfant avec l’icône Coût planifié en tant que parent. Utilisez cette méthode dans le champ Script de l’enregistrement de widget enfant.

Coût planifié renvoyé par cette méthode correspond à la période et au type de dépense spécifiés lors de l’instanciation de l’objet FinancialsWidgetUtil .

Tableau 8. Paramètres

Nom	Type	Description
Aucun

Tableau 9. Renvoie

Type	Description
Objet	Objet contenant la valeur d’affichage et la valeur du coût planifié. { "displayValue": "String", "value": Number }
<Object>.displayValue	Valeur d’affichage du coût planifié, par exemple 4,05 000 $. Type de données : chaîne
<Object>.Valeur	Valeur du coût planifié, telle que 4 050. Type de données : nombre

Cet exemple ajoute un widget enfant au widget Coût planifié qui affiche le coût planifié pour OpEx uniquement.

var context = JSON.parse(context);
var investment = context.investment;
(function getCost() {
   var invGr = new GlideRecord('sn_invst_pln_invst_investment');
   if (invGr.get(investment.sys_id)) {
      var opexCost = new sn_invst_pln.FinancialsWidgetUtil(invGr, context.timeScope, 'opex').getPlannedCost();
      return {
         displayValue: PPMCurrencyHelper.getFormattedAmountWithCurrency(opexCost.value),
         value: opexCost.value
      };
   }
})();