FinancialsWidgetUtil : inclus dans le champ d’application

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 5 minutes de lecture
  • L’include de script FinancialsWidgetUtil fournit des méthodes 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
    Vous pouvez utiliser l’include de script FinancialsWidgetUtil 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
    Cette capture d’écran montre les widgets pour le budget, l’estimation à l’achèvement, l’écart de budget par rapport au CAE, le coût planifié et le coût réel à ce jour.

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

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

    L’include de script 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). Cet include de script est fourni dans l’espace de noms sn_invst_pln .

    FinancialsWidgetUtil : FinancialsWidgetUtil(GlideRecord, investmentGr, object, timeScope, String, 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 d’expense Chaîne Facultatif. Type de dépense à inclure dans l’agrégation, telle que les dépenses d’investissement (CapEx) ou les dépenses d’exploitation (OpEx).
    Valeurs valides :
    • Capex (Capex)
    • Opex (dépenses d’exploitation)

    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’attribut Coût réel à ce jour en tant que parent. Utilisez cette méthode dans le champ Script de l’enregistrement de widget enfant.

    Le 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, par exemple 1,00 K $.

    Type de données : chaîne

    <Object>.valeur Valeur du coût réel, par exemple 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 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’attribut 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 USD.

    Type de données : chaîne

    <Object>.valeur Valeur du budget, par exemple 2500.

    Type de données : nombre

    Cet exemple ajoute un widget enfant au widget Budget qui affiche le budget 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').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’attribut Estimation à l’achèvement en tant que parent. Utilisez cette méthode dans le champ Script de l’enregistrement de widget enfant.

    Valeur EAC 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 du code EAC.

    { 
       "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, par exemple 2380.

    Type de données : nombre

    Cet exemple ajoute un widget enfant au widget Estimation at Completion (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é 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’attribut Coût planifié en tant que parent. Utilisez cette méthode dans le champ Script de l’enregistrement de widget enfant.

    Le 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 prévu, par exemple 4,05 000 $.

    Type de données : chaîne

    <Object>.valeur Valeur du coût prévu, 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
          };
       }
    })();