ai.calendar

Um período que pode conter dados brutos ou agregados. Consulte Etapas: alterar calendários.

Funções

Método	Parâmetros	Devoluções	Descrição
getNextPeriod( período [, opções ])	period: valor da cadeia de caracteres do período para obter o próximo período opções: Objeto Objeto que contém uma propriedade de tipo "number" e uma propriedade de valor como um int. Exemplo: {type: 'number', value: 3}	ai.calendar.period	Retorna o próximo Período no Adaptive Planning Calendário do período passado no argumento
getPreviousPeriod( período [, opções ] )	period: valor da cadeia de caracteres do período para obter o período anterior opções: Objeto Objeto que contém uma propriedade de tipo "number" e uma propriedade de valor como um int. Exemplo: {type: 'number', value: 3}	ai.calendar.period	Retorna o Período anterior no Adaptive Planning Calendário do período passado no argumento
getAvailablePeriodTypes( periodType )	periodType: código do estrato da cadeia de caracteres de um dos estratos disponíveis.	Array<String>	Retorna uma matriz de códigos de estrato (tipo de período) com suporte no calendário em um nível superior na hierarquia em relação ao estrato passado em (ex ['QuarterYear', 'HalfYear', 'Year'] )
getPeriodStartDateTime( period )	period: ai.calendar.period Período para o qual você quer obter a data e hora de início	Cadeia de caracteres	Retorna a data e hora de início do período no formato de cadeia de caracteres de data ISO8601 (por exemplo, '2015-06-15T12:00:00+10:00')
getPeriodEndDateTime( period )	period: ai.calendar.period Período para o qual você quer obter a data e hora de término	Cadeia de caracteres	Retorna a data e hora de término do período no formato de cadeia de caracteres de data ISO8601 (por exemplo, '2015-06-15T12:00:00+10:00')
convertToAdaptivePeriodStart ( start, end )	start: cadeia de caracteres com formato ISO8601 - data de início do período a ser convertido end: data de término da cadeia de caracteres no formato ISO8601 do período a ser convertido	Cadeia de caracteres	Retorna o correspondente Adaptive Planning Data de início do período no formato de cadeia de caracteres de data ISO8601 (ex: '2015-06-15T12:00:00+10:00')
isWithinAdaptivePeriodRange ( start, end, periodFrom, periodEnd )	start: cadeia de caracteres com formato ISO8601 - data de início do período a ser convertido end: data de término da cadeia de caracteres no formato ISO8601 do período a ser convertido periodFrom: ai.calendar.period Período a partir do qual você quer comparar periodEnd: ai.calendar.period Período ao qual você quer comparar	Booliano	Retorna verdadeiro se as datas de início e de término informadas estiverem dentro dos períodos inicial e final. Caso contrário, retorna falso. (ex verdadeiro/falso)

Exemplos

Exemplo para getNextPeriod( period [, Options ] ) e getPeviousPeriod( period [, Options ] )


function PreviewData(context) {
   var calendar = context.getCalendar();
   var dataSource = context.getDataSource();
   var periods = dataSource.getSetting("Periods").getValue();
   // getNextPeriod
   var nextMonth = calendar.getNextPeriod(periods.getFromPeriod());
   //getPreviousPeriod
   var prevMonth = calendar.getPreviousPeriod(periods.getFromPeriod());
}

Exemplo para convertToAdaptivePeriodStart ( start, end )


function PreviewData(context) {
   var calendar = context.getCalendar();
   var newDate = calendar.convertToAdaptivePeriodStart(ai.date.create('2016-02-01', 'America/Los_Angeles'), ai.date.create('2016-05-01', 'America/Los_Angeles'));
   // write the corresponding Adaptive Planning period start date to log.  
   ai.log.logInfo(newDate);
  //Assuming server is in PST timezone, the corresponding output is '2016-04-01T00:00:00.0000000-07:00'
}

Exemplo para getAvailablePeriodTypes( periodType )


 function PreviewData(context) {
   var dataSource = context.getDataSource();
   var calendar = context.getCalendar();
   var availableTypeMonth = calendar.getAvailablePeriodTypes('month');
   var availableTypeQuarter = calendar.getAvailablePeriodTypes('qtr');
   var availableTypeYear = calendar.getAvailablePeriodTypes('year');
   ai.log.logInfo("Stratum code of one of the available Strata for month: "+availableTypeMonth);
   ai.log.logInfo("Stratum code of one of the available Strata for quarter: "+availableTypeQuarter);
   ai.log.logInfo("Stratum code of one of the available Strata for year: "+availableTypeYear);
  }
   //Stratum code of one of the available Strata for month: month,qtr,year
   //Stratum code of one of the available Strata for quarter: qtr,year
   //Stratum code of one of the available Strata for year: year

ai.calendar.period

Um período que pode conter dados brutos ou agregados.

Funções: Método
Parâmetros
Devoluções
Descrição

getValue()
cadeia de caracteres
Retorna o valor de cadeia de caracteres do Período que as colunas filho que podem ser usadas para passar para funções de calendário como argumentos.
Exemplo: function PreviewData(context) { var dataSource = context.getDataSource(); var calendar = context.getCalendar(); var periods = dataSource.getSetting("Periods").getValue(); var period = calendar.nextPeriod(periods.getFromPeriod()); var nextPeriod = calendar.nextPeriod(period.getValue()); }