queryProcessTemplates

Syntax

com.tibco.wcc.base.Requests.queryProcessTemplates(requestId,
                                                  txtFilter,
                                                  txtSort);

Parameters

• requestId - (String) Uniquely identifies the request. For more information, see Submitting Server Requests.
• txtFilter - (String) A filter expression to limit the number of process templates. Only the process templates that satisfy the expression are returned. For information about filter syntax, see the "Sorting and Filtering Process Lists" topic in the developer's guide for your BPM runtime environment.

  For a list of the attributes that can be used in the filter expression, use the listProcessTemplateAttributes request.

• txtSort - (String) The sort order to apply to the process templates returned. Specify the sort attribute, following by either ASC or DESC, for ascending or descending, respectively. Separate multiple sort attributes with commas. For example:

  DEFINITION.PRIORITY ASC, DEFINITION.NAME DESC

  For a list of the attributes that can be used in the filter expression, use the listProcessTemplateAttributes request.

Returns

Returns an <ap:ProcessTemplate> element for each process template returned. The <ap:ProcessTemplate> element contains the following elements:

• <ap:DEFINITION.DESCRIPTION> - Description of the process template.
• <ap:DEFINITION.VERSION> - Version of the process template.
• <ap:DEFINITION.NAME> - Name of the process template.
• <ap:MODULE.NAME> - The path to the XPDL file that defines the “process package”.
• <ap:DEFINITION.PRIORITY> - The priority of the process template.
• <ap:DEFINITION.CREATION_DATE> - The date/time the process template was created.

For example:

<ap:Requests>
  <ap:QueryProcessTemplates Id="ApiSample.queryProcessTemplates">
    <ap:QueryId>0</ap:QueryId>
    <ap:ProcessTemplateCount>16</ap:ProcessTemplateCount>
    <ap:ProcessTemplates>
      <ap:ProcessTemplate>
        <ap:DEFINITION.DESCRIPTION>*** Generated by TIBCO Business Studio.</ap:DEFINITION.DESCRIPTION>
        <ap:DEFINITION.VERSION>1.0.0.201101101413</ap:DEFINITION.VERSION>
        <ap:DEFINITION.NAME>Fields3Process</ap:DEFINITION.NAME>
        <ap:MODULE.NAME>/Acme-CommonFields/Process Packages/CommonFields.xpdl</ap:MODULE.NAME>
        <ap:DEFINITION.PRIORITY>NORMAL</ap:DEFINITION.PRIORITY>
        <ap:DEFINITION.CREATION_DATE>2011-02-23T16:31:02.390-08:00</ap:DEFINITION.CREATION_DATE>
    </ap:ProcessTemplate>
                .
                .
                .
    </ap:ProcessTemplates>
  </ap:QueryProcessTemplates>
</ap:Requests>