Revise-Objects
The Revise-Objects webject advances the revision of Windchill objects. If multiple objects are specified, and a single object cannot be revised, then an exception is thrown and none of the specified objects are revised.
Objects do not need to be checked out to be revised by this webject.
Syntax
<ie:webject name="Revise-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="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="FIELD" data="field"/>
<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="MODIFICATION"
data="[REPLACE | ADD | DELETE | REMOVE]" />
<ie:param name="NEXT_OP" data="operation_name"/>
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="ONE_OFF_VERSION" data="[TRUE | FALSE]"/>
<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="TYPE" data="type_name"/>
<ie:param name="UNFORMATTED" data="dataType" />
<ie:param name="WHERE" data="where_clause"/>
<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
|
|
FIELD
|
FORMAT
|
|
GROUP_FILTER
|
GROUP_OUT
|
|
GROUP_IN
|
MODIFICATION
|
|
INCLUDE_ARGS
|
ONE_OFF_VERSION
|
|
INCLUDE_CONSTRAINTS
|
REFERENCE_DELIMITER
|
|
INCLUDE_DESCRIPTORS
|
REFERENCE_OUTPUT_DELIMITER
|
|
NEXT_OP
|
SESSION_ID
|
|
OBJECT_REF
|
UNFORMATTED
|
|
PASSWD
|
|
|
REFERENCE_EXCEPTIONS
|
|
|
TYPE
|
|
|
WHERE
|
|
|
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. |
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.
FIELD
An attribute and associated value to be included in the requested operation. The attribute and associated value are separated by an equals sign. For example:
<ie:param name="FIELD" data="source=wt.part.Source.make"/>
The attribute and value are dependent on the object and operation being performed. This parameter is optional. This parameter can have multiple values.
GROUP_IN
One or more objects to be revised. The OBID attribute of each element selects the object to be updated. The other attributes in each element specify values to be replaced, added, or deleted.
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.
MODIFICATION
Specifies how attributes are being modified. Acceptable values are REPLACE, ADD, DELETE, and REMOVE. The default value is REPLACE. 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.
ONE_OFF_VERSION
Specifies whether the webject should create a new version of each object or a one-off version of each object. A value of TRUE creates a one-off version of each object. The default for this parameter is FALSE. 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
Specifies a query expression identifying the objects to be revised. This parameter can be used instead of or in combination with OBJECT_REF and GROUP_IN.
If WHERE is specified, then TYPE must also be specified. For more information, see
Specifying the TYPE and WHERE Parameters.
