Passer au contenu principal
Documentation
Documentation
Adaptive Planning
ai.calendar

ai.calendar

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

Fonctions

Méthode
Paramètres
Retours
Description
get SuivantPeriod ( période [, options ] )
  • period: Valeur de chaîne de la période pour obtenir la période suivante pour
  • options: Object Object contenant un ’nombre’ de propriété de type et une propriété de valeur en tant qu’ valeur int. Exemple : {type : ’number’, valeur : 3}
ai.calendar.period
Renvoie la période suivante dans le
Adaptive Planning
 Calendrier à partir de la période transmise dans l’argument
getPreviousPeriod( période [, options ] )
  • period: valeur de chaîne de la période pour obtenir la période précédente
  • options: Object Object contenant un ’nombre’ de propriété de type et une propriété de valeur en tant qu’ valeur int. Exemple : {type : ’number’, valeur : 3}
ai.calendar.period
Renvoie la période précédente dans la section
Adaptive Planning
 Calendrier à partir de la période transmise dans l’argument
getAvailablePeriodTypes( periodType )
  • periodType: String Code de strate de l'une des strates disponibles.
Tableau<String>
Renvoie un tableau de codes de strate (type Période) pris en charge par le calendrier plus élevé dans la hiérarchie que la strate transmise (ex ['QuarterYear', 'HalfYear', 'Year'])
getPeriodStartDateTime( période )
  • period: ai.calendar.period Période pour laquelle vous souhaitez obtenir la date et l'heure de début
Chaîne
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 pour laquelle vous souhaitez obtenir la date et l'heure de fin
Chaîne
Renvoie l’heure de fin de la période au format de chaîne de date ISO8601 (ex « 2015-06-15T12:00:00+10:00 »)
convertAdaptToivePeriodStart (start, end)
  • start: Date de début de la période au format String ISO8601 à convertir
  • end: Date de fin de la période au format String ISO8601 à convertir
Chaîne
Renvoie la valeur correspondante
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: Date de début de la période au format String ISO8601 à convertir
  • end: Date de fin de la période au format String ISO8601 à convertir
  • periodFrom: ai.calendar.period Période à partir de laquelle vous souhaitez effectuer la comparaison
  • periodEnd: ai.calendar.period Période à laquelle vous souhaitez comparer
Booléen
Renvoie la valeur Vrai si à la fois la date de début et la date de fin données se situent dans la période de début et la période de fin. Renvoie la valeur Faux dans le cas contraire. (ex vrai/faux)

Exemples

Exemple pour Suivant getPeriod ( période [, options ] ) et getPEviousPeriod( période [, 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

Période temporelle pouvant contenir des données brutes ou regroupé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());
}