Difference between revisions of "Rest Arguments Builder"
(Created page with "Category:How to and other features in FXLData Please click here to read the article.") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:How to and other features in FXLData]] | [[Category:How to and other features in FXLData]] | ||
| + | The Wizard (available from the FXL Data tab) now includes a button to select the Rest Arguments Builder. Which can be used to specify additional SDMX query arguments that are not available through other options in the User Interface, such as round=2 for rounding numeric values. It is intended for the advanced user who needs finer control over the query behaviour. | ||
| − | [[ | + | [[File:Rest-argument-builder-button.png|1000-px]] |
| + | |||
| + | To use the Builder, select a dataflow and then click on the Builder button. | ||
| + | |||
| + | Click the button to access the builder. | ||
| + | |||
| + | [[File:Rest-argument-builder.png|1200-px]] | ||
| + | |||
| + | '''Apply Button''' | ||
| + | |||
| + | When the Apply button is pressed in the REST Arguments Builder, it performs the following action: | ||
| + | |||
| + | * It populates the REST Args box on the main Wizard screen with the constructed query string based on the enabled and valid arguments. | ||
| + | * It does not execute the FXLData function or retrieve any data at this stage. | ||
| + | * To actually run the query and fetch data into Excel, the user must return to the Wizard screen and press its Apply button. | ||
| + | This separation ensures the user can review and finalize their full query setup before triggering data retrieval. | ||
| + | |||
| + | ====Interaction with the Wizard==== | ||
| + | '''Existing Arguments''' | ||
| + | |||
| + | If the wizard already contains rest arguments when the Builder is opened, it will attempt to interpret and reconstruct the existing argument as accurately as possible. | ||
| + | |||
| + | [[File:Rest-arguments-box.png|1200-px]] | ||
| + | |||
| + | '''Arguments handled via the Wizard''' | ||
| + | |||
| + | * startperiod | ||
| + | * endperiod | ||
| + | * max | ||
| + | * time-format-frequency-id | ||
Latest revision as of 08:29, 15 June 2026
The Wizard (available from the FXL Data tab) now includes a button to select the Rest Arguments Builder. Which can be used to specify additional SDMX query arguments that are not available through other options in the User Interface, such as round=2 for rounding numeric values. It is intended for the advanced user who needs finer control over the query behaviour.
To use the Builder, select a dataflow and then click on the Builder button.
Click the button to access the builder.
Apply Button
When the Apply button is pressed in the REST Arguments Builder, it performs the following action:
- It populates the REST Args box on the main Wizard screen with the constructed query string based on the enabled and valid arguments.
- It does not execute the FXLData function or retrieve any data at this stage.
- To actually run the query and fetch data into Excel, the user must return to the Wizard screen and press its Apply button.
This separation ensures the user can review and finalize their full query setup before triggering data retrieval.
Interaction with the Wizard
Existing Arguments
If the wizard already contains rest arguments when the Builder is opened, it will attempt to interpret and reconstruct the existing argument as accurately as possible.
Arguments handled via the Wizard
- startperiod
- endperiod
- max
- time-format-frequency-id
