AX1744

Navigate to Report command

Use the Navigate to Report command to open an browser-based Axiom file from within an Axiom form. This can be used as an alternative to opening files via a generated hyperlink. The command can be used to open other Axiom forms, web reports, or Axiom Intelligence reportsReports that provide business intelligence-style reporting, with the ability to perform ad hoc analysis and explore your data. Axiom Intelligence reporting is currently only available to a subset of products. Consult your product documentation for more information..

Can be used in

  • Axiom forms

When the Navigate to Report command is selected from the Command Library as the shortcut target, it displays as command://NavigateToReport.

Shortcut parameters

This command uses the following shortcut parameters:

Item Description

Document

The document to open when the command is executed. The document must be a browser-based file such as an Axiom form or a web report. Spreadsheet Axiom files cannot be opened using this command.

You can specify the file using either of the following options.

  • Click the [...] button to open Axiom Explorer and browse to select a file. The path for the selected file will be written as a document shortcut.

    OR

  • Enter a cell reference in brackets to read the document path from that cell. For example: [Variables!J24]

    If you use this option, the referenced cell should contain a full path to the file using document shortcut syntax. For example:

    document://\Axiom\Reports Library\Budget Reports\Budget Comparison.xlsx

Filter

Defines a filter to apply to the document. Only applies when the target document is an Axiom form.

You can type a filter criteria statement into the Filter box, or you can enter a cell reference in brackets to read the filter from that cell. For example: [Variables!J24]. If you use this option, the referenced cell should contain a valid filter criteria statement.

The filter is applied as a sheet filter to all sheets in the form source file, so that all queries are affected by the filter. The filter can be displayed in the form by using the function GetCurrentValue("QuickFilter").

Open in New Window

By default, the specified document opens in the current window, replacing the current document. If this option is enabled, then the document opens in a new window.

Processing step

Specifies when the command will be executed during the Axiom form update process.

This option is set to Form - After Updating Values and cannot be changed. For more information, see Timing of command execution and Axiom form update process.

If the target document is opened in the same window as the current document, then the form update process does not proceed beyond the After Updating Values step. If the target document is opened in a new window, the original form will continue and complete its update cycle.

Document variables

You can define one or more optional Document Variables to pass to the target document. The values for these variables can be used to impact the target document in some way, such as to filter a query or to display in header text.

To define document variables:

  • Click the plus button to add a new variable/value pair to the Document Values section.

  • In the left-hand box, type the name of the variable. For example: Account.

  • In the right-hand box, type the value to be used for this variable, or enter a cell reference in brackets to read the value from that cell. For example: [Variables!J24].

To use the variable value in the target document, that document must have a GetDocumentInfo function to return the variable value. For example, if the variable is named Account, the function GetDocumentInfo("Variable","Account") will return the variable value passed in from the parent form. There is one exception: if you are opening a web report with a Year refresh variable, you can use the reserved document variable ReportYear to set the initial value of the refresh variable.

This section only applies when the target document is an Axiom form, except when defining the reserved ReportYear variable for a web report.

Visibility

In Axiom forms, the command used does not impact whether the button is visible or enabled.

Remarks