付録A.5 ダイレクトアクセスURLの設定について
ダイレクトアクセスURL機能を使用すると,ログイン後,目的の画面に素早くアクセスできます。
(1) ダイレクトアクセスURLの指定形式と指定項目
ダイレクトアクセスURLは,表示する画面を指定するためのラウンチURLと,その画面で表示する情報を指定するためのクエリパラメータから構成されています。ラウンチURLとクエリパラメータは「?」で区切られています。
ダイレクトアクセスURLの先頭に指定する文字列は,WebブラウザーとJP1/AOサーバ間の通信方式によって異なります。ここではhttp接続の場合を記載していますが,必要に応じてhttpsに読み替えてください。
ラウンチURLの指定が不正な場合,[ログイン]画面は表示されないでWebクライアントまたはWebサーバのエラーメッセージが表示されます。
クエリパラメータの指定が不正な場合,[ログイン]画面にエラーが表示されます。
それぞれのダイアログボックスを表示する場合の,ダイレクトアクセスURLの指定形式を次に示します。
[サービス設定]画面(編集)の場合
http://ホスト名:ポート番号/Automation/launcher/ConfigService?sg=サービスのサービスグループ名&sn=サービス名※1
[サービス実行]画面の場合
http://ホスト名:ポート番号/Automation/launcher/SubmitTask?sg=サービスのサービスグループ名&sn=サービス名&tn=タスク名&td=タスクの説明&pr_プロパティキー=プロパティ値※1※2
- 注※1
サービスグループ名を表す「sg」の代わりに,JP1/AO 10-52以前で使用していた「rg」を指定しても接続できます。
- 注※2
pr_プロパティキー=プロパティ値は,「&pr_プロパティキー1=プロパティ値1&pr_プロパティキー2=プロパティ値2...」のように,「&」を付与することで複数指定できます。
[タスク詳細]画面の場合
http://ホスト名:ポート番号/Automation/launcher/TaskDetails?task_id=タスクID
ダイレクトアクセスURLの指定項目
ダイレクトアクセスURLの指定項目を次に示します。
項番 |
構成要素 |
指定項目 |
説明 |
---|---|---|---|
1 |
ラウンチURL |
ホスト名 |
JP1/AOサーバのホスト名,またはIPアドレスを指定します。 |
2 |
ポート番号 |
JP1/AOのWebサーバのポート番号を指定します。 |
|
3 |
クエリパラメータ |
sg=サービスのサービスグループ名 |
表示したいサービスが所属するサービスグループ名を,URLエンコード※1した文字列で指定します。 サービスグループ名は,操作画面での表示,またはサービスの一覧を出力するコマンド(listservices)で出力したファイルの「Service Group」列に出力される値で確認できます。 なお,「sg」の代わりに,JP1/AO 10-52以前で使用していた「rg」を指定することもできます。 |
4 |
sn=サービス名 |
表示したいサービス名をURLエンコード※1した文字列(文字セットはUTF-8)で指定します。 サービス名は,操作画面での表示,またはサービスの一覧を出力するコマンド(listservices)で出力したファイルの「Service Name」列に出力される値で確認できます。 |
|
5 |
task_id=タスクID |
表示したいタスクIDを指定します。 タスクIDは,操作画面での表示,またはタスクの一覧を出力するコマンド(listtasks)で出力したファイルの「TaskID」列に出力される値で確認できます。 |
|
6 |
tn=タスク名※2 |
入力したいタスク名をURLエンコード※1した文字列(文字セットはUTF-8)で指定します。値に指定できる文字数は,最大128文字です。 |
|
7 |
td=タスクの説明※2 |
入力したいタスクの説明をURLエンコード※1した文字列(文字セットはUTF-8)で指定します。値に指定できる文字数は,最大1,024文字です。 |
|
8 |
pr_プロパティキー=プロパティ値※2 |
入力したいプロパティキーとそのプロパティ値を指定します。複数指定する場合は,「&pr_プロパティキー1=プロパティ値1&pr_プロパティキー2=プロパティ値2...」のように「&」を付与した形式で指定します。プロパティ値は,URLエンコード※1した文字列(文字セットはUTF-8)で指定してください。 なお,ダイレクトアクセスURL で指定したプロパティ値は[サービス実行]画面だけに反映されます。[サービス設定]画面,およびサービス共有プロパティの設定には反映されません。 |
- 注※1
URLエンコードとは,WebブラウザーがURLとして読み取れない文字をURLで使用できるように変換するための処理です。
例えば,[サービス設定]画面(編集)を表示する場合のURLを次に示します。
- サービスの設定内容
ホスト名:host01
ポート番号:22015
サービスグループ名:DefaultServiceGroup
サービス名:JP1/AJSジョブネット実行登録
- 指定するURL
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
クエリパラメータに指定できる文字数には制限があります。クエリパラメータの文字数を確認するための見積もり式については,「付録A.5(2) クエリパラメータの見積もり方法」を参照してください。
表示するダイアログボックスごとの指定項目の省略の可否を次に示します。
項番 |
構成要素 |
指定項目 |
[サービス設定]画面(編集) |
[サービス実行]画面 |
[タスク詳細]画面 |
---|---|---|---|---|---|
1 |
ラウンチURL |
ホスト名 |
× |
× |
× |
2 |
ポート番号 |
× |
× |
× |
|
3 |
クエリパラメータ |
sg=サービスのサービスグループ名 |
× |
× |
- |
4 |
sn=サービス名 |
× |
× |
- |
|
5 |
task_id=タスクID |
- |
- |
× |
|
6 |
tn=タスク名 |
- |
○ |
- |
|
7 |
td=タスクの説明 |
- |
○ |
- |
|
8 |
pr_プロパティキー=プロパティ値 |
- |
○ |
- |
- (凡例)
○:省略できます。 ×:省略できません。 -:指定できません。
クエリパラメータ指定時の注意事項
クエリパラメータには,ASCII文字を使用してください。
指定できる文字数は,最大1,024文字です。
サロゲートペア文字または制御文字をURLエンコードした文字列は,指定できません。
クエリパラメータのキーには,次の文字が指定できます。
「a~z,A~Z」(半角英字)
「0~9」(半角数字)
「-」(半角ハイフン)
「_」(半角アンダーライン)
「.」(半角ピリオド)
使用できる文字の範囲内で,指定項目にないクエリパラメータを指定した場合,そのクエリパラメータは無視されます。
省略できるクエリパラメータについて,値を省略した場合,値は設定されません。
ダイレクトアクセスURLにパスワードなどの機密性の高い情報を指定する場合は,セキュリティに注意してください。
「pr_プロパティキー=プロパティ値」の指定方法
プロパティキーには,[サービス実行]画面に表示されている入力プロパティを指定してください。
指定が必須のプロパティで,データ型が「list」または「boolean」の場合は,プロパティ値を必ず指定してください。
プロパティのデータ型によって,クエリパラメータの指定方法が異なります。次の表にデータ型ごとの指定内容を示します。
表A‒16 プロパティのデータ型に対応した指定形式 パラメータのデータ型
指定形式
string
1,024文字以内の文字列を指定する。
boolean
「true」または「false」を指定する。
integer
-2,147,483,648~2,147,483,647の整数を指定する。
double
約±4.9×10-324~±1.7×10308の倍精度浮動小数点数を指定する。
date
「YYYY-MM-DD」の形式で日付を指定する。なお,1900-01-01~2100-12-31の日付を指定できる。
YYYY:年
MM:月
DD:日
password
1,024文字以内の文字列を指定する。
list
プルダウンメニューに表示されるプロパティ値を指定する。
composite
クエリパラメータに指定できません。
(2) クエリパラメータの見積もり方法
ダイレクトアクセスURLのクエリパラメータに指定できる文字数は,最大1,024文字です。指定できる文字数を確認するためのクエリパラメータの見積もり式を次に示します。
(サービスグループ名の文字数+サービス名の文字数+タスク名の文字数+タスクの説明の文字数)+16+(プロパティキーの文字数+プロパティ値の文字数+5)×n※≦1,024
注※ nは指定するプロパティの数です。