Describe-Attributes
Describes the specified attributes and produces introspection data for the specified Windchill type name.
The output group includes the following attributes:
|
name
|
defaultValue
|
|
displayName
|
required
|
|
type
|
hidden
|
|
upperLimit
|
valueHidden
|
|
lowerLimit
|
editable
|
The value of the required attribute is dependant on the value of the NEXT_OP parameter.
The values of the hidden, valueHidden, and editable attributes are dependant on the values of the INCLUDE_CONSTRAINTS and NEXT_OP parameters.
For attributes with subclass wt.fc.EnumeratedType, a list of valid values is provided with the following attributes:
|
value
|
fullDisplay
|
|
localizedValue
|
shortDescription
|
|
stringValue
|
longDescription
|
|
localizedDefaultValue
|
selectableValue
|
|
abbreviatedDisplay
|
unSelectableValue
|
Syntax
<ie:webject name="Describe-Attributes" type="OBJ">
<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_ATTEMPTS_INTERVAL" data="attempts"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INCLUDE_ATTRIBUTES_FROM_SOURCE"
data="[SURFACE | ALL]"/>
<ie:param name="INCLUDE_CONSTRAINTS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_DESCRIPTORS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_SOFT_ATTRIBUTES" data="[TRUE | FALSE]"/>
<ie:param name="INSTANCE" data="appl_name"/><ie:param
<ie:param name="NEXT_OP" data="operation_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="TYPE" data="type"/>
<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="CONNECTION_ATTEMPTS" data = "attempts"/>
<ie:param name="CONNECTION_ATTEMPTS_INTERVAL" data="attempts"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INCLUDE_ATTRIBUTES_FROM_SOURCE"
data="[SURFACE | ALL]"/>
<ie:param name="INCLUDE_CONSTRAINTS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_DESCRIPTORS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_SOFT_ATTRIBUTES" data="[TRUE | FALSE]"/>
<ie:param name="INSTANCE" data="appl_name"/><ie:param
<ie:param name="NEXT_OP" data="operation_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="TYPE" data="type"/>
<ie:webject>
Parameters
|
Required
|
Interdependent
|
Optional
|
|---|---|---|
|
INSTANCE
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
TYPE
|
DBUSER
|
ATTRIBUTE
|
|
INCLUDE_CONSTRAINTS
|
CONNECTION_ATTEMPTS
|
|
|
INCLUDE_DESCRIPTORS
|
CONNECTION_ATTEMPT_INTERVAL
|
|
|
INCLUDE_SOFT_ATTRIBUTES
|
GROUP_OUT
|
|
|
NEXT_OP
|
INCLUDE_ATTRIBUTES_FROM_SOURCE
|
|
|
PASSWD
|
 |
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 Common Webject Parameters section in Adapter Webjects Overview.
|
ATTRIBUTE
Specifies the attributes to be described for the specified type. Multiple values can be specified for this parameter. If this parameter is not specified, a default set of attributes is returned.
The default set of attributes for a type is configured in DefaultAttributes property of the wt.adapter.delegates.properties file. If the DefaultAttributes property is not defined, all attributes of all objects are returned. 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.
INCLUDE_ATTRIBUTES_FROM_SOURCE
Specifies whether the returned attributes are filtered so that only surface attributes are exposed or if all attributes are returned. Specifying SURFACE returns only the surface attributes. The default for this parameter is ALL. This parameter is optional.
INCLUDE_SOFT_ATTRIBUTES
Specifies whether to include global attributes along with modeled attributes. By default, only modeled attributes are included in the output.
TYPE
Specifies the type of the object to be described. For example, the fully qualified Java class name wt.part.WTPart can be supplied. This parameter is required.