アダプタ Webject の概要

高度なカスタマイズ > Windchill アダプタ > Windchill アダプタ Webject ライブラリ > アダプタ Webject の概要

アダプタ Webject の概要

Windchill アダプタに有効な Action および Query Webject について以下に説明します。Display Webject と Task Webject はすべてのアダプタで使用できるので、これらの Webject は Info*Engine User's Guide で説明されています。構文の詳細については、Info*Engine User's Guide を参照してください。

このトピックで説明している Action Webject および Query Webject の使用例については、Windchill アダプタの例の説明に従って、インストールされているサンプルセットにアクセスしてください。

Webject について説明する前に、パラメータのカテゴリについて説明します。

• 必須 - このパラメータは常に必要です。

• 相互依存 - 指定するパラメータと別のパラメータの間に関係が存在します。たとえば、DBUSER パラメータと PASSWD パラメータは相互依存です。DBUSER パラメータを指定する場合、PASSWD パラメータも指定する必要があります。

指定するパラメータの値がほかのパラメータの使用に関係する場合も、相互依存です。たとえば、Query-Links Webject の SELECTBY パラメータに入力した値によって、使用できる SELECT_ パラメータが異なります。したがって、SELECTBY パラメータと SELECT_ パラメータは「相互依存」列に示されます。

• オプション - このパラメータは常にオプションであり、別のパラメータとの関係はありません。

Info*Engine の代入構文を使用する JSP では、${...} 構文を使用しなくなりました。Info*Engine では、代替構文 $(...) がサポートされるようになりました。

既存の JSP は、新しい $(...) 構文を使用するために更新する必要があります。更新しないと、コンパイルに失敗して予期したとおりに動作しません。

既存の Info*Engine タスクは、そのままで引き続き動作します。変更する必要はありません。すべての Info*Engine タスクは、$(...) または ${...} で機能します。

Action Webject のサマリー説明

Action Webject は、1 つまたは複数の Windchill オブジェクトの作成および更新など、特定の操作を実行します。

Webject	説明
Add-ContentItems	Windchill ビジネスオブジェクトにコンテンツを追加します。
Apply-Service	Windchill サービスメソッドを 1 つ以上のオブジェクトに適用します。
Change-Identity	オブジェクトのアイデンティティを定義するオブジェクトの属性を修正します。
CheckIn-Objects	Windchill にオブジェクトをチェックインします。
CheckOut-Objects	Windchill からオブジェクトをチェックアウトします。
Commit-Transaction	トランザクションを終了し、すべての変更をデータベースにコミットします。
Create-Links	Windchill ビジネスオブジェクト間で新規の関連付けを作成します。
Create-Objects	1 つのオブジェクトを作成し、Windchill に保存します。
Create-TypeInstance	1 つのオブジェクトのインスタンスを作成しますが、データベースに保存しません。
Delete-ContentItems	Windchill ビジネスオブジェクトからコンテンツを削除します。
Delete-Objects	Windchill ビジネスオブジェクトを削除します。
Emit-Event	オプションパラメータを使用して Windchill ワークフローイベントを発生させます。
End-Session	リソースをリリースし、セッションに関連付けられたオープントランザクションをロールバックします。
Move-Objects	オブジェクトを現在のフォルダから新規のフォルダへ移動します。
Purge-Cache	Windchill プリンシパルキャッシュからユーザーオブジェクトおよびグループオブジェクトをパージします。
Revise-Objects	Windchill ビジネスオブジェクトの改訂名を改訂します。
Rollback-Transaction	セッション時のすべての変更をデータベースから消去します。
Start-Session	トランザクション内で Webject を実行するセッションを作成します。
Start-Transaction	トランザクションを開始します。
Start-Workflow	ワークフロープロセスのインスタンスを開始する。
Subscribe-Objects	クラスの特定のインスタンスと特定の購読ユーザー用にモデル化されたイベントを購読します。
Undo-Checkout	チェックアウトしたオブジェクトと関連付けられたロックおよび変更を解除します。
Unsubscribe-Objects	クラスの特定のインスタンスと特定の購読ユーザー用にモデル化されたイベントの購読を解除します。
Update-Objects	1 つ以上の Windchill オブジェクトを更新します。

Query Webject のサマリー説明

Query Webject を使用すると、Info*Engine の作成者は、Windchill 内の情報検索のソリューションを実装したり、Windchill オブジェクト間の関係を考察したりできます。Info*Engine、Webject、およびタスクの詳細については、Info*Engine User's Guide を参照してください。

Webject	説明
All-Versions	Windchill オブジェクトのすべてのバージョンに関する情報を返します。
Describe-Attributes	モデル化された Windchill クラスに指定された属性を説明します。
Expand-References	指定された属性によって参照されているグループ内にあるオブジェクトを取得します。
Generate-Report	Windchill レポートテンプレートを実行し、その結果を Info*Engine グループとして返します。
Get-ContentItems	Windchill ビジネスオブジェクトからコンテンツを読み込みます。
Get-IconURL	指定されたビジネスオブジェクトのセットに関連するアイコンの URL を返します。
Get-LifeCycles	ビジネスオブジェクトセットのライフサイクルを指定するグループを返します。
Get-Properties	Windchill 設定プロパティを含んだグループを返します。
Indexed-Search	Windchill オブジェクトのインデックシングコンテンツについてインデックスサーチを照会します (インデックスサーチが有効化されている場合)。
Iteration-History	Windchill オブジェクトの前回の作業版数に関する情報を返します。
LifeCycle-History	指定された Windchill オブジェクトのライフサイクル履歴を返します。
List-ContentItems	指定された Windchill オブジェクトのコンテンツアイテムを照会して返します。
List-FolderContents	フォルダまたはキャビネットに含まれるビジネスオブジェクトのリストを返します。
Query-Links	Windchill ビジネスオブジェクト間の関連付けを走査します。
Query-Objects	特定の属性値に基づいてオブジェクトを検索します。
Query-Tree	Windchill ビジネスオブジェクト間の関連付けを走査し、関連オブジェクトのツリーを生成する。
Query-Type-Tree	Windchill ビジネスオブジェクトタイプおよびその子の表示名を含んでいるグループを返します。
Search-Objects	モデル化された属性値とインスタンスベースの属性値の両方に基づいて 1 回の照会で複数のタイプのサーチを行う、フェデレーションサーチ機能を提供します。
Validate-User	指定されたユーザー名および資格が有効かどうかを示す。
Version-History	Windchill オブジェクトの以前のバージョンに関する情報を返します。

一般 Webject パラメータ

以下のパラメータは複数の Webject に適用され、共通の定義を持っています。

共通パラメータが適用されるかどうかを確認するには、各 Webject エントリの「パラメータ」セクションの表を参照してください。

Webject 間で共通する追加パラメータもいくつかありますが、Webject がそのパラメータをどのように使用するかによって定義が異なります。次に、ユニバーサル定義を持つパラメータについてのみ説明します。

ACCEPT_LANGUAGE

Windchill 属性値およびメッセージの言語プリファレンスおよびロケール。この値を使用して、ロケール固有の入出力を処理するときに使用する適切な java.util.Locale を決定します。ACCEPT_LANGUAGE は、呼び出し元が Info*Engine の自動ロケール検出をオーバーライドするときに使用できます。

ロケール固有の値は、言語プリファレンスに対応するロケールを使用して解析され、フォーマットされます。フォーマットは LN-CC-ds です。

• "LN" は ISO およびインターネット規格で定義されている 2 文字の言語識別子です (英語は en、フランス語は fr、ドイツ語は de など)。

• "CC" は ISO およびインターネット規格で定義されている 2 文字の国コードです (アメリカ合衆国は US、フランスは FR、ドイツは DE、ドイツは DE など)。

• "ds" は地域で定義されている方言識別子です。

CC および ds コンポーネントは省略する場合があります。一般的に、CC コンポーネントは指定し、方言文字列は省略します。一般的な例は、en-US、en-GB、fr-FR、de-DE、de-CH (ドイツ語/スイス)、it-IT (イタリア語) などです。

このパラメータはオプションです。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

ATTRIBUTE

オブジェクトごとに出力グループに返される属性。このパラメータには複数の値を指定できます。このパラメータが指定されていない場合は、デフォルトの属性セットが返されます。

各タイプの属性のデフォルトセットは wt.adapter.delegates.properties ファイルの DefaultAttributes プロパティ値で定義されています。

DefaultAttributes プロパティが定義されていない場合は、すべてのオブジェクトのすべての属性が返されます。このパラメータはオプションです。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

ATTRIBUTE パラメータは、次の Webject に対して固有の定義を持っています。

Describe-Attributes	Get-Properties
Expand-References

AUTHORIZATION

有効な HTTP 認証ヘッダー値。HTTP Basic 認証のみがサポートされます。指定すると、このパラメータはユーザー名とパスワードのソースとして動作し、Webject の実行と関連付けられ、DBUSER と PASSWD は無視されます。AUTHORIZATION、DBUSER、および PASSWD パラメータで資格証明を指定しない場合は、Info*Engine の認証マッピングメカニズムによって、これらのパラメータ値が指定されます。

このパラメータはすべての Webject に適用されます。

標準の Windchill インストールでは、署名を常に要求するよう設定されています。つまり、サーバーは認証のために Web サーバーに提供されたユーザー名を信頼します。このユーザー名は、Windchill にルーティングする Webject 呼び出し時に使用され、DBUSER、PASSWD、および AUTHORIZATION パラメータ値は無視されます。

認証およびユーザー認証の仕様の詳細については、Info*Engine User's Guide を参照してください。

DBUSER

DBUSER Webject は、Windchill システムへの認証時に使用するユーザー名を指定します。このパラメータを適用するには、PASSSWD も指定する必要があります。

AUTHORIZATION が指定されている場合、DBUSER と PASSWD は無視されます。AUTHORIZATION、DBUSER、および PASSWD パラメータで資格証明を指定しない場合は、Info*Engine の認証マッピングメカニズムによって、これらのパラメータ値が指定されます。

このパラメータはすべての Webject に適用されます。

CONNECTION_ATTEMPTS

エラーを返す前にアダプタの接続の確立を試行する最大回数。デフォルト値は 1 です。このパラメータはオプションです。

複数の INSTANCE パラメータ値を指定する場合、CONNECTION_ATTEMPTS の値は、アダプタインスタンスのリストを繰り返す最大数を定義します。

このパラメータはオプションであり、すべての Webject に適用されます。

CONNECTION_ATTEMPT_INTERVAL

Windchill システムへの接続が失敗した場合、接続の試行を繰り返す間の遅延秒数。デフォルト値は 60 秒です。このパラメータはオプションです。

複数の INSTANCE パラメータ値が指定されている場合、CONNECTION_ATTEMPT_INTERVAL の値は、アダプタインスタンスのリスト全体を繰り返す試行間の待機秒数を定義します。

このパラメータはオプションであり、すべての Webject に適用されます。

DESCRIPTOR

Webject が実行する基本コマンドのコマンドフィルタに含む属性名。このパラメータは何度も指定してフィルタに含む複数の属性名を認識させることができます。

これらは、基本コマンドが実行するデータベース照会で返される属性です。ほとんどの場合、この属性セットは ATTRIBUTE パラメータによって認識される属性セットと組み合わせます。ただし、ATTRIBUTE パラメータは Webject の出力グループの各エレメントに返される属性セットも指定します。DESCRIPTOR パラメータは、Webject が実行する Windchill コマンドによってデータベースから選択されたビジネスオブジェクト属性の制御に使用されます。

GROUP_FILTER が指定されている場合、このパラメータは無視されます。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

FORMAT

オブジェクトごとに出力グループで返される属性をエンドユーザー向けにフォーマットするかどうかを指定します。TRUE を指定すると、各属性は表示値を返すようにフォーマットされます。FALSE を指定すると、各属性の未処理の内部値が返されます。

このパラメータのデフォルトは TRUE です。このパラメータはオプションです。

詳細については、カスタム Windchill アダプタ Webjectの属性変換の委任の定義セクションを参照してください。

このパラメータはオプションです。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

GROUP_FILTER

コマンドフィルタ (コマンドレイヤー AttributeContainerSpec) を含むグループの名前。

このパラメータを指定すると、参照するグループに 1 つのエレメントのみが含まれており、そのエレメントには command_filter という名前の属性が含まれていると見なされます。属性値は Java クラスの com.ptc.core.meta.container.common.AttributeContainerSpec のインスタンスであると見なされます。

このパラメータを指定すると、DESCRIPTOR、INCLUDE_DESCRIPTORS、INCLUDE_CONSTRAINTS、INCLUDE_ARGS、および NEXT_OP は無視されます。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

INCLUDE_ARGS

Webject によって実行される基本コマンドが実行結果にデータベースフィルタの属性コンテキスト関数の引数を含めるかどうかを指定します。TRUE または FALSE を指定します。このパラメータのデフォルトは FALSE です。GROUP_FILTER が指定されている場合、このパラメータは無視されます。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

INCLUDE_CONSTRAINTS

Webject によって実行される基本コマンドが制約情報を適用するかどうかを指定します。TRUE または FALSE を指定します。このパラメータのデフォルトは FALSE です。GROUP_FILTER が指定されている場合、このパラメータは無視されます。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

INCLUDE_DESCRIPTORS

Webject が実行した基本コマンドを実行結果の DESCRIPTOR パラメータ値に含めるかどうかを指定します。TRUE または FALSE を指定します。このパラメータのデフォルトは FALSE です。GROUP_FILTER が指定されている場合、このパラメータは無視されます。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

INSTANCE

Windchill アダプタの名前を指定します。Info*Engine の「プロパティ管理」ユーティリティでアダプタを設定するときに、アダプタ名を定義できます。詳細については、INSTANCE パラメータを使用したアダプタの名前の指定を参照してください。

このパラメータはすべての Webject で必須です。

NEXT_OP

Webject によって返されるオブジェクトに適用する次の操作の識別子を指定します。これにより、INCLUDE_CONSTRAINTS が TRUE に指定されている場合に適用される制約を決定します。GROUP_FILTER が指定されている場合、このパラメータは無視されます。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

PASSWD

Windchill システムへの認証に使用するパスワードを指定します。DBUSER パラメータを指定する場合は、PASSWD パラメータも指定する必要があります。

このパラメータはすべての Webject に適用されます。

認証およびユーザー認証の仕様の詳細については、Info*Engine User's Guide を参照してください。

REFERENCE_DELIMITER

属性参照を区切るために使用される区切り記号を指定します。このパラメータはオプションです。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

REFERENCE_EXCEPTIONS

ユーザーが参照オブジェクトを読み取るためのアクセス許可を持たない場合に、参照をたどり展開する Webject がどのように動作するかを指定します。このパラメータに有効な値は TRUE および FALSE です。

ユーザーが参照されているオブジェクトを読み取るためのアクセス許可を持たない場合は次のようになります。

• FORMAT に TRUE が指定され、REFERENCE_EXCEPTIONS に TRUE が指定された場合、アクセス制御例外が発生します。

• FORMAT に TRUE が指定され、REFERENCE_EXCEPTIONS に FALSE が指定された場合、「セキュリティ保護されている情報」などの文字列が表示されます。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

REFERENCE_OUTPUT_DELIMITER

出力の生成時に属性参照を区切るために使用される区切り記号。デフォルト値は REFERENCE_DELIMITER の値です。このパラメータはオプションです。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

SESSION_ID

Webject を実行するセッションの識別子。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

このパラメータはほとんどの Webject でオプションですが、次の Webject では必須です。

Commit-Transaction	Rollback-Transaction
End-Session	Start-Transaction

UNFORMATTED

FORMAT=true の場合に未フォーマットのままにする必要があるデータタイプ (たとえば java.sql.Timestamp などの完全修飾 Java クラス名)。このパラメータには複数の値を指定できます。このパラメータはオプションです。

このパラメータはすべての Webject に適用されるわけではありません。各 Webject の説明の「パラメータ」表を参照してください。

WHERE_CASE_SENSITIVITY

サーチが大文字小文字の区別をするかどうかを指定します。このパラメータのデフォルトは FALSE です。つまり、サーチでは大文字と小文字を区別しません。サーチで大文字と小文字を区別するには TRUE を指定します。

このパラメータは WHERE が指定されているときにのみ指定されます。