Get-ContentItems
The Get-ContentItems webject retrieves content from Windchill objects that are content holders and returns them in an Info*Engine BLOB stream. For example, the webject retrieves content such as documents, spreadsheets, and CAD files, from wt.doc.WTDocument and wt.part.WTPart.
Syntax
<ie:webject name="Get-ContentItems" 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="MIME_TYPE" data="text/plain" />
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="STAGED_FILE_ID" data="file_id" />
<ie:param name="STAGING_AREA" data="/" />
<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>
<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="MIME_TYPE" data="text/plain" />
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="STAGED_FILE_ID" data="file_id" />
<ie:param name="STAGING_AREA" data="/" />
<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
|
|
|
MIME_TYPE
|
GROUP_OUT
|
|
|
OBJECT_REF
|
||
|
PASSWD
|
||
|
STAGED_FILE_ID
|
||
|
STAGING_AREA
|
||
|
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 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
The name of the input group containing one or more objects whose attributes are retained in the output group and whose reference attributes will be dereferenced.
The GROUP_IN parameter value can be obtained from Query-Objects webject specified within the same task file. This parameter can be specified instead of or in addition to TYPE, WHERE, or OBJECT_REF.
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.
MIME_TYPE
The MIME type to use when downloading a previously staged content item. This parameter is only used if STAGED_FILE_ID is specified.
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.
STAGED_FILE_ID
The identifier of a previously staged content item to be downloaded instead of downloading content from an object.
STAGING_AREA
A relative path to a file directory located on a server where content items that have been previously staged are now located.
The STAGING_AREA parameter is enabled only when an administrator has defined the wt.adapter.stagingAreaRoot property, which identifies the root file directory path of the staging area. The value specified for the STAGING_AREA parameter is appended to this property to create an absolute file path to the directory in which staged content items are stored. The wt.adapter.stagingAreaRoot property can be set in the wt.properties file
The absolute path for the staged files is:
stagingAreaRoot/STAGING_AREA/username
• stagingAreaRoot is the value defined for the wt.adapter.stagingAreaRoot property.
• STAGING_AREA is the value specified for this parameter.
• username is the user name of the current user.
If the current user has one or more alternate user names, you cannot predict or control which alternate name will be used to build the staging area directory path.
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.