RunInterfaceService (Export) - Current Bucket at scenario level

The RunInterfaceService (Export) – Current Bucket macro is used to run an interface service that exports plan data from the current planning period. 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], "Current 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) - Current 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 of the item 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 Current 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 [number of periods] of [horizon level] range 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 current planning period are exported.

For example, Calendar Level to Store Scenario Values = Part Weeks, Current Period = FY19 M07, Current Planning period = FY19 W28A (planning period is moved on one week), Horizon Level = "Months", Number of Periods = 3. This exports the base data for the first 3 months starting from FY19 W28A (12 weeks of data).

Note: The first available planning period (FY19 W28A) is not exported within the FY19 M07 current period.
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) - Current Bucket macro:

Requirement Syntax
Export All items at all locations from the current planning period for the cycle period horizon. RunInterfaceService("Export Scenario file","Export","","","Current Bucket","","","","")
Export GOO items at all locations for the current planning period. For example, "FY10 M03" for 1 month period (if cycle calendar level to store scenario values = months). RunInterfaceService("Export Scenario file","Export","GOO","","Current Bucket","1","","","").
Export All items at US locations from the current scenario for 52 weekly periods (if cycle calendar level to store scenario values = weeks). RunInterfaceService("Export Scenario file","Export","","US","Current Bucket","52","","","").
Export GOO items at all locations where 0 < [DPLS_FUNITS] for pconst. For example, "FY10 M03" for 1 month period (if cycle calendar level to store scenario values = months and no telescopic buckets defined). RunInterfaceService("Export Scenario file","Export","GOO","","Current Bucket","1","", "0 < [DPLS_FUNITS]","").
Export GOO items at all locations for the current planning period. For example, "FY10 M03" for 1 Month of weekly periods (cycle calendar level to store scenario values = Weeks and no telescopic buckets defined). RunInterfaceService("Export Scenario file","Export","GOO","","Current Bucket","1","Months","","").
Export GOO items at all locations for the current planning period. For example, "FY10 M03" for 1 Month where telescopic is enabled for the cycle. Cycle calendar level to store scenario values = Weeks, telescopic periods for cycle = 7 days, with future horizon = 8 weeks. Result is 1 month of telescopic, base buckets, that is, 7 daily buckets, 3 weekly buckets. RunInterfaceService("Export Scenario file","Export","GOO","","Current Bucket","1","Months","","").
Export All items at all locations from the current planning period for the cycle period horizon to the Master SCV Data Source. RunInterfaceService("Export Scenario file","Export","","","Current Bucket","",,"","","Master SCV")
Related topics