ai.calendar

Un periodo de tiempo que puede contener datos sin procesar o agregados. Consulte Pasos: cambio de calendarios.

Funciones

Método	Parámetros	Devoluciones	Descripción
getNextPeriod( period [, options ] )	period: valor de cadena del periodo para el que se obtendrá el siguiente periodo. options: Object Objeto que contiene una propiedad de tipo "number" y una propiedad de valor como int. Ejemplo: {type: 'number', value: 3}	ai.calendar.period	Devuelve el siguiente periodo del Adaptive Planning Calendario del periodo transcurrido en el argumento
getPreviousPeriod( period [, options ] )	period: valor de cadena del periodo para obtener el periodo de tiempo anterior options: Object Objeto que contiene una propiedad de tipo "number" y una propiedad de valor como int. Ejemplo: {type: 'number', value: 3}	ai.calendar.period	Devuelve el periodo anterior en el Adaptive Planning Calendario del periodo transcurrido en el argumento
getAvailablePeriodTypes( periodType )	periodType: código de estrato de cadena de uno de los estratos disponibles.	Array<String>	Devuelve una matriz de códigos de estrato (tipo de periodo) admitidos por el calendario más alto en la jerarquía que el estrato pasado (por ejemplo, ['QuarterYear', 'HalfYear', 'Year'])
getPeriodStartDateTime(period)	period: ai.calendar.period Periodo cuya fecha inicial desea obtener	Cadena	Devuelve la fecha y hora de inicio del periodo en formato de cadena de fecha ISO8601 (por ejemplo, "2015-06-15T12:00:00+10:00").
getPeriodEndDateTime( period )	period: ai.calendar.period Periodo cuya fecha final desea obtener	Cadena	Devuelve la fecha y hora de finalización del periodo en formato de cadena de fecha ISO8601 (por ejemplo, "2015-06-15T12:00:00+10:00").
convertToAdaptivePeriodStart ( start, end )	start: cadena de fecha inicial del periodo con formato ISO8601 para convertir end: cadena de fecha final con formato ISO8601 del periodo que se va a convertir	Cadena	Devuelve el correspondiente Adaptive Planning Fecha inicial de periodo en formato de cadena de fecha ISO8601 (por ejemplo, "2015-06-15T12:00:00+10:00")
isWithinAdaptivePeriodRange ( start, end, periodFrom, periodEnd )	start: cadena de fecha inicial del periodo con formato ISO8601 para convertir end: cadena de fecha final con formato ISO8601 del periodo que se va a convertir periodFrom: ai.calendar.period Periodo desde el que desea comparar periodEnd: ai.calendar.period Periodo con el que desea comparar	Booleano	Devuelve verdadero si tanto la fecha inicial como la fecha final se encuentran dentro del periodo inicial y final. De lo contrario, devuelve falso. (por ejemplo, verdadero/falso)

Ejemplos

Ejemplo de getNextPeriod( period [, options ] ) y 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());
}

Ejemplo de 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'
}

Ejemplo de 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

Un periodo temporal que puede contener datos sin procesar o agregados.

Funciones: Método
Parámetros
Devoluciones
Descripción

getValue()
cadena
Devuelve el valor de cadena del periodo que las columnas secundarias que se pueden usar para pasar a las funciones de calendario como argumentos.
Ejemplo: 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()); }