A.5 Configuring direct-access URLs
You can use the direct-access URL function to quickly access a specific window after logging in.
- Organization of this subsection
(1) Format and parameters of direct-access URLs
A direct-access URL consists of a launch URL that specifies the window to display, and query parameters that specify the information to display in the window. The launch URL and query parameters are delimited by a question mark (?).
The character string that prefixes the direct-access URL depends on the communication method used between the Web browser and the JP1/AO server. The examples below show the URLs for an HTTP connection. For HTTPS connections, interpret http as https where appropriate.
|
![[Figure]](GRAPHICS/F0000027.GIF)
If you specify an invalid launch URL, an error output by the Web client or Web server appears instead of the Login window.
If you specify a query parameter incorrectly, an error message appears in the Login window.
The formats of the direct-access URLs for each dialog box are as follows:
For the Service Definition dialog box (editing)
http://host-name:port-number/Automation/launcher/ConfigService?sg=service-group-name-of-service&sn=service-name#1
For the Submit Service dialog box
http://host-name:port-number/Automation/launcher/SubmitTask?sg=service-group-name-of-service&sn=service-name&tn=task-name&td=task-description&pr_property-key=property-value#1#2
- #1
If you use rg instead of sg to indicate the service group name, the window will still display correctly. The rg parameter was used in JP1/AO version 10-52 and earlier.
- #2
You can specify pr_property-key=property-value multiple times by separating each parameter with an ampersand (&), in the format &pr_property-key-1=property-value-1&pr_property-key-2=property-value-2.
For the Task Details dialog box
http://host-name:port-number/Automation/launcher/TaskDetails?task_id=task-ID
Parameters of direct-access URLs
The following table shows the parameters of direct-access URLs:
No. |
Component |
Parameter |
Description |
|---|---|---|---|
1 |
Launch URL |
host-name |
Specifies the host name or IP address of the JP1/AO server. |
2 |
port-number |
Specifies the port number of the JP1/AO Web server. |
|
3 |
Query parameters |
sg=service-group-name-of-service |
Specifies the name of the service group that contains the service you want to display, as a URL-encoded#1 character string. The service group of a service is shown in the JP1/AO interface. You can also identify the service group from the value in the Service Group column of the file output by the command that outputs a services list (listservices). You can specify rg instead of sg. The rg parameter was used in JP1/AO version 10-52 and earlier. |
4 |
sn=service-name |
Specify the name of the service you want to display, as a URL-encoded #1 character string (using the UTF-8 character set). The name of a service appears in the JP1/AO interface. You can also identify the service name from the value in the Service Name column of the file output by the command that outputs a services list (listservices). |
|
5 |
task_id=task-ID |
Specify the ID of the task you want to display. The ID of a task appears in the JP1/AO interface. You can also identify the task ID from the value in the TaskID column of the file output by the command that outputs a tasks list (listtasks). |
|
6 |
tn=task-name#2 |
Specify the task name you want to enter, as a URL-encoded #1 character string (UTF-8). You can specify a maximum of 128 characters. |
|
7 |
td=task-description#2 |
Specify the task description you want to enter, as a URL-encoded#1 character string (UTF-8). You can specify a maximum of 1,024 characters. |
|
8 |
pr_property-key=property-value#2 |
Specify the property keys and values you want to enter. You can specify this parameter multiple times by using an ampersand as a delimiting character, in the format &pr_property-key-1=property-value-1&pr_property-key-2=property-value-2. Specify the property values as URL-encoded#1 character strings (UTF-8). The property values specified in a direct-access URL only take effect when the URL displays the Submit Service dialog box. They do not apply to the Service Definition dialog box or Set Service Share Property dialog box. |
- #1
URL encoding is the process of converting characters that are not permitted in URLs to characters that can be interpreted by a Web browser.
An example of a URL used to display the Service Definition dialog box (editing) is shown below.
- Service settings
Host name: host01
Port number: 22015
Service group name: DefaultServiceGroup
Service name: JP1/AJS jobnet execution registration
- URL to specify
http://host01:22015/Automation/launcher/ConfigService?sg=DefaultServiceGroup&sn=JP1%2fAJS%e3%82%b8%e3%83%a7%e3%83%96%e3%83%8d%e3%83%83%e3%83%88%e5%ae%9f%e8%a1%8c%e7%99%bb%e9%8c%b2
- #2
The number of characters that can be specified in query parameters is limited. For details on the formula for estimating and checking the number of characters in query parameters, see A.5(2) Estimating the number of characters in query parameters.
The following table shows which parameters can be omitted for each type of dialog box.
No. |
Component |
Parameter |
Service Definition dialog box (editing) |
Submit Service dialog box |
Task Details dialog box |
|---|---|---|---|---|---|
1 |
Launch URL |
host-name |
N |
N |
N |
2 |
port-number |
N |
N |
N |
|
3 |
Query parameters |
sg=service-group-name-of-service |
N |
N |
-- |
4 |
sn=service-name |
N |
N |
-- |
|
5 |
task_id=task-ID |
-- |
-- |
N |
|
6 |
tn=task-name |
-- |
Y |
-- |
|
7 |
td=task-description |
-- |
Y |
-- |
|
8 |
pr_property-key=property-value |
-- |
Y |
-- |
- Legend:
Y: Can be omitted. N: Cannot be omitted. --: Not applicable.
Notes on specifying query parameters
Use ASCII characters in query parameters.
You can specify a maximum of 1,024 characters.
You cannot specify a character string that contains URL-encoded surrogate pair characters or control characters.
You can specify the following characters in the key of a query parameter:
Single-byte alphabetic characters (a to z and A to Z)
Single-byte numerals (0 to 9)
Single-byte hyphens (-)
Single-byte underscores (_)
Single-byte periods (.)
A query parameter that uses valid characters but is not listed in the table will be ignored.
If you omit the value for an optional query parameter, no value is set for that parameter.
Consider the security implications before specifying sensitive information such as passwords in a direct-access URL.
Specifying pr_property-key=property-value
As the property key, specify an input property that appears in the Submit Service dialog box.
You must specify a property value if a property is mandatory and has list or boolean as its data type.
The format in which you specify a query parameter depends on the data type of the property. The following table shows the format for each data type:
Table A‒16: Specification format by property data type Data type of parameter
Format
string
Specify a character string of no more than 1,024 characters.
boolean
Specify true or false.
integer
Specify an integer within a range from -2,147,483,648 to 2,147,483,647.
double
Specify a double precision floating point number from approximately ±4.9 x 10-324 to ±1.7 x 10308.
date
Specify a date in the format YYYY-MM-DD. You can specify a date from 1900-01-01 to 2100-12-31.
YYYY: Year
MM: Month
DD: Day
password
Specify a character string of no more than 1,024 characters.
list
Specify a property value that appears in the pull-down menu.
composite
You cannot use this data type in a query parameter.
(2) Estimating the number of characters in query parameters
You can specify a maximum of 1,024 characters in the query parameters of a direct-access URL. Use the following formula to find out how many characters you can specify.
(number-of-characters-in-service-group-name + characters-in-service-name + characters-in-task-name + characters-in-task-description) + 16 + (characters-in-property-key + characters-in-property-value + 5) x n# ≤ 1,024
#: n is the number of properties you specify.