Search Tasks

Operation Name

Search Tasks

Functional Overview

Searches task histories on DataSpider BPM.

Data Model

Table Model type.

Properties

For information about using variables, refer to "variables".

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter the name to show on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a global resource. For more details on Global Resource settings, refer to "Global Resource Properties". [Add]: Adds a new global resource [Edit the list]: Enables to edit the global resource settings in the "Edit resource list".
Category	Optional	Available	Inputs category of process model as search criteria.
Process model	Optional	Available	Inputs process model as search criteria.
Operator	Optional	Available	Inputs email address of person in charge of the conduct as search criteria.	If user, who is not specified at the [Email] of global resource, were to search for task that they are in charge of conduct, then the user need control authority or data browsing rights of the process they want to search for.

Process status

Item name	Required/Optional	Use of variables	Description
Running	Optional	Not available	Select whether to search for running processes. [Checked]:(default) Searches a running process. [Not checked]: Does not search running processes.
Completed	Optional	Not available	Selects whether to search for completed processes. [Checked]:(default) Searches completed processes. [Not checked]: Does not search completed processes.
Terminated	Optional	Not available	Select whether to search terminated processes. [Checked]:(default) Searches terminated processes. [Not Check]: Does not search terminated processes.

Task status

Item name	Required/Optional	Use of variables	Description
Offered	Optional	Not available	Selects whether to search offered tasks. [Checked]:(default) Searches offered tasks. [Not checked]: Does not search offered tasks.
Allocated	Optional	Not available	Selects whether to search allocated tasks. [Checked]:(default) Searches allocated tasks. [Not checked]: Does not search allocated tasks.
Operating	Optional	Not available	Selects whether to search operating tasks. [Checked]:(default) Searches operating tasks. [Not checked]: Does not search operating tasks.
Finished	Optional	Not available	Select whether to search finished tasks. [Checked]:(default) Searches finished tasks. [Not checked]: Does not search finished tasks.
Failed	Optional	Not available	Select whether to search failed tasks. [Checked]:(default) Searches failed tasks. [Not checked]: Does not search failed tasks.

Search setting

Item name	Required/Optional	Use of variables	Description	Remarks
Page size	Optional	Available	Inputs the number of tasks you want to acquire at single request.	Default value is "1000", if omit than value will be set up as "1000". In case of input values other than numerical value, it will be set up as default value. Maximum value is "1000".

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select the data processing method. [Use script settings]:(default) Applies the setting of mass data processing setup in script property to the adapter. [Disable]: Mass data processing is not performed. [Enable]: Mass data processing is performed.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input Schema

None.

Output Schema

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>Task ID/id</column>
    <column>Task name/nodeName</column>
    <column>Task number/nodeNumber</column>
    <column>Task status/state</column>
    <column>Process model ID/processModelInfoId</column>
    <column>Process model category/processModelInfoCategory</column>
    <column>Process model name/processModelInfoName</column>
    <column>Process model version/processModelVersion</column>
    <column>Title/processInstanceTitle</column>
    <column>Process ID/processInstanceId</column>
    <column>Process ID(for display)/processInstanceIdForView</column>
    <column>Process status/processInstanceState</column>
    <column>ID of process commenced organization/processInstanceInitGroupId</column>
    <column>Name of process commenced organization/processInstanceInitGroupName</column>
    <column>Process commenced user ID/processInstanceInitUserId</column>
    <column>Process commenced user name/processInstanceInitUserName</column>
    <column>Process commenced user's email address/processInstanceInitUserEmail</column>
    <column>Process commenced datetime/processInstanceStartDatetime</column>
    <column>Process terminated datetime/processInstanceEndDatetime</column>
    <column>Task allocated organization ID/allocatedGroupId</column>
    <column>Task allocated organization name/allocatedGroupName</column>
    <column>Task allocated user ID/allocatedUserId</column>
    <column>Task allocated user name/allocatedUserName</column>
    <column>Task allocated user's email address/allocatedUserEmail</column>
    <column>Task allocated datetime/allocateDatetime</column>
    <column>Task commenced datetime/startDatetime</column>
    <column>Task offer datetime/offerDatetime</column>
    <column>Task terminated datetime/endDatetime</column>
    <column>Task limitation/timeLimitDatetime</column>
    <column>Swimlane type/swimlaneType</column>
    <column>Starred status/starred</column>
  </row>
  <row>
    :
  </row>
</table>

Element name	Column name/label	Type	Description	Remarks
row	-		Returns the number of task that was searched.
column	Task ID/id	String	ID for a task instance
	Task name/nodeName	String	Name of a task
	Task number/nodeNumber	String	Number of a task
	Task status/state	String	Status of a task	Outputs following values. OFFERED ALLOCATED STARTED ENDED FAILED
	Process model ID/processModelInfoId	String	ID for a process model
	Process model category/processModelInfoCategory	String	Category for a process model
	Process model name/processModelInfoName	String	Name of a process model
	Process model version/processModelVersion	String	Version for a process model
	Title/processInstanceTitle	String	Title of a process
	Process ID/processInstanceId	String	ID for a process	Example:123
	Process ID(For Display)/processInstanceIdForView	String	Character string notation for display of Process's ID	Example:p123
	Process status/processInstanceState	String	Status for a process	Outputs following values. STARTED ENDED FAILED
	Process commenced organization ID/processInstanceInitGroupId	String	ID of process commenced organization
	Process commenced organization name/processInstanceInitGroupName	String	Name of process commenced organization.
	Process commenced user ID/processInstanceInitUserId	String	ID of user who commenced process
	Process commenced user name/processInstanceInitUserName	String	User name who commenced process
	Process commenced user's email address/processInstanceInitUserEmail	String	User's email address who commenced process
	Process commenced datetime/processInstanceStartDatetime	Date, Time	Datetime of when process was commenced
	Process terminated datetime/processInstanceEndDatetime	Date, Time	Datetime of when process was terminated
	Task allocated organization ID/allocatedGroupId	String	ID of the organization that task is allocated to
	Task allocated organization name/allocatedGroupName	String	Name of the organization that task is allocated to
	Task allocated user ID/allocatedUserId	String	ID of the user whose task is allocated to
	Task allocated user name/allocatedUserName	String	Name of the user whose task is allocated to
	Task allocated user's email address/allocatedUserEmail	String	Email address of user whose task is allocated
	Task allocated datetime	Date, Time	Datetime of when task was allocated
	Task started datetime	Date, Time	Datetime of when task was commenced
	Task offer datetime	Date, Time	Datetime of when task was offered
	Task terminated datetime	Date, Time	Datetime of when task was commenced
	Task datatime limit	Date, Time	Ending time of date for task
	Swim lane type	String	Classification of swimlane which task is positioned at	Output following values. NORMAL GROUP
	Starred Status	String	Presence of star	Outputs following values. true:Star present false:Star absent

Loading Schema on Mapper

Schema will be loaded automatically.

For more detail, refer to, "Edit Schema".

Mass Data Processing

Mass data processing is supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
count	Returns the number of tasks that was searched.	Default value is null.
message_category	Stores the category of message code corresponding to the occurred error.	Default value is null.
message_code	Stores the code of message code corresponding to the occurred error.	Default value is null.
message_level	Stores the severity of message code corresponding to the occurred error.	Default value is null.
error_type	When an error occurs, the class of error will be stored.	Default value is null. Class of error is in following format. Example: "java.io.FileNotFoundException" Depending on version for the DataSpider Servista, stored contents may alter.
error_message	When an error occurs, message of the error will be stored.	Default value is null. Depending on version for DataSpider Servista, stored contents may alter.
error_trace	When an error occurs, the trace information of error will be stored.	Default value is null. Depending on version for DataSpider Servista or executing client application, stored contents may alter.

Specification Limits

If not all status are checked in [Process status], all process status will be search targets.
If not all status are checked in [Task status], all task status will be search targets.

Main Exceptions

Exception name	Cause	Measure
ResourceNotFoundException Resource definition cannot be found. Name:[]	[Destination] is not specified.	Specify [Destination].
ResourceNotFoundException Resource definition cannot be found. Name:[<Global resource name>]	Selected resource definition in [Destination] cannot be found.	Confirm the global resource specified in [Destination].
InvalidPropertyConfigurationException <Property name> is not specified.	[<Property name>] is not specified.	Specify [<Property name>].
AuthenticationException	[Email] or [Password] for the global resource is false.	Confirm the global resource setting.
UserNotFoundException	User specified in [Operator] does not exist.	Specify the email address of existing user in [Operator].
InvalidEmailAddressException	User's email address specified in [Operator] is false.	Specify the email address in [Operator].