Working with publishing 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.

The Publisher page allows you to work with publishing tasks to publish your Route, Service or Job item that is designed in Talend Studio into the Nexus Artifact repository.

Note

To publish the Route, Service or Job item into the Artifact repository, you can also use the Commandline. Type in help to show the list of commands and their respective description. For more information about Commandline, see CommandLine features.

Prerequisites:

  • the CommandLine application is started.

  • Nexus Artifact repository is started and its connection parameters are filled in the Artifact Repository node of the Configuration page. For more information, see Setting up the Artifact Repository parameters.

To access the publishing task list, complete the following:

  • In the Menu tree view, click Conductor, then Publisher to display the list of tasks that will publish your Route, Service or Job item into an Artifact repository.

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

The default Publisher page provides the following information:

Column label

Description

Status Status of the current task. It can be: Ready to publish, Publishing, Published, Unknown, Incomplete configuration.

Error status

Error message is displayed if the task does not complete properly.

Label

Name of the task to be executed.

Active

True or false indicating if the publishing task is active or not. If a task is deactivated, it can not be published.

Trigger status

Triggering state:

No trigger: no trigger has been set for this task.

Running: the trigger is activated and the task execution will start.

Completed: the task is complete.

All triggers paused: the trigger has been paused and needs to be resumed manually.

Time left before next triggering

Time before the next triggering occurs.

Last run

Date and time of the last time publishing task was executed.

Project

Name of the project containing the Route, Service or Job item(s) to be published.

Branch

Name of the branch/tag containing the Route, Service or Job item(s) to be published.

Publish scope

The scope of item(s) to be published. It can be individual Route/Service/Job, all Services/Routes, all Services and Routes.

Name

The name of the individual Route, Service or Job item to be published. This column is empty if the task will publish all Routes or all Services in the specified project and the SVN branch.

Version

The version of the individual Route, Service or Job item to be published. This column is empty if the task will publish all Routes or all Services in the specified project and the SVN branch.

Publish as Snapshot

True or false indicating if the item(s) will be published as snapshot.

Repository

The repository in which to publish the artifact item(s), either releases or snapshots.

Group ID

The name of the group in which to publish your artifact item(s).

Artifact

The name of the artifact item. This field is empty if the task will publish all Routes or all Services in the specified project and the SVN branch.

Publish Version

The version of the artifact item. This field is empty if the task will publish all Routes or all Services in the specified project and the SVN branch.

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

These extra columns provide the following information:

Column

Description

ID

Unique identifier that can be used as parameter to launch the task via a Webservice, for example.

Description

The description text typed at task creation.

Next triggering on

Date and time of the next triggering.

Last ended run

Date and time of the last time the publishing task was complete.

CommandLine version

Revision number of the CommandLine.

Adding a publishing task

To add a publishing task from Talend Administration Center, complete the following:

  1. From the toolbar on the Publisher page, click Add to clear the Publish Task 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.

    Active

    Select/clear this check box to activate/deactivate this task. If a task is deactivated, it can not be published.

    Project

    Select the project that holds the Service, Job, or Route to be published.

    Branch

    Select the SVN branch/tag, if any is created, of the project containing the Service, Job, or Route to be published. For more information about projects stored on SVN, see Managing SVN/Git branches and tags for a project.

    All Services

    Select this check box to publish all the Services in the project and branch defined above at execution.

    Note

    When you publish a task of All Services type, the services will always get updated with all last versions and new developed services will be added automatically.

    All Routes

    Select this check box to publish all the Routes in the project and branch defined above at execution.

    All Batch Jobs

    Select this check box to publish all the Standard Jobs in the project and branch defined above at execution.

    All Runtime Jobs

    Select this check box to publish all the OSGI Jobs in the project and branch defined above at execution.

    Individual

    Select from Route, Service, Job - Runtime (.kar file) or Job - Batch (.jar file) in the list to publish. This field is disabled when All Services, All Routes, All Batch Jobs or All Runtime Jobs check box is selected.

    Note

    Note that Individual Job is the option to be used to publish the REST service because Individual Service and All Services only concern SOAP services.

    Name

    All the items of the Individual from the selected project are shown in the list. Select the item you want to publish. This field is disabled when All Services, All Routes, All Batch Jobs or All Runtime Jobs check box is selected.

    Version

    The versions of the item are automatically retrieved. Select Latest or one of the existing versions in the SVN project from the list. This field is disabled when All Services, All Routes, All Batch Jobs or All Runtime Jobs check box is selected.

    Publish as Snapshot

    Select this check box to publish the item(s) as snapshot.

    Repository

    Select releases or snapshots. By default, the release or snapshot repository is selected depending on the Publish as Snapshot check box.

    Group ID

    By default this field is automatically filled in with the org.example group ID. Change it by typing in the name of the group in which to publish your artifact item.

    Artifact

    This field is automatically filled in with the name of the item to publish. Change it according to your need. This field is disabled when All Services, All Routes, All Batch Jobs or All Runtime Jobs check box is selected.

    Publish Version

    This field is automatically filled in with the version of the item to publish. Change it according to your need. This field is disabled when All Services, All Routes, All Batch Jobs or All Runtime Jobs check box is selected.

    Max failed test

    This option appears when the All Routes or All Batch Jobs check box is selected, or when Route or Job - Batch is selected in the Individual list. Select this check box and enter the maximum number or percentage of failed tests associated with Jobs or Routes. When launching the publish task, if the actual failed tests exceed this value, the Jobs or Routes will not be published and an error message Test failed exceeded the threshold will be shown in the Error status column of the Publisher page. For more information on how to create and execute tests associated with Jobs and Routes, see the Talend Studio User Guide and the Talend Software Development Life Cycle Best Practices Guide.

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

Editing a task

To edit a task:

  1. On the Publisher page, select the task you want to modify. Its details are displayed in the publishing task 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.

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 Publisher 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.

Deleting a task

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

  1. On the Publisher page, select the task you want to delete. Its details are displayed in the publishing task configuration panel.

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

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

Searching a task

If you have a great number of tasks and want to filter them, you can do so by typing key words or by selecting some check boxes in the Filters fields of the columns listed below:

  • Active

  • Artifact

  • Branch

  • CommandLine version

  • Description

  • Error status

  • Group ID

  • ID

  • Label

  • Last ended run

  • Last run

  • Name

  • Next triggering on

  • Project

  • Publish as Snapshot

  • Publish scope

  • Publish Version

  • Repository

  • Status

  • Time left before next triggering

  • Trigger status

  • Version

Example of how to apply a filter on the label of several tasks

  1. Click the arrow on the Label column to display its options, then select the Filters option.

  2. Type in the name by which you want to filter the tasks. Here, the text Service is used to display only the tasks whose names include these terms.

    The filtered column appears in blue bold. To remove the filter, clear the Filters check box in this column.

    To remove all filters and reset the page, click the cog icon on the right of the top toolbar.

Customizing the display of the task list

You can customize the publishing 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 Publisher 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 list where you can select/clear the check box next to the column(s) you want to show/hide

    Filters

    display a list where you can select/clear the check box next to the filter(s) by which you want to filter the tasks

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.

Launching a task

Once the task is created and listed in the publishing task list, you will be able to launch it via the toolbar at the top of the Publisher page. To do so:

  1. Select the task in the publishing task list.

  2. Click the Publish button of the toolbar.

    The status of the task changes from Ready to publish to Publishing and then Published.

Note

If you select a task that is not active and click the Publish button of the toolbar, a dialog box appears asking if you want to activate the task before publish. Click OK to activate the task and publish it or click Cancel to cancel it.

You can also define a trigger to launch a publishing task. For further information, see Scheduling publishing tasks.

Accessing the artifact repository

From the Publisher page of Talend Administration Center, you can access at any time the Nexus artifact repository containing the two snapshots and releases 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 Publisher.

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.

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