1.19.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 which specify the information to be displayed in that window. The launch URL and query parameters are delimited by a question mark (?).
The character that can be specified as the first character of the direct-access URL varies depending on the method of communication between Web browser and JP1/AO server. The following figure provides an example for HTTP connection, but replace it with HTTPS if necessary.
|
|
![[Figure]](GRAPHICS/UG020061.GIF)
If you specify a launch URL incorrectly, an error message delivered by the Web client or Web server appears instead of the Login window.
If you specify a query parameter incorrectly, an error message is displayed in the Login window.
The following are the specification formats of the direct access URLs for opening dialog boxes.
-
For the Service Definition dialog box
http://host-name:port-number/Automation/launcher/ConfigService?rg=resource-group-name-of-service&sn=service-name
-
For the Submit Service dialog box
http://host-name:port-number/Automation/launcher/SubmitTask?rg=resource-group-name-of-service&sn=service-name&tn=task-name&td=task-description&pr_property-key=property-value#
- #
-
Multiple pr_property-key=property-value specifications are allowed if you use & between specifications, such as &pr_property-key1=property-value1&pr_property-key2=property-value2....
-
For the Task Details dialog box
http://host-name:port-number/Automation/launcher/TaskDetails?task_id=task-ID
Parameters of a direct-access URL
The following table shows the parameters of a direct-access URL.
|
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 |
rg=resource-group-name-of-service |
Specify the name of the resource group that contains the service you want to display, as a URL-encoded#1 character string. You can find the resource group for a service by looking in the JP1/AO windows. You can also find it in the Resource Group column in the file output by the listservices command. |
|
4 |
sn=service-name |
Specify the name of the service you want to display as a URL-encoded#1 character string (the character set is UTF-8). You can find the service name by looking in the JP1/AO windows. You can also find it in the Service Name column in the file output by the listservices command, which outputs a list of services. |
|
|
5 |
task_id=task-ID |
Specify the ID of the task you want to display. You can find the task ID by looking in the JP1/ AO windows. You can also find it in the TaskID column in the file output by the listtasks command, which outputs a list of tasks. |
|
|
6 |
tn=task-name#2 |
Specify the name of the task you want to enter as a URL-encoded#1 character string (the character set is UTF-8). You can specify a maximum of 128 characters for the value. |
|
|
7 |
td=task-description#2 |
Specify a description of the task you want to enter as a URL-encoded#1 character string (the character set is UTF-8). You can specify a maximum of 256 characters for the value. |
|
|
8 |
pr_property-key=property-value#2 |
Specify the property key and the property value you want to enter. To specify this parameter more than once, use &, such as &pr_property-key1=property-value1&pr_property-key2=property-value2.... Specify the property value as a URL-encoded#1 character string (the character set is UTF-8). The property value specified as a direct access URL is applied only to the Submit Service dialog box. It is not applied to the Service Definition dialog box and the shared service property settings. |
- #1
-
URL-encoded means processing that converts characters that cannot be read by a Web browser as a URL to characters that can be read.
For example, the following is a URL used to display the Service Definition dialog box:
- Service settings
-
host-name: host01
port-number: 23015
resource-group-name: All Resources
service-name: JP1/AJS jobnet execution registration
- URL to specify
-
http://host01:23015/Automation/launcher/ConfigService?rg=All%20Resources&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 as a query parameter is limited. For details about the formula for estimating and checking the number of characters in a query parameter, see 1.19.2 How to estimate the number of characters in a query parameter.
The following table explains whether items to specify for a dialog box to be displayed can be omitted.
|
No. |
Component |
Parameter |
Service Definition dialog box |
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 |
rg=resource-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, --: Cannot be specified.
Notes on specifying query parameters
-
Use ASCII characters for a query parameter.
-
The maximum number of characters that can be specified is 1,024.
-
A character string that contains URL-encoded surrogate pair characters or control characters cannot be specified.
-
The following are characters that can be specified for a query parameter:
-
Half-width letters (a to z and A to Z)
-
Half-width numbers (0 to 9)
-
Half-width hyphen (-)
-
Half-width underscore (_)
-
Half-width period (.)
-
-
If you specify a query parameter that uses specifiable characters, but is not listed in the Parameter column in the table, the query parameter is ignored.
-
If you did not specify a value for a query parameter that can be omitted, no value is set.
-
Carefully consider security when you specify passwords or other confidential information in a direct access URL.
How to specify pr_property-key=property-value
-
Specify an input property displayed in the Submit Service dialog box as a property key.
-
You must specify a property value for a property that must be specified and whose data type is either list or boolean.
-
The format for specifying a query parameter is determined by the data type of the property. The following table describes specification formats for each data type.
Table 1‒29: Specification formats for each property data type Parameter data type
Format
string
Specify a character string of no more than 1,024 characters.
boolean
Specify true or false.
integer
Specify an integer from -2,147,483,648 to 2,147,483,647.
double
Specify a double floating-point number from approximately ±4.9×10-324 to ±1.7×10308.
date
Specify the date in YYYY-MM-DD format. 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 is displayed in the list box.
-