ノーツ式読み取り処理

オペレーション名

ノーツ式読み取り

機能概要

ノーツ式を用いてデータを読み取ります。

データモデル

本コンポーネントのデータモデルはテーブルモデル型です。

プロパティ

変数の使用については、「変数」を参照してください。

基本設定

項目名	必須/省略可	変数の使用	説明	備考
名前	必須	使用不可	スクリプトキャンバス上での名前を入力します。

必須設定

項目名

必須/省略可

変数の使用

説明

備考

接続先

必須

使用不可

グローバルリソースを選択します。

グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。

[追加]:
新規にグローバルリソースを追加します。
[一覧の編集]:
「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。

フォーム名

必須

使用可

フォーム名を選択または入力します。

スクリプト変数を指定した場合、[フィールド定義]は設定されません。

フィールド定義

必須

[フォーム名]で指定したフォームのフィールド定義を表示します。

フィールド定義/フィールド名

必須

使用可

フィールド名を入力します。
デフォルトでは指定したフォーム内のフィールド名が設定されます。

フィールド定義/型

必須

使用不可

フィールドの型を選択します。
デフォルトでは指定した指定したフォーム内のフィールドの型が設定されます。

[string]
[datetime]
[double]

型を変更した場合の動作については、「型変換の動作について」を参照してください。

ノーツ式

必須

使用可

Notes/Dominoの式言語を入力します。

SELECT予約語と@関数を組み合わせた式を使用できます。

設定例:

式	説明
SELECT @All	データベース内の全文書を検索し、[フォーム名]で設定したフォーム内の文書を取得します。
SELECT Form = "<フォーム名>"	<フォーム名>で指定したフォーム内の文書のみを取得します。 ([フォーム名]で設定したフォームを指定する必要があります。)
SELECT @Created = @Today	作成日が今日の文書を取得します。

@関数については、Notesのヘルプを参照してください。

最大取得文書数

省略可

使用可

取得する文書数を入力します。

デフォルト値は「0」で、省略した場合は「0」が設定されます。
「0」を指定した場合、フォーム内の全文書を取得します。
フォーム内の全文書を超える数を指定した場合、フォーム内の全文書を取得します。

区切り文字

省略可

使用可

複数値の区切り文字を入力します。

複数値の区切り文字を任意で指定することができます。
デフォルト値は「,」で、省略した場合は「,」が設定されます。
複数値は、フィールドの種類が「テキスト」の場合のみ取得できます。

添付ファイル保存先

必須

使用可

リッチテキストのHTMLファイルや添付ファイルを保存するディレクトリを選択または入力します。

[参照]ボタンを押下するとディレクトリチューザが起動し、ディレクトリの選択ができます。

デフォルト値は「/tmp」です。
ファイルパスはDataSpiderファイルシステムの絶対パスで指定してください。
パス区切り文字「/」以外のDataSpiderファイルシステムの使用禁止文字は使用できません。
存在しないディレクトリを指定した場合、実行時にエラーが発生します。

文書ごとにディレクトリに保存

必須

使用可

リッチテキストのHTMLファイルや添付ファイルを文書ごとにユニバーサルIDと同名のディレクトリに保存するかどうかを選択します。

[チェックあり]:
[添付ファイル保存先]で指定したディレクトリ下にユニバーサルIDと同名のディレクトリを作成し、その直下に保存します。
[チェックなし]:(デフォルト)
[添付ファイル保存先]で指定したディレクトリ内に保存します。

チェックを入れない場合、異なる文書に存在する同名の添付ファイルは、そのうち1つのみを取得します。

データ処理方式

項目名	必須/省略可	変数の使用	説明	備考
データ処理方式	必須	使用不可	データ処理方式を選択します。 [スクリプトの設定を使用する]:(デフォルト) スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。 [大容量データ処理を行わない]: 大容量データ処理を行いません。 [大容量データ処理を行う]: 大容量データ処理を行います。

項目名	必須/省略可	変数の使用	説明	備考
コメント	省略可	使用不可	このアダプタの簡単な説明を記述することができます。説明を記述すると、仕様書に反映させることができます。

スキーマ

入力スキーマ

ありません。

出力スキーマ

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>ユニバーサルID</column>
    <column>Note ID</column>
    <column>フィールドのデータ</column>
    :
  </row>
  <row>
    :
  </row>
</table>

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。

詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応しています。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名	説明	備考
count	読み取ったデータの件数が格納されます。	デフォルト値はnullです。
message_category	エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。	デフォルト値はnullです。
message_code	エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。	デフォルト値はnullです。
message_level	エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。	デフォルト値はnullです。
error_type	エラー発生時、発生したエラーの種類が格納されます。	デフォルト値はnullです。エラーの種類は、以下のような形式となります。例:「java.io.FileNotFoundException」 DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_message	エラー発生時、発生したエラーのメッセージが格納されます。	デフォルト値はnullです。 DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_trace	エラー発生時、発生したエラーのトレース情報が格納されます。	デフォルト値はnullです。 DataSpider Servistaのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

型変換の動作について

[フィールド定義]の[型]を指定した場合の型変換の動作は以下の通りです。

[型]	動作	備考
[string]	フィールドの種類に関係なく、すべてString型に変換して読み取ります。
[datetime]	フィールドの種類が「数値」の場合、その値を基にDate型に変換して読み取ります。フィールドの種類が「テキスト」でDate型に変換できないデータの場合、読み取ることができません。	例:フィールドから読み取ったデータが「1」の場合、「1970-01-01T09:00:00.001+0900」に変換されます(OSのタイムゾーンが日本標準時の場合)。
[double]	フィールドの種類が「日付/時刻」の場合、データが保持しているlong値をDouble型に変換して読み取ります。フィールドの種類が「テキスト」でDouble型に変換できないデータの場合、読み取ることができません。	例:フィールドから読み取った取得したデータが「1970-01-01T09:00:00.001+0900」の場合、「1」に変換されます(OSのタイムゾーンが日本標準時の場合)。

仕様制限

本アダプタからDominoサーバーのデータベースへアクセスする際のユーザーは、Notesクライアントで設定されているユーザー固定となります。
また、ユーザーのパスワードが解除されている必要がありますので、Notesクライアントからパスワード解除を行ってください。
Notesクライアントで設定されているユーザーの「パスワードクオリティスケール」はパスワードなしを許容する設定にしてください。

本アダプタの実行時には、Notesクライアントは起動しないようにしてください。

フィールドの種類が「式」のデータを読み取ることはできません。

フィールドの種類が「テキスト」・「ダイアログリスト」・「チェックボックス」・「リストボックス」のデータについて
- 複数値の場合は、[区切り文字]で指定した文字で区切って読み取ります。
フィールドの種類が「日付/時刻」のデータについて
- 「yyyy-MM-dd'T'HH:mm:ss.SSSZZ」形式でフォーマットして取得します。
- 日付のみのデータは、DataSpiderServerが稼働するOSのタイムゾーンを考慮した日時データとして取得します。
  例:OSのタイムゾーンが日本標準時の場合「2009/10/01」→「2009-10-01T09:00:00.000+0900」
- 日付の年は常に4桁で取得します。
- ミリ秒の読み取りはサポートしていません。
- 複数値の場合は、最初の値のみ読み取ります。
フィールドの種類が「数値」のデータについて
- 数値は「-1.7976931348623158E+308」から「1.7976931348623158E+308」の範囲が取り扱い可能です。
- 複数値の場合は、最初の値のみ読み取ります。

フィールドの種類が「リッチテキスト」・「リッチテキストライト」のデータについて

リッチテキストとして指定された文字修飾およびテキストデータは、HTMLファイルとして取得します。
リッチテキストフィールド1つに対し、HTMLファイルが1つ生成されます。
本アダプタでは、文書内の以下のオブジェクトを「添付ファイル」として取得します。
- 文書の添付ファイル
- 文書の画像(GIF、BMP、JPEG、PNG、TIFF 5.0)
- 文書のOLEオブジェクトのプレビュー画像
- 文書の添付ファイルのアイコン画像
各添付ファイルのファイル名を結果データとして取得することはできません。
フィールドのデータが先頭から64KBを超えた場合、自動的に改行を付与して取得します。
文書の添付ファイルの更新日時は、アダプタで取得した日時ではなく、文書上の添付ファイルの更新日時と同一になります。

各添付ファイルの命名規則は以下の通りです。

種類	命名規則	備考
HTMLファイル	「richtext」 +「_」+「<GID(DataSpiderServerで生成される一意なID)>」+「.html」
文書の添付ファイル	「<添付ファイル名(拡張子を含む)>」同一文書内に同名の添付ファイルが存在する場合、2つ目以降のファイルは以下の命名規則になります。「Notes内部の識別ID」+「<添付ファイル名(拡張子を含む)>」	添付ファイル名に「DataSpiderファイルシステムの禁止文字」が含まれる場合、「_」(半角アンダースコア)に変換して取得します。
文書の画像	「<(画像が添付されている文書の)ユニバーサルID>」+「-」+「GRAPHIC」+「-」+「<連番>」+「.bmp」	ユニバーサルIDは16桁ずつに分割し「-」で繋いで出力します。連番は文書ごとに付与されます。同一文書内に同名の画像が存在する場合、1つのみが取得されます。
文書のOLEオブジェクトのプレビュー画像	「<(画像が添付されている文書の)ユニバーサルID>」+「-」+「GRAPHIC」+「-」+「<連番>」+「.bmp」	ユニバーサルIDは16桁ずつに分割し「-」で繋いで出力します。連番は文書ごとに付与されます。同一文書内に同名のプレビュー画像が存在する場合、1つのみが取得されます。
文書の添付ファイルのアイコン画像	「<(画像が添付されている文書の)ユニバーサルID>」+「-」+「PREVIEW」+「-」+「<連番>」+「-」+「<添付ファイル名(拡張子を含む)>」+「.bmp」	ユニバーサルIDは16桁ずつに分割し「-」で繋いで出力します。連番は文書ごとに付与されます。添付ファイル名に「DataSpiderファイルシステムの禁止文字」が含まれる場合、「_」(半角アンダースコア)に変換して出力します。添付ファイル名に「.」が含まれる場合、「_2E」に変換して出力します。

[フォーム名]の表示名は、フォームの「名前」が表示されます。
フォームに「別名」が設定されている場合は、最初の別名が表示されます。最後の別名を表示するには、プロパティファイルの設定を変更する必要があります。また、無題のフォームは表示できません。
詳細については、以下の通りです。

キー

配置場所

説明

備考

notes.compat.220

$DATASPIDER_HOME/server/plugin/data_processing/share/classes/
lotusnotescommon.properties

true:(デフォルト)
「別名」が設定されていない場合はフォームの「名前」、設定されている場合は最初の別名を[フォーム名]に表示します。

名前最初の別名最後の別名表示名

有有有 最初の別名

有有 × 最初の別名

有 × × 名前
false:
「別名」が設定されていない場合はフォームの「名前」、設定されている場合は最後の別名を[フォーム名]に表示します。

名前最初の別名最後の別名表示名

有有有 最後の別名

有有 × 最初の別名

有 × × 名前

指定例:notes.compat.220=false

文書のフィールドが「表示用の計算結果」または「サブフォームの計算結果」である場合、そのフィールドは[フィールド定義]に表示されません。

Domino Designerで削除したフィールドが[フィールド定義]に表示されることがあります。
本動作はDomino Designerの「設計ペインの[フィールドと関数]に削除したフィールド名が表示されてしまう」問題と同一の事象となります。
詳細については、IBM社に問い合わせてください。

本アダプタがサポートしているエンコードはShift_JISです。
また、Shift_JISコードとしてサポートしているのは、JISX0201/JISX0208の符号化文字集合で定義されている以下の文字コードの範囲です。
- 1バイト文字:0x20 - 0x7E、0xA1 - 0xDF
- 2バイト文字:0x8140 - 0xEAA4の中でShift_JISとして定義されている文字
以下のベンダー定義外字(NEC特殊文字、IBM拡張文字)、ユーザ定義外字はサポートしていません。
- NEC特殊文字:0x8740 - 0x8790、0xED40 - 0xEEFC
- IBM拡張文字:0xFA40 - 0xFBFC
- ユーザー定義外字:0xF040 - 0xF9F0
Notesの一部のバージョンでは外字文字の入出力ができる場合がありますが、それは仕様上動作を保証しているものではありません。

Lotus Notes 8.0アダプタで、Lotus Notes 7.0以前の環境で作成された文書を読み取る場合、名前に「⇒」を含むファイルが添付された文書を取得することができません。
Lotus Notes 8.0環境で対象の文書を開き、対象の添付ファイルを添付し直してください。

主な例外

例外名	原因	対策
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[]	[接続先]が指定されていません。	[接続先]を指定してください。
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]	[接続先]で指定したリソース定義が存在しません。	[接続先]で存在するグローバルリソースを指定してください。
InvalidPropertyConfigurationException 「<プロパティ名>」が指定されていません。	[<プロパティ名>]が指定されていません。	[<プロパティ名>]を指定してください。
InvalidPropertyConfigurationException The notes formula is not found, or empty	[ノーツ式]が指定されていません。	[ノーツ式]を指定してください。
LotusNotesException [STATUS:1281] 式のエラー -- The notes formula "<ノーツ式>" is invalid.	[ノーツ式]で指定した関数式が不正です。	[ノーツ式]を確認してください。

Migration Kitの機能

本機能は、Migration Kitを適用した場合のみ有効になります。

プロパティ

互換性

項目名	必須/省略可	変数の使用	説明	備考
1.5形式のデータを使用	省略可	使用不可	結果データのスキーマの形式を選択します。 [チェックあり]: DataSpider 1.5形式のスキーマで結果データを作成します。出力スキーマについては、「1.5形式のスキーマ」を参照してください。 [チェックなし]:(デフォルト) DataSpider Servista 2.0以降のスキーマで結果データを作成します。
XMLとして不正な文字を削除	省略可	使用不可	結果データ構築中にXMLとして不正な文字列が見つかった場合に自動的に削除するかどうかを選択します。 [チェックあり]: XML文書内の不正な文字列を削除します。 [チェックなし]:(デフォルト) XML文書内の不正な文字列を削除しません。	[1.5形式のデータを使用]にチェックを入れた場合、有効になります。
VIEW_NAME	省略可	使用可	ビュー名を入力します。	[1.5形式のデータを使用]にチェックを入れた場合、有効になります。
RICHTEXT_TRANSLATION	省略可	使用不可	リッチテキストフィールドの取得方法を選択します。 [テキストとして取得]: テキストデータとして本文を取得します。文字装飾情報や、添付･埋め込みファイルの位置情報は失われます。 [HTMLとして取得]:(デフォルト) HTML形式で本文を取得します。文字装飾情報や、添付･埋め込みファイルの位置情報は、HTMLタグとして取得できます。	[1.5形式のデータを使用]にチェックを入れた場合、有効になります。
HTML_ENCODING	省略可	使用不可	[RICHTEXT_TRANSLATION]に[HTMLとして取得]を指定した場合の、本文の取得方法を選択します。 [PlainText]:(デフォルト) HTMLデータを、HTMLタグ付のテキストデータとして取得します。 [Base64]: HTMLデータを、Base64エンコードを行って取得します。	[1.5形式のデータを使用]にチェックを入れた場合、有効になります。 Base64エンコードで取得したデータをファイルに出力する場合は、ファイルシステムアダプタを使用してください。

1.5形式のスキーマ

<?xml version="1.0" encoding="UTF-8"?>
<database name="" title="">
  <documents>
    <document noteid="" unid="" punid="">
      <fields>
        <field name="" names="" authors="" readers="" type="">
          <value/>
        </field>
      </fields>
      <attachments>
        <attachment base64encoding="" name="" fieldname=""/>
      </attachments>
    </document>
  </documents>
</database>

ノーツ式読み取り処理

オペレーション名

機能概要

データモデル

プロパティ

基本設定

必須設定

データ処理方式

コメント

スキーマ

入力スキーマ

出力スキーマ

Mapperでのスキーマ読み込み

大容量データ処理

PSPでの使用について

使用できるコンポーネント変数

型変換の動作について

仕様制限

主な例外

Migration Kitの機能

プロパティ

互換性

1.5形式のスキーマ