2.1.4 基本URLに指定できるパラメタ
基本URLにパラメタを指定する場合の形式,および指定できるパラメタの種類について説明します。
(1) 基本URLに指定できるパラメタの形式
- 基本URLに指定するときの形式
-
基本URL?パラメタ名1=パラメタの値[[&パラメタ名2=パラメタの値]…]
基本URLとパラメタは「?」で,パラメタとパラメタは「&」で連結します。「&」で連結することで,複数のパラメタを指定できます。
基本URLの末尾にパラメタを追加すると,ログイン後に最初に表示する画面を変更できます。また,プラグインやカスタム画面と連携できるようになります。
なお,次の場合は基本URLにすでにパラメタが含まれているため,基本URLとパラメタの接続には「?」でなく「&」を指定してください。
-
業務編集画面にアクセスする場合
-
カスタム画面にアクセスする場合
-
Cosminexusの統合ユーザ管理フレームワークを利用してシングルサインオンする場合
(2) 基本URLに指定できるパラメタの一覧
基本URLに指定できるパラメタを次に示します。指定できるパラメタの種類は画面ごとに異なります。
パラメタ名 |
パラメタの値 |
説明 |
使用可否 |
||
---|---|---|---|---|---|
業務実行画面 |
業務編集画面 |
カスタム画面(新規画面) |
|||
contentId |
業務コンテンツID |
指定したIDを持つ業務コンテンツを直接開きます。編集可能または読み取り専用のどちらの状態で開くかは,指定した業務コンテンツの状態によって異なります。 業務コンテンツIDの大文字と小文字は区別されます。業務コンテンツIDは業務編集画面のメニューから取得します。業務編集画面のメニューについては,マニュアル「ナビゲーション プラットフォーム コンテンツ作成ガイド」を参照してください。 また,業務実行画面に[URL取得]メニューが表示されている場合,メニューを選択すると,contentIdに業務コンテンツIDが指定されたURLを取得できます。業務実行画面に[URL取得]メニューを表示させるには,ユーザプロパティファイル(ucnp_user.properties)のucnp.base.server.geturl.link.displayプロパティに「true」を指定する必要があります。ユーザプロパティファイル(ucnp_user.properties)については,「8.5 ユーザプロパティファイル(ucnp_user.properties)の設定」を参照してください。 |
○ |
○ |
× |
open_editor |
true |
ログイン後に業務編集画面を直接開きます。 このパラメタを省略すると,ログイン後に業務実行画面が表示されます。[編集画面表示]メニューをクリックすることで業務編集画面へ遷移します。 |
× |
○ |
× |
start_editor |
true |
[編集画面表示]メニュー/[実行画面表示]メニューを表示します。このパラメタを指定すると,業務実行画面と業務編集画面を切り替えられるようになります。 このパラメタは,実行環境では使用できません。 |
○ |
○ |
× |
ucnpCloseBtn※ |
close_only |
画面を閉じるボタンの種別を指定します。 「close_only」を指定すると,クリックしてもログアウトをしないで画面を閉じる,[閉じる]ボタンが表示されます。 |
○ |
○ |
× |
logout_close |
画面を閉じるボタンの種別を指定します。 「logout_close」を指定すると,クリックしたときにログアウトをしてから画面を閉じる,[閉じる]ボタンが表示されます。 |
○ |
○ |
× |
|
logout |
画面を閉じるボタンの種別を指定します。 「logout」を指定すると,クリックしたときにログアウトをしてからログイン画面に遷移する,[ログアウト]ボタンが表示されます。 |
○ |
○ |
× |
|
ucnpOptions |
ユーザプラグイン(入出力プラグインまたは中断再開プラグイン)で利用する値 |
パラメタの値をプラグインの処理で利用します。URIで使用できない文字をパラメタの値として使用する場合は,必要に応じてURLエンコードした値を指定してください。プラグインで利用する値は,プラグインを開発したユーザに問い合わせてください。 また,このパラメタの値をプラグインで利用する方法の詳細は,マニュアル「ナビゲーション プラットフォーム 開発ガイド」を参照してください。 このパラメタに指定できる文字および長さは次のとおりです。
|
○ |
× |
× |
ucnpUserData |
カスタム画面(新規画面)で利用する値 |
パラメタの値をカスタム画面(新規画面)の処理で利用します。 利用する値は,新規画面を開発したユーザに問い合わせてください。また,このパラメタの値を新規画面で利用する方法の詳細は,マニュアル「ナビゲーション プラットフォーム 開発ガイド」を参照してください。 |
× |
× |
○ |
ucnpUserPageId |
カスタム画面プラグイン名 |
ログイン後にカスタム画面(新規画面)を表示します。 |
× |
× |
○ |
- 注※
-
-
ユーザプロパティファイル(ucnp_user.properties)のucnp.base.server.close.button.settingプロパティでも,画面を閉じるボタンの種類を設定することができます。また,ユーザプロパティファイルでは,ボタンを表示しないように設定することもできます。URLのパラメタとユーザプロパティファイルの両方でボタンの種類を指定した場合は,URLのパラメタでの指定が有効になります。
-
ユーザプロパティファイル(ucnp_user.properties)のucnp.base.client.confirm.page.unload.enableプロパティに「true」を指定している場合で,このパラメタを使用するときは,ユーザメッセージプロパティファイル(ucnp_message_user.properties)のKDCZ00146-Wの内容も見直してください。ユーザメッセージプロパティファイル(ucnp_message_user.properties)の詳細については,「8.6 ユーザメッセージプロパティファイル(ucnp_message_user.properties)の設定」を参照してください。
-
(3) パラメタを指定したURLの例
URLに指定するパラメタの組み合わせ例を次に示します。
http://ホスト名:ポート番号/ucnpBase/portal/screen/TitlePortlet/portlet/ucnp/pane/-44Ob44O844Og55S76Z2i/layout_id/default?open_editor=true&ucnpCloseBtn=logout_close&contentId=業務コンテンツのID