Get-IconURL
The Get-IconURL webject constructs an output group containing icons associated with one or more objects. The output group contains one element per object. Each element contains the following attributes: class, obid, and icon.
Each element can also contain a tooltip attribute if a tooltip is available. Each element can also contain one or more glyph attributes depending on a the current state of the object.
Syntax
<ie:webject name="Get-IconURL" type="OBJ">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<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="GROUP_FILTER" data="group_name"/>
<ie:param name="GROUP_IN" data="group_in"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="TYPE" data="type_name"/>
<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
|
CONNECTION_ATTEMPTS
|
|
DBUSER
|
CONNECTION_ATTEMPT_INTERVAL
|
|
GROUP_FILTER
|
GROUP_IN
|
|
OBJECT_REF
|
GROUP_OUT
|
|
PASSWD
|
|
|
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 Common Webject Parameters section 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.
GROUP_IN
Name of an input group containing the objects for which to fetch icon URLs.
When the value of GROUP_IN equals the value of GROUP_OUT, a new group is not created and the related icon attributes are added to the input group.
When GROUP_IN is specified, the objects in the group are not re-fetched from the database. As a result, for the webject to generate useful icon information, it is necessary for each element of the input group to contain a specific set of attributes:
• format.standardIconStr
• checkoutInfo.state
• containerReference
• oneOffVersionInfo.identifier.oneOffVersionId
For EPM documents, the attributes are authoringApplication and docType. 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.
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.
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.
