Delete-ContentItems
wt.doc.WTDocment や wt.part.WTPart など、コンテンツホルダーである Windchill オブジェクトからコンテンツアイテムを削除するか、以前に保存したコンテンツを削除します。以前に保存したコンテンツを削除すると、この Webject は空の出力グループを返します。
構文
<ie:webject name="Delete-ContentItems" type="ACT">
<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="CONTENT_ITEM" data="item"/>
<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_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="ufid"/>
<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="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="STAGED_FILE_ID" data="file_id" />
<ie:param name="STAGING_AREA" data="/" />
<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
|
|
CONTENT_ITEM
|
CONNECTION_ATTEMPTS
|
|
DBUSER
|
CONNECTION_ATTEMPT_INTERVAL
|
|
DESCRIPTOR
|
FORMAT
|
|
GROUP_FILTER
|
GROUP_OUT
|
|
INCLUDE_ARGS
|
REFERENCE_DELIMITER
|
|
INCLUDE_CONSTRAINTS
|
REFERENCE_OUTPUT_DELIMITER
|
|
INCLUDE_DESCRIPTORS
|
SESSION_ID
|
|
NEXT_OP
|
UNFORMATTED
|
|
OBJECT_REF
|
|
|
PASSWD
|
|
|
REFERENCE_EXCEPTIONS
|
|
|
STAGED_FILE_ID
|
|
|
STAGING_AREA
|
|
|
TYPE
|
|
|
WHERE
|
|
|
WHERE_CASE_SENSITIVITY
|
|
|
表に記載されているパラメータの定義が以下にない場合、そのパラメータは共通の定義を持っています。これらのパラメータの説明については、 アダプタ Webject の概要のセクション「一般 Webject パラメータ」を参照してください。
|
CONTAINER_REF
Webject を適用する対象となる Windchill コンテキスト。このパラメータは以下のタイプの入力を受け取ります。
• Windchill コンテキストの UFID。このパラメータには複数の UFID を指定できます。
• MEMBERSHIP - ユーザーがメンバーになっているコンテキストのみが照会されます。
このパラメータを指定した場合、TYPE および WHERE パラメータに対して実行される照会の範囲は、関連付けられたコンテキストに限られます。
CONTENT_ITEM
削除するコンテンツアイテムの UFID。コンテンツアイテムは、TYPE、WHERE、または OBJECT_REF パラメータによって指定されるコンテンツホルダーオブジェクトに含まれています。このパラメータの値は、List-ContentItems Webject によって生成された GROUP_OUT の各要素に返された OBID 属性となり得ます。STAGED_FILE_ID を指定しない場合、このパラメータは必須です。
GROUP_OUT
結果を含む出力グループの名前。このパラメータが省略されると、出力グループの名前は文字列 "_Output" を Webject 名に追加することで構築されます。このパラメータはオプションです。
OBJECT_REF
Windchill オブジェクトの Unique Federation Identifier (UFID)。複数の値を指定して複数のオブジェクトを識別できます。
このパラメータは、WHERE の代わりに、または WHERE と組み合わせて使用できます。WHERE を指定しない場合は、OBJECT_REF を指定する必要があります。
STAGED_FILE_ID
削除の対象となる、以前に保存されたコンテンツアイテムの識別子。その後 Webject は特定の保存済みコンテンツアイテムを削除し、空の出力グループを返します。このパラメータには複数の値を指定できます。
STAGING_AREA
サーバー上の以前に保存されたコンテンツアイテムが置かれているファイルディレクトリの相対パス。
STAGING_AREA パラメータは、ステージング領域のルートのファイルディレクトリパスを指定する wt.adapter.stagingAreaRoot プロパティを管理者が定義している場合にのみ有効になっています。STAGING_AREA パラメータで指定した値はこのプロパティに付加され、保存コンテンツアイテムが保存されているディレクトリへの絶対パスが生成されます。wt.adapter.stagingAreaRoot プロパティは、wt.properties ファイルで設定できます。
保存されたファイルの絶対パスは次のとおりです。
stagingAreaRoot/STAGING_AREA/ユーザー名
• stagingAreaRoot は wt.adapter.stagingAreaRoot プロパティに定義された値です。
• STAGING_AREA はこのパラメータに指定された値です。
• username は現在のユーザーの名前です。
現在のユーザーが別のユーザー名を 1 つ以上持っている場合、ステージング領域のディレクトリパスを生成する際に使用されるのがどのユーザー名になるか予測またはコントロールすることはできません。
TYPE
オブジェクトタイプの名前。WHERE を指定した場合、TYPE も指定する必要があります。詳細については、
TYPE および WHERE パラメータの指定を参照してください。
WHERE
新規コンテンツを削除するコンテンツホルダーを選択する照会定義式。このパラメータは、OBJECT_REF の代わりに、または OBJECT_REF と組み合わせて使用できます。
OBJECT_REF が指定されていない場合、WHERE を指定する必要があります。WHERE を指定した場合、TYPE も指定する必要があります。詳細については、
TYPE および WHERE パラメータの指定を参照してください。