What's new ⬇ Download Reportworq
⬇ Guide PDF

Global parameters#

Early release. This feature is in early release, so its screens and behavior may change. Tell us what you think with Send feedback. See Early release features and Send feedback.

A global parameter is a named value that lives at the workspace level instead of inside one job or one report. You define it once, such as the reporting year, the version, or the entity, and everything that needs it points at it. When the value changes, you change it in one place and every user of it follows on its next run.

This page is the reporting view of global parameters: what they are for next to data model variables, and the rules to know. Creating, renaming, and deleting them is covered in full in Global parameters in the User Guide.

When to use it. Use a global parameter when the same value is, or should be, identical across many jobs or many prompts. At Timberline Harvest Co. the Current Year global parameter is a subset of the time dimension in the planning model, and the Financial Statements job and the budget campaign read it as their Year. A data model variable such as {{Year}} can offer the same list of years as its choices. Use a plain variable default instead when only one view needs the value.

Where a global parameter is used#

Place How it uses the value
A distribution job's parameter The author binds the job's parameter to the global parameter on the job's Parameters step. The job then runs with the global value. See Parameterize a distribution job.
A data model variable's Choices A variable's prompt can take its list of values from any parameter type, Global Parameter included. The list a reader picks from then follows the global value.
A schedule or a run parameter Points at the global parameter the same way a job does.

A web report or a data model view does not read a global parameter directly. The value reaches a view only through a variable: a job or a prompt supplies the variable's value, and Reportworq fills it into the view's query as described in Data model variables.

Use a global parameter as a variable's choices#

  1. Open the data model, select the view, and select the Variables tab.
  2. On the variable's card, select Prompt.
  3. Under Choices, select Parameter list, then select Set the list…. The editor opens, titled Choices for {{Name}}.
  4. Set the parameter type to Global Parameter and pick the global parameter.
  5. Save the editor, then select Save Changes on the data model.
A variable's Choices set to a Global Parameter in the Choices for editor
A variable's Choices set to a Global Parameter in the Choices for editorTap or click the image to view it full screen

The card then reads List from: and the type. Select Edit the list… to change it.

Rules to know#

Going deeper. For the full steps to create and change a global parameter, and the Used In list, see Global parameters. For the parameter types a global parameter can hold, see Parameters reference. To see Timberline's Current Year at work, see How Timberline rolls the reporting year forward.

Feedback on this page

Comments, questions, requests, or something missing or unclear? Email us - the page you are on is filled in for you.

Email feedback on this page

Or write to support@reportworq.com directly.