Working with ESB execution tasks - 6.3

Talend Administration Center User Guide

EnrichVersion
6.3
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 Real-Time Big Data Platform
task
Administration and Monitoring
Deployment
EnrichPlatform
Talend Administration Center

Warning

Only users that have the Operation Manager role and rights can have a read-write access to the tasks list. Other types of users can have a read-only access or no access to the list. For further information on access rights, see User roles/rights in the Administration Center . When a user of the Administration Center opens this page, he/she will have access only to the items for which the user has been granted the right authorization by the Administrator.

Warning

Make sure your Talend Runtime server(s) are configured (agent must be running), then you can create the various execution tasks that you want to launch.

An ESB execution task represents a set of actions that you can configure in Talend Administration Center in order to start the Services, Routes and data service Jobs designed in Talend Studio or to start generic OSGi features designed in your Java IDE, directly from the Administration Center.

To access the execution task list, complete the following:

In the Menu tree view, click Conductor, then ESB Conductor to display the list of tasks that will deploy and start your Services, Routes, data service Jobs and other Generic OSGi features on the Talend Runtime.

When you access this list for the first time, no task shows on the list.

The default ESB Conductor page provides the following information:

Column label

Description

Online Status

The real-time status of the task Feature. It depends on the status of all the bundles the Feature contains.

  • : all bundles are active.

  • : there are both active and inactive bundles in the Feature.

  • : all bundles are not active or the Runtime is down.

  • : the Feature is not selected in the list.

  • : the Feature is just created and has not been deployed, or just undeployed.

Last Action Last action performed on the task, it can be: CREATED, UPDATED, STARTED, STOPPED, DEPLOYED, or UNDEPLOYED.

Label

Name of the task to be deployed and executed.

Name

Name of the Feature to be deployed and executed.

Version

Version of the Feature as defined in the artifacts designed in Talend Studio or as defined in the Features file of your generic OSGi feature build in Java.

Type Type of the artifact to be deployed and started. It can be: Route, Service, Generic.

Context

Name of the context as defined for the Feature.

Server

Name of the server on which the task was last deployed.

Tag Name of a group gathering several tasks.

Feature URL

Maven URL of the feature to be deployed.

Some extra columns are hidden by default but can be added to the table. For more information, see Customizing the display of the task list

Adding an execution task

To add an execution task from Talend Administration Center, complete the following:

  1. From the toolbar on the ESB Conductor page, click Add to clear the Edition configuration panel.

  2. Enter/select the following information as necessary.

    Field

    Description

    Label

    Type in the name of the task to be triggered.

    Description

    Provide any useful information regarding the task to be carried out.

    Tag

    Type in or select in the list the name of the group in which you want to group your task.

    Feature

    Click the Select Feature button to select from the Artifact repository the artifact you want to deploy and start. The [Select Feature from Artifact repository] wizard opens.

    1. In the Repository list, select the repository in which the artifact has been published.

    2. In the tree view, select the group in which the artifact has been published, then select the feature corresponding to the artifact that has been published.

    3. Click OK.

    The Repository, URL, Name and Version fields are automatically populated.

    Repository

    Name of the Artifact repository on which the artifact (Service, Route or Generic) has been published. This field is automatically filled in when selecting the feature but you can also type it in manually.

    URL

    If you selected the artifact to deploy in the Feature field through the Select Feature button, the URL field will automatically be filled in with the Maven URL of the Feature to deploy and start.

    But you can also directly type in this URL if you know it. The format of this URL is: mvn:<groupID>/<artifactID>/<version>/xml. For example: mvn:org.example/route_cFile-feature/0.2/xml

    Note

    The Repository must have been defined before entering the URL manually.

    Name

    Select the name of the Feature you want to deploy and start, as an artifact can be made of several features.

    Version

    The version of the Feature to deploy and start is automatically retrieved.

    Type

    Select the type of artifact to be deployed and started. It can be: Route, Service or Generic.

    Context

    If several contexts are available for the selected Feature, select the relevant context.

    Server

    Select the server on which the task should be deployed and started. Only Talend Runtime servers are available in this list.

    If the relevant server does not appear on the list, check the Servers page and make sure the server is correctly configured. For more information regarding the execution server configuration, see Configuring execution servers.

    If a virtual server is selected which still has a Cellar Group, a dialog will be shown prompting you to remove the cluster configuration from the virtual server as the Cellar Group option is not supported from version 6.0:

    Property ID (PID)

    This field is automatically filled in with the identifier of the artifact (the name of the Route, Service or Generic OSGi feature) when this artifact is using a context or a configuration file. So if the artifact does not use any context or configuration file, this field will remain empty.

    Note

    The PID of the task can be manually changed if needed.

  3. Click Save to validate the configuration or Cancel to cancel the creation of the task.

Warning

If you click on any of the tasks in the list before finalizing the creation or modification of the current task, a dialog box pops up prompting you to save the parameters in the configuration panel before switching to another task. Click Cancel to return to the configuration panel and save the parameters.

Editing a task

To edit a task:

  1. On the ESB Conductor page, select the task you want to modify. Its details are displayed in the Edition configuration panel.

  2. Make the relevant changes to the task details where necessary.

  3. Click Save to validate the changes or Cancel to cancel the changes.

Warning

If you click on any of the tasks in the list before finalizing the creation or modification of the current task, a dialog box pops up prompting you to save the parameters in the configuration panel before switching to another task. Click Cancel to return to the configuration panel and save the parameters.

Duplicating a task

To avoid creating a new task from scratch, you can duplicate an existing one and work around its metadata to have a new task in the list.

To duplicate a task, complete the following:

  1. On the ESB Conductor page, select the task you want to duplicate.

  2. On the toolbar, click Duplicate. The panel to the right shows the metadata of the selected task.

  3. Modify the metadata as needed in order to create a new task.

  4. Click Save to validate the operation or Cancel to cancel it.

    The new task is listed in the Execution tasks list.

Warning

If you click on any of the tasks in the list before finalizing the creation or modification of the current task, a dialog box pops up prompting you to save the parameters in the configuration panel before switching to another task. Click Cancel to return to the configuration panel and save the parameters.

Deleting a task

To delete one or more tasks from the task list, complete the following:

  1. On the ESB Conductor page, select the task you want to delete. Its details are displayed in the Edition configuration panel.

  2. On the toolbar, click Delete. A confirmation dialog box appears.

  3. Click OK to remove the task from the task list.

Customizing the display of the task list

You can customize the execution task list view to restrict the number of displayed tasks according to different criteria. You can also show/hide one or more columns in the task list.

  1. On the ESB Conductor page, put the pointer on a column name and click the drop-down arrow.

  2. In the drop-down list, select:

    Item

    To...

    Sort Ascending

    arrange the list in an ascending order

    Sort Descending

    arrange the list in an descending order

    Columns

    display a drop-down list where you can select/clear the check box next to the column(s) you want to show/hide

    Group by this field

    arrange the list by the name of the selected column

    Show in groups

    show the list as one group

The below figure shows the list view options in the drop-down list.

Once you have customized the list, your preferences are saved (column filters, order or width). To reset the page, you have to click the cog icon on the right of the top toolbar.

Refreshing the task list

The task list is refreshed automatically at regular intervals of time, but you can refresh it any time by clicking Refresh on the toolbar.

Deploying a task

Once the task created and listed in the execution task list, you will be able to deploy, undeploy, start and stop it via the toolbar at the top of the ESB Conductor page.

You have full control over the execution of all tasks, as you have the possibility to:

  • Deploy the Feature associated to the task into Talend Runtime with the Deploy button.

  • Stop the Feature without uninstalling and undeploying it from Talend Runtime with the Stop button.

  • Restart the stopped Feature with the Start button.

  • Undeploy the Feature associated to the task from Talend Runtime with the Undeploy button.

  • Modify the value of the context parameters of the task's Feature whether it is a route, a service or a generic OSGi Feature, or modify the value of the configuration parameters for your generic OSGi Feature using a configuration file.

Deploying tasks

To deploy an execution task in the ESB Conductor:

  1. Select the task in the execution task list.

  2. Click the Deploy button of the toolbar.

    The status of the task changes from CREATED to STARTED.

Note

By clicking the Deploy button, you will deploy and start the feature, and its bundle(s), at the same time.

Undeploying tasks

To undeploy an execution task in the ESB Conductor:

  1. Select the task in the execution task list.

  2. Click the Undeploy button of the toolbar.

    The status of the task changes to UNDEPLOYED.

Note

This will uninstall the Feature from Talend Runtime, it will not longer be startable unless you redeploy it.

Starting tasks

To start an execution task in the ESB Conductor:

  1. Select the task in the execution task list.

  2. Click the Start button of the toolbar.

    The status of the task changes to STARTED.

Stopping tasks

To stop an execution task in the ESB Conductor:

  1. Select the task in the execution task list.

  2. Click the Stop button of the toolbar.

    The status of the task changes to STOPPED.

Note

This option is only available if you filled in the Bundle Name field of the task to be started. As this will identify the main bundle composing the feature, it will allow to kill the Feature by stopping its main bundle without undeploying it. For more information, see Adding an execution task

Modifying execution parameters

You can modify the value of the context parameters of the task's Feature whether it is a Route, a Service or a generic OSGi Feature, or modify the value of the configuration parameters for your generic OSGi Features using a configuration file directly from Talend Administration Center and execute the task with those new values without the need to republish the Feature in Talend Runtime.

To set new values for context parameters:

  1. In the upper half of the ESB Conductor page, select the task for which you want to modify the context values.

  2. Go to the Config properties view in the lower half of the ESB Conductor page to display the corresponding view.

    Context parameters are automatically extracted from bundles and listed in the Config properties view.

  3. Select the context parameter you want to change and type in the new value in its corresponding Custom value field.

  4. When you edit the value of a context parameter, your change is activated automatically. You can also select or clear the Active check box on your own to enable or disable the use of the Custom value. The Original value of the parameter is read-only and will be used when the Active check box is cleared.

  5. When you edit a field, a small red triangle appears at the top left hand corner of the field to indicate that the field has been modified but not saved. Click the Save button if you want to apply your changes.

  6. In the list of tasks, click Deploy to deploy the task with the newly set values of the context parameters.

From the Config properties view, you can also:

  • add one parameter by clicking the Add button and typing in the name and value you want to set in the Name and Custom value field respectively

  • delete one parameter by selecting it in the list and clicking the Delete button

  • reset ALL the values at once to the default ones by clicking the Reset button

Managing Feature bundles

When you create a task Feature in the ESB Conductor page, the bundles contained in the Feature are displayed in the Bundles view on the lower half of the page. You can manage the Feature bundles in the Bundles view.

To do so:

  1. In the upper half of the ESB Conductor page, select the task for which you want to manage the Feature bundles.

  2. Click the Bundles view in the lower half of the ESB Conductor page to display it.

    The default Bundles view provides the following information regarding the bundles of the selected Feature:

    Column label

    Description

    Available

    The status of the bundle:

    : The bundle is active

    : The bundle is not active

    Bundle Name

    The name that identifies the bundle in the Artifact repository. The bundle name is obtained from the Feature file when the task is created.

    Bundle Symbolic Name

    The symbolic name that identifies the bundle in Runtime. The symbolic name of the bundle is obtained by the Administration Center when the Feature is deployed into Runtime.

    Version

    The version of bundle. You can specify the version of the bundle when there are multiple versions of the bundle in the Runtime.

    Is Fragment

    True or false indicating if the bundle is fragment or not. All bundles are not marked as fragment by default.

    You can customize the display of the bundle list to show/hide one or more columns or arrange the list in a certain order using the context menu of a column name.

  3. From the Bundles view, you can:

    • edit an existing bundle

    • add a bundle by clicking the Add button and specify the bundle name, bundle symbolic name, version and whether it is fragment in the corresponding fields

    • delete a bundle by selecting it in the list and clicking the Delete button

    The list of bundles is used to indicate the online status of the Feature. When you add or delete a bundle in the list, the bundle is not added or deleted in Runtime.

  4. Click Save to save your changes.

Accessing the artifact repository

From the ESB conductor page of Talend Administration Center, you can access at any time the Nexus artifact repository containing the two ESB artifact repositories on which all the artifacts to be deployed and started in Talend Runtime are published. To do so, simply click the Open Artifact repository button in the toolbar of the ESB Conductor.

Once connected to your artifact repository, you will be able to access all the available repositories and browse to all the artifacts published in them.

For more information on how to install these artifact repositories, see the Talend Installation Guide.

The Nexus artifact repository is based on Sonatype Nexus: for more information on how to use it, see Sonatype Nexus's documentation on http://www.sonatype.org/nexus.