Passa al contenuto principale
Documentazione
Documentazione
Adaptive Planning
ai.calendar

ai.calendar

Un periodo di tempo che può contenere dati non elaborati o aggregati. Consultare Procedura: Modificare i calendari.

Funzioni

Metodo
Parametri
Resi
Descrizione
getNextPeriod( period [, options ] )
  • period: String Valore del periodo per il quale ottenere il periodo di tempo successivo
  • options: Object Oggetto contenente una proprietà di tipo "number" e una proprietà value come valore int. Esempio: {type: 'number', value: 3}
ai.calendar.period
Restituisce il Periodo successivo in
Adaptive Planning
 Calendario dal periodo trascorso nell'argomento
getPreviousPeriod( period [, options ] )
  • period: String Valore del periodo per il quale recuperare il periodo di tempo precedente
  • options: Object Oggetto contenente una proprietà di tipo "number" e una proprietà value come valore int. Esempio: {type: 'number', value: 3}
ai.calendar.period
Restituisce il Periodo precedente in
Adaptive Planning
 Calendario dal periodo trascorso nell'argomento
getAvailablePeriodTypes( periodType )
  • periodType: String Codice strato di uno degli strati disponibili.
Array<String>
Restituisce una matrice di codici strato (tipo periodo) supportati dal calendario più in alto nella gerarchia rispetto allo strato passato (ad es. ['QuarterYear', 'HalfYear', 'Year'] )
getPeriodStartDateTime( period )
  • period: ai.calendar.period Periodo per il quale si desidera ottenere la data e l'ora di inizio
String
Restituisce la data e l'ora di inizio per il periodo nel formato stringa di data ISO8601 (ad es. "15/06/2015 T12:00:00+10:00")
getPeriodEndDateTime( period )
  • period: ai.calendar.period Periodo per il quale si desidera ottenere la data e l'ora di fine
String
Restituisce la data e l'ora di fine per il periodo nel formato stringa di data ISO8601 (ad es. "15/06/2015 T12:00:00+10:00")
convertToAdaptivePeriodStart ( start, end )
  • start: data di inizio in formato ISO8601 del periodo da convertire
  • end: data di fine in formato ISO8601 del periodo da convertire
String
Restituisce il corrispondente
Adaptive Planning
 Data inizio periodo in formato stringa data ISO8601 (ad es. '2015-06-15T12:00:00+10:00')
isWithinAdaptivePeriodRange ( start, end, periodFrom, periodEnd )
  • start: data di inizio in formato ISO8601 del periodo da convertire
  • end: data di fine in formato ISO8601 del periodo da convertire
  • periodFrom: ai.calendar.period Periodo da cui si desidera eseguire il confronto
  • periodEnd: ai.calendar.period Periodo con cui si desidera eseguire il confronto
Booleano
Restituisce vero se sia la data di inizio che la data di fine specificate rientrano nel periodo iniziale e al periodo. Restituisce false in caso contrario. (ex vero/falso)

Esempi

Esempio per 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());
}
Esempio di 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'
}
Esempio per 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 di tempo che può contenere dati non elaborati o aggregati.
Funzioni
Metodo
Parametri
Resi
Descrizione
getValue()
stringa
Restituisce il valore stringa delle colonne figlio Periodo che possono essere utilizzate per passare alle funzioni Calendario come argomenti.
Esempio

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