Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
ai.calendar

ai.calendar

Ein Zeitraum, der Rohdaten oder aggregierte Daten enthalten kann. Siehe: Schritte: Kalender ändern.

Funktionen

Methode
Parameter
Retouren
Beschreibung
getNextPeriod( Periode [, Optionen])
  • period: Zeichenfolgenwert der Periode, für die die nächste Zeitperiode abgerufen werden soll
  • Optionen: Objekt, das die Eigenschaft „Zahl“ der Art „Zahl“ und die Eigenschaft „Wert“ als Ganzzahl enthält. Beispiel: {type: 'number', value: 3}
ai.calendar.period
Gibt die nächste Periode in zurück
Adaptive Planning
 Kalender aus der Periode, die im Argument übergeben wurde
getPreviousPeriod( Periode [, Optionen ] )
  • period: Zeichenfolgenwert der Periode, für die die vorherige Zeitperiode abgerufen werden soll
  • Optionen: Objekt, das die Eigenschaft „Zahl“ der Art „Zahl“ und die Eigenschaft „Wert“ als Ganzzahl enthält. Beispiel: {type: 'number', value: 3}
ai.calendar.period
Gibt die vorherige Periode in zurück
Adaptive Planning
 Kalender aus der Periode, die im Argument übergeben wurde
getAvailablePeriodTypes( periodType )
  • periodType: Zeichenfolgenschichtcode für eine der verfügbaren Schichten.
Array<String>
Gibt ein Array von Schichtcodes (Art Period) zurück, die vom Kalender unterstützt werden, der in der Hierarchie weiter oben liegt als die übergebene Schicht (z. B. ['QuarterYear', 'HalfYear', 'Year'] ).
getPeriodStartDateTime( period )
  • period: ai.calendar.period Periode, für die Sie die Startzeit abrufen möchten
String
Gibt die Startzeit für die Periode im Datumszeichenfolgenformat nach ISO8601 zurück (z. B. '2015-06-15T12:00:00+10:00').
getPeriodEndDateTime( period )
  • period: ai.calendar.period Periode, für die Sie die Endzeit abrufen möchten
String
Gibt die Endzeit für die Periode im Datumszeichenfolgenformat nach ISO8601 zurück (z. B. '2015-06-15T12:00:00+10:00').
convertToAdaptivePeriodStart ( start, end )
  • start: Zeichenfolge mit ISO8601-Format für das Startdatum der zu konvertierenden Periode
  • end: Mit ISO8601 formatiertes Enddatum der zu konvertierenden Periode
String
Gibt den entsprechenden Wert zurück
Adaptive Planning
 Periodenstartdatum im Datumszeichenfolgenformat nach ISO8601 (z. B. 2015-06-15T12:00:00+10:00)
isWithinAdaptivePeriodRange ( start, end, periodFrom, periodEnd )
  • start: Zeichenfolge mit ISO8601-Format für das Startdatum der zu konvertierenden Periode
  • end: Mit ISO8601 formatiertes Enddatum der zu konvertierenden Periode
  • periodFrom: ai.calendar.period Periode, ab der Sie vergleichen möchten
  • periodEnd: ai.calendar.period Periode, mit der Sie vergleichen möchten
Boolesch
Gibt "true" zurück, wenn sowohl das angegebene Start- als auch das Enddatum in Periode "Von Periode" und "Bis Periode" liegen. Andernfalls wird „false“ zurückgegeben. (ex wahr/falsch)

Beispiele

Beispiel für getNextPeriod( period [, Optionen ] ) und getPeviousPeriod( Periode [, Optionen ] )

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());
}
Beispiel für konvertierenToAdaptivePeriodStart (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'
}
Beispiel für 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

Eine Zeitperiode, die Rohdaten oder aggregierte Daten enthalten kann.
Funktionen
Methode
Parameter
Retouren
Beschreibung
getValue()
Zeichenfolge
Gibt den Zeichenfolgenwert der Periode zurück, der untergeordnete Spalten sind, die zur Übergabe an Kalenderfunktionen als Argumente verwendet werden können.
Beispiel

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