REST Service Planner

This feature integrated on the Control Panela allows you to easily plan the call to REST services.

It is available to users with an administrator, developer or analytics role.

You can find it on the DEVELOPMENT menu option:

First you´ll see a list with all planners defined by user, including their URL. From here you can edit, delete, and start defined planners, according to the set frequency or executing them asynchronously:

When you need to create a REST Planner you have to specify:

Identification: Name.
Description.
CRON: CRON Expression (how often it will be executed).
URL: URL to invoke.
HTTP Method: HTTP Method to invoke URL.
Activated from & to: Task start and end dates are optional and can be left blank.

To simplify the creation of the CRON expression, the user can use this interface in which the expression is defined in a more intuitive way, choosing it from a pop-up.

When you define the URL you can user “${ENV}” so platform replace this word for the environment URL in which you are:

The Planner also allows the user to define headers and properties which are passed to the URL of invocation as parameters:

You can use the Execute button in order to invoke one time the REST Service defined.

You can see result of the invocation on Control Panel logs.

To set the task to be executed as established in the CRON expression, you must press the Play button.

The page will automatically reload, the Stop icon appears and the REST task starts.

The results logs can be observed in the rest-planner module.