Skip to main content
Documentatie
Documentatie
Adaptive Planning
Laatst bijgewerkt: 2023-06-23
ai.calendar

ai.calendar

Een tijdsperiode die onbewerkte of geaggregeerde gegevens kan bevatten. Zie Steps: Change Calendars.

Functies

Methode
Parameters
Retouren
Omschrijving
getNextPeriod( period [, options ] )
  • period: tekenreekswaarde van de periode waarvoor de volgende tijdsperiode moet worden opgehaald:
  • opties: Object Object met de type-eigenschap number en een value-eigenschap als een int. Voorbeeld: {type: 'number', value: 3}
ai.calendar.period
Retourneert de volgende periode in de
Adaptive Planning
 Kalender uit de periode die in het argument is doorgegeven
getPreviousPeriod( period [, options ] )
  • period: tekenreekswaarde van de periode waarvoor de vorige tijdsperiode moet worden opgehaald:
  • opties: Object Object met de type-eigenschap number en een value-eigenschap als een int. Voorbeeld: {type: 'number', value: 3}
ai.calendar.period
Retourneert de vorige periode in de
Adaptive Planning
 Kalender uit de periode die in het argument is doorgegeven
getAvailablePeriodTypes( periodType )
  • periodType: tekenreeksstratumcode van een van de beschikbare strata.
Matrix<String>
Retourneert een matrix met stratumcodes (periodetype) die worden ondersteund door de kalender die hoger in de hiërarchie staat dan het stratum dat is doorgegeven in (ex ['QuarterYear', 'HalfYear', 'Year'] )
getPeriodStartDateTime( periode )
  • period: ai.calendar.period Periode waarvoor u de begindatum/tijd wilt ophalen
String
Retourneert de begindatum en -tijd voor de periode in ISO8601-datumtekenreeksnotatie (bijv. 15-06-15T12:00:00+10:00 uur)
getPeriodEndDateTime( periode )
  • period: ai.calendar.period Periode waarvoor u de einddatum en -tijd wilt ophalen
String
Retourneert de einddatum-tijd voor de periode in ISO8601-datumtekenreeksnotatie (bijv. 15-06-15T12:00:00+10:00 uur)
convertToAdaptivePeriodStart ( start, end )
  • begin: tekenreeks - begindatum met ISO8601-notatie van de periode die moet worden geconverteerd
  • einde: tekenreeks - einddatum met ISO8601-notatie van de periode die moet worden geconverteerd
String
Retourneert het bijbehorende
Adaptive Planning
 Begindatum periode in ISO8601-datumtekenreeksnotatie (bijvoorbeeld 15-06-15T12:00:00+10:00 uur)
isWithinAdaptivePeriodRange ( start, end, periodFrom, periodEnd )
  • begin: tekenreeks - begindatum met ISO8601-notatie van de periode die moet worden geconverteerd
  • einde: tekenreeks - einddatum met ISO8601-notatie van de periode die moet worden geconverteerd
  • periodFrom: ai.calendar.period Periode van waaruit u wilt vergelijken
  • periodEnd: ai.calendar.period Periode waarmee u wilt vergelijken
Boole-waarde
Retourneert waar als zowel de opgegeven begin- als einddatum binnen de periode 2 van de periode van en tot vallen. Anders wordt false geretourneerd. (ex waar/onwaar)

Voorbeelden

Voorbeeld voor getNextPeriod( period [, options ] ) en 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());
}
Voorbeeld voor 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'
}
Voorbeeld voor 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

Een periode die onbewerkte of geaggregeerde gegevens kan bevatten.
Functies
Methode
Parameters
Retouren
Omschrijving
getValue()
tekenreeks
Retourneert de tekenreekswaarde van de periode die onderliggende kolommen die kunnen worden gebruikt om aan Kalenderfuncties door te geven als argumenten.
Voorbeeld

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