RunInterfaceService (Export) at scenario level

The RunInterfaceService (Export) macro is used to run an interface service that exports plan data for the current scenario. This macro is executed at scenario level.

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) 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. Possible values:
  • Bucket: The period specified in ‘Period Label’ and uses [Period Label], [Num Periods] and [Horizon Level] parameters.
  • Current Bucket: The current planning period and uses [Num Periods] and [Horizon Level] only.
  • Start Bucket: The first (oldest) period in the cycle period horizon and can be used to retrieve all buckets. The [Num Periods] and [Horizon Level] is used.
Note: If the value is not specified, Start Bucket period is considered.
Period Label The cycle period to export. This supports rolling period nodes.
Note: 
  • This field is applicable when Calendar Type is set to Bucket.
  • If the value is not specified, current planning period is considered.
Num 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: All the base periods till the end of the cycle period horizon are exported.
  • 0: All the base buckets belong to the period specified in Period Label (if Calendar Type = ‘Bucket’) are exported.
  • • >=1: All base periods belong to [Num Periods] of Horizon Level buckets, starting from the specified Start Period are exported.
Horizon Level The calendar horizon level to be used by [num 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 used to determine the item and location selection at period constant (PCONST). Only the relevant data, of the selected items and locations that meet the specified criteria, is exported. See, Filter Parameter syntax.
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 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 duration of the calendar bucket ‘Current Year’ at the calendar level to store scenario values (no telescopic buckets are defined). RunInterfaceService("Export Scenario file","Export","GOO","","Bucket","Current Year","0")
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 cycle period for 52 weekly periods (if cycle calendar level to store scenario values = weeks). RunInterfaceService("Export Scenario file","Export","","US","Current Bucket","52").
Export All items at all locations from calendar bucket "FY10 M03" for 9 month periods (if cycle calendar level to store scenario values = months). RunInterfaceService("Export Scenario file","Export","","","Bucket","FY10 M03","9")
Export All items at all locations for all periods in the cycle period horizon; starting from first (oldest) historic period. RunInterfaceService("Export Scenario file","Export","","","","")
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")
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 are defined). RunInterfaceService("Export Scenario file","Export","GOO","","Current Bucket","1","", "0 < [DPLS_FUNITS]").
Export All items at all locations from calendar bucket "FY10 M03" for 3 Months of weekly periods (if cycle calendar level to store scenario values = weeks). RunInterfaceService("Export Scenario file","Export","","","Bucket","FY10 M03","3", "Months").
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 are 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 one 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 one 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 for the cycle period horizon from the current planning period to the Master SCV Data Source. RunInterfaceService("Export Scenario file","Export","","","Current Bucket","",,"","","Master SCV")