About URL Query Strings

You can reference a DivePort page by its URL, which includes the page UUID. Every DivePort page has a UUID.

Syntax

https://<server>/<diveport>#project=<project_name>&page=<page_UUID>

Where:

<server> is your DiveLine server.

<diveport> is your DivePort portal.

#project=<project_name> is the Workbench project.

& is a seperator

page=<page_UUID> is the UUID of your DivePort page. In addition to appearing in the browser address, the UUID is listed in logs, scan environment, and the portal dump tables.

URL Parameters

Parameter	Description
area	Specifies the DiveBook Area.
dive-allvalues-key	Defines the QuickView in the query string set to All Values. Syntax: `dive-allvalues-key=<QuickView name>`
dive-encoding	Indicates that the URL includes Unicode characters. Syntax: `dive-encoding=fix-<type>` Example: `dive-encoding=fix-utf8`.
dive-key	Defines the QuickView as part of a query string. Syntax: `dive-key=<QuickView Dimension>`
dive-value	Specifies the QuickView value as part of a query string. Syntax: `dive-value=<QuickView value>` NOTE: When specifying a date for a special Measure Factory QuickView, you must use a full date string, such as 2023/04/01.
embed	Renders the page content without headers and navigation components, and suppresses the message of the day. Syntax: `embed=true`. Or, to embed the URL parameter to display the My Library navigation bar, `embed=mylibrary`. See also Embedding DivePort Pages.
factory	Specifies the factory. Syntax: `factory=<factory_name>`
file	Specifies a marker or Spectre Dive file.
locale	Specifies the interface language. Syntax: `locale=<DivePort_UI_language>`
measure	Specifies the measure being used. Syntax: `measure=<measure_name>`
page	Specifies the DivePort page UUID. Syntax: `page=<page_uuid>`
password	Specifies a dlcgi-generated single-use password when login credentials are used with web server authentication. Syntax: `password=<DiveLine_password>`
project	Specifies the DivePort project. Syntax: `project=<project_name>`
topic	Specifies the DiveBook Topic.
username	Specifies the DiveLine username when login credentials are used with web server authentication. Syntax: `logon?username=<DiveLine_username>`

NOTE: The project, file, area, and topic parameters can be specified as part of the URL fragment. This means that they appear after the # character. These parameters are automatically added to the URL when NetDiver is used. Therefore, a user can bookmark a NetDiver page, and use that bookmark to return to the same file or DiveBook topic.

Specifying QuickView Values

You can add a query string to the URL to specify QuickView values.

Syntax

https://<server>/<diveport>#project=<project_name>&page=<page_UUID>&dive-key=<QuickView Dimension>&dive-value=<QuickView Value>

Where:

https://<server>/<diveport> is your DivePort server.

#project=<project_name>is the Workbench project.

& is a separator.

page=<page_UUID> is the UU ID of your DivePort page.

& is a separator.

dive-key=<QuickView Dimension> defines the QuickView.

& is a separator.

dive-value=<QuickView Value> defines the QuickView value.

Multiple dive-key/dive-value pairs can be specified by using an ampersand & to separate each parameter pair. For example:

https://companyabc:8443/diveport#page=737ab8df-a951-4b5e-b51e-04cc55ff0752&dive-key=Salesperson&dive-value=Atkins&dive-key=Salesperson&dive-value=Bailey&dive-key=Salesperson&dive-value=Baker

IMPORTANT: URLs with query strings cannot contain spaces. If the dive-key or dive-value contains spaces, use the URL-encoded space character %20 in place of the space.

Time Range Start and Time Range End QuickViews

You can set Time Range Start and Time Range End QuickViews via URL by using the QuickView label as the dive-key, and the full date as the dive-value. The dive-value must conform to the following requirements:

The full date, including year, month, and day, must be provided in the format yyyy/mm/dd. This is true even if the QuickView on the target page is rolled up to only show months, quarters, or years.
A forward slash must be used as the separator.
The first day of a rollup period must be provided for Time Range Start, and the last day must be provided for Time Range End.

For example, if a page has user-defined Time Range Start and Time Range End QuickViews with default labels and a rollup of months, you could use the following URL to display data for December 2023:

`https://<server>/<diveport>#project=<project_name>&page=<page_UUID>&dive-key=Time%20Range%20Start&dive-value=2023/12/01&dive-key=Time%20Range%20End&dive-value=2023/12/31`