Hitachi

JP1 Version 12 JP1/Navigation Platform Setup and Operations Guide


2.1.4 Parameters that can be specified in basic URLs

This subsection describes the parameters you can specify in basic URLs and the format to use when specifying these parameters.

Organization of this subsection

(1) Format of parameters specifiable in basic URLs

Use the following format when specifying parameters in basic URLs:

basic-URL?parameter-name-1=parameter-value[[&parameter-name-2=parameter-value]...]

Separate the basic URL and the first parameter with a question mark (?), and separate each subsequent parameter with an ampersand (&). You can specify multiple parameters by connecting them with ampersands (&) in this way.

By adding parameters to the end of the basic URL, you can control which window appears when a user logs in to Navigation Platform. You can also use parameters to integrate plugins and custom windows.

Under the following circumstances, because the basic URL already contains parameters, specify an ampersand (&) instead of a question mark (?) as the character that connects the basic URL to its parameters:

(2) List of parameters specifiable in basic URLs

The table below lists the parameters you can specify in a basic URL. The parameters you can specify depend on the window you are accessing.

Table 2‒1: Parameters specifiable in basic URLs

Parameter name

Parameter value

Description

Whether parameter can be used

Operational Content Execution Window

Operational Content Editing Window

Custom window (new window)

contentId

Operational Content ID

Directly opens the Operational Content associated with the specified ID. Whether the Operational Content opens as editable or read-only depends on the status of the specified Operational Content.

Operational Content IDs are case sensitive. You can acquire Operational Content IDs by using a menu command in the Operational Content Editing Window.

For details about the menus in the Operational Content Editing Window, see the manual JP1/Navigation Platform Content Editing Guide.

If the Get URL menu appears in the Operational Content Execution Window, you can acquire a URL with the Operational Content ID already set in the contentId parameter. To display the Get URL menu in the Operational Content Execution Window, the property ucnp.base.server.geturl.link.display must be set to true in the user property file (ucnp_user.properties). For details about the ucnp_user.properties user property file, see 8.5 Specifying settings in the user property file (ucnp_user.properties).

Y

Y

N

open_editor

true

Directly opens the Operational Content Editing Window after login.

If you omit this parameter, the Operational Content Execution Window appears after login. The user can then switch to the Operational Content Editing Window by clicking the Editing Window View menu command.

N

Y

N

start_editor

true

Displays the Editing Window View and Execution Window View menu commands. When this parameter is specified, the user can switch between the Operational Content Execution Window and the Operational Content Editing Window.

You cannot use this parameter in the execution environment.

Y

Y

N

ucnpCloseBtn#

logout

Specifies the behavior of the button used to exit Navigation Platform windows.

If you specify logout, a Logout button is displayed that logs you out and returns you to the login window.

Y

Y

N

ucnpOptions

Values used by a User Plugin (I/O Plugin or Suspend/Resume Plugin)

This parameter provides values to be used by plugins. If you need to use a character in a parameter value that cannot be used in a URI, specify the value as a URL-encoded string. You can find out the values a plugin uses by contacting the user who developed the plugin.

For details about how the values of this parameter are used in a plugin, see the manual JP1/Navigation Platform Development Guide.

The following describes the characters you can specify in a value of this parameter, and the maximum length of the value:

Specifiable characters

ASCII characters (excluding characters with the ASCII codes 0x00 to 0x1F and 0x7F).

Maximum length of parameter value

Character strings (or the length of the URL-encoded character string) must not exceed 1,024 bytes. If a character string exceeds 1,024 bytes in length, the message KDCZ10306-W is output to the trace file and characters beyond 1,024 bytes are deemed invalid.

Y

N

N

ucnpUserData

Values used by a custom window (new window)

This parameter provides values for use by custom windows (new windows).

You can find out the values used by the new window by contacting the user who developed the window. For details about how the values of this parameter are used in the new window, see the manual JP1/Navigation Platform Development Guide.

N

N

Y

ucnpUserPageId

Name of Custom Window Plugin

Displays a custom window (new window) after login.

N

N

Y

Legend:

Y: Can be used.

N: Cannot be used.

#
  • If you use this parameter when true is specified for the property ucnp.base.client.confirm.page.unload.enable in the user property file (ucnp_user.properties), make sure that you also review the contents of message KDCZ00146-W in the user message properties file (ucnp_message_user.properties). For details about the user message properties file (ucnp_message_user.properties), see 8.6 Specifying settings in the user message properties file (ucnp_message_user.properties).

(3) Example of URL with parameters specified

The following is an example of a URL that combines a number of parameters:

http://host-name:port-number/ucnpBase/portal/screen/TitlePortlet/portlet/ucnp/pane/-44Ob44O844Og55S76Z2i/layout_id/default?open_editor=true&ucnpCloseBtn=logout&contentId=Operational-Content-ID