Release notes

R2022-09

Crawler

Feature Description Related API documentation
New API A new API allows you to retrieve a full list of assets contained in a connection, in a single operation. For examples of this API in use, see Crawler. Crawler

R2022-07

Pausing or resuming a task

Feature Description Related API documentation
Pause and resume tasks

A new endpoint has been added to help you easily pause or resume task executions, when required by a certain circusmstance, for example, when a system maintenance window imposes a pause of task executions.

Accordingly, related endpoints have been updated to take the task pause status into account.

New endpoint:

Updated endpoints:

Timeout on triggers

Feature Description Related API documentation
Timeout settings

In addition to the configuration level and the execution level, you can now set a timeout parameter in the trigger level of a Job task.

A timeout set on a trigger applies on the task run started by this trigger only. It overrides the task configuration timeout if that task has one.

Set this timeout when you append a trigger to a schedule or update a trigger of that schedule.

When you set a timeout value, be aware:
  • Only time-based triggers support it; a webhook trigger does not.
  • Its accuracy is 10 seconds.
  • It is defined in minutes.
  • It applies only on Job tasks running on Remote Engine Gen1 v2.12.0 and onwards, Remote Engine Cluster and Cloud Engine.

Observability metrics

Feature Description Related API documentation
New endpoint You can now search for raw component metrics data to build reports about your Data Integration tasks, running on a Cloud Engine or a Remote Engine v2.12.0 onwards. Search raw component metrics

R2022-06

API domains

Feature Description Related API documentation
New business domains The Talend Cloud Management Console specific API endpoints have been carefully tailored to new business domains:
  • Orchestration
  • Processing
  • Security
  • Monitoring

These domains also contain a variety of subsets to bring the business oriented endpoints to an even finer granularity.

All these endpoints support both Personal Access Tokens (PATs) and Service Account Tokens (SATs)

See the following page to discover all these endpoints in their subsets and domains:

Orchestration

Feature Description Related API documentation
Multiple time triggers New schedule-specific endpoints have been created to help you manage up to 15 time-based triggers for a task or plan:
  • directly define multiple triggers for a task or plan. You do not need to duplicate your tasks or plans for each of those triggers anymore.

  • simulate all the events to be triggered before applying a schedule to a task or plan
  • manage changes in a schedule without taking any risk upon your current executions
  • reuse and adapt existing schedules for other tasks or plans
  • avoid redundant trigger definitions and tight event frequency, including the bissextile years "effect"
  • protect against accidental deletion of a schedule when it is still used by a task or plan

Note that a schedule supports time triggers only. For this reason, a webhook trigger, which is merely event related, must be used as a separate option, that is to say, without being mixed with the time triggers.

For detailed use cases about how to use these endpoints with a task or a plan, see Using API to schedule task or plan runs

Task filtering endpoint You can now select tasks by setting filters on their tags and trigger types in the request body of a new endpoint.
Environment endpoint New endpoint has been added for environment creation.
Workspace endpoint You can now create a workspace via API.

Job task timeout

Feature Description Related API documentation
Timeout settings A timeout parameter is now available to help you automatically terminate task runs when their durations exceed intended timeframes:

You can set this parameter at two different levels to dynamically manage the timeout of your tasks:

  • Task configuration level: set in the PUT request to the Configure Task execution endpoint. This timeout is added to the configuration of a task and thus applies on all the runs of this task.
  • Task execution level: set in the POST request to the Execute Task endpoint. This timeout dynamically applies on the current task run only. It overrides the task configuration timeout if that task has one.
When you set a timeout value, be aware:
  • Its accuracy is 10 seconds.
  • It is defined in minutes.
  • It applies only on Job tasks running on Remote Engine Gen1 v2.12.0 and onwards, Remote Engine Cluster and Cloud Engine.

R2022-05

Processing

Feature Description Related API documentation
Task executions You can now obtain task runs by setting filters on their tags. The TMC_OPERATOR role is required to use this endpoint. Get available Tasks Executions
Plan executions Specific criteria for filtering plan runs have been added: environmentId and workspaceId. The TMC_OPERATOR role is required to use this endpoint. Get available Plans executions

Orchestration

Feature Description Related API documentation
Event retrieval A new Orchestration API endpoint has been added to retrieve a list of all types of runs scheduled for a given period. The TMC_OPERATOR role or the TMC_ENGINE_USE permission is required to use this endpoint. Get scheduled executions

Observability metrics

Feature Description Related API documentation
New endpoint A new endpoint has been added to get the observability metrics of your Data Integration tasks. Get component metrics of task runs

R2022-04

Execution logs

Feature Description Related API documentation
New parameters New optional query parameters to select the format or define the log file name:
  • fileFormat: the format of the log file to be generated, JSON or TEXT.
  • newFileName: this parameter indicates whether you need to include task IDs and execution IDs in the filename of the log to be generated. It is recommended to set this value to be true as the old filename format is going to be deprecated.
Generate full logs for a completed or ongoing execution
New date format A new isoDate field has been added to the content of the logs. This field displays human readable dates.

R2022-03

Service Account

Feature Description Related API documentation
New API A new API allows you to create and manage service accounts. For examples of this API in use, see Service accounts. Service Accounts

Orchestration

Feature Description Related API documentation
New endpoints Two new endpoints have been added to the task and the plan APIs to retrieve a list of the upcoming scheduled runs.

Processing

Feature Description Related API documentation
New field in promotion data types Data types used in promotion-related operations have been updated to include a new context field. This optional field contains the description of the circumstances related to a promotion run.