Scheduling 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 read-write access to the triggers list. Other types of users can have 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 appropriate authorization by the Administrator.

On the Job Conductor page, you can schedule an execution task using different types of triggers.

Available triggers are:

  • Time-based triggers (SimpleTrigger)

  • Periodic multi-platform CRON-like triggers (CronUITrigger)

  • File-based triggers (FileTrigger):

The trigger list includes the following information:

Column

Description

Label

Trigger name

Trigger type

One of the following trigger types:

SimpleTrigger

CRONUITrigger FileTrigger

Status

Status of the current trigger.

Normal: The trigger is ready to be launched

Waiting for the task to end: The triggering has taken place, the task execution is in progress

Paused: The trigger is disabled

Completed: The trigger execution is complete

Error/Invalid: The trigger execution has failed or is invalid

Previous triggering on

Date and time when the previous triggering took place

Number of triggerings

Estimated number of triggering that will take place over the selected period of time and/or for the number of triggering repetition set.

Time left before next triggering

Time to elapse before the next triggering starts.

Next triggering on

Date and time when the next triggering will take place.

Final triggering on

Estimated or set triggering end time.

Start time

Date and time when the first triggering takes place.

End time

Actual time when the last triggering ended.

File mask

In case of file-based trigger, enter the file name extension for the relevant file

Id

Trigger identification

On the Triggers view at the bottom half of the Job Conductor page, you can add triggers, edit triggers, enable/disable triggers, delete triggers and customize the trigger list.

Adding triggers

To schedule the execution of your tasks, you can set time-based triggers (simple or CRON) or event-based triggers (file) onto a task that will start its execution.

If you want to schedule one or several execution of a task at a precise moment, you can use the simple trigger. For more information on how to use simple triggers, see How to add a simple trigger onto a task.

If you want to schedule one execution of a task on a regular basis (daily, weekly, monthly etc.), you can use the CRON-based trigger. For more information on how to use CRON triggers, see How to add a CRON-based trigger.

If you want to execute a task on a file-based event, such as the presence, creation, modification of the file, you can use the File trigger. For more information on how to use File triggers, see How to add a File trigger.

How to add a simple trigger onto a task

You can add a simple trigger onto a task to schedule one or several execution(s) at a defined date and time.

  1. On the Job Conductor page, select the task you want to implement a trigger on.

  2. In the bottom half of the page and in the Triggers view, click Add trigger... and then select Add simple trigger from the drop-down list. The Simple trigger configuration panel opens.

  3. Enter the following information:

    Field

    Description

    Label

    Give a name to the trigger you are setting

    Description

    Provide a description if the type of trigger is not obvious enough

    Time zone

    In the dialog box, select the time zone of the triggering time in the list. It can be the execution server time, the Web application time or another time zone you define.

    To take advantage of the autocomplete feature, type the first three letters of the time zone you are searching for.

    Start time

    Click the calendar button to open a calender. Click the date and set the exact time for the trigger to be executed. The time format must be HH:MM:SS

    If you do not fill this field, the triggering is immediate

    Note

    For immediate triggering, we advise you to click the execute button on the table.

    End time

    Click the calendar button to open a calendar. Click the date and set the exact time for the trigger to be executed. The time format must be HH:MM:SS.

    If you do not fill this field: the Job will be executed indefinitely (until the number of repetitions is reached, if any)

    Number of repetitions

    Type in the number of execution that should occur in addition to the first execution.

    If you do not fill this field: as many executions as possible within the time frame given

    0: only the first execution is carried out.

    n: n extra execution is carried out in addition to the first one.

    Time interval

    Type in (in sec) the time interval between triggerings. For long interval, use CRON-based triggers.

    Pause trigger on error

    Select the check box in order to pause the trigger if an error occurs during the execution of the task.

    Note

    Fields marked with exclamation mark are mandatory.

  4. Click Save to validate the simple trigger configuration or Cancel to cancel the operation.

The Trigger Status icon for the selected task changes from No Trigger to At least one trigger is running.

Note that, if the task is already running when the task is triggered, the Job Conductor will wait for the current task to finish. If the task is not finished after 60 seconds, then the status of the task execution changes to 'misfired'. A misfired event also occurs if the trigger misses its firing time because of Talend Administration Center is shut down. For more information on task execution status and monitoring, see Monitoring task executions in the Monitoring node.

How to add a CRON-based trigger

If you need to execute a task on a regular basis over a period of time, then use a CRON-based trigger.

  1. On the Job Conductor page, select the task you want to implement a trigger on.

  2. In the Triggers view, click Add trigger... and then select Add CRON trigger from the drop-down list. The CRON trigger configuration panel opens.

  3. Fill in the Label and Description fields and then click Open UI configurer to open the [Cron UI trigger configuration] dialog box.

  4. Select the hour and date items at which you want the task to be executed as the following:

    Field

    Description

    Label

    Enter a name to the trigger you are setting.

    Description

    Enter a description for the trigger type and usage.

    Minutes

    The minute at which you want to execute the task.

    Hours

    The hour at which you want to execute the task.

    Days of month

    The month day on which you want to execute the task.

    If you want the task to be executed on the last day of the selected month(s), select last day of month in the [Cron UI trigger configuration] dialog box or type in L in the Days of month field.

    Months

    The month in which you want to execute the task.

    Days of week

    The week day on which you want to execute the task.

    Years

    The year in which you want to execute the task.

     

    Fields marked with **: Select one or more week day OR one or more dates.

    Fields marked with *: mandatory information.

    For multiple selection, press Ctrl + click.

  5. Click Apply modifications. The dialog box closes and the selected data is displayed in the CRON UI trigger configuration panel.

  6. Click Save to validate the CRON-based trigger configuration or Cancel to cancel the operation.

The Trigger Status for the selected task changes from No Trigger to At least one trigger is running.

Note that, if the task is already running when the task is triggered, the Job Conductor will wait for the current task to finish. If the task is not finished after 60 seconds, then the status of the task execution changes to 'misfired'. A misfired event also occurs if the trigger misses its firing time because of Talend Administration Center is shut down. For more information on task execution status and monitoring, see Monitoring task executions in the Monitoring node.

How to add a File trigger

You can use a file to trigger Job execution tasks. The presence of this file in a defined location will trigger the Job execution task. This file becomes then a job trigger with no other purpose.

For more information on how file triggers work in Talend Administration Center, refer to Talend Help Center (https://help.talend.com).

Note

If a context has been defined and that you intend to use the trigger file in the Job to execute, then make sure to define the following context parameters in the Contexts view in Talend Studio: folderPath, filepath and fileName. Thus, the Job Conductor passes these values to the Job during its execution.

To schedule an execution task based on the presence of a file in a defined location:

  1. On the Job Conductor page, select the task you want to implement a trigger on.

  2. In the Triggers view, click Add trigger... and then select Add file trigger from the drop-down list. The File trigger configuration panel opens.

  3. Fill in the following information:

    Fields

    Description

    Label

    Enter a name to the trigger you are setting.

    Description

    Enter a description for the trigger type and usage.

    Pollint

    Polling interval in seconds, corresponding to the time between each checking operation of the file server.

    Folder Path

    Path to the folder to be scanned regularly for the trigger file.

    File mask

    Mask of the trigger file.

    In order not to trigger job execution for every file in the polling folder, do the following:

    Exist: select this check box to trigger on file if the file already exists in the polling folder

    Created: select this check box to trigger on file if the file is being created and does not already exist in the polling folder

    Modified: select this check box to trigger on file if the file is modified.

    Note

    It is possible to select more than one check box.

    Execution server

    Select the server where the trigger file is put.

  4. Click Save to validate the File trigger configuration or Cancel to cancel the operation.

The Trigger Status icon for the selected task changes from No Trigger to At least one trigger is running.

Editing a trigger

To edit a trigger entry, do the following:

  1. On the Job Conductor page, select the relevant task to display the corresponding triggers in the trigger list.

  2. Select the trigger entry you want to modify. Its details are displayed in the configuration panel to the right.

  3. Make the relevant changes to trigger details where necessary.

  4. Click Save to validate the changes or click Cancel to cancel.

Disabling/Enabling a trigger

To disable or enable a trigger, do the following:

  1. On the Job Conductor page, select the relevant task to display the corresponding triggers and their details in the trigger list.

  2. Select the trigger entry you want to disable/enable.

  3. From the toolbar in the Triggers panel, click Pause trigger/Resume trigger. The selected trigger icon displays as disabled/enabled.

Note

You cannot disable/enable a trigger if its status is Completed.

Deleting one or more triggers

To delete one or more triggers from the trigger list, do the following:

  1. On the Job Conductor page, select the relevant task and click the Triggers tab to display the corresponding triggers and their details in the trigger list.

  2. Select the trigger entry or entries you want to delete.

  3. From the toolbar in the Triggers panel, click Delete. A confirmation dialog box appears.

  4. Click OK to remove the selected trigger entry or entries from the trigger list.

Customizing the display of the trigger list

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

  1. On the Job Conductor page and in the Triggers panel, 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 figure below shows the list view options in the drop-down list.

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