Adding parameters to dashboards and documents

You must have designer rights to add parameters to dashboards and documents.

You can add parameters to a dashboard or document that will prompt end users to fill in values before they can view the content online. The parameters filter the data, enabling users to view the same dashboard or document with different values to obtain varying results. For example, in an IT-related dashboard that displays components for Incident Category and Incident Priority, you could add a parameter for filtering those components by Incident Owner.

Incorporating parameters into your dashboards and documents is a two-step process—first add one or more parameters, then create one or more variable filter conditions that reference those parameters at the global or individual component level.

Tips for using parameters

You can add as many parameters as you want per dashboard or document, and you can create one or more global or component-level filters that reference each parameter.

When creating a new dashboard, the most efficient workflow for adding a parameter and global filter is to name the dashboard, select the layout, add the parameters, then create the variable filter condition(s) for the Default Filter. Do this before dragging and dropping any components onto the layout and saving the content. That way, each added component will have the filters already in place. This workflow applies to documents as well.

Global filters added after saving a dashboard or document only apply to new components that you drag and drop onto the display.

You can hover your mouse over the The information icon provides more details about an item. icon in a dashboard, document, or component header to get a quick view of all applied parameters and filters. With dashboards, it's also possible to view the applied parameter value in brackets after the parameter name. To do so, the Xtraction administrator needs to enable the Show Parameter Value option in the Administration > Settings dialog.

Xtraction enables you to export and schedule exports for dashboards and documents that contain parameters. You must save the content before doing so. For details about scheduling exports, see Scheduling exports.

Dashboard parameters

After adding a parameter, you'll need to create one or more global or component filters that reference the parameter.

Document parameters

After adding a parameter, you'll need to create one or more global or component filters that reference the parameter.

For additional guidance, see the Document Parameters video on the Ivanti community website.

Copying a parameter value into a document URL

You can copy a parameter value directly into the URL of a document. This enables you to share exactly what your target viewers want to see.