Query-Type-Tree
|
|
This webject is no longer used. Instead, use the Query-TypeHierarchy webject. For details on the Query-TypeHierarchy webject, see Query-TypeHierarchy. |
The Query-Type-Tree webject returns a group containing the display names for Windchill object types and their descendants. The group is a hierarchical list of elements.
Syntax
<ie:webject name="Query-Type-Tree" type="OBJ" >
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ADD_ALL_TYPE" data="[TRUE | FALSE]"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONTAINER_REF" data="[ufid | MEMBERSHIP]"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<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_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="ROOT_LEVEL" data="root_level"/>
<ie:param name="SEARCH_TYPE"
data="[ROOT_TYPES | HARD_TYPES | SOFT_TYPE | BOTH]"/>
<ie:param name="SESSION_ID" data="$(session_id[]SESSION_ID[])"/>
</ie:webject>
Parameters
|
Required
|
Interdependent
|
Optional
|
|
INSTANCE
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
ROOT_LEVEL
|
CONTAINER_REF
|
ADD_ALL_TYPE
|
|
DBUSER
|
FORMAT
|
|
INCLUDE_ARGS
|
GROUP_OUT
|
|
INCLUDE_CONSTRAINTS
|
SEARCH_TYPE
|
|
INCLUDE_DESCRIPTORS
|
SESSION_ID
|
|
NEXT_OP
|
|
|
OBJECT_REF
|
|
|
PASSWD
|
|
|
REFERENCE_EXCEPTIONS
|
|
|
|
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 Common Webject Parameters section in Adapter Webjects Overview. |
ADD_ALL_TYPE
If more than one type is specified in the ROOT_LEVEL parameter and this parameter is set to TRUE, a dummy type (of type wt.fc.Persistable) is returned with a display value of “All.”
CONTAINER_REF
The Unique Federation Identifier (UFID) of the organization context that should be used to retrieve the subtypes, provided the parameter SEARCH_TYPE is set to SOFT_TYPES or BOTH.
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 an existing object type that serves as the base object, and returns all descendants associated with types specified in the SEARCH_TYPE parameter.
ROOT_LEVEL
The object types that are the top-level nodes in the resulting group. The ROOT_LEVEL parameter is a required parameter that must contain one or more objects to be part of the resulting group.
SEARCH_TYPE
Specifies what type of descendants should be returned for each object type specified in the ROOT_LEVEL parameter.
• ROOT_TYPES—No descendants are returned, and only the types specified in the ROOT_LEVEL parameter are returned in the group.
• HARD_TYPES—Only descendants that are provide by PTC are returned along with the parent type.
• SOFT_TYPES—Only descendants that are customer-created are returned along with the parent type.
• BOTH—Descendants that are PTC-provided and customer-created types are returned along with the parent type.
