CheckOut-Objects
The CheckOut-Objects webject checks out objects from Windchill.
Typically, objects are checked out in order to update them in various ways, and to maintain a long-term exclusive lock on them to prevent others from modifying them until they are checked in (see the CheckIn-Objects webject). If an error occurs during checkout, the webject returns an error message and no object is checked out.
If GROUP_IN is specified and its value is equal to GROUP_OUT and no other input parameters are specified, then the UFIDs within the input group are updated with the working copy UFIDs. This allows the output of CheckOut-Objects to be used as input to other webjects (for example, Update-Objects) with minimal effort.
Syntax
<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>
Parameters
Required
Interdependent
Optional
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
* 
If a parameter is listed in the table but is not defined below, then it has a common parameter definition. For descriptions of those parameters, see the section Common Webject Parameters in Adapter Webjects Overview.
CHECKOUT_FOLDER_GROUP
The checkout folder of the checked out object. If this parameter is specified, then a reference is returned to the folder in which the object or objects are checked out. This parameter is optional.
COMMENT
Any text string to be added as comment. This parameter is optional.
CONTAINER_REF
A Windchill context to apply the webject against. This parameter accepts the following types of input:
The UFID of a Windchill context. Multiple UFIDs can be specified for this parameter.
MEMBERSHIP—The query finds only those contexts of which the user is a member.
When this parameter is specified, the scope of queries executed against the TYPE and WHERE parameters are restricted to the associated context.
GROUP_IN
The name of an input group containing one UFID per element (OBID attribute). This parameter is optional.
GROUP_OUT
The name of the output group containing the results. If this parameter is omitted, then the name of the output group is constructed by appending the string “-Output” to the webject name. This parameter is optional.
OBJECT_REF
The Unique Federation Identifier (UFID) of a Windchill object. Multiple values can be specified for this parameter to identify multiple objects.
This parameter can be used instead of or in combination with WHERE. If WHERE is not specified, then OBJECT_REF must be specified.
RESERVED_COPY_GROUP
The reserved copy of the checked out object. This group contains the original objects, not the working objects returned in the GROUP_OUT. This parameter is optional.
TYPE
The object type name. If WHERE is specified, TYPE must also be specified. For more information, see Specifying the TYPE and WHERE Parameters.
WHERE
A query expression identifying the objects for which to query. This parameter can be used instead of or in combination with OBJECT_REF.
If OBJECT_REF is not specified, WHERE must be specified. If WHERE is specified, TYPE must also be specified. For more information, see Specifying the TYPE and WHERE Parameters.
这对您有帮助吗?