RunInterfaceService (Export) - Start Bucket at scenario level

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

For executing the macro, the value for the Command field must be specified in this format:

RunInterfaceService(Interface Service Name, "Export", [Item Hierarchy Node], [Location Hierarchy Node], "Start Bucket", [Number of periods], [Horizon Level], [Filter], [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 values must be set to Export.
Item Hierarchy Node	The item to export. Note: If the value is not specified, all items are exported.
Location Hierarchy Node	The location to export. Note: If the value is not specified, all locations are exported.
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 export. 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 the base periods till the end of the cycle period horizon are exported. >=1: All base periods belong to [Number of Periods] of [Horizon Level] buckets, starting from the specified Start Period are exported. For example, Calendar Level to Store Scenario Values = Weeks, First period of horizon= FY20 M08, Horizon Level = "Months", Number of Periods = 3. This exports the base data for the first 3 months starting from FY20 M08 (12 weeks of data).
Horizon Level	The calendar horizon level to be used by [number of periods] for exporting. Note: If the value is not specified, the number of periods are based on the calendar level to store scenario values.
Filter	The filter condition is used to determine the item and location selection at period constant (PCONST). Only the base item and location data of the selected items and locations that meet the specified criteria, is exported. See, Filter Parameter syntax. Note: If the value is not specified, the filter condition is not considered for the item and location.
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 All items at all locations for all periods in the cycle period horizon; starting from the first (oldest) historic period.	RunInterfaceService("Export Scenario file","Export","","","Start Bucket","","","","")
Export All items at all locations for 7 periods at calendar level to store scenario values; starting from the first (oldest) period in the cycle period horizon. If the cycle horizon is specified as historical = 6 and future = 6. Results is 6 historical periods and 1 future period in the export process (no telescopic buckets are defined).	RunInterfaceService("Export Scenario file","Export","","","Start Bucket","7","","","")