State Filter Attributes and Parameters

Below are the attributes and parameters along with a detailed description.

Attributes

Attribute Name

Description

Name

Descriptive name of the task.

Type

“StateFilter”

Parameters

Parameters are inherited from Collection and referencing elements (i.e. Task).

Parameter Name

Description

containerName

Name of the product or library to be queried

containerType

Internal object type name of the container to be queried. The out-of-the-box Library container name is “wt.inf.library.WTLibrary”. The out-of-the-box Product container name is “wt.pdmlink.PDMLinkProduct”. If containerName is specified, containerType is required.

State

Internal name of the target state. Required.

objectType

The fully qualified name of the object type to be queried. The default Document object type is “WCTYPE|wt.doc.WTDocument” and the default EPM Document Type is “WCTYPE|wt.epm.EPMDocument”

Folder

The container folder to be queried. For example “/Publications”.

Criteria

Any additional criteria to be included in the query. The criteria must confirm to the Info*Engine Search-Objects task WHERE Clause. For additional information, refer to the PTC Windchill Adapters Guide.

excludeIfLaterRevision

If the objects returned by the filter are of a later version that what is already been returned by previous filters, if excludeIfLaterRevision is true, the object is removed from the filter. For example, if a document revision history is:

B.1 Cancelled

A.2 Released

A.1 In Work

If a previous filter queried for released objects, version A.2 would be in the collection. However, if the a second filter is applied to query for Cancelled objects, returning B.1, and the excludeIfLaterRevision is true, A.2 will be removed from the collection.

Repository

Name of the repository element. Required.

Example

<Collection name="Released Documents" type="Basic">

<Param name="repository" value="Windchill"/>

<Param name="containerName" value="GlobalManuals"/>

<Param name="containerType" value="wt.inf.library.WTLibrary"/>

<Param name="objectType" value="com.oberontech.DynamicDocument"/>

<Filters>

<Filter name="IncludeReleased" type="StateFilter">

<Param name="state" value="RELEASED"/>

</Filter>

<Filter name="ExcludeCancelled" type="StateFilter">

<Param name="excludeIfLaterRevision" value="true"/>

<Param name="state" value="CANCELLED"/>

</Filter>

<Filter name="IncludeWTDocument" type="StateFilter">

<Param name="state" value="RELEASED"/>

<Param name="objectType" value="wt.doc.WTDocument"/>

</Filter>

</Filters>

</Collection>