FinancialsWidgetUtil - com escopo

A API FinancialsWidgetUtil pode ser usada para personalizar widgets na seção Finanças de Espaço do projeto e Planejamento estratégico Espaço.

Os widgets a seguir estão disponíveis em Espaço do projeto e Planejamento estratégico Espaço por padrão.

• Orçamento
• Estimativa na Conclusão
• Custo planejado
• Custo real até o momento

A API FinancialsWidgetUtil pode ser usada para adicionar widgets secundários que mostram valores para um período ou tipo de despesa especificado.

Figura 1. Seção Finanças no Espaço do projeto

Neste exemplo de Espaço do projeto, o widget Custo planejado tem widgets secundários que mostram valores CapEx e OpEx, enquanto o widget Orçamento não tem widgets secundários.

Para usar essa API, crie um widget secundário com um dos widgets financeiros disponíveis como primário. Use os métodos desta API no campo Script do registro do widget secundário.

A API FinancialsWidgetUtil requer a aplicação Financials Core (sn_invst_pln), bem como a aplicação Planejamento estratégico (sn_apw_advanced) ou Espaço do projeto (sn_pw). Esta API é fornecida no namespace sn_invst_pln.

FinancialsWidgetUtil - FinancialsWidgetUtil(GlideRecord InvestmentGr, objeto timeScope, cadeia de caracteres expenseType)

Instancia um objeto FinancialsWidgetUtil.

Este objeto é usado para obter valores agregados, como orçamento e custo planejado para um investimento.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
GR de investimento	GlideRecord	Investimento para obter valores agregados para. Localizado na tabela Investment [sn_invst_pln_invst_investment].
timeScope	Objeto	Objeto que contém os períodos fiscais a serem usados como datas de início e término para a agregação. { "startFiscalPeriodSysId": "String", "endFiscalPeriodSysId": "String" }
timeScope.startFiscalPeriodSysId	Cadeia de caracteres	Sys_id do período fiscal a ser usado como data de início para a agregação. Localizado na tabela Período fiscal [fiscal_period].
timeScope.endFiscalPeriodSysId	Cadeia de caracteres	Sys_id do período fiscal a ser usado como data de término para a agregação. Localizado na tabela Período fiscal [fiscal_period].
expenseType	Cadeia de caracteres	Opcional. Tipo de despesa a ser incluída na agregação, como despesa de capital (CapEx) ou despesa operacional (OpEx). Valores válidos: capex opex

Este exemplo instancia um objeto FinancialsWidgetUtil que pode ser usado para retornar valores agregados para um investimento em que o tipo de despesa é CapEx e o período é 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()

Retorna o custo real de todos os itens de planejamento e itens de trabalho vinculados a um investimento.

Para usar este método, crie um widget secundário com o widget Custo real até o momento como primário. Use este método no campo Script do registro do widget secundário.

O custo real retornado por este método é para o período e o tipo de despesa especificados ao instanciar o objeto FinancialsWidgetUtil.

Tabela 2. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 3. Retorna

Tipo	Descrição
Objeto	Objeto que contém o valor de exibição e o valor do custo real. { "displayValue": "String", "value": Number }
<Object>.displayValue	Exiba o valor do custo real, como US$ 1 mil. Tipo de dados: cadeia de caracteres
<Object>.valor	Valor do custo real, como 1000. Tipo de dados: número

Este exemplo adiciona um widget secundário ao widget Custo real até a data que mostra o custo real somente para 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').getActuals();
      return {
         displayValue: PPMCurrencyHelper.getFormattedAmountWithCurrency(opexCost.value),
         value: opexCost.value
      };
   }
})();

FinancialsWidgetUtil – getBudget()

Retorna o orçamento de todos os itens de planejamento e itens de trabalho vinculados a um investimento.

Para usar este método, crie um widget secundário com o widget Orçamento como primário. Use este método no campo Script do registro do widget secundário.

O orçamento retornado por este método é para o período e o tipo de despesa especificados ao instanciar o objeto FinancialsWidgetUtil.

Tabela 4. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 5. Retorna

Tipo	Descrição
Objeto	Objeto que contém o valor de exibição e o valor do orçamento. { "displayValue": "String", "value": Number }
<Object>.displayValue	Exiba o valor do orçamento, como US$ 2,50 mil. Tipo de dados: cadeia de caracteres
<Object>.valor	Valor do orçamento, como 2500. Tipo de dados: número

Este exemplo adiciona um widget secundário ao widget Orçamento que mostra o orçamento somente para 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()

Retorna o valor de estimativa na conclusão (EAC) para todos os itens de planejamento e itens de trabalho vinculados a um investimento.

Para usar este método, crie um widget secundário com o widget Estimativa na conclusão como primário. Use este método no campo Script do registro do widget secundário.

O valor de EAC retornado por este método é para o período e o tipo de despesa especificados ao instanciar o objeto FinancialsWidgetUtil.

Tabela 6. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 7. Retorna

Tipo	Descrição
Objeto	Objeto que contém o valor de exibição e o valor do EAC. { "displayValue": "String", "value": Number }
<Object>.displayValue	Exiba o valor do EAC, como US$ 2,38 mil. Tipo de dados: cadeia de caracteres
<Object>.valor	Valor do EAC, como 2380. Tipo de dados: número

Este exemplo adiciona um widget secundário ao widget Estimativa na conclusão que mostra o EAC somente para 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').getEAC();
      return {
         displayValue: PPMCurrencyHelper.getFormattedAmountWithCurrency(opexCost.value),
         value: opexCost.value
      };
   }
})();

FinancialsWidgetUtil - getPlannedCost()

Retorna o custo planejado para todos os itens de planejamento e itens de trabalho vinculados a um investimento.

Para usar este método, crie um widget secundário com o widget Custo planejado como primário. Use este método no campo Script do registro do widget secundário.

O custo planejado retornado por este método é para o período e o tipo de despesa especificados ao instanciar o objeto FinancialsWidgetUtil.

Tabela 8. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 9. Retorna

Tipo	Descrição
Objeto	Objeto que contém o valor de exibição e o valor do custo planejado. { "displayValue": "String", "value": Number }
<Object>.displayValue	Exiba o valor do custo planejado, como US$ 4,05 mil. Tipo de dados: cadeia de caracteres
<Object>.valor	Valor do custo planejado, como 4050. Tipo de dados: número

Este exemplo adiciona um widget secundário ao widget Custo planejado que mostra o custo planejado somente para 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').getPlannedCost();
      return {
         displayValue: PPMCurrencyHelper.getFormattedAmountWithCurrency(opexCost.value),
         value: opexCost.value
      };
   }
})();