complexType PurgeOptions

diagram
namespace	http://www.tibco.com/bx/2009/management/processManagerType
children	pm:states pm:batchSize pm:runInBackground pm:threshold pm:applications pm:processTemplates pm:processInstances
used by	element  purgeTerminatedProcessInstancesRequestType/options
annotation	documentation Provides options to control how a purge is carried out
source	<xsd:complexType name="PurgeOptions">   <xsd:annotation>     <xsd:documentation>Provides options to control how a purge is carried out</xsd:documentation>   </xsd:annotation>   <xsd:sequence>     <xsd:element name="states" type="pm:TerminalStates" minOccurs="0">       <xsd:annotation>         <xsd:documentation>(Optional) purge those process instances with specified state(s).  If no state(s) are specified, then process instances that are in a terminal state will be purged. </xsd:documentation>       </xsd:annotation>     </xsd:element>     <xsd:element name="batchSize" type="xsd:int" minOccurs="0">       <xsd:annotation>         <xsd:documentation>(Optional) Number of process instances that should be deleted before the transaction is committed. Default value: 100</xsd:documentation>       </xsd:annotation>     </xsd:element>     <xsd:element name="runInBackground" type="xsd:boolean" minOccurs="0">       <xsd:annotation>         <xsd:documentation>(Optional) Boolean value specifying whether the purge runs in the background. If: - True: The purge will run in the background and the operation returns immediately. This is the default value. - False: The operation waits for the purge to complete before returning (subject to timeouts).</xsd:documentation>       </xsd:annotation>     </xsd:element>     <xsd:element name="threshold" type="xsd:dateTime" minOccurs="0">       <xsd:annotation>         <xsd:documentation>(Optional) Date before which process instances must have been completed, cancelled or failed for them to be purged in this operation. If this value is omitted, all completed, cancelled and failed instances will be deleted.</xsd:documentation>       </xsd:annotation>     </xsd:element>     <xsd:element name="applications" type="pm:Applications" minOccurs="0">       <xsd:annotation>         <xsd:documentation>(Optional) specified the applications for which all the process instances in the contained process templates are to be purged.</xsd:documentation>       </xsd:annotation>     </xsd:element>     <xsd:element name="processTemplates" type="pm:ProcessTemplatesType" minOccurs="0">       <xsd:annotation>         <xsd:documentation>(Optional) specified the tagged process templates for which the corresponding instances are to be purged.</xsd:documentation>       </xsd:annotation>     </xsd:element>     <xsd:element name="processInstances" type="pm:ProcessInstancesType" minOccurs="0">       <xsd:annotation>         <xsd:documentation>(Optional) specified the tagged process instances to be purged.</xsd:documentation>       </xsd:annotation>     </xsd:element>   </xsd:sequence> </xsd:complexType>

element PurgeOptions/states

diagram
namespace	http://www.tibco.com/bx/2009/management/processManagerType
type	pm:TerminalStates
properties	minOcc  0 maxOcc  1 content  complex
children	pm:state
annotation	documentation (Optional) purge those process instances with specified state(s).  If no state(s) are specified, then process instances that are in a terminal state will be purged.
source	<xsd:element name="states" type="pm:TerminalStates" minOccurs="0">   <xsd:annotation>     <xsd:documentation>(Optional) purge those process instances with specified state(s).  If no state(s) are specified, then process instances that are in a terminal state will be purged. </xsd:documentation>   </xsd:annotation> </xsd:element>

element PurgeOptions/batchSize

diagram
namespace	http://www.tibco.com/bx/2009/management/processManagerType
type	xsd:int
properties	minOcc  0 maxOcc  1 content  simple
annotation	documentation (Optional) Number of process instances that should be deleted before the transaction is committed. Default value: 100
source	<xsd:element name="batchSize" type="xsd:int" minOccurs="0">   <xsd:annotation>     <xsd:documentation>(Optional) Number of process instances that should be deleted before the transaction is committed. Default value: 100</xsd:documentation>   </xsd:annotation> </xsd:element>

element PurgeOptions/runInBackground

diagram
namespace	http://www.tibco.com/bx/2009/management/processManagerType
type	xsd:boolean
properties	minOcc  0 maxOcc  1 content  simple
annotation	documentation (Optional) Boolean value specifying whether the purge runs in the background. If: - True: The purge will run in the background and the operation returns immediately. This is the default value. - False: The operation waits for the purge to complete before returning (subject to timeouts).
source	<xsd:element name="runInBackground" type="xsd:boolean" minOccurs="0">   <xsd:annotation>     <xsd:documentation>(Optional) Boolean value specifying whether the purge runs in the background. If: - True: The purge will run in the background and the operation returns immediately. This is the default value. - False: The operation waits for the purge to complete before returning (subject to timeouts).</xsd:documentation>   </xsd:annotation> </xsd:element>

element PurgeOptions/threshold

diagram
namespace	http://www.tibco.com/bx/2009/management/processManagerType
type	xsd:dateTime
properties	minOcc  0 maxOcc  1 content  simple
annotation	documentation (Optional) Date before which process instances must have been completed, cancelled or failed for them to be purged in this operation. If this value is omitted, all completed, cancelled and failed instances will be deleted.
source	<xsd:element name="threshold" type="xsd:dateTime" minOccurs="0">   <xsd:annotation>     <xsd:documentation>(Optional) Date before which process instances must have been completed, cancelled or failed for them to be purged in this operation. If this value is omitted, all completed, cancelled and failed instances will be deleted.</xsd:documentation>   </xsd:annotation> </xsd:element>

element PurgeOptions/applications

diagram
namespace	http://www.tibco.com/bx/2009/management/processManagerType
type	pm:Applications
properties	minOcc  0 maxOcc  1 content  complex
children	pm:applicationName
annotation	documentation (Optional) specified the applications for which all the process instances in the contained process templates are to be purged.
source	<xsd:element name="applications" type="pm:Applications" minOccurs="0">   <xsd:annotation>     <xsd:documentation>(Optional) specified the applications for which all the process instances in the contained process templates are to be purged.</xsd:documentation>   </xsd:annotation> </xsd:element>

element PurgeOptions/processTemplates

diagram
namespace	http://www.tibco.com/bx/2009/management/processManagerType
type	pm:ProcessTemplatesType
properties	minOcc  0 maxOcc  1 content  complex
children	pm:processQName
annotation	documentation (Optional) specified the tagged process templates for which the corresponding instances are to be purged.
source	<xsd:element name="processTemplates" type="pm:ProcessTemplatesType" minOccurs="0">   <xsd:annotation>     <xsd:documentation>(Optional) specified the tagged process templates for which the corresponding instances are to be purged.</xsd:documentation>   </xsd:annotation> </xsd:element>

element PurgeOptions/processInstances

diagram
namespace	http://www.tibco.com/bx/2009/management/processManagerType
type	pm:ProcessInstancesType
properties	minOcc  0 maxOcc  1 content  complex
children	pm:processInstance
annotation	documentation (Optional) specified the tagged process instances to be purged.
source	<xsd:element name="processInstances" type="pm:ProcessInstancesType" minOccurs="0">   <xsd:annotation>     <xsd:documentation>(Optional) specified the tagged process instances to be purged.</xsd:documentation>   </xsd:annotation> </xsd:element>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy