shorttermforecasthistorydates#

The function returns forecast run dates. This is a funtion without parameters that sends a get request to Hyperion V4 shorttermforecasthistorydates endpoint.

In the Formula Builder, select Hyperion 4.0, then choose the shorttermforecasthistorydates function from the Enter Function dropdown. Once selected, click Insert to automatically add the formula to Excel.

ShortTermForecastHistoryDates function selected in SynMax Formula Builder UI

Syntax#

=SMXH4.shorttermforecasthistorydates()

Output Parameters#

When executed, this function returns data to the Excel worksheet with all relevant fields and records.

Example of shorttermforecasthistorydates output generated in Excel

The Excel output includes the following data columns:

Field

Type

Description

Example

date_forecast_run

string

A date in MM/DD/YYYY format

“11/24/2021”


Errors#

Functions may return the following error messages:

Error

Description

#VALUE!

Input parameters are invalid or cannot be parsed.

#REF!

The function cannot retrieve data from the SynMaxax API due to a network or connectivity issue.

!!! EXCEPTION

Invalid input parameters. Make sure dates are enclosed in quotes. Check if the API key is valid. To know more about how to use an API key, please check the section on authentication.

#No Data

Input data is invalid or does not exist.

Note

You can also check the logs for more information on errors. You can access the logs by clicking on SynMax Commodities on the Excel ribbon and then clicking on Logs.