tBonitaInstantiateProcess Standard properties - 6.4

Bonita

author
Talend Documentation Team
EnrichVersion
6.4
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance > Third-party systems > Business applications > Bonita components
Data Quality and Preparation > Third-party systems > Business applications > Bonita components
Design and Development > Third-party systems > Business applications > Bonita components
EnrichPlatform
Talend Studio

These properties are used to configure tBonitaInstantiateProcess running in the Standard Job framework.

The Standard tBonitaInstantiateProcess component belongs to the Business family.

The component in this framework is available in all Talend products.

Basic settings

Schema and Edit Schema

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. The schema is either Built-In or stored remotely in the Repository.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

The schema of this component is read-only. You can click Edit schema to view the schema.

In this component the schema is related to the Module selected.

Note:

The ProcessInstanceUUID column is pre-defined in the schema of this component, reserved for the identifier number of the process instance being created.

Bonita Client Mode

Select the client mode you want to use to instantiate a Bonita process.

For more information about all the Bonita client modes, see Bonita's manuals.

URL

Enter the URL of the Bonita Web application server you need to access for the process instantiation.

This field is available only in the HTTP client mode.

Auth Username and Auth Password

Enter the authentication details used to connect to the Bonita Web application server as technical user.

To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

The default authentication information is provided in these fields. For further information about them, see Bonita's manuals.

These fields are available only in the HTTP client mode.

Bonita version

Select the version number of the Bonita Runtime engine to be used.

This field is available only in the Java client mode.

Bonita Runtime Environment File

Browse to, or enter the path to the Bonita Runtime environment file.

This field is available only in the Java client mode.
Note:

This field is displayed only when you select Bonita version 5.3.1 from the Bonita version list.

Bonita Runtime Home

Browse to, or enter the path to the Bonita Runtime environment directory.

Note:

This field is displayed only when you select Bonita version 5.6.1 from the Bonita version list.

Bonita Runtime Jaas File

Browse to, or enter the path to the Bonita Runtime jaas file.

This field is available only in the Java client mode.

Bonita Runtime logging file

Browse to, or enter the path to the Bonita Runtime logging file.

This field is available only in the Java client mode.

Use Process ID

Select this check box to instantiate an existing process.

Once checked, the Process definition ID field is activated in which you can enter the Definition ID of this process

This field is available only in the Java client mode.

Note:

The process definition ID is created when the process is deployed into the Bonita Runtime engine.

Process Name and Process Version

Enter the ID information of a specific process you want to instantiate. This information is used to automatically generate the ID of this process.

This field is available in both of the Java client mode and the HTTP client mode.

User name

Type in your user name used to instantiate this process.

This filed is available in both of the Java client mode and the HTTP client mode.

Password

Type in your password used to instantiate this process.

To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

This field is available only in the Java client mode.

Die on error

This check box is cleared by default, meaning to skip the row on error and to complete the process for error-free rows.

Advanced settings

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at a Job level as well as at each component level.

Global Variables

Global Variables

ProcessInstanceUUID: the identifier number of the process instance being created. This is a Flow variable and it returns a string. It can also be retrieved over the Row> Main output link.

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

Usage rule

Usually used as a stand-alone component or as an output component.

To use this component, you have to manually download the Bonita solution you need to use.

Connections

Outgoing links (from this component to another):

Row: Main (providing the output parameters from this process)

Trigger: Run if; On Component Ok; On Component Error, On Subjob Ok, On Subjob Error.

Incoming links (from one component to this one):

Row: Main (providing the input parameters to this process)

Trigger: Run if, On Component Ok, On Component Error, On Subjob Ok, On Subjob Error

For further information regarding connections, see Connection types in Talend Studio User Guide.

Limitation

The Bonita Runtime environment file, the Bonita Runtime jaas file and the Bonita Runtime logging file must be all stored on the execution server of the Job using this component.