Query-Links
The Query-Links webject navigates associations between Windchill objects. If it is given a base object, it returns all of the objects associated with the base object by a specified relationship and role.
Syntax
<ie:webject name="Query-Links" type="OBJ">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute_name"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="AUTO_NAVIGATE" data="[TRUE|FALSE]"/>
<ie:param name="CONFIGSPEC_OBJECT_META" data="meta_name"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONTENT_TYPE" data="content_type"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DESCRIPTOR" data="attribute_name"/>
<ie:param name="DIRECTION" data="role-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="OUTPUT_TYPE"
data="[OTHER_SIDE | RELATION | FULL]"/>
<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="SELECTBY" data="config_spec_name" />
<ie:param name="SELECTBY_BASELINE_REF"
data="selectby_baseline" />
<ie:param name="SELECTBY_CONFIG_ITEM_REF" data="ufid" />
<ie:param name="SELECTBY_CONFIGSPEC_REF" data="ufid" />
<ie:param name="SELECTBY_DATE" data="date" />
<ie:param name="SELECTBY_IN_USE_BY_USER" data="[TRUE | FALSE]" />
<ie:param name="SELECTBY_INCLUDE_WORKING" data="[TRUE | FALSE]"/>
<ie:param name="SELECTBY_LIFECYCLE_STATE"
data="selectby_lifecycle_state" />
<ie:param name="SELECTBY_UNIT" data="unit_value" />
<ie:param name="SELECTBY_VIEW_REF" data="view_object_ufid" />
<ie:param name="TYPE" data="type_name"/>
<ie:param name="UNFORMATTED" data="dataType" />
</ie:webject>
Parameters
|
Required
|
Interdependent
|
Optional
|
|
DIRECTION
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
INSTANCE
|
CONFIGSPEC_OBJECT_META
|
ATTRIBUTE
|
|
TYPE
|
DBUSER
|
AUTO_NAVIGATE
|
|
GROUP_IN
|
CONNECTION_ATTEMPTS
|
|
DESCRIPTOR
|
CONNECTION_ATTEMPT_INTERVAL
|
|
GROUP_FILTER
|
CONTENT_TYPE
|
|
INCLUDE_ARGS
|
FORMAT
|
|
INCLUDE_CONSTRAINTS
|
GROUP_OUT
|
|
INCLUDE_DESCRIPTORS
|
OUTPUT_TYPE
|
|
NEXT_OP
|
REFERENCE_DELIMITER
|
|
OBJECT_REF
|
REFERENCE_OUTPUT_DELIMITER
|
|
PASSWD
|
UNFORMATTED
|
|
REFERENCE_EXCEPTIONS
|
|
|
SELECTBY
|
|
|
SELECTBY_BASELINE_REF
|
|
|
SELECTBY_CONFIG_ITEM_REF
|
|
|
SELECTBY_CONFIGSPEC_REF
|
|
|
SELECTBY_DATE
|
|
|
SELECTBY_IN_USE_BY_USER
|
|
|
SELECTBY_INCLUDE_WORKING
|
|
|
SELECTBY_LIFECYCLE_STATE
|
|
|
SELECTBY_UNIT
|
|
|
SELECTBY_VIEW_REF
|
|
|
|
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. |
AUTO_NAVIGATE
Specifies whether the initial navigation results should be post-processed automatically to produce results that are usually more directly usable. If not specified, the default value is TRUE. This parameter is optional.
In Windchill, product structures are constructed from iterated and versioned objects that have a master and iteration data model.
The root of a product structure is a master object that might have multiple iterations. Masters are linked to their iterations, and each iteration is linked, in turn, to the masters that represent their children in the product structure. Typically, applications do not want to navigate the master and iteration links themselves. Instead, they prefer to see only the iterations, which contain all of the relevant attributes.
The AUTO_NAVIGATE parameter enables the webject to navigate automatically from masters to iterations so that the output group contains the information that the federated client application typically seeks. The AUTO_NAVIGATE parameter also enables the webject to de-reference LightweightProxy objects automatically, returning elements in the output group that have been retrieved from remote systems.
CONFIGSPEC_OBJECT_META
The name of the metadata containing the ConfigSpec object to use when filtering objects. This parameter only applies if SELECTBY=CONFIGSPEC_OBJECT.
This parameter is not required. The default value is com.ptc.windchill.configSpec.
CONTENT_TYPE
The types of objects to return. Multiple values can be specified for this parameter in order to identify multiple types of objects to return. Each value of this parameter is the fully qualified name of a modeled class or subtype.
If this parameter is omitted, all objects contained within the folder are returned. This parameter is optional.
DIRECTION
The role of the link class played by the objects to be returned. For example: usedBy, references, and referencedBy. Valid values are dependent upon the link classes defined by the TYPE parameter. This parameter is required.
GROUP_IN
Specifies a group containing objects. For each element of the group that contains an object ID (OBID) attribute, the object referenced by the OBID attribute value is used as a base object.
If not specified, the OBJECT_REF parameter must be specified. If the OBJECT_REF parameter is not specified, this parameter must be specified. If both the OBJECT_REF and GROUP_IN parameters are specified, the multiple indicated base objects are navigated.
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 the Windchill object from which to list contents.
Multiple values can be specified for this parameter. This parameter can be used instead of or in combination with WHERE and GROUP_IN. If neither WHERE nor GROUP_IN is specified, OBJECT_REF must be specified. Otherwise, you can also use STAGING_AREA.
OUTPUT_TYPE
Specifies whether to return the associated objects, the link objects themselves, or both. Link objects are the objects defining the relationship between two objects. Valid values for this parameter are the following:
• OTHER_SIDE—Returns the objects to which objects specified by TYPE, WHERE, or OBJECT_REF are related.
• RELATION—Returns the link objects themselves.
• FULL—Returns the objects to which specified objects are related, merged with attributes from the link objects that define each such relationship. The name of each attribute obtained from a link object is formed by concatenating the object class name of the link object with attribute name from the link object in the following format:
wt.part.WTPartUsageLink.quantity.amount
◦ wt.part.WTPartUsageLink is the class of a link object.
◦ quantity.amount is the name of the link object attribute.
The default for this parameter is OTHER_SIDE. This parameter is optional.
SELECTBY
The Windchill configuration specification that is applied when the objects referenced by the specified type of link are members of a product structure (versioned objects). Valid values for this parameter are:
• LATEST—Returns the latest versions of the objects.
• USER—Returns objects selected by the default configuration specification defined for the calling user. If the calling user has no default configuration specification, LATEST is used.
• BASELINE—Returns objects associated with a specific baseline. The SELECTBY_BASELINE_REF parameter must also be specified to identify the baseline to apply.
• VIEW—Returns objects associated with a specific view. The SELECTBY_VIEW_REF parameter must also be specified to identify the view to apply.
• LIFECYCLE —Returns objects associated with a specific lifecycle state. The SELECTBY_LIFECYCLE_STATE parameter must also be specified to identify the lifecycle state to apply.
• IN_USE—Returns objects that are in use.
• EFFECTIVITY—Returns objects associated with specific effectivities. The SELECTBY_CONFIG_ITEM_REF, SELECTBY_DATE, and SELECTBY_UNIT parameters must also be specified to define the effectivity constraints to apply.
• STANDARD—Returns objects associated with the standard configuration specification. The SELECTBY_VIEW_REF, SELECTBY_LIFECYCLE_STATE, and SELECTBY_INCLUDE_WORKING parameters can also be specified to identify constraints to apply.
|
|
This value is specific to WTPart objects.
|
• STANDARD_DOCUMENT—Selects objects associated with the standard configuration specification. The SELECTBY_LIFECYCLE_STATE, SELECTBY_INCLUDE_WORKING, and SELECTBY_IN_USE_BY_USER parameters can also be specified to identify constraints to apply.
• CONFIGSPEC_REF—Selects objects based on a configured and persisted ConfigSpec object. The SELECTBY_CONFIGSPEC_REF parameter must also be specified.
• CONFIGSPEC_OBJECT—Allows a custom ConfigSpec object to be programmatically constructed and passed to the webject to use during filtering. The CONFIGSPEC_OBJECT_META parameter may also be specified. Using the SELECTBY value requires that a GROUP_IN is supplied to seed navigation and that the ConfigSpec object has been stored on the GROUP_IN object as metadata.
The default for this parameter is LATEST. This parameter is ignored when AUTO_NAVIGATE is specified as FALSE
SELECTBY_BASELINE_REF
The UFID of a baseline object used when SELECTBY is specified as BASELINE.
SELECTBY_CONFIG_ITEM_REF
The UFID of a configuration item used when SELECTBY is specified as EFFECTIVITY. When this parameter is specified, either SELECTBY_DATE or SELECTBY_UNIT must also be specified.
SELECTBY_CONFIGSPEC_REF
A reference to a persisted ConfigSpec object to use in filtering objects.
SELECTBY_DATE
A date used when SELECTBY is specified as EFFECTIVITY. This parameter can be used by itself, or it in conjunction with SELECTBY_CONFIG_ITEM_REF.
SELECTBY_IN_USE_BY_USER
Specifies whether only to select objects in use by the user. This parameter is a boolean. It is only used of SELECTBY=STANDARD_DOCUMENT. If not specified, then in use is not used as criteria when selecting objects.
SELECTBY_INCLUDE_WORKING
Specifies whether to include working objects when SELECTBY is specified as STANDARD. Working objects are objects in the personal cabinet of a user. Valid values for this parameter are TRUE and FALSE. The default for this parameter is TRUE.
SELECTBY_LIFECYCLE_STATE
The name of a life cycle state used when SELECTBY is specified as LIFECYCLE or STANDARD.
SELECTBY_UNIT
A unit value used when SELECTBY is specified as EFFECTIVITY. If this parameter is specified, then SELECTBY_CONFIG_ITEM_REF must also be specified.
SELECTBY_VIEW_REF
The UFID of a view object used when SELECTBY is specified as VIEW or STANDARD.
TYPE
Specifies the name of the notifiable Windchill type of the objects to be queried for. If WHERE is specified, then TYPE must also be specified. OBJECT_REF can be specified instead of, or in addition to, this parameter.
OBJECT_REF can be specified instead of or in addition to this parameter. This parameter is required.
