Starting the application with parameters

This document describes the construction of parameterized query strings for starting the application FactPages. It assumes a basic understanding of web site parameters and their usage. Please notice: Allthough we do our best to keep parameter names once they have been established, the parameter naems described in this documnet may change without notice.

Background

The standard way to use the application is to enter or paste its URL - http://factpages.npd.no/factpages/Default.aspx - in the web browser’s address bar, and to navigate to the desired information by user clicks. Alternatively, the application can be started with parameters, in order to access specific information directly. Examples of access sources are applications and office automation software related documents (Outlook, Word, Excel, Power point).

Obtaining the query string for a specific report

  • Navigate to the report in the standard way (by clicking).
  • Click the menu option “Show link”.
  • You can now copy the query string for further usage.
This is the most convenient and common way to create a link to a given report. The following sections give detailed descriptions of the available parameters, and are intended for the especially interested.

Using parameters

  • To indicate the presence of parameters, a question mark (?) must be added after the application’s URL. The question mark is to be followed by one or more parameters.
  • Each parameter has a name and a value which are separated by an equal sign (=).
  • Parameters (including names and values) are separated by ampersands (&).
  • Parameter names are case sensitive and to be entered using lower case.
  • Parameter values are case sensitive and to be entered using PascalCasing (capital first letters).

Validation

When invalid parameter names or values are provided, the application will respond with instructive error messages.

Parameter Names

Legal parameter names are: culture, nav1, nav2, nav3, menu, format. Nav in nav1, nav2 and nav3 is short for "navigation". When entered as parameters they produce the same result as a user click on the corresponding control in the user interface. See figure 1. For illegal parameter names the application will respond with a message informing that one or more illegal parameter names are present in the query string.

Parameter Values

For illegal parameter values, the application will respond with an appropriate error message and a list of values allowed in the current context. Legal parameter values can be identified by trial and failure as described below.

Identifying legal parameter values by trial and failure

You can identify the legal values for any parameter or parameter section (sections apply to Nav2 only) as follows:
  1. Make sure the first part of the parameter string is correct, by entering it into the address line, for instance http://factpages.npd.no/factpages/Default.aspx?culture=en&nav1=company
  1. Press “Enter” and verify that the application responds as expected.
  1. Add the parameter you want to find the legal values for, followed by an equal sign and a value which is known to be illegal, e.g. like this:

    http://factpages.npd.no/factpages/Default.aspx?culture=en&nav1=company&nav2=xxx
This will display an error message and list of legal values for the topical tab and tree view level.

Culture

Description
he Culture parameter specifies the culture/language in which to display information.

Legal name
culture

Legal values
nb-no, en

Default value if parameter is not included
The web browser’s default language if this is set to Norwegian or English, English otherwise. Examples
http://factpages.npd.no/factpages/Default.aspx?culture=en
http://factpages.npd.no/factpages/Default.aspx?culture=nb-no

Nav1

Description
Specifies the tab for which to display information.

Legal name
nav1

Legal values
wellbore, license, field, company, seis_acquisition, facility, tuf, discovery

Examples
http://factpages.npd.no/factpages/Default.aspx?culture=en&nav1=company
http://factpages.npd.no/factpages/Default.aspx?culture=en&nav1=seis_acquisition

Nav2

Legal name
nav2

Description
Specifies the selection in the tree view control to the left on the screen.
  • The form of this parameter is: <Section1>|< Section2>|< Section3>
  • Each section represents the corresponding tree view level.
  • Sections (i.e. tree view levels) are delimited by “|”.
Legal values
Legal values for Nav2 parameters vary with context and are therefore not listed here.
You can identify legal values as described in the section Identifying legal parameter values by trial and failure.

Example
http://factpages.npd.no/factpages/Default.aspx?culture=en&nav1=seis_acquisition&nav2=PageView|ByVessel|Finished|Acergy%20Viking&nav3=7146

Note 1: Spaces in section 3may have to be represented by the sequence %20 unless pasted directly into the browsers URL filed.
Note 2: There is an underscore in tab seis_acquisition which is camouflaged by the link underline in the example above.

Nav3

Description
Specifies the NpdId for which to display information. Only applicable for PageView

Legal name
nav3

Legal vaues
All legal values of NPDID for the tab in question

Example
http://factpages.npd.no/factpages/Default.aspx?culture=en&nav1=seis_acquisition&nav2=PageView|ByVessel|Finished|Acergy%20Viking&nav3=7146

Menu

Legal name
menu

Description
Specify whether to display the report within the application’s navigation menu, or as a standalone report.

Legal values
Yes, No

Default value if parameter is not included
Yes

Example with application menus

http://factpages.npd.no/factpages/Default.aspx?culture=en&nav1=company&nav2=PageView|CurrentOperators&nav3=562
Example without application menus
To display a report only (without displaying the application menus) the parameter menu must be set to No and the report format must be specified):

http://factpages.npd.no/factpages/Default.aspx?culture=en&nav1=company&nav2=PageView|CurrentOperators&nav3=562&menu=No&format=PDF

Format

Legal name
format

Description
Specifies the export format for a standalone report, i.e. for a repoprt displayed without the application menus.
Assumes that the parameter “Menu” is present, and has the value “No”.

Legal values for PageView
PDF

Legal values for TableView
CSV, EXCEL, XML

Examples
http://factpages.npd.no/factpages/Default.aspx?culture=nb-no&nav1=wellbore&nav2=PageView|Shallow&nav3=6148&menu=No&format=PDF

http://factpages.npd.no/factpages/default.aspx?culture=nb-no&nav1=wellbore&nav2=TableView|Exploration|CurrentYear&menu=No&format=EXCEL