RunInterfaceService (Export) - Start Bucket at cycle period level

The RunInterfaceService (Export) - Start Bucket macro is used to run an interface service that exports calendar data from the first (oldest) period in the cycle period horizon. This macro can be used to retrieve all calendar buckets till the end of the horizon. Data is exported for the base periods regardless of the values specified for the Horizon Level, and Number of Periods parameters.

The value for the Command field must be specified in this format:

RunInterfaceService(Interface Service Name, "Export", "Start Bucket", [Period Label], [Number of periods], [Horizon Level], [Data Source])
Note: The optional parameters are specified in [ ].
This table lists the parameters used to execute the RunInterfaceService (Export) – Start Bucket macro:
Parameter Name Description
Interface Service Name The name of the interface service that is run.
Direction The direction of the data flow. The value must be set to Export.
Note: 
  • Calendar interface service from the context of a cycle period is supported only when this value is set to Export.
  • By default, this value is set to Export.
Calendar Type The period for which the data is exported.
Note: By default, this value is set to Start Bucket.
Number of Periods The number of horizon level periods to be exported. If the horizon level is not equal to the Calendar Level to store scenario values or if the Telescopic option is enabled, all the base buckets within the specified range of selected periods are exported. Possible values:
  • Null or Zero: All base periods till the end of the cycle period horizon are exported.
  • >=1: All the base periods that belong to [Number Periods] of [Horizon Level] buckets, starting from the specified Start Bucket are exported.

For example, Calendar Level to Store Scenario values = Weeks, Calendar Type = "Start Bucket", Horizon Level = "Months", Number of Periods = 3. This exports the base data for the first 3 months from the cycle period horizon.
Horizon Level The calendar horizon level to be used by [Number of periods] for export.
Note: If this value is not specified, the number of periods are based on the calendar level to store scenario values.
Data Source An alternate data source to execute the Interface Service.
Note: The type of the data source must be the same as defined in the Interface Service.

This table lists the examples of the RunInterfaceService (Export) - Start Bucket macro:

Requirement Syntax
Export 10 months of base calendar periods from the oldest or first bucket in the cycle horizon. RunInterfaceService("My AP Calendar","Export","Start Bucket","10","Months","")
Related topics