Guide: Create a Schedule

OnlyDC-Maestro userscan create and manage Schedules.
Summary of steps

Introduction

A Schedule groups together a set of tasks (Pipeline), scheduled or not.
It can run manually, or automatically without you being connected.

When a user creates a Schedule, they become its owner.
The owner account is used to communicate with DataChain and perform DataChain tasks.

Your rights on the elements and your global permissions condition the access to the elements of DataChain Projects as well as the proper execution of tasks.

Select Working Instance

To create a Schedule, you must have selected an available DataChain Instance from the list of Instances.

List of instances with one instance selected as Working Instance

The selected instance is called Working Instance and will remain visible in the left menu.

To create a Schedule, DC-Maestro must be able to communicate with the Working Instance.
If the Working Instance is connected, the icon Instance connected is displayed.
If the connection is lost, the icon Connection failed will be displayed.
In this case, it will not be possible to create a Schedule or modify the Pipeline.

Enter your password

To create a new Schedule, click on the Create a Schedule button located in the left menu.

The user who creates a Schedule automatically becomes its owner.
This means that all DataChain tasks will be executed according to its profile, and therefore its DataChain rights and permissions.

In order to secure the Schedule execution and allow DC-Maestro to execute the tasks even if you are not connected, enter your password then click on Validate.

Security mode

Select DataChain Project

The first step in creating a Schedule is selecting a Project.
Only Projects of which you are a member are visible.

When you click on a Project card, you automatically move on to the next step.
If you want to change Project, click on the Previous button.

The choice of Project cannot be modified once the initialization step is complete.
It defines the scope of the Schedule and therefore conditions the DataChain elements available for the tasks execution.
It is not possible to perform tasks on items from different projects in the same Schedule.

Select DataChain task

Different types of DataChain tasks are available for the initialization step.
Once you have selected a task to run, click on the Next button to display the list of DataChain elements available in this project for this type of task.

To change Project, click on the Previous button.

Select a DataChain element

The list of DataChain elements available specifically for the selected task is displayed.
You can sort the list and search by tag.

Click on a line to select an element then on Next to go to the last step.

To edit the task, click the Previous button.

Complete the metadata and set the privacy parameter.

Only the label is mandatory, but we recommend that you briefly describe the Schedule goal and add a tag to simplify research and understanding.
These elements can be modified after the initialization step.

How you want the Schedule to be shared defines the privacy parameter.

  • Public: all the elements that make up the Schedule can be consulted in read-only mode by allDC-Maestro users

  • Private: the Schedule is only visible to the owner

In all cases, only the owner and contributors can modify or delete elements (metadata, tasks, execution, …​) of a Schedule.

Set execution type and frequency

During the initialization step, it is recommended to choose a manual execution, in order to execute the Pipeline and automate it whenever you want.

In all cases, all the parameters can be modified later.

By default, autorun is set to run every day at 6am (UTC).

To modify this setting, you can either use the form or the CRON language.

The orchestration time zone is UTC.
When you set the execution frequency, you must take the difference into account +. For example, if you want to schedule an execution every day at 18:00, and the server indicates 12:00 whereas your computer indicates 13:00, you must subtract one hour, i.e. set the CRON to 17:00. The server time can be viewed at any time in the top menu.

Once all the fields have been correctly filled in, click on Summary to go to the last step.

Save Schedule

After checking all the elements, click on Save.

The initialization is complete and the integration phase begins.
The integration time in the orchestrator can vary from a few seconds to a few minutes.
During this integration phase, the Schedule cannot be executed.
If you try to run the Schedule during this phase, a warning message is displayed.
It is possible to modify the Schedule during this phase and to build the Workflow.

As soon as the integration phase is finished, you can test the execution from the list of Schedules by clicking on Play.

Related pages