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. This macro is executed at cycle period level.
This table lists the parameters used to execute the RunInterfaceService (Export) macro:
Parameter 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.
The value for the Command field must be specified in this format: RunInterfaceService (Interface Service Name, Direction, [Calendar Type], [Period Label], [Num Periods], [Horizon Level]).
Note: The optional Parameters are specified in [ ].
Table 1. Example
Requirement Parameter
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 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").

Validation and error messages

This table lists the Cycle Period status and the related validation messages:
Cycle Period status Scenario status Can Execute? Validation message
Pending N/A No Cannot run macro {0} because Cycle Period has status "Pending".
Running Any Yes N/A
Completed Any Yes N/A
Aborted Any Yes N/A
Paused Any Yes N/A
Archived Any No Cannot run macro {0} because Cycle Period has status "Archived"
The calendar data is exported in the context of specified cycle period on successful validation and execution of the macro. If the validation fails, the macro is aborted, and the related error message is displayed. This table lists the error messages displayed for various validation failures:
Validation Condition/Rules Error Message
Check that the passed interface service is valid. Interface Service "{0}" cannot be found
If the Direction does not match the Interface Direction of the selected Interface Service, the macro is not executed. Direction parameter {0} does not match the direction of the selected Interface Service "{1}".
If the calendar level is not higher or equal to the Calendar level for storing scenario values, a warning message is displayed, and the Import process is aborted. Calendar Level {0} is below the Calendar level {1} for storing scenario values.
RunInterfaceService in cycle period context must be from a cycle period with Running, Paused, Completed, Aborted status. Cannot execute RunInterfaceService for a cycle period with status {0}.
If the selected Interface Service data entity is not applicable to the current macro context, the macro is not executed, that is, RunInterfaceService can only run interfaces of data entity = calendar in a cycle period context. Interface Service {0} does not match the data entity required for a cycle period macro.
When executing RunInterfaceService in a cycle period context, the selected interface service must refer to a calendar that matches the calendar of the current cycle period. Else the macro is not executed. Calendar referenced in Interface Service {0} does not match the calendar of the current cycle period
When executing RunInterfaceService for export, check that the horizon level, if specified, is valid. Horizon Level {0} cannot be found.
When executing RunInterfaceService for export, check that the horizon level, if specified, is at or above Calendar Level to store plans (if the Telescopic option is not enabled). Horizon Level {0} is below the Calendar level {1} for storing scenario values