Skip to main content link. Accesskey S
  • Help
  • HCL Logo
  • HCL Notes and Domino Application Development wiki
  • THIS WIKI IS READ-ONLY. Individual names altered for privacy purposes.
  • HCL Forums and Blogs
  • Home
  • Product Documentation
  • Community Articles
  • Learning Center
  • API Documentation
Search
Community Articles > 日本語 - Japanese > XPages データソース解説 - URL パラメータ
  • Share Show Menu▼
  • Subscribe Show Menu▼

Recent articles by this author

XPages データソース解説 - URL パラメータ

XPages のデータソースとページをアクセスする際の URL パラメータとの関係について解説します。

XPages データソース解説 - スコープ

XPages のデータソースのスコープについて解説します。

XPages データソース解説 - 定義方法

XPages のデータソースの定義方法について解説します。

XPages データソース解説 - 種類

XPages のデータソースの種類について解説します。

XPages データソース解説 - 内部動作

XPages のデータソースの内部動作について解説します。
Community articleXPages データソース解説 - URL パラメータ
Added by ~Martha Brekroflar | Edited by ~Martha Brekroflar on January 12, 2012 | Version 8
  • Actions Show Menu▼
expanded Abstract
collapsed Abstract
XPages のデータソースとページをアクセスする際の URL パラメータとの関係について解説します。
Tags: XPages, データソース
ShowTable of Contents
HideTable of Contents
  • 1 XPage をアクセスする URL
  • 2 Domino 文書データソースがサポートする URL パラメータ
  • 3 Domino ビューデータソースがサポートする URL パラメータ
  • 4 XPage が複数のデータソースを定義する場合の URL パラメータ
    • 4.1 ignoreRequestParam プロパティ
    • 4.2 requestParamPrefix プロパティ
XPages で定義したデータソースは、基本的にはプロパティに指定された情報に基づき動作します。
しかしながら設定の一部に関しては、データソースを定義している XPage をアクセスする URL のクエリー文字列で指定される
パラメータにより、外部から変更することが可能です。

シリーズ目次:
  • データソースの種類external link
  • データソースの定義方法external link
  • データソースのアクセス方法external link
  • データソースのスコープexternal link
  • データソースとURL パラメータexternal link
  • データソースの内部動作external link

XPage をアクセスする URL


XPage をブラウザからアクセスする際には、ページの名前を含む以下のような形式の URL を利用します。

http://サーバー名/NSFファイル名.nsf/XPage名.xsp

URL はクエリー文字列を持つことが可能で、XPage アプリケーションでも利用されています。
例えば、ビューコントロールの「列をリンクとして表示する」オプションは、 URL パラメータを利用して動作しています。
ビューから文書を選択した際に遷移先ページをアクセスするための例が以下のような URL です。
開くべき Domino 文書の UNID およびオープンモードが指定されています。

http://appsrv.corp.com/DataSrc.nsf/form.xsp?documentId=0EC1BCE7EC8417E14925797C004EB107&action=openDocument

指定されているパラメータは、アクセスされた XPage 内で定義されたデータソースが受け取り処理を行います。
パラメータによる指定は、データソースのプロパティ設定による指定をオーバーライドします。

Domino 文書データソースがサポートする URL パラメータ


Domino 文書タイプのデータソースは、以下のパラメータを処理します。

パラメータ役割
action文書を開く際のアクションを指定します。

  newDocument: 新規文書を作成します。
  openDocument: 既存文書を読み込みモードで開きます。
  EditDocument: 既存文書を編集モードで開きます。

openDocument/EditDocument を指定した場合でも、
同時に documentId を指定しない場合には新規文書の作成となります。
databaseName対象となる Domino 文書を格納するデータベース名を指定します。
documentId対象となる Domino 文書の Note ID または UNID を指定します。
parentId新規文書を既存文書の子文書として作成する場合に、親となる文書の
Note ID または UNID を指定します。

Domino ビューデータソースがサポートする URL パラメータ


Domino ビュータイプのデータソースは、以下のパラメータを処理します。

パラメータ役割
databaseName対象となる Domino ビューを格納するデータベース名を指定します。
viewNameオープンするビューの名前を指定します。
parentIdビューに含まれるコンテンツを、特定の文書の返答文書およびその子孫に制限します。
絞込みを行う親文書の Note ID または UNID を指定します。
search全文検索の絞込みを行うための検索文字列を指定します。
searchMaxDocs全文検索結果に含める最大件数を指定します。
categoryFilterビューに含まれるコンテンツを指定したカテゴリに含まれるものだけに制限します。
sortColumnビューをソートする列名を指定します。
sortOrderビューのソート順を指定します。

  ascending: 昇順に並べます。
  descending: 降順に並べます。
expandLevel階層を持つビューに対し、展開して表示するレベルを指定します。

  0: 全ての階層を展開して表示します。
  1: 1レベルめだけを(つまり、全ての階層を省略して)表示します。
  2: 2レベルめまでを(つまり、1レベルめだけを展開して)表示します。
         :
keysソートされた列に対して、指定した値を持つもののみに絞込みを行います。
keysExactMatchkeys プロパティで指定した値を完全一致で利用するかどうかを true/falseで指定します。

XPage が複数のデータソースを定義する場合の URL パラメータ


XPage が複数のデータソースを定義していた場合、全てのデータソースは同じ URL パラメータによってオバーライドされ、
その結果、同一の Domino 文書あるいはビューをポイントすることになってしまいます。

通常複数のデータソースを用意するのは、異なる Domino 文書あるいはビューをアクセスするためであり、
これは望ましい結果ではありません。この問題を解決するために用意されているプロパティが
ignoreRequestParam および requestpatamPrefix です。

ignoreRequestParam プロパティ


このプロパティを true にセットした場合、そのデータソースは URL パラメータによる設定を無視する、
つまり、プロパティによる設定を参照して動作します。

ビューを表示する XPage とフォームを表示する XPage があり、ビューページから文書を選択して
フォームページでそのフィールド値を表示するような典型的なアプリケーション,に対し、
2つめのデータソースをフォームページに追加して関連するDomino 文書を同時に表示させるような場合、
2つめのデータソースに対して ignoreRequestParam を true に設定します。

これにより、ビューページでの文書選択は1つめのデータソースがURL パラメータ経由で受け取って処理し、
2つめのデータソースはそれを無視して独自に計算した文書情報をアクセスするといった処理を行うことが
可能になります。

requestParamPrefix プロパティ


もうひとつのオプションが requestParamPrefix プロパティです。このプロパティを設定することにより、
データソースがパラメータを取り出すキー名を変更することができます。

例えば、2つめのデータソースの requestParamPrefix に対して "sub" を設定した場合、
subdocumentId=abc パラメータを documentId として処理するようになります。

よって例えば以下のような URL 指定することにより、
1つめのデータソースは Note ID=8FE の文書を読み込みモードでオープンし、
2つめのデータソースは Note ID=906 の文書を編集モードでオープンする
といったことを行うことができます。

http://appsrv.corp.com/DataSrc.nsf/form.xsp?documentId=8FE&action=openDocument&subdocumentId=906&subaction=editDocument

  • Actions Show Menu▼


expanded Attachments (0)
collapsed Attachments (0)
Edit the article to add or modify attachments.
expanded Versions (8)
collapsed Versions (8)
Version Comparison     
VersionDateChanged by              Summary of changes
This version (8)Jan 12, 2012, 6:49:24 AM~Martha Brekroflar  
6Jan 12, 2012, 6:48:01 AM~Yoshi Froluchekettu  
5Jan 12, 2012, 5:17:49 AM~Yoshi Froluchekettu  Minor Change
5Jan 12, 2012, 6:44:55 AM~Yoshi Froluchekettu  
4Jan 12, 2012, 5:12:25 AM~Yoshi Froluchekettu  Minor Change
1Jan 12, 2012, 4:23:39 AM~Yoshi Froluchekettu  
0Jan 12, 2012, 4:25:26 AM~Yoshi Froluchekettu  
0Jan 12, 2012, 4:26:53 AM~Yoshi Froluchekettu  
expanded Comments (0)
collapsed Comments (0)
Copy and paste this wiki markup to link to this article from another article in this wiki.
Go ElsewhereStay ConnectedAbout
  • HCL Software
  • HCL Digital Solutions community
  • HCL Software support
  • BlogsDigital Solutions blog
  • Community LinkHCL Software forums and blogs
  • About HCL
  • Privacy
  • Accessibility