Start Process

Operation Name

Start Process

Function Overview

Starts processing on DataSpider BPM.

Data Model

XML 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.
Input data	Optional	Not available	Select the component on the script canvas.	[Input data] is required if you set more than one process data to [Input data definition].

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a global resource. For global resource setting procedures, please refer to "Global Resource Property". [Add]: Adds a new global resource. [Edit list]: Enables to edit the global resource settings in the "Edit resource list".
Category	Optional	Available	Select or enter the category on DataSpider BPM.
Process model	Required	Available	Select or enter the process model on DataSpider BPM.	If you specify the variables to [Category], process model list will not be shown. Please manually enter [Process model].
Position	Optional	Available	Enter the position upon executing the process.	When the position of the executing process multiply exist, entering is required. You can omit this if only one position exists. Enter the organization that enables to execute the process.
Wait for the process finished	Optional	Not available	Select whether to wait for process finished or not. [Checked]:(default) Wait for process finished. [Not checked]: Does not wait for process finished.	If you chose to wait for the process finished, you can receive the process data value upon process finished. In other words, if you chose not to wait, you can not receive the value.
Polling interval	Optional	Available	Enter the interval in second to confirm whether the process has completed.	Enables if you check [Wait for the process finished] button. Default value is "10". If you omit, then the default value will be set. Enter the value larger than "1". Default value will be set if you enter the values other than numeric values.

Input setting

Item name	Required/Optional	Use of variables	Description
Input data definition	Optional	-	Specify the process data to enter in the starting front task. You can operate each column of the input data definition with the following buttons. [Add]: Adds a column. [Up]: Moves the selected column upwards. [Down]: Moves the selected column downwards. [Delete]: Deletes a column.
Input data definition/Process data definition number	Required	Not available	Enter the process data definition number of the entering process data.
Input data definition/Data type	Required	Not available	Select the data type of the entering process data.

Output setting

Item name	Required/Optional	Use of variables	Description	Remarks
Output data definition	Optional	-	Specify the process data to receive from the executing process. You can operate the output data definition with the following buttons. [Add]: Adds a column. [Up]: Moves the selected column upwards. [Down]: Moves the selected column downwards. [Delete]: Deletes a column.	Enables if you check in [Wait for the process completion]
Output data definition/Process data definition number	Required	Not available	Enter the process data definition number of the receiving process data
Output data definition/Data type	Required	Not available	Select the data type of the receiving process data
Retrieving method of file data	Required	Not available	Select the retrieving method of the file data contents. [Not receive]:(default) Does not retrieve the contents of the file type data, but the file name. [Data]: Outputs the file type data contents to the result data. [File]: Outputs the file type data contents to the file.
File store directory	Required	Available	Enter the directory path of the DataSpider file system that saves file type data. If you click on [Browse], the directory chooser will launch and enables you to select directory. File type data is saved in [File store directory]/<Process ID>/[Output data definition/Process data definition number]/<File ID> directories. File IDs are the IDs allocated to each files.	Valid if you select [File] in [Retrieving method of file data]. Specify the directory path of DataSpider file system as the absolute path. Path delimiter other than "/" Not available character of DataSpider file system cannot be used. If [File store directory] do not exist, directory will be created when file type data is saved.
Replace prohibited characters in file name	Optional	Not available	If file name includes "Prohibited character of DataSpider file system", select whether to permuting file name and acquire or not. [Checked]:(default) If file name includes prohibited character string of DataSpider file system, acquires it by permuting characters with "_", an en underscore. [Not checked]: Becomes error instead of permuting file name, when prohibited characters of DataSpider file system is included in file name.	Enables if you select [File] in [Retrieving method of file data].

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

<?xml version="1.0" encoding="UTF-8" ?>
 <processdata>
   <title>title</title>
   <dataProcess data definition number>Process data</dataProcess data definition number>
     :
   <dataProcess data definition number>Process data</dataProcess data definition number>
 </processdata>

Depending on the [Input data definition] settings, data element numbers would vary. Also, according to the set data type of process data, some may have schema.

Schema of each data type

Data type	Schema	Description	Remarks
String	None.		If you enter the empty character, values will not be entered to the front task of the started process model.
Numeric	None.		If you enter the empty character, values will not be entered to the front task of the started process model.
Date	None.		If you enter the empty character, values will not be entered to the front task of the started process model.
Datetime	None.		If you enter the empty character, values will not be entered to the front task of the started process model.
Select	<dataProcess data definition number> <items> <item> <value>Choice ID</value> </item> : <item> <value>Choice ID</value> </item> </items> </dataProcess data definition number>	Select and input the value to the element. Input "Choice ID" of choice type process data item for the value.	If you select multiple value, create multiple item element, and enter the values to select in each value element of item element. If you enter non-existing Choice ID, values will not be input to the starting process model's head task. If the schema differs, values will not be input to the head task of the started process model. If you enter empty character to value element value, the value will not be input to the head task of the starting process model. All the radio button, select box, search select box cannot select multiple value. If you select multiply, "TaskFailedException" error will occur.
User	None.	Enter the user's email address to input on the value element.	If you enter the empty character, values will not be entered to the front task of the started process model.
Organization	None.	Enter the organization name to input on the value element.	If you enter the empty character, values will not be entered to the front task of the started process model.
Discussion	None.		If you enter the empty character, values will not be entered to the front task of the started process model.
Table	<dataProcess data definition number> <list> <row> <col>Table item data</col> : <col>Table item data</col> </row> </list> </dataProcess data definition number>	Input table type value of each item to col element.	Input the same amount of col element as item numbers defined in table type data. Option type table item inputs "Choice ID". If the schema differs, values are not input to the head task of starting process model. If "Product of the two items are entered" is checked in numeric type table item, the values will not be entered to the head task of the starting process model.
File	<dataProcess data definition number> <files> <file> <path>File path</path> </file> : <file> <path>File path</path> </file> </files> </dataProcess data definition number>	Enter the path on DataSpider file system in the file in order to input to path element.	Specify the absolute path of the DataSpider file system as the file path. Constrained Characters of DataSpider File System cannot be used, except for the path separator "/". If schema differs, the values will not be input to the head task of the starting process model. If the empty character is entered to path element value, the values will not be input to the head task of the starting process model. Content-Type is application/octet-stream. You cannot enter files above 100MB.

Output Schema

<?xml version="1.0" encoding="UTF-8" ?>
 <processdata>
   <title>Title</title>
   <dataProcess data definition number>Process data</dataProcess data definition number>
     :
   <dataProcess data definition number>Process data</dataProcess data definition number>
 </processdata>

Depending on the [Output data definition] settings, data element numbers would vary. Also, according to the set data type of process data, some may have schema.

Schema of each data type

Data type	Schema	Description	Remarks
String	None.
Numeric	None.
Date	None.
Datetime	None.		Values of seconds and milliseconds will not be output.
Select	<dataProcess data definition number> <items> <item> <value>Choice ID</value> <displayname>Label</displayname> </item> : <item> <value>Choice ID</value> <displayname>Label</displayname> </item> </items> </dataProcess data definition number>	"Choice ID" selected in value element is output, and "Option name" is output to displayname element.	If not selected, only data element will be output, and the value is not output. If you select multi-values, multiple item element will be output.
User	None.
Organization	None.
Discussion	None.
Table	<dataProcess data definition number> <list> <row> <col>Table item data</col> : <col>Table item data</col> </row> <summary> <col>Table item data</col> : <col>Table item data</col> </summary> </list> </dataProcess data definition number>	Each item value of the Table type is output to col element.	If Table type data is not set yet, only data element will be output, and the value will not be output. The same amount of col elements as items defined in Table type data will be output. Summary element is output only when you check in the numeric type table item "Displays aggregation under the table". Table item value is output to col element under row element. The aggregation value is output to col element under summary element. "Label" is output to option type table item. "Choice ID" is not output.
File	<dataProcess data definition number> <files> <file> <name>File name</name> <path>File path</path> <data>Data</data> </file> : <file> <name>File name</name> <path>File path</path> <data>Data</data> </file> </files> </dataProcess data definition number>	File name to name element, File path saved in path element, and file contents to data element are output as Base64 format.	If the file type data is not set, only data element is output and the value is not output. The same amount of file element as the file numbers set in file type data will be output. Path element value is output if you select [File] in [File type data retrieving method]. Data element value is output if you select [Data] in [File type data retrieving method]. OutOfMemoryError may occur when you select [Data] in [File type data retrieving method] and retrieves big sized data. In that case, keep the largest heap size of DataSpiderServer.

Loading schema in Mapper

Schema is loaded automatically.

For details, please refer to "Edit Schema".

Mass Data Processing

Mass data processing is supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
process_instance_id	Started process ID is stored.	The value defaults to 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, its corresponding error types is stored.	The value defaults to null. Error types will be the following format. Ex:"java.io.FileNotFoundException" Storing contents may vary depending on the versions of DataSpider Servista.
error_message	When an error occurs, the message of error will be stored.	The value defaults to null. Storing contents may vary depending on the versions of DataSpider Servista.
error_trace	When an error occurs, the trace information of errors will be stored.	The value defaults to null. Storing contents may vary depending on the versions of DataSpider Servista or client applications.

Specification Limits

The authentication method supports BASIC certification and it does not support OAuth certification.

If you checked DataSpider BPM server's [System Settings]-[SSO (SAML)]-[Disable Password Authentication], only users who have system management authority can connect to DataSpider BPM server.

You can start the process starting with "Start event". However, you cannot start processes, which starts with the start event except for "Start event" such as "Message start event" or "Timer start event".

Starting process is specified with [Category], [Process model]. "TooManyProcessesFoundException" error will occur if the same [Category], [Process model] processes exist multiply.

If the "TaskFailedException" occurs and the implementation of head task fails, then forcibly ends the process.

If you prefer to input data to the starting process, set the data editing permission of the process data item from the starting process's head task you prefer to input into "Editable". In case of "-" or "Only display", the starting process's head task will be executed normally, but the data will not be input.

If you input values to non-existing process data item, the value will not be input to the head task of starting process model.

Integrate the data type setting in the data type of starting process's process data item, [Input data definition] and [Output data definition]. If they don't correspond, "TaskFailedException" error may occur, or the value may not be in-output depending on the combinations.

You cannot retrieve the non-existing process data item values. If you set the non-existing process data item to [Output data definition], only data element will be output.

After editing the schema having the data-type schema using Mapper, if you update [Input data definition] or [Output data definition] and click on [Complete], it will be reset as the contents [Input data definition] or [Output data definition] which was updated by the schema of the edited Mapper.

Main Exceptions

Exception name	Cause	Solution
InputDataNotFoundException	[Input data] is not specified.	Specify [Input data] or draw a data flow.
ResourceNotFoundException Resource definition could not be found.Name: []	[Destination] is not specified.	Specify [Destination].
ResourceNotFoundException Resource definition could not be found.Name: [<name of Global Resources>]	Resource definition selected in [Destination] is not found.	Please check the global resource specified in [Destination].
InvalidPropertyConfigurationException <Property name> is not specified.	[<Property name>] is not specified.	Specify [<Property name>].
AuthenticationException	[Email] or [Password] of the global resource is false.	Please check the global resource settings.
ProcessNotFoundException	Specified process model do not exist.	Confirm the settings for [Category] or [Process model].
TooManyProcessesFoundException	Multiple process with same [Category] or same [Process model] exists.	Set up process to avoid multiple process with same [Category] or same [Process model].
ProcessFailedException	Started process was forced to be terminated and did not normally terminated.	Confirm process status executed on DataSpider BPM.
TaskFailedException	Execution of head task for specified process model is failing.	Confirm following items concerning input data of process start operation or setting for [Position]. Do all the required process data items input with value? Does format for process data items match? Is non-existing user input in exist user type process data? Is non-existing organization input in exist organization type process data? Does table type process data's number of table item and element number for col input data match? Is value input in [Position] appropriate?
GroupNotFoundException	Organization specified in [Position] does not exist.	Confirm settings for [Position].
PathIsNotAbsoluteException	Path specified in [File store directory] is not a absolute path.	Specify the absolute path for [File store directory].