How to create a BPM Service - 6.1

Talend Real-time Big Data Platform Studio User Guide

EnrichVersion
6.1
EnrichProdName
Talend Real-Time Big Data Platform
task
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Talend Studio also enables you to create a SOAP or REST Service from an existing BPM process that is either exported as a Bar file or deployed on the Bonita BPM Portal.

Note that the following procedures only work in conjunction with Bonita BPM 6.5.2.

  1. Open Talend Studio.

  2. In the Repository tree view, right-click the Services node and select Create BPM Service from the contextual menu.

  3. The [Create Service From BPM Process] wizard opens to help you define the main properties of the new BPM Service.

    Enter the Service properties as the following:

    Field

    Description

    Name

    the name of the new BPM Service. A message comes up if you enter prohibited characters.

    Purpose

    Service purpose or any useful information regarding the Service use.

    Description

    Service description.

    Author

    a read-only field that shows by default the current user login.

    Locker

    a read-only field that shows by default the login of the user who owns the lock on the current Service. This field is empty when you are creating a Service and has data only when you are editing the properties of an existing Service.

    Version

    a read-only field. You can manually increment the version using the M and m buttons. For more information, see Managing Job and Route versions.

    Status

    a list to select from the status of the Services you are creating.

    Path

    a list to select from the folder in which the Service will be created.

  4. Click Next to open the Source Selection view on the wizard. By default, the From .BAR file option is selected.

  5. Select one of the options below to define the BPM process source.

Creating a SOAP Service from a BPM process exported as a .bar file

Once you have selected the From .BAR File option in the [Create Service From BPM Process] wizard, do the following.

  1. Browse your system to the .bar file holding the process from which you want to create a Service.

  2. Click Next to select the fields you want to include in the Service.

  3. By default, all the fields corresponding to the variables defined in the BPM process are selected. If required, clear the Name check box of a field, and then choose one of the following options from the Non-request Field Type list field:

    • Custom: to leave an empty value for the field; if needed, you can specify a custom value or expression for the column corresponding to this field in the output table of the first tXMLMap component in the generated Job, to pass custom information to the BPM process, before running the Job to start the Service. This is the default option for a non-request field.

    • Security Token: use this field to pass the Security Token, if any, in the service request to the BPM process.

    • Correlation ID: use this field to pass the correlation ID, if any, in the service request to the BPM process.

  4. Select the SOAP option and check the default generated information of the BPM service. Clear the Use default check box to update them according to your needs.

  5. Then click Finish. The related Job and data Service are created in the Repository tree view.

You can now:

Creating a SOAP Service from a BPM process deployed on Bonita BPM Portal

Prerequisites:

  • Bonita BPM Portal is up and running.

  • The process from which you want to create a Service is deployed on Bonita BPM Portal. For details of how to deploy a process on Bonita BPM Portal, see the Bonita documentation.

Once you have selected the From BPM Portal option in the [Create Service From BPM Process] wizard, do the following.

  1. In the Process tree structure, select the BPM process from which you want to create a Service.

  2. By default, all the fields corresponding to the variables defined in the BPM process are selected. If required, clear the Name check box of a field, and then choose one of the following options from the Non-request Field Type list field:

    • Custom: to leave an empty value for the field; if needed, you can specify a custom value or expression for the column corresponding to this field in the output table of the first tXMLMap component in the generated Job, to pass custom information to the BPM process, before running the Job to start the Service. This is the default option for a non-request field.

    • Security Token: use this field to pass the Security Token, if any, in the service request to the BPM process.

    • Correlation ID: use this field to pass the correlation ID, if any, in the service request to the BPM process.

  3. Select the SOAP Service option.

    The default generated information of the BPM Service is described in the Generated Wsdl Information area.

    To change these information, clear the Use default check box and update the fields according to your needs.

  4. Click Finish. The related Job and data service are created in the Repository tree view.

You can now edit the generated WSDL file. For more information, see How to edit a WSDL file.

Creating a REST Service from a BPM process exported as a .bar file

Once you have selected the From .BAR File option in the [Create Service From BPM Process] wizard, do the following.

  1. Browse your system to the .bar file holding the process from which you want to create a Service.

  2. Click Next to select the fields you want to include in the Service.

  3. By default, all the fields corresponding to the variables defined in the BPM process are selected. If required, clear the Name check box of a field, and then choose one of the following options from the Non-request Field Type list field:

    • Custom: to leave an empty value for the field; if needed, you can specify a custom value or expression for the column corresponding to this field in the output table of the first tXMLMap component in the generated Job, to pass custom information to the BPM process, before running the Job to start the Service. This is the default option for a non-request field.

    • Security Token: use this field to pass the Security Token, if any, in the service request to the BPM process.

    • Correlation ID: use this field to pass the correlation ID, if any, in the service request to the BPM process.

  4. Select the REST Service option, and edit the REST configuration if needed.

    Field

    Description

    Endpoint

    URI location where the REST Service will be accessible for requests.

    Uri Pattern

    REST-ful URI that describes the resource.

    Job

    Name of the Job that will be created.

  5. Click Finish. The related Job and the metadata are created in the Repository tree view, and the Job is automatically opened on the design workspace.

You can now:

Creating a REST Service from a BPM process deployed on Bonita BPM Portal

Prerequisites:

  • Bonita BPM Portal is up and running.

  • The process from which you want to create a REST Service has been deployed on Bonita BPM Portal. For details of how to deploy a process on Bonita BPM Portal, see the Bonita documentation.

Once you have selected the From Bonita BPM Portal option in the [Create Service From BPM Process] wizard, do the following.

  1. In the Process tree structure, select the BPM process from which you want to create a Service.

  2. By default, all the fields corresponding to the variables defined in the BPM process are selected. If required, clear the Name check box of a field, and then choose one of the following options from the Non-request Field Type list field:

    • Custom: to leave an empty value for the field; if needed, you can specify a custom value or expression for the column corresponding to this field in the output table of the first tXMLMap component in the generated Job, to pass custom information to the BPM process, before running the Job to start the Service. This is the default option for a non-request field.

    • Security Token: use this field to pass the Security Token, if any, in the service request to the BPM process.

    • Correlation ID: use this field to pass the correlation ID, if any, in the service request to the BPM process.

  3. Select the REST Service option, and edit the REST configuration if needed.

    Field

    Description

    Endpoint

    URI location where the REST Service will be accessible for requests.

    Uri Pattern

    REST-ful URI that describes the resource.

    Job

    Name of the Job that will be created.

  4. Click Finish. The related Job and the metadata are created in the Repository tree view, and the Job is automatically opened on the design workspace.

You can now: