RunInterfaceService (Export) at cycle period level

The RunInterfaceService (Export) macro is used to run an interface service that exports calendar data in the context of a cycle period.

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) macro:
Parameter Name Description
Interface Service Name The name of the interface service that is run.
Direction The direction of the data flow.
Note: This value is set to ‘Export’ when the macro is created.
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 start period for exporting the data. 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.
Num Periods The number of horizon level periods to be exported. If the horizon level is not equal to the Calendar Level to store plans or if the Telescopic option is enabled, all the base buckets within the specified range of selected periods are exported. Possible values:
  • Null: All base periods till the end of the cycle period horizon are exported.
  • 0: All the base buckets that belong to the period specified in Period Label are exported, if Calendar Type is set to ‘Bucket.
  • >=1: All the base periods that 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 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) 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","")
Export base calendar periods from the current planning period to the cycle period horizon at the calendar level, to store scenario values (no telescopic periods are defined). RunInterfaceService("My AP Calendar","Export","Current Bucket","")
Export base calendar periods starting from the current planning period corresponding to 6 buckets at the calendar level, to store scenario values. RunInterfaceService("My AP Calendar","Export","Current Bucket","6")
Export base calendar periods from the current planning period to the cycle period horizon at the calendar level to store scenario values (no telescopic periods defined). RunInterfaceService("My AP Calendar","Export","Current Bucket","","","Master SCV")
Export base calendar periods from FY14 M12 period corresponding to 10 periods at the calendar level to store scenario values. RunInterfaceService("My AP Calendar","Export","Bucket","FY14 M12","10")
Export base calendar periods, starting from FY14 M12 period corresponding to 10 months. RunInterfaceService("My AP Calendar","Export","Bucket","FY14 M12","10", "Months")

Export 1 month of telescopic, base buckets of calendar data from the current planning period. For example, "FY14 M12", where the Telescopic option is enabled for the cycle. Cycle calendar level to store plans = 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","Current Bucket","1","Months").
Export base calendar periods for 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 period FY 2020 corresponding to 10 months. RunInterfaceService("My AP Calendar","Export","Bucket","FY2020","10", "Months","")