CheckOut-Objects
CheckOut-Objects Webject は、オブジェクトを Windchill からチェックアウトします。
一般的に、チェックアウトは、さまざまな方法でオブジェクトを更新するために実行されます。これにより、オブジェクトは長期間排他的にロックされ、チェックインするまでほかのユーザーが修正できないようになります (CheckIn-Objects Webject を参照)。チェックアウト時にエラーが発生すると、Webject はエラーメッセージを返し、オブジェクトはチェックアウトされません。
GROUP_IN を指定し、その値が GROUP_OUT と同じで、ほかの入力パラメータを指定していない場合、入力グループ内の UFID は作業コピー UFID で更新されます。これにより、最低限の作業量で CheckOut-Objects の出力をほかの Webject (Update-Objects など) への入力として使用できます。
構文
<ie:webject name="CheckOut-Objects" 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="CHECKOUT_FOLDER_GROUP"
data="check_out_folder"/>
<ie:param name="COMMENT" data="string"/>
<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="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="RESERVED_COPY_GROUP" data="reserved_copy"/>
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="UNFORMATTED" data="dataType" />
<ie:param name="WHERE" data="appl_name"/>
<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="CHECKOUT_FOLDER_GROUP"
data="check_out_folder"/>
<ie:param name="COMMENT" data="string"/>
<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="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="RESERVED_COPY_GROUP" data="reserved_copy"/>
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="UNFORMATTED" data="dataType" />
<ie:param name="WHERE" data="appl_name"/>
<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
|
CHECKOUT_FOLDER_GROUP
|
|
|
INCLUDE_ARGS
|
COMMENT
|
|
|
INCLUDE_CONSTRAINTS
|
FORMAT
|
|
|
INCLUDE_DESCRIPTORS
|
GROUP_IN
|
|
|
NEXT_OP
|
GROUP_OUT
|
|
|
OBJECT_REF
|
REFERENCE_DELIMITER
|
|
|
PASSWD
|
REFERENCE_OUTPUT_DELIMITER
|
|
|
REFERENCE_EXCEPTIONS
|
RESERVED_COPY_GROUP
|
|
|
TYPE
|
SESSION_ID
|
|
|
WHERE
|
UNFORMATTED
|
|
|
WHERE_CASE_SENSITIVITY
|
 |
表に記載されているパラメータの定義が以下にない場合、そのパラメータは共通の定義を持っています。これらのパラメータの説明については、アダプタ Webject の概要のセクション「一般 Webject パラメータ」を参照してください。
|
CHECKOUT_FOLDER_GROUP
チェックアウトしたオブジェクトのチェックアウトフォルダ。このパラメータが指定されている場合、オブジェクトがチェックアウトされるフォルダに参照が返されます。このパラメータはオプションです。
COMMENT
コメントとして追加するテキスト文字列。このパラメータはオプションです。
CONTAINER_REF
Webject を適用する対象となる Windchill コンテキスト。このパラメータは以下のタイプの入力を受け取ります。
• Windchill コンテキストの UFID。このパラメータには複数の UFID を指定できます。
• MEMBERSHIP - ユーザーがメンバーになっているコンテキストのみが照会されます。
このパラメータを指定した場合、TYPE および WHERE パラメータに対して実行される照会の範囲は、関連付けられたコンテキストに限られます。
GROUP_IN
エレメントごとに 1 つの UFID が含まれている入力グループの名前 (OBID 属性)。このパラメータはオプションです。
GROUP_OUT
結果を含む出力グループの名前。このパラメータが省略されると、出力グループの名前は文字列 "_Output" を Webject 名に追加することで構築されます。このパラメータはオプションです。
OBJECT_REF
Windchill オブジェクトの Unique Federation Identifier (UFID)。複数の値を指定して複数のオブジェクトを識別できます。
このパラメータは、WHERE の代わりに、または WHERE と組み合わせて使用できます。WHERE を指定しない場合は、OBJECT_REF を指定する必要があります。
RESERVED_COPY_GROUP
チェックアウトされたオブジェクトの予約コピー。このグループには GROUP_OUT に返された作オブジェクトではなく元のオブジェクトが含まれます。このパラメータはオプションです。
TYPE
オブジェクトタイプの名前。WHERE を指定した場合、TYPE も指定する必要があります。詳細については、TYPE および WHERE パラメータの指定を参照してください。
WHERE
照会するオブジェクトを識別する照会定義式。このパラメータは、OBJECT_REF の代わりに、または OBJECT_REF と組み合わせて使用できます。
OBJECT_REF が指定されていない場合、WHERE を指定する必要があります。WHERE を指定した場合、TYPE も指定する必要があります。詳細については、TYPE および WHERE パラメータの指定を参照してください。