FinancialsWidgetUtil - スコープ指定

FinancialsWidgetUtil API を使用すると、 および 戦略的計画 ワークスペースの [財務] セクションプロジェクトワークスペースのウィジェットをカスタマイズできます。

次のウィジェットは、 および戦略的計画 ワークスペースデフォルトで使用できますプロジェクトワークスペース。

• 予算
• 完了時の推定 (EAC)
• 計画コスト
• 現在までの実績コスト

FinancialsWidgetUtil API を使用して、指定された期間または経費タイプの値を表示する子ウィジェットを追加できます。

図 : 1. の [財務] セクション プロジェクトワークスペース

のこの例では プロジェクトワークスペース、計画コストウィジェットには投資と経費の値を表示する子ウィジェットがありますが、予算ウィジェットには子ウィジェットがありません。

この API を使用するには、利用可能な財務ウィジェットの 1 つを親として持つ 子ウィジェットを作成します 。この API のメソッドを子ウィジェットレコードの スクリプト フィールドで使用します。

FinancialsWidgetUtil API には、Financials Core アプリケーション (sn_invst_pln) とアプリケーション (sn_apw_advanced) またはプロジェクトワークスペースアプリケーション (sn_pw) 戦略的計画 が必要です。この API は、 sn_invst_pln 名前空間内で提供されます。

FinancialsWidgetUtil - FinancialsWidgetUtil(GlideRecord investmentGr, オブジェクト timeScope, 文字列 expenseType)

FinancialsWidgetUtil オブジェクトをインスタンス化します。

このオブジェクトは、投資の予算や計画コストなどの集計値を取得するために使用されます。

表 : 1. パラメーター

名前	タイプ	説明
投資Gr	GlideRecord	集計値を取得する投資。投資 [sn_invst_pln_invst_investment] テーブルにあります。
timeScope	オブジェクト	集計の開始日と終了日として使用する会計期間を含むオブジェクト。 { "startFiscalPeriodSysId": "String", "endFiscalPeriodSysId": "String" }
timeScope.startFiscalPeriodSysId	文字列	集計の開始日として使用する会計期間Sys_id。会計期間 [fiscal_period] テーブルにあります。
timeScope.endFiscalPeriodSysId	文字列	集計の終了日として使用する会計期間のSys_id。会計期間 [fiscal_period] テーブルにあります。
経費タイプ	文字列	オプション。資本的支出 (CapEx) や運用経費 (OpEx) など、集計に含める経費のタイプ。 有効な値： 投資 Opex

この例では、経費タイプが投資で期間が context.timeScope である投資の集計値を返すために使用できる FinancialsWidgetUtil オブジェクトをインスタンス化します。

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()

投資にリンクされている計画立案アイテムと作業アイテムの実際のコストを返します。

このメソッドを使用するには、 Configure a widget for project financial metrics 現在までの実績コスト X ウィジェットを親として使用します。このメソッドは、子ウィジェットレコードの [スクリプト ] フィールドで使用します。

実績コスト このメソッドによって返される X は、FinancialsWidgetUtil オブジェクトをインスタンス化するときに指定された期間と経費タイプに対するものです。

表 : 2. パラメーター

名前	タイプ	説明
なし

表 : 3. 返される内容

タイプ	説明
オブジェクト	表示値と実績コストの値を含むオブジェクト。 { "displayValue": "String", "value": Number }
<Object>.displayValue	実際のコストの表示値 ( $1.00 K など)。 データタイプ：文字列
<Object>。値	実績コストの値 ( 1000 など)。 データタイプ：数値

この例では、経費のみの実績コストを表示する実績コストを日付ウィジェットに子ウィジェットに追加します。

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()

投資にリンクされている計画立案アイテムと作業アイテムの予算を返します。

このメソッドを使用するには、 Configure a widget for project financial metrics 予算 X ウィジェットを親として使用します。このメソッドは、子ウィジェットレコードの [スクリプト ] フィールドで使用します。

予算 このメソッドによって返される X は、FinancialsWidgetUtil オブジェクトをインスタンス化するときに指定された期間と経費タイプに対するものです。

表 : 4. パラメーター

名前	タイプ	説明
なし

表 : 5. 返される内容

タイプ	説明
オブジェクト	予算の表示値と値を含むオブジェクト。 { "displayValue": "String", "value": Number }
<Object>.displayValue	予算の表示値 ( $2.50 K など)。 データタイプ：文字列
<Object>。値	予算の値 ( 2500 など)。 データタイプ：数値

この例では、経費の予算のみを表示する子ウィジェットを予算ウィジェットに追加します。

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()

投資にリンクされている計画立案アイテムおよび作業アイテムの完了時推定 (EAC) 値を返します。

このメソッドを使用するには、 Configure a widget for project financial metrics 完了時の推定 (EAC) X ウィジェットを親として使用します。このメソッドは、子ウィジェットレコードの [スクリプト ] フィールドで使用します。

EAC 値 このメソッドによって返される X は、FinancialsWidgetUtil オブジェクトをインスタンス化するときに指定された期間と経費タイプに対するものです。

表 : 6. パラメーター

名前	タイプ	説明
なし

表 : 7. 返される内容

タイプ	説明
オブジェクト	EAC の表示値と値を含むオブジェクト。 { "displayValue": "String", "value": Number }
<Object>.displayValue	EAC の表示値 ( $2.38 K など)。 データタイプ：文字列
<Object>。値	EAC の値 ( 2380 など)。 データタイプ：数値

この例では、経費のみの EAC を表示する [完了時の推定 (EAC)] ウィジェットに子ウィジェットを追加します。

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()

投資にリンクされている計画立案アイテムと作業アイテムの計画コストを返します。

このメソッドを使用するには、 Configure a widget for project financial metrics 計画コスト X ウィジェットを親として使用します。このメソッドは、子ウィジェットレコードの [スクリプト ] フィールドで使用します。

計画コスト このメソッドによって返される X は、FinancialsWidgetUtil オブジェクトをインスタンス化するときに指定された期間と経費タイプに対するものです。

表 : 8. パラメーター

名前	タイプ	説明
なし

表 : 9. 返される内容

タイプ	説明
オブジェクト	計画コストの表示値と値を含むオブジェクト。 { "displayValue": "String", "value": Number }
<Object>.displayValue	計画コストの表示値 ( $4.05 K など)。 データタイプ：文字列
<Object>。値	計画コストの値 ( 4050 など)。 データタイプ：数値

この例では、経費のみの計画コストを表示する子ウィジェットを計画コストウィジェットに追加します。

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
      };
   }
})();