JText メタオブジェクトは階層構造になっています。デフォルトの トップレベル・メタオブジェクトは、MO_JTextConnector_Default です。 トップレベル・メタオブジェクトの 2 つの属性 EventDataHandler および OutputDataHandler は、コネクターが使用するデータ・ハンドラーの構成情報を提供する子メタオブジェクトを表します。コネクターは、データ・ハンドラーを使用して、ビジネス・オブジェクトとストリング (またはバイト配列) の間でデータ変換を行います。
デフォルトでは、これらの 2 つの属性は同じデータ・ハンドラー ・メタオブジェクト (MO_DataHandler_DefaultNameValueConfig) を指定します。 このデータ・ハンドラー・メタオブジェクトが NameValue データ ・ハンドラーを呼び出して、実際にデータを変換します。つまり、出荷時の デフォルト構成は、イベントおよび出力ファイル変換が同一のデータ・ハンドラー を使用することを指定します。データ・ハンドラーのインスタンス作成についての詳細は、「データ・ハンドラー・ガイド」を参照してください。
フォーマッターの使用についての詳細は、JText コネクターの 3.0.0 または 2.3.0 リリースの資料を参照してください。
図 5 は、デフォルト JText メタオブジェクトの階層構造および各属性の名前とタイプを示しています。
トップレベル JText メタオブジェクト MO_JTextConnector_Default には、コネクターの構成情報と子メタオブジェクトが含まれています。 コネクターが処理するビジネス・オブジェクトのタイプごとに、個別 のトップレベル・メタオブジェクトを作成できます。こうしたカスタム・メタオブジェクト に同一または異なる子メタオブジェクトを持たせて、データ・ハンドラーのタイプを構成することができます。例えば、Customer ビジネス・オブジェクトと Item ビジネス・オブジェクトを 処理が異なるように構成するには、MO_JTextConnector_Customer メタオブジェクトと MO_JTextConnector_Item メタオブジェクトを作成し、異なるデータ・ハンドラー・メタオブジェクト を持つようにトップレベル・メタオブジェクトを設計します。
初期設定時に、コネクターはサポートされているメタオブジェクトとビジネス・オブジェクト のリストを統合ブローカーで検索します。これらのオブジェクト名から、コネクターは、どのビジネス・オブジェクトが自身に 関連するトップレベル・メタオブジェクトを持っているかを判別します。実行時に、コネクターは要求ビジネス・オブジェクト名とサポートされているメタオブジェクト のいずれかとを突き合わせて、適切な構成情報を検索します。
例えば、コネクターが以下のメタオブジェクトをサポートしているとします。
ビジネス・オブジェクトは以下のとおりです。
統合ブローカーが要求 Customer ビジネス・オブジェクトを送信すると、コネクターは MO_JTextConnector_Customer メタオブジェクトに指定された構成情報を使用します。 統合ブローカーが要求 Order ビジネス・オブジェクトを送信する と、コネクターは MO_JTextConnector_Default メタオブジェクトに指定された構成情報を使用します。
このセクションでは、MO_JTextConnector_Default メタオブジェクトの属性について説明します。
表 8 および以下のセクションでは 、MO_JTextConnector_Default メタオブジェクトの各属性 の機能について説明します。その他の情報では、この表には 各単純属性の DefaultValue プロパティーの値が含まれています。 製品提供時の値は、ユーザー独自の値に置き換えることができます。
属性名 | 説明 |
---|---|
ArchiveDir |
アーカイブ・ディレクトリーの絶対パスを指定します。ディレクトリーは既存のものである必要があります。出荷時のデフォルト値は以下のとおりです。
Linux: /tmp/JTextConn/Default/archive Windows: C:¥temp¥JTextConn¥Default¥Archive i5/OS: /QIBM/UserData/WBIServer44/<instance>/connectors/JText/archive Windows 対応の BIDI です。BIDI が使用可能なすべてのプロパティーは、Windows BIDI 形式から、JText コネクター標準プロパティーである BiDi.Metadata 形式に変換されます。 |
DataEncoding |
DataEncoding は、ビジネス・オブジェクト・ストリングの読み取りおよび書き込みに使用する エンコードです。静的メタオブジェクトでこのプロパティーが指定されていない場合は、コネクターは、特定のエンコードを使用せずに ビジネス・オブジェクト・ストリングの読み取りまたは書き込みを行います。この属性には、Java でサポートされている任意のエンコード・セットを指定できます。 |
DataProcessingMode |
この属性は、バイナリー・ファイルの読み取りと書き込みを可能にするために追加されました。この MO プロパティーが Binary に設定されている場合、JText では、適切なデータ・ハンドラー・インターフェースを呼び出して BO からバイト配列への変換またはその逆方向の変換を実行し、ファイル・システムのバイナリー・ファイルを読み取ることや書き込むことができます。通常の設定は Text です。Text モードでは、BO からストリングへの変換、またはその逆方向の変換のためのデータ・ハンドラー・インターフェースが使用されます。このプロパティーは、設定されていない場合、デフォルト値の Text になります。Binary モードを使用するのは、getBO(byte[]) および getByteArrayFromBO() メソッドが適切に実装されているデータ・ハンドラーとともに使用する場合に限る必要があります。 |
DummyKey |
この属性は、各ビジネス・オブジェクト定義の 1 つの属性で Key プロパティーが 使用可能になっている必要があるために存在します。 |
EndBODelimiter |
入力ファイル内のビジネス・オブジェクトを分離する区切り文字を指定します。EndBODelimiter 属性の詳細については、特定のビジネス・オブジェクトのポーリングを参照してください。 構成時にデフォルト値を指定していない場合、このプロパティーのデフォルト値は、DataProcessingMode が Text に設定されていれば <EndBO:BOName> になります。DataProcessingMode が Binary のとき、このプロパティーのデフォルト値は FF01 になります。 注:
NameValue データ・ハンドラーはデフォルトのデータ・ハンドラーに設定されているので、EndBODelimiter 値は <EndBO:BOName> に設定されています。Delimited データ・ハンドラーなどの別のデータ・ハンドラーを使用する場合は、対応する値を指定する必要があります。Delimited データ・ハンドラーの場合は、EOL ストリングが有効な EndBODelimiter の値です。 |
EndOfFileDelimiter |
DataProcessingMode が Binary であり、かつ FTPDataStructure が Record である場合には、EndBODelimiter と EndOfFileDelimiter の両方が使用されます。このプロパティーは、レコード・ファイルの EOF (ファイル終わり) マーク文字として使用されているバイトを 16 進数で表したものに設定します。設定されていない場合には、デフォルト値 FF02 が使用されます。 |
EventDataHandler |
データ・ハンドラーでイベント処理 (ビジネス ・オブジェクト・ストリングがビジネス・オブジェクトに変換される) に使用される構成値を提供する属性を持つ、子メタオブジェクトを表 します。出荷時のデフォルト値は MO_DataHandler_DefaultNameValueConfig です。 |
EventDir |
イベント・ディレクトリーの絶対パスを指定します。ディレクトリーは既存のものである必要があります。異なるビジネス・オブジェクトに個別にメタオブジェクトを作成し、両方に同一の EventDir パスを指定する場合、それぞれのメタオブジェクト の EventExt 属性に固有な値を指定する必要があります。詳細については、イベント・ディレクトリーおよび拡張子の指定を参照してください。コネクターを構成して、イベント処理用にリモート FTP ファイル・システムを 使用するには、この属性に FTP URL を指定します。オプションで、この属性を 使用して URL 内に以下の追加情報を指定することができます。
EventDir 属性で FTP 情報を指定するための構文は、以下のとおりです。 ftp://[UserId:password@]FTPserver[:port][RemoteEventDirectory] 詳細については、リモートのイベント処理を参照してください。EventDir 属性でローカル・ファイル情報を指定するには、ファイルの絶対パスを使用します。 あるいは、以下の形式の FILE URL を使用します。 [file://]FullPathname
出荷時のデフォルト値は以下のとおりです。
Windows: C:¥temp¥JTextConn¥Default¥Event i5/OS:/QIBM/UserData/WBIServer44/<instance>/connectors/JText/event Windows 対応の BIDI です。BIDI が使用可能なすべてのプロパティーは、Windows BIDI 形式から、E メール・コネクター標準プロパティーである BiDi.Metadata 形式に変換されます。 注:
新しく導入されたコネクター固有 boolean プロパティー「NoPoll」により、オプションでポーリングをオフにできます。デフォルト値は false です。true に設定されている場合、アダプターは要求のみを処理し、ポーリングは処理しません。 |
EventExt |
イベント通知に使用されるファイルの拡張子を指定します。値が指定されない場合、JText コネクターはファイル拡張子なしでファイルをポーリングします。詳細については、複数のイベント・ファイルまたは複数のイベント・ディレクトリーの指定を参照してください。
注:
この属性にアスタリスク (*) を使用すると、拡張子がサポートされて
いなくても、単一イベント・ディレクトリー内のすべてのファイルをポーリングできます。
出荷時のデフォルト値は in です。 |
FailArchiveExt |
正常に処理されなかったビジネス・オブジェクトのアーカイブ に使用するファイル拡張子を指定します。詳細については、イベント・アーカイブの指定を参照してください。出荷時のデフォルト値は fail です。 |
FileSeqEnabled |
各ビジネス・オブジェクトを個別のファイルに 出力する、ファイル名の順序付けを指定します。ファイル名には固有のシーケンス番号が含まれます。詳細については、要求処理の指定を参照してください。出荷時のデフォルト値は true です。 |
FixedBOSize |
このメタオブジェクト・プロパティーが有効な値とともに指定されている場合、このプロパティーが EndBODelimiter プロパティーに優先し、ユーザーは従来の区切り文字ベースの BO 解析に代わる解析を行うことができます。 |
FTPArchiveDir |
FTP サーバーにあるアーカイブ・ディレクトリーの相対パスを指定します。ディレクトリーは既存のものである必要があります。この属性を使用したアーカイブの指定には、いくつかのオプションがあります。
Windows 対応の BIDI です。BIDI が使用可能なすべてのプロパティーは、Windows BIDI 形式から、E メール・コネクター標準プロパティーである BiDi.Metadata 形式に変換されます。 |
FTPDataStructure |
この属性は String 型です。この属性を使用すると、リモート・サイトに対するファイルの読み取りと書き込みを、FTP データ構造 (File または Record) を指定して実行できます。何も指定されていない場合、JText は File をデフォルト値として使用します。 |
FTPEventFileMask |
組み込みワイルドカード文字を使用して、イベント処理用のリモート FTP ファイルの マスクまたはプレフィックスを指定します。この属性に値を指定するのは、Windows、Linux、または i5/OS システムに適用されるのと同じ命名標準に準拠しないメインフレーム上で、ファイル・マスクを識別する場合だけです。ファイル名にワイルドカード文字を使用すると、イベント処理に複数のファイルを指定 できるようになります。例えば、ACT.Z1UC.INPT* というフォーマット を使用すると複数のイベント・ファイルを指定できます。詳細については、メインフレーム上のファイルの識別: オプション構成を参照してください。出荷時のデフォルト値はありません。 ポーリングする場合は、かなり具体的なマスクを指定してください。例えば、USER.JTEXT.TEST001.EVENT、USER.JTEXT.TEST002.EVENT、 USER.JTEXT.TEST003.EVENT、USER.JTEXT.TEST004.EVENT のすべてのイベント・ファイルをポーリングし、FTPArchiveDir が / と設定されるかブランクのまま場合、および FTPRenameExt が RENAME と設定されている場合は、これらのファイルがUSER.JTEXT.TEST001.RENAME、 USER.JTEXT.TEST002.RENAME、 USER.JTEXT.TEST003.RENAME のようにアーカイブされます。したがって、FTPEventFileMask=USR.JTEXT.TEST*.* と指定すると、すべてのイベントが最初のポーリングで選択されます。アーカイブ・ファイルも同じファイル・マスクに適合しているので、次のポーリングですべてのアーカイブ・ファイルが選択されます。この状態を避けるには、かなり具体的なマスクを指定する必要があります。例えば、USR.JTEXT.TEST*.EVENT のように入力し、ポーリング時に USR.JTEXT.TEST*.RENAME が選択されないようにします。 注:
イベント・ファイルとアーカイブ・ファイルの両方に適用可能なマスクを指定しないでください。
Windows 対応の BIDI です。BIDI が使用可能なすべてのプロパティーは、Windows BIDI 形式から、E メール・コネクター標準プロパティーである BiDi.Metadata 形式に変換されます。 |
FTPFileListingFormat |
JText コネクターがファイルを読み取るときに想定する ファイル情報のフォーマットを指定します。これにより、コネクターは、異なるロケールの (例えば日時情報がファイル・フォーマット情報と異なる順序で 格納されている) ファイルを読み取ることができます。所定のロケールのフォーマットを使用するようにコネクターを構成するには、ファイル属性が出現する順序を表す文字をセミコロンで区切って列挙します。以下に、指定可能な文字とファイル属性の対応関係を示します。 P アクセス権 L リンク U ユーザー G グループ S サイズ D 日付 M 月 T 時刻 N 名前例えば、この属性の値は P:L:U:G:S:D:M:T:N のようになります。 |
FTPGetQuantity |
各リモート・ポーリングにより、リモート FTP URL から検索されるファイル数を決定します。 |
FTPKeepConnectionOpen |
この属性の Default Value プロパティーを値 true に設定すると、JText コネクターは FTP サイトとの接続を保持します。この属性を値 true に設定すると、コネクターは、コネクターが終了する場合 または (構成されたタイムアウトなどを理由として) FTP サーバー自体が接続をクローズした場合 にのみ接続をクローズします。コネクターは、FTP サーバーがタイムアウトを理由として 接続をクローズする場合に対処するため、リモート操作を実行するたびに 接続がアクティブになっていることを検査します。接続がクローズされている場合は、コネクターは接続を再確立します。この属性の Default Value プロパティーを値 false に設定すると、JText コネクターは、操作を実行するたびに FTP サーバーとの接続をオープンし、操作が完了すると接続をクローズします。コネクターが接続を保持するように構成すると、FTP サイトでの要求処理時のパフォーマンスが向上します。 |
FTPLocalEventDir |
コネクターが FTP サイトからダウンロードしたイベント・ファイルを格納する、ローカル・システム・ディレクトリーを指定します。コネクターが FTP を使用してイベントを処理できるようにするために、この属性に値を指定する必要があります。詳細については、ローカル・ディレクトリーの指定を参照してください。出荷時のデフォルト値はありません。 Windows 対応の BIDI です。BIDI が使用可能なすべてのプロパティーは、Windows BIDI 形式から、E メール・コネクター標準プロパティーである BiDi.Metadata 形式に変換されます。 |
FTPOSPlatform |
この属性を使用するのは、コネクターを構成して、リモート FTP サーバーが MVS プラットフォームである リモート FTP ファイル・システムを使用できるようにする場合のみです。 この場合、属性の値に MVS を指定します。大文字小文字は区別されません。詳細については、リモート FTP ファイル・システムの指定を参照してください。出荷時のデフォルト値はありません。 |
FTPPassword |
FTP サーバーに接続して FTP 操作を実行する特権を持つユーザーのパスワード を指定します。EventDir 属性または OutputDir 属性で指定した URL に パスワードが含まれている場合、この属性に値を指定する必要はありません。詳細については、FTP URL およびログイン情報の指定を参照してください。この属性には、出荷時のデフォルト値はありません。 |
FTPPollTerminateIfServerDown |
イベントがあるかどうか FTP サイトをポーリングするように
構成した場合に FTP サイトが使用不能なときの
コネクターの振る舞いを指定します。FTPPollTerminateIfServerDown 属性の Default Value プロパティーを値 true に設定した場合、コネクターが呼び出しをポーリングしたときに FTP サイトが使用不能な場合は、コネクターは終了します。FTPPollTerminateIfServerDown 属性の Default Value プロパティーを値 false に設定した場合、コネクターが呼び出しをポーリングしたときに FTP サイトが使用不能な場合でも
コネクターは終了しません。
|
FTPRenameExt |
コネクターがリモート FTP ファイルのポーリング後にそのファイル名を変更する ときに使用する、ファイル拡張子またはサフィックスを指定します。 ファイル名を変更することによって、次のポーリング・サイクルに同じファイルを ポーリングすることがなくなります。あるいは、コネクターを構成して 処理済みのイベント・ファイル名を変更し、それをアーカイブ・ディレクトリーに移動することもできます。詳細については、FailArchiveExt 属性を参照してください。詳細については、メインフレーム上のファイルの識別: オプション構成を参照してください。出荷時のデフォルト値はありません。 |
FTPRequestTerminateIfServerDown |
FTP サイトで要求処理および通信を行うようにコネクターを構成した場合に、FTP サイトが使用不能なときのコネクターの振る舞いを指定します。FTPRequestTerminateIfServerDown 属性の Default Value プロパティーを値 true に設定した場合、コネクターが要求を処理するときに FTP サイトが使用不能な場合は、コネクターは終了します。FTPRequestTerminateIfServerDown 属性の Default Value プロパティーを値 false に設定した場合、コネクターが要求を処理するときに FTP サイトが使用不能な場合でも
コネクターは終了しません。
|
FTPTransferType |
この JText メタオブジェクト・プロパティーは、イベント処理時と要求処理時の両方で使用されます。このプロパティーに指定可能な値は、Binary と ASCII です。このプロパティーは、JText がリモートで FTP サーバーに対してファイルの配置や取得を実行するときに使用する転送タイプを示します。このプロパティーが存在しない場合、アダプターの動作のタイプは Binary になります。 |
FTPUserId |
FTP サーバーに接続して FTP 操作を実行する特権を持つユーザー名を指定します。EventDir 属性 または OutputDir 属性で指定した URL に ユーザー ID が含まれている場合、この属性に値を指定する必要はありません。EventDir 属性 (イベント処理時) または OutputDir 属性 (要求処理時) に FTP URL が見つからない場合、コネクターはこの属性を無視します。詳細については、FTP URL およびログイン情報の指定を参照してください。この属性には、出荷時のデフォルト値はありません。 |
IncludeEndBODelimiter |
EndBODelimiter メタオブジェクト属性に指定された値を、JText コネクターがファイルに書き込むストリングに含めるかどうかを指定します。この属性の Default Value プロパティーを true に設定した場合は、コネクターは、ファイルへの書き込み時に EndBODelimiter 属性に 指定された値を含めます。この属性の Default Value プロパティーを false に設定した場合は、コネクターは、ファイルへの書き込み時に EndBODelimiter 属性で 指定された値を含めません。 |
LargeObject |
JText アダプター (true に設定されている場合) の大規模オブジェクト最適化機能をオンにするために使用されるフラグです。このフラグを true に設定すると、アーカイバーの振る舞いが次のように変更されます。
また、アーカイブ状況を追跡するため、余分のログ・ファイルが内部で作成されます。 |
MVSSiteCommand |
MVS FTP サイト・コマンドを発行するために使用されます。このサイト・コマンドは、SITE または QUOTE キーワードを使用せずに指定してください。サイト・コマンド値には、例えば LRECL=<value> BLKSIZE=<value> などがあります。ここで、<value> は渡されるサイト・コマンドの引数を表します。 |
ObjectEventID |
メタオブジェクト内のコネクターは使用しないが、統合ブローカー で必要なプレースホルダー。この属性は、メタオブジェクト内の最 後の属性である必要があります。出荷時のデフォルト値はありません。 |
OriginalArchiveExt |
オリジナルのイベント・ファイルのアーカイブに使用するファイル拡 張子を指定します。これにより、ビジネス・オブジェクトが処理に失敗 したりアンサブスクライブされた場合の参照用に、イベント・ファイルが保存されます。詳細については、イベント・アーカイブの指定を参照してください。出荷時のデフォルト値は orig です。 |
OutputDataHandler |
データ・ハンドラーでサービス呼び出し要求 (ビジネス・オブジェク トがビジネス・オブジェクト・ストリングに変換される) に使用される構 成値を提供する属性を持つ、子メタオブジェクトを表します。出荷時のデフォルト値は MO_DataHandler_DefaultNameValueConfig です。 |
OutputDir |
出力ディレクトリーの絶対パスを指定します。ディレクトリーは既存のものである必要があります。コネクターを構成して、要求処理用にリモート FTP ファイル・システムを 使用するには、この属性に FTP URL を指定します。オプションで、この属性を 使用して URL 内に以下の追加情報を指定することができます。
OutputDir 属性で FTP 情報を指定する構文は、ftp://[UserId:password@]FTPserver[:port] です。詳細については、リモートの要求処理を参照してください。OutputDir 属性でローカル・ファイル情報を指定するには、ファイルの絶対パスを使用します。 あるいは、以下の形式の FILE URL を使用します。 [file://]FullPathname
出荷時のデフォルト値は以下のとおりです。
Windows 対応の BIDI です。BIDI が使用可能なすべてのプロパティーは、Windows BIDI 形式から、E メール・コネクター標準プロパティーである BiDi.Metadata 形式に変換されます。 |
OutputExt |
要求処理に使用されるファイルの拡張子を指定します。出荷時のデフォルト値は out です。 注:
OutputFileName 属性に拡張子が含まれず、OutputExt 属性に
拡張子が含まれている場合、生成される出力ファイルにはファイル名と拡張子が付きます。
どちらの属性にも拡張子が含まれない場合、生成される出力ファイルには拡張子が付きません。 |
OutputFileName |
要求処理時にコネクターが着信ビジネス・オブジェクトを書き込む、出力ファイルの名前とパスを指定します。OutputDir 属性に有効な出力ディレクトリーが含まれている場合、出力ファイルは指定されたディレクトリー に生成されます。詳細については、出力ファイル名の指定を参照してください。 注:
OutputFileName 属性および OutputExt 属性に拡張子が含まれない場合、生成される出力ファイルには拡張子が付きません。
出荷時のデフォルト値は Native です。
|
PartialArchiveExt |
正常に処理されたビジネス・オブジェクトのアーカイブに使用するフ ァイル拡張子を指定します (イベント・ファイルに複数のビジネス・オブジェクト が含まれている場合、一部は正常に処理されません)。詳細については、イベント・アーカイブの指定を参照してください。出荷時のデフォルト値は partial です。 |
StagingDir |
コネクターが、OutputDir 属性で指定された ディレクトリーにファイルを移動する前に ファイルを書き込むディレクトリーを指定します。これは、JText コネクターがファイルを出力する ディレクトリーを他のソフトウェア・プロセスがモニターおよび操作する 環境 (コネクターによって作成されたファイルを FTP プロセスが検出し、別の場所に移動するなど) を扱うために設計されています。このような場合は、ファイルの書き込みが完了する前に 外部プロセスがファイルを移動してしまう危険性があります。StagingDir 属性でステージング・ディレクトリーを指定し、コネクターがファイルを完全にステージング・ディレクトリーに書き込み、その書き込みが完了してからファイルを出力ディレクトリーに移動することにより、外部プロセスが不完全なファイルを抽出してしまう危険性を回避できます。 ステージング・ディレクトリーと出力ディレクトリーは 同じファイル・システムまたはドライブに置き、オペレーティング・システムごとのファイル移動方式の差異を吸収してください。StagingDir は、リモート・ディレクトリーにすることができます。出荷時のデフォルト値はありません。 Windows 対応の BIDI です。BIDI が使用可能なすべてのプロパティーは、Windows BIDI 形式から、E メール・コネクター標準プロパティーである BiDi.Metadata 形式に変換されます。 |
SuccessArchiveExt |
すべて正常に処理されたビジネス・オブジェクトのアーカイブに使用するファイル拡張子を 指定します。詳細については、イベント・アーカイブの指定を参照してください。出荷時のデフォルト値は success です。 |
UnsubscribedArchiveExt |
すべてアンサブスクライブされたビジネス・オブジェクトのアーカイブに使用する ファイル拡張子を指定します。詳細については、イベント・アーカイブの指定を参照してください。出荷時のデフォルト値は unsub です。 |
出力ファイル名を指定する方法は 3 つあります。
この属性を使用するのは、コネクターを構成して、同一タイプのビジネス・オブジェクトを 固有のシーケンス番号付きの別々のファイルに書き込むか、複数のビジネス・オブジェクトを指定された名前の単一ファイルに追加する場合です。
動的子メタオブジェクトを使用するのは、ビジネス・オブジェクトのタイプごとに 出力ファイル名を動的に生成するか、コネクターが生成した出力ファイル名を戻す場合です。詳細については、動的子メタオブジェクトの使用を参照してください。
OutputFileName 属性を使用して出力ファイル名を使用する方法はいくつかあります。
Native は予約語です。
詳細については、要求処理の指定を参照してください。