EBX® は、HTTP プロトコルを介して呼び出されるユーザーインターフェイス Web コンポーネントとして使用できます。EBX® Web コンポーネントは、サポートされている Web ブラウザーからアクセスできる任意のアプリケーションに統合できます。このアクセス方法は、ユーザー認証、データ検証、自動ユーザーインターフェイス生成など、EBX® の主な利点を提供すると同時に、リポジトリの特定のエレメントにユーザーナビゲーションを集中させる機能を提供します。
EBX® Web コンポーネントの一般的な使用法には、組織のイントラネットフレームワーク、またはユーザーへの特定のタスクの割り当てを管理するアプリケーションへの統合が含まれます。
EBX® Web コンポーネントを呼び出す Web アプリケーションは次のとおりです。
Java 以外のアプリケーションで、最も基本的なのは静的 HTML ページです。
この場合、アプリケーションは、EBX® Web コンポーネントのリクエストの仕様に従う HTTP リクエストを送信する必要があります。
Java アプリケーションの例としては、次のものがあります。
ターゲットとする EBX® リポジトリと同じアプリケーションサーバーインスタンスまたは別のアプリケーションサーバーインスタンスで実行されている Java Web アプリケーション。
EBX® ユーザーサービスまたはカスタムウィジェット。この場合、新しいセッションは親 EBX® セッションから自動的に継承されます。
Java では、EBX® Webコンポーネントを呼び出す HTTP リクエストを作成するための推奨される方法は、API でクラス
を使用することです。UIHttpManagerComponent
EBX® Web コンポーネントが呼び出されると、ユーザーは最初に新しくインスタンス化された HTTP セッションで認証される必要があります。次に、Web コンポーネントはリポジトリエレメントを選択し、リクエストで定義された scope
レイアウトパラメーターに従ってそれを表示します。
パラメーター firstCallDisplay
は、その値に応じてこの自動表示を変更する場合があります。
選択できるリポジトリエレメントは次のとおりです。
データスペースまたはスナップショット
データセット
ノード
テーブルまたは公開されたビュー
テーブルレコード
スコープは、ユーザーに表示されるユーザーインターフェイスの量を決定し、ユーザーがセッション内でナビゲートできる場所を定義します。Web コンポーネントが使用するデフォルトのスコープは、リクエストによって選択または呼び出されるエンティティまたはサービスに応じて、可能な限り最小になります。
パースペクティブアクションだけでなく、特定のパースペクティブを選択することもできます。
デフォルトでは、スコープが「full」の場合、エレメントの選択はユーザーパースペクティブのコンテキストで行われます。
Web コンポーネントの URL は、パースペクティブとアクションまたはエンティティ (データスペース、データセットなど) を指定できます。したがって、URL でパースペクティブとエンティティを指定している (ただしアクションは指定していない) Web コンポーネントの場合、パースペクティブのアクションがこのエンティティと一致すると、このアクションが自動的に選択されます。
それ以外の場合、このエンティティに一致するアクションがない場合、アクションは選択されませんが、エンティティは関係なく開かれます。
エンティティと同時にアクションが指定されている場合、この最後は無視され、アクションが選択されます。
ターゲットエンティティがレコードであり、このレコードを含むテーブルにアクションがある場合、このアクションが選択され、アクション内でレコードが開かれます。
同様に、ワークフロー作業項目が Web コンポーネントの対象であり、パースペクティブに «受信トレイ» のアクションが存在する場合、このアクションが選択され、作業項目がその中で開かれます。
Web コンポーネントがテーブルをフィルタリングするための述語を指定する場合、パースペクティブアクションは、選択されるのとまったく同じ述語を指定する必要があります。
同様に、パースペクティブアクションがテーブルをフィルタリングするための述語を指定する場合、Web コンポーネントは、一致を確立するためにまったく同じ述語を指定する必要があります。
デフォルトの展開では、ベース URL は次の形式にする必要があります。
http://<host>[:<port>]/ebx/
ベース URL は、Web アプリケーション ebx.war
の展開記述子 /WEB-INF/web.xml
に定義されているサーブレット FrontServlet
を参照する必要があります。
パラメーター | 説明 | 必須 |
---|---|---|
| ユーザー認証のプロパティを指定します。ログインとパスワードのペアもユーザーディレクトリ固有のトークンも提供されていない場合、ユーザーはリポジトリのログインページを介して認証する必要があります。 詳細については、 | いいえ |
| 新しいセッションの追跡情報を指定します。追跡情報は履歴テーブルに記録されます。さらに、プログラムでアクセス許可を制限するために使用できます。 詳細については、 | いいえ |
| コンポーネントセッションの終了時にユーザーが [閉じる] ボタンをクリックしたときにリダイレクトされる URL。レコードを選択する場合は常に [閉じる] ボタンが表示されますが、それ以外の場合に表示するかどうかは、パラメーター 詳細については、終了ポリシー (非推奨)を参照してください。 | いいえ |
| 使用するロケールを指定します。値は | いいえ。デフォルトはユーザーに登録されているロケールです。 |
パラメーター | 説明 | 必須 |
---|---|---|
| 指定されたデータスペースを選択します。 | いいえ |
| 指定したスナップショットを選択します。 | いいえ |
| 指定されたデータセットを選択します。値は、選択したデータスペースまたはスナップショットに存在するデータセットの参照である必要があります。 |
|
| 選択したコンテンツに適用する表形式、階層、またはタイルビューのパブリケーション名を指定します。 このパブリケーション名は、ビューの公開中に宣言された名前です。これは、[ビューの構成] > [ビュー] の下の [管理] 領域にあります。 ビューのすべての設定、つまり、フィルター、並べ替え順序、および表示される列が結果に適用されます。このビューを適用するには、データスペースとデータセットを選択する必要があります。ビューの定義に基づいて自動的に決定できるため、ターゲットテーブルの選択は必要ありません。このパラメーターは、 | いいえ |
| データセット内のノード選択を指定します。 値は、選択したデータセットにある有効な絶対パスにすることができます。表記は、構文が省略された簡略化された XPath に準拠している必要があります。 また、他の Web コンポーネントパラメーター (たとえば、 XPath 構文については、XPath でサポートされている構文を参照してください。 詳細については、 | いいえ |
| アクセスするサービスを指定します。 ビルトインユーザーサービスの詳細については、ビルトインサービスを参照してください。 詳細については、Java API で | いいえ |
| 選択するワークフローセクションを指定します。 詳細については、 | いいえ |
| 選択するパースペクティブの名前を指定します。 このパラメーターを指定した場合、 |
|
| 非推奨。代わりに 選択するパースペクティブアクションの識別子を指定します。 | いいえ |
| 選択するパースペクティブアクションの一意の名前を指定します。 | いいえ |
パラメーター | 説明 | 必須 |
---|---|---|
| Web コンポーネントが使用するスコープを指定します。値は、 詳細については、 | いいえ。デフォルトは、ターゲットの選択に応じて可能な限り最小になるように計算されます。 |
| 選択と 可能な値は次のとおりです。
例
詳細については、 詳細については、 詳細については、 | いいえ。デフォルトはターゲットの選択に従って計算されます。 |
| セッション終了ボタンの表示方法を指定します。値は、 詳細については、 | いいえ。スコープが |
| データセットレベルまたはテーブル外のフォームで UI サービスに表示する機能を指定します。 これらのオプションは、ワークスペースの機能にのみ関係します。このプロパティは、可能な限り最小の 構文
説明
例
詳細については、 | いいえ |
| 表形式、階層、またはタイルビュー (テーブルレベル)で表示する機能を指定します。 これらのオプションは、ワークスペースの機能にのみ関係します。このプロパティは、可能な限り最小の 構文
説明
例
詳細については、 | いいえ |
| レコードレベルでフォームに表示する必要がある機能を指定します。 これらのオプションは、ワークスペースの機能にのみ関係します。このプロパティは、可能な限り最小の 構文
説明
例
詳細については、 | いいえ |
| テーブルビュー (表形式、階層形式、またはタイル形式) でページごとに表示されるレコードの数を指定します。 | いいえ |
| 作業項目を自動的に取得して開始する必要があることを指定します。値は 詳細については、 | いいえ。デフォルト値は |
最小 URI
http://localhost:8080/ebx/
ユーザー「admin」としてログインし、「参照」データスペースを選択します。
http://localhost:8080/ebx/?login=admin&password=admin&branch=Reference
「参照」データスペースを選択し、ビルトインの検証サービスにアクセスします。
http://localhost:8080/ebx/?login=admin&password=admin&branch=Reference&service=@validation
デフォルトディレクトリのロールテーブルを選択します。
http://localhost:8080/ebx/?login=admin&password=admin&branch=ebx-directory&instance=ebx-directory&xpath=/directory/roles
デフォルトディレクトリのレコード「admin」を選択します。
http://localhost:8080/ebx/?login=admin&password=admin&branch=ebx-directory&instance=ebx-directory&xpath=/directory/users[./login="admin"]
注意
分かりやすくするために、上記の URL はエンコードされていないため、一部のアプリケーションサーバーと互換性がなくなる可能性があります。
デフォルトディレクトリに新しいユーザーを作成するためのインターフェイスにアクセスします。
http://localhost:8080/ebx/?login=admin&password=admin&branch=ebx-directory&instance=ebx-directory&xpath=/directory/users&service=@creation
デフォルトディレクトリのレコード「admin」をレコード「jSmith」と比較します。
データセット「Reference」のデータセット「instanceId」のレコード「R1」をレコード「R0」と比較します。
http://localhost:8080/ebx/?login=admin&password=admin&branch=ebx-directory&instance=ebx-directory&xpath=/directory/users[./login="admin"]&service=@compare&compare.branch=ebx-directory&compare.instance=ebx-directory&compare.xpath=/directory/users[./login="jSmith"]
注意
分かりやすくするために、上記の URL はエンコードされていないため、一部のアプリケーションサーバーと互換性がなくなる可能性があります。