Passer au contenu principal
Documentation
Documentation
Adaptive Planning
ai.calendar

ai.calendar

Période pouvant contenir des données brutes ou agrégées. Voir Étapes : modifier les calendriers.

Fonctions

Méthode
Paramètres
Retours
Description
getNextPeriod(période [, options] )
  • period : valeur de chaîne de la période pour laquelle obtenir la période suivante
  • options : Objet Objet contenant une propriété de type 'nombre' et une propriété de valeur sous forme d'int. Exemple : {type : 'nombre', valeur : 3}
ai.calendar.period
Renvoie la période suivante dans le
Adaptive Planning
 Calendrier de la période passée dans l'argument
getPreviousPeriod( period [, options ] )
  • period : valeur de chaîne de la période pour laquelle obtenir la période précédente
  • options : Objet Objet contenant une propriété de type 'nombre' et une propriété de valeur sous forme d'int. Exemple : {type : 'nombre', valeur : 3}
ai.calendar.period
Renvoie la période précédente dans le
Adaptive Planning
 Calendrier de la période passée dans l'argument
getAvailablePeriodTypes( periodType )
  • periodType : code de strate de chaîne d'une des strates disponibles.
Tableau <String>
Renvoie le tableau de codes de strate (type de période) pris en charge par le calendrier supérieur dans la hiérarchie que la strate acceptée (ex : ['QuarterYear', 'HalfYear', 'Année'] )
getPeriodStartDateTime( period )
  • period: ai.calendar.period Période dont vous souhaitez obtenir l'heure de début
String
Renvoie l'heure de début de la période au format de chaîne de date ISO8601 (ex. '2015-06-15T12:00:00+10:00')
getPeriodEndDateTime( period )
  • period: ai.calendar.period Période dont vous souhaitez obtenir la date de fin
String
Renvoie l'heure de fin de la période au format de chaîne de date ISO8601 (par exemple '2015-06-15T12:00:00+10:00')
convertToAdaptivePeriodStart (départ, fin)
  • start : chaîne de date de début de la période à convertir au format ISO8601
  • end: chaîne de date de fin de la période à convertir au format ISO8601
String
Renvoie le correspondant
Adaptive Planning
 Date de début de la période au format de chaîne de date ISO8601 (ex. '2015-06-15T12:00:00+10:00')
isWithinAdaptivePeriodRange (start, end, periodFrom, periodEnd)
  • start : chaîne de date de début de la période à convertir au format ISO8601
  • end: chaîne de date de fin de la période à convertir au format ISO8601
  • periodFrom: ai.calendar.period Période à partir de laquelle vous voulez comparer
  • periodEnd: ai.calendar.period Période à laquelle vous voulez comparer
Boolean
Renvoie Vrai si la date de début et la date de fin données se situent dans la période de début et dans la période de fin. Sinon, renvoie la valeur false (faux). (ex vrai/faux)

Exemples

Exemple pour getNextPeriod(period [, options]) et getPeriod(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());
}
Exemple pour 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'
}
Exemple pour 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

Une période pouvant contenir des données brutes ou agrégées.
Fonctions
Méthode
Paramètres
Retours
Description
getValue()
chaîne
Renvoie la valeur de chaîne de la période que les colonnes enfants peuvent être utilisées pour transmettre aux fonctions de calendrier comme arguments.
Exemple

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