List-ContentItems
List-ContentItems Webject は、指定された Windchill オブジェクトのコンテンツアイテムを返します。指定された Windchill クラスは、ContentHolder インタフェースを実装している必要があります。
構文
<ie:webject name="List-ContentItems" type="OBJ">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONTAINER_REF" data="[ufid | MEMBERSHIP]"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DESCRIPTOR" data="attribute_name"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_FILTER" data="group_name"/>
<ie:param name="GROUP_IN" data="group_in"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INCLUDE_ARGS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_CONSTRAINTS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_DESCRIPTORS" data="[TRUE | FALSE]"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="NEXT_OP" data="operation_name"/>
<ie:param name="OBJECT_REF" data="object_ref"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="REFERENCE_DELIMITER" data="^" />
<ie:param name="REFERENCE_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_OUTPUT_DELIMITER" data="^" />
<ie:param name="STAGING_AREA" data="pathname"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="UNFORMATED" data="dataType"/>
<ie:param name="WHERE" data="where_clause"/>
<ie:param name="WHERE_CASE_SENSITIVITY" data="[TRUE | FALSE]"/>
</ie:webject>
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONTAINER_REF" data="[ufid | MEMBERSHIP]"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DESCRIPTOR" data="attribute_name"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_FILTER" data="group_name"/>
<ie:param name="GROUP_IN" data="group_in"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INCLUDE_ARGS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_CONSTRAINTS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_DESCRIPTORS" data="[TRUE | FALSE]"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="NEXT_OP" data="operation_name"/>
<ie:param name="OBJECT_REF" data="object_ref"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="REFERENCE_DELIMITER" data="^" />
<ie:param name="REFERENCE_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_OUTPUT_DELIMITER" data="^" />
<ie:param name="STAGING_AREA" data="pathname"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="UNFORMATED" data="dataType"/>
<ie:param name="WHERE" data="where_clause"/>
<ie:param name="WHERE_CASE_SENSITIVITY" data="[TRUE | FALSE]"/>
</ie:webject>
パラメータ
|
必須
|
相互依存
|
オプション
|
|---|---|---|
|
INSTANCE
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
CONTAINER_REF
|
ATTRIBUTE
|
|
|
DBUSER
|
CONNECTION_ATTEMPTS
|
|
|
DESCRIPTOR
|
CONNECTION_ATTEMPT_INTERVAL
|
|
|
GROUP_FILTER
|
FORMAT
|
|
|
INCLUDE_ARGS
|
GROUP_IN
|
|
|
INCLUDE_CONSTRAINTS
|
GROUP_OUT
|
|
|
INCLUDE_DESCRIPTORS
|
REFERENCE_DELIMITER
|
|
|
NEXT_OP
|
REFERENCE_OUTPUT_DELIMITER
|
|
|
OBJECT_REF
|
UNFORMATTED
|
|
|
PASSWD
|
||
|
REFERENCE_EXCEPTIONS
|
||
|
STAGING_AREA
|
||
|
TYPE
|
||
|
WHERE
|
||
|
WHERE_CASE_SENSITIVITY
|
 |
表に記載されているパラメータの定義が以下にない場合、そのパラメータは共通の定義を持っています。これらのパラメータの説明については、アダプタ Webject の概要の「一般 Webject パラメータ」セクションを参照してください。
|
CONTAINER_REF
Webject を適用する対象となる Windchill コンテキスト。このパラメータは以下のタイプの入力を受け取ります。
• Windchill コンテキストの UFID。このパラメータには複数の UFID を指定できます。
• MEMBERSHIP - ユーザーがメンバーになっているコンテキストのみが照会されます。
このパラメータを指定した場合、TYPE および WHERE パラメータに対して実行される照会の範囲は、関連付けられたコンテキストに限られます。
GROUP_IN
属性が出力グループに保持され、参照属性が逆参照される 1 つ以上のオブジェクトが含まれている入力グループの名前。
GROUP_IN パラメータ値は、同じタスクファイル内で指定されている Query-Objects Webject から取得できます。このパラメータは TYPE、WHERE、または OBJECT_REF パラメータの代わり、または追加として指定できます。
コンテンツホルダーオブジェクトを照会する Query-Objects Webject の出力グループは、この入力グループとして使用できます。
GROUP_OUT
結果を含む出力グループの名前。このパラメータが省略されると、出力グループの名前は文字列 "_Output" を Webject 名に追加することで構築されます。このパラメータはオプションです。
OBJECT_REF
コンテンツのリスト元である Windchill オブジェクトの Unique Federation Identifier (UFID)。
このパラメータには複数の値を指定できます。このパラメータは、WHERE および GROUP_IN の代わりに、または WHERE および GROUP_IN と組み合わせて使用できます。WHERE および GROUP_IN のいずれも指定しない場合は、OBJECT_REF を指定する必要があります。それ以外の場合、STAGING_AREA も使用できます。
STAGING_AREA
サーバー上の以前に保存されたコンテンツアイテムが置かれているファイルディレクトリの相対パスを指定します。
このパラメータを使用すると、特定のコンテンツホルダーオブジェクトに関連付けられたコンテンツアイテムのリストではなく、以前に保存されたコンテンツアイテムのリストが返されます。このパラメータと OBJECT_REF、TYPE、GROUP_IN、および WHERE パラメータは相互に排他的です。
WHERE および TYPE (または OBJECT_REF) のいずれも指定しない場合は、STAGING_AREA によって、以前 Add-ContentItems webject を使用してコンテンツアイテムをアップロードしたディレクトリを識別できます。この結果、List-ContentItems は以前に保存されたコンテンツアイテムの識別子を提供する要素を含んだ出力グループを返します。
各要素には、ソースファイルの名前を指定する source 属性と、保存コンテンツアイテムの識別子を示す staged_file_id 属性が含まれます。後でこの識別子を Add-ContentItems webject の STAGED_FILE_ID パラメータに使用して、データベースおよび Delete-ContentItems と Get-ContentItems webject に転送する保存アイテムを選択できます。
STAGING_AREA パラメータは、ステージング領域のルートのファイルディレクトリパスを指定する wt.adapter.stagingAreaRoot プロパティを管理者が定義している場合にのみ有効になっています。STAGING_AREA パラメータで指定した値はこのプロパティに付加され、保存コンテンツアイテムが保存されているディレクトリへの絶対パスが生成されます。wt.adapter.stagingAreaRoot プロパティは、wt.properties ファイルで設定できます。
保存されたファイルの絶対パスは次のとおりです。
stagingAreaRoot/STAGING_AREA/ユーザー名
• stagingAreaRoot は wt.adapter.stagingAreaRoot プロパティに定義された値です。
• STAGING_AREA はこのパラメータに指定された値です。
• username は現在のユーザーの名前です。
現在のユーザーが別のユーザー名を 1 つ以上持っている場合、ステージング領域のディレクトリパスを生成する際に使用されるのがどのユーザー名になるか予測またはコントロールすることはできません。
TYPE
照会するオブジェクトの通知可能な Windchill タイプの名前を指定します。WHERE を指定した場合、TYPE も指定される必要があります。OBJECT_REF はこのパラメータの代わり、または追加として指定できます。
WHERE
照会するオブジェクトを識別する照会定義式。このパラメータは、OBJECT_REF および GROUP_IN の代わりに、または OBJECT_REF および GROUP_IN と組み合わせて使用できます。OBJECT_REF および GROUP_IN のいずれも指定しない場合は、WHERE を指定する必要があります。WHERE を指定した場合、TYPE も指定される必要があります。詳細については、TYPE および WHERE パラメータの指定を参照してください。