RunInterfaceService (Export) - Bucket at cycle period level

The RunInterfaceService (Export) – Bucket macro is used to run an interface service that exports calendar data for the specified Period Label. Data is exported for the base periods regardless of the values specified for the Period Label, Horizon Level, and Number of Periods parameters.

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

RunInterfaceService(Interface Service Name, "Export", "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) – 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 Bucket.
Period Label The period containing the data to export. This supports rolling period nodes.
Note: 
  • This field is applicable only when Calendar Type is set to Bucket.
  • If the value is not specified, the current planning period is considered.
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 belonging to the period specified in the Period Label parameter are exported.
  • >=1: All the base periods that belong to [Number of Periods] of [Horizon Level] buckets within the specified period label are exported.

For example, Calendar Level to Store = Weeks, Calendar Type = "Bucket", Period Label = "FY 2017", Horizon Level = "Months", Num Periods = 3. This exports the base data for the first 3 months of the FY 2017 (12 weeks) period label.
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) - Bucket macro:

Requirement Syntax
Export base calendar periods for the period FY 2020 corresponding to 10 periods at the calendar level to store scenario values. RunInterfaceService("My AP Calendar","Export","Bucket","FY 2020","10","","")
Export base calendar periods starting from the first period in FY 2020 corresponding to 10 months. RunInterfaceService("My AP Calendar","Export","Bucket","FY 2020","10", "Months","")