Skip to main content

Schedule Process

Synopsis

This operator schedules a process on a RapidMiner AI Hub with given input, output and macros.

Description

This operator starts a process which is given as a repository location on a RapidMiner AI Hub. The AI Hub instance of this repository will execute the process independently from the current process, so that an own process context is available. This context, i.e. the input and output of the process and the macros, can be defined as parameters as well.

Several different schedule modes are available which determine when the process will be started. The modesnow,onceandoffsetare used to start the process once at a given time, wherebycron schedule允许执行the process periodically according to a given cron expression which can be easily created by the cron editor.

It is necessary that the repository of the process which will be scheduled is a repository of a RapidMiner AI Hub instance. Although it is possible to schedule a process from a local RapidMiner instance on a remote AI Hub, it is not possible to execute several process within a local RapidMiner instance with this operator.

Input

through

Output

through

Parameters

Process entry

A valid path should be specified here in order to execute a process. This parameter references a process in a remote repository, i.e. a repository on a RapidMiner AI Hub.

Process input

The process input which will be provided to the process which will be executed. This repository location has to be reachable by the process on the RapidMiner AI Hub instance.

Process output

Indicates where the process output shall be stored. This repository location has to be reachable by the process on the RapidMiner AI Hub instance.

Macros

The macros which will be accessible by the executed process.

Forward macros

If checked, the macros defined in the current context are forwarded to the process to schedule. Manually defined macros will not be overridden.

Schedule mode

The mode defines the time when the selected process will be executed on the AI Hub.

  • now: The process will be executed immediately
  • once: The process will be executed at the date provided by thedateparameter
  • offset: The process will be executed after a given offset provided by theoffsetandtime_unitparameters
  • cron schedule: The process will be executed periodically given astartandenddate and thecron expression

Date

If the schedule modeonceis selected this date parameter specifies the exact date and time when the process will be started.

Offset

The offset to specify for the schedule modeoffset. Combined with the parametertime_unitthis sets the time from now to the start of the process.

Time unit

For theoffsetmode this specifies the unit of time of the value defined in theoffsetparameter. So if the offset is set to 10, this parameter defines if the process will be started in 10 seconds, 10 minutes, 10 hours or 10 days.

Expression

If the schedule modecron scheduleis selected, the expression parameter offers acronvalue which can be added by hand or via the cron editor. This allows to start the process periodically.

Set start date

For a cron expression this parameter determines if a start date will be used. This start date specifies the time when the cron expression is activated to schedule a process.

Start date

The start date which specifies the date to start the scheduling of a process via the cron expression defined inexpression. This parameter is only in use if theset_start_dateparameter is set to true.

Set end date

For a cron expression this parameter determines if a end date will be used. This end date specifies the time until when the cron expression is activated to schedule a process.

End date

The end date which specifies the date until the cron expression will be used to schedule a process. This parameter is only in use if theset_end_dateparameter is set to true.