tBonitaInstantiateProcess - 6.1

Talend Components Reference Guide

EnrichVersion
6.1
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 Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

tBonitaInstantiateProcess Properties

Component family

Business/Bonita

 

Function

This component instantiates a process already deployed in a Bonita Runtime engine.

Purpose

This component starts an instance for a specific process deployed in a Bonita Runtime engine.

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.

Authorization

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.

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.

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

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.

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.

Scenario 1: Executing a Bonita process via a Talend Job

This scenario describes a Job that deploys a Bonita process into the Bonita Runtime and executes this process, in which a personnel request is treated.

The Job in this scenario uses three components.

  • tBonitaDeploy: this component deploys a Bonita process into the Bonita Runtime.

  • tFixedFlowInput: this component generates the schema used as execution parameters of this deployed process.

  • tBonitaInstantiateProcess: this component executes this deployed process.

Before beginning to replicate this schema, prepare your Bonita.bar file. You need to manually export this file from the Bonita system and then deploy it into the Bonita Runtime engine, using, for example, tBonitaDeploy as presented later in this scenario. In this scenario, this file is TEST--4.0.bar. Once deployed, this process can be checked via the Bonita interface.

Setting up the Job

  1. Drop tBonitaDeploy, tFixedFlowInput and tBonitaInstantiateProcess onto the design workspace.

  2. Right-click tBonitaDeploy and connect tBonitaDeploy to tFixedFlowInput using a Trigger> On Subjob Ok connection.

  3. Right-click tFixedFlowInput and connect this component to tBonitaInstantiateProcess using a Row > Main connection.

Configuring the deployment of the process

To replicate this scenario, proceed as follows:

  1. Double-click tBonitaDeploy to open its Basic settings view.

  2. Select Bonita version 5.3.1 from the Bonita version list. The version you select should be in sync with the version number of the Bonita Runtime engine you are using.

  3. In the Bonita Runtime Configuration area, browse to the Bonita Runtime variable files. In the Bonita Runtime Environment file field, browse to the bonita-environnement.xml file; in the Bonita Runtime Jaas File field, browse to the jaas-standard.cfg file; in the Bonita Runtime Logging File field, browse to the logging.properties file.

    Note

    For users based on Bonita version 5.2.3, only the Bonita Runtime Jaas File field and the Bonita Runtime Logging File field need to be filled.

    For users based on Bonita version 5.6.1, in the Bonita Runtime Home field, browse to the Bonita Runtime environment directory.

  4. In the Business Archive field, browse to the Bonita .bar file that is the process exported from your Bonita system and will be deployed into the Bonita Runtime engine.

  5. In the Username and the Password fields, type in your authentication information to connect to your Bonita.

Configuring the input flow

  1. Double-click tFixedFlowInput to open its Basic settings view.

  2. Click the three-dot button next to Edit schema to open the schema editor.

  3. Click the plus button to add one row and rename it as Name.

    This name is identical with the parameter set in Bonita to execute the same process. This way, Bonita can recognize this column as valid parameter and read its value to instantiate this process.

  4. Click OK.

  5. In the Mode area of the Basic settings view, select the Use inline table option and click the plus button to add one row in the table.

  6. In the inline table, click the added row and type in the person's name from your personnel between the quotation marks: ychen, whose request will be treated by this deployed process.

Configuring the Basic settings of tBonitaInstantiateProcess

  1. Double-click tBonitaInstantiateProcess to open its Basic settings view.

  2. Select Bonita version 5.3.1 from the Bonita version list. The version you select should be in sync with the version number of the Bonita Runtime engine you are using.

  3. In the Bonita Runtime Configuration area, browse to the Bonita Runtime variable files. In the Bonita Runtime Environment file field, browse to the bonita-environnement.xml file; in the Bonita Runtime Jaas File field, browse to the jaas-standard.cfg file; in the Bonita Runtime Logging File field, browse to the logging.properties file.

    Note

    For users based on Bonita version 5.2.3, only the Bonita Runtime Jaas File field and the Bonita Runtime Logging File field need to be filled.

    For users based on Bonita version 5.6.1, in the Bonita Runtime Home field, browse to the Bonita Runtime environment directory.

  4. Select the Use Process ID check box to activate the Process Definition Id field.

  5. In the Process Definition Id field, click between the quotation marks and press Ctrl+space to open the auto-completion drop-down list containing the available global variables for this Job.

  6. Double-click the variable you need use to add it between the quotation marks. In this scenario, double-click tBonitaDeploy_1_ProcessDefinitionUUID, which retrieves the process definition ID of the process being deployed by tBonitaDeploy.

    Note

    You can as well clear the Use Process ID check box to activate the Process name and the Process version fields and enter the corresponding information in the two fields. tBonitaInstantiateProcess concatenates the process name and the process version you type in to construct the process definition ID.

  7. In the Username and Password fields, enter the username and password to connect to your Bonita.

Job Execution

Press F6 to run the Job.

This process is deployed into the Bonita Runtime and an instance is created for the personnel requests.

Scenario 2: Outputting the process instance UUID over the Row > Main link

This scenario deploys a Bonita process into the Bonita Runtime, starts an instance and outputs the process instance UUID via the Row > Main link.

Linking the components

  1. Drop tBonitaDeploy, tBonitaInstantiateProcess and tLogRow onto the workspace.

  2. Rename tBonitaDeploy as deploy_process, tBonitaInstantiateProcess as start_instance and tLogRow as show_instance_uuid.

  3. Link tBonitaDeploy to tBonitaInstantiateProcess using the OnSubjobOk trigger.

  4. Link tBonitaInstantiateProcess to tLogRow using a Row > Main connection.

Configuring the components

  1. Double-click tBonitaDeploy to open its Basic settings view.

  2. In the Bonita Runtime Jaas File field, specify the path and name of the jaas file.

    In the Bonita Runtime Logging File field, specify the path and name of the logging file.

    In the Business Archive field, specify the path and name of the Bonita process.

  3. In the Username and Password fields, enter the user authentication credentials.

  4. Double-click tBonitaInstantiateProcess to open its Basic settings view.

  5. In the Bonita Runtime Jaas File field, specify the path and name of the jaas file.

    In the Bonita Runtime Logging File field, specify the path and name of the logging file.

  6. In the Process Name and Process Version fields, enter the process information.

  7. In the Username and Password fields, enter the user authentication credentials.

  8. Double-click tLogRow to open its Basic settings view.

  9. In the Mode area, select Table (print values in cells of a table for better display.

Executing the Job

  1. Press Ctrl+S to save the Job.

  2. Press F6 to run the Job.

    As shown above, the instance is created and the UUID is output.