You are viewing the documentation for Blueriq 14. Documentation for other versions is available in our documentation directory.

Scheduler maintenance REST API is designed to provide the possibility to interfere when running blueriq on single or multi-nodes environments. 

This REST API must be used when:

  • Servers shutdowns occur unexpectedly on multi-nodes environments. In this situation the abandoned tasks have to be recovered by calling Cancel All Started Tasks Endpoint.
  • Application name and/or version is changed in Blueriq Studio. In this situation the changes are propagated to the database by calling the Update Application Name and Version Endpoint.

These two endpoint are described below:

Cancel All Started Tasks

Situation

Cancel started tasks is the mechanism of recovering the abandoned tasks that were not completed due to unexpected runtime nodes shutdowns.

Blueriq provides two ways for enabling this mechanism:

  1. Setting the property blueriq.processengine.cancel-started-tasks to true on the process module. This is supported also in previous Blueriq versions and it is designed for single node environments. For more information about process module properties please consult Process Module Properties.
  2. Using the cancel started tasks endpoint described below. It is designed for multi-nodes environments and overrules the blueriq.processengine.cancel-started-tasks property.

Setting the property blueriq.processengine.cancel-started-tasks to true when running in a multi-node environment might cause unexpected behavior. For example while the cancellation of started tasks triggered on one runtime node is running, a specific task could be still in progress on another runtime node and it might be reopen.

When unexpected runtime nodes shutdowns occur:

  • It is recommended to use the endpoint in multi-node environments.
  • In single node environments either the endpoint or the property can be used.

Description

PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/tasks/cancelStarted

By calling this endpoint, all started manual tasks across all nodes will be reset to open and all started automatic tasks will executed.

Update Application Name And Version

Situation

This endpoint is needed in case you already ran a process enabled project and find out that you have to rename the model name and/or version. Renaming the model in studio doesn't change the cases and jobs references to the model in the database; they still use the old, previous model. The result is that the previously created timers cannot be used anymore, priority algorithm won't be called anymore and tasks with expiration will not expire anymore. To get it back working normally the application name and/or version have to be changed to the new name and/or version (as provided in the studio model) in the database. This can be done by using this endpoint.

Description

By calling one of these endpoint, the application ids for cases matching the application name from the url will be updated with new values. Every job registered to these cases will be updated as well.

PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/{currentApplicationId}?caseId={caseId}

{
"name" : {newApplicationName},
"version" : {newApplicationVersion}
}

Validations

  1. Current application id consists of application name and application version. Format of the application id is: applicationName:applicationVersion.
  2. Current application id is mandatory, case id is optional.
    If case id is specified, only one case will be updated. If case id is not specified all cases matching the application id will be updated.
  3. At least new name or new version must be specified in the request body.

Steps:

  1. Find all cases matching the application id (from the url). If case id is specified, find the case by it's id.
  2. Update application id for the cases from step 1, with the new data sent in the request body. Name or version or both can be updated, depending on what is specified in the request body.
  3. Get the jobs for the cases and update them accordingly.

Request examples:

  1. Update application name

    The application ids, for the cases with the current application id "export-TestOldProject:0.0-Trunk", are updated to "export-TestNewProject:0.0-Trunk". 

    PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/export-TestOldProject:0.0-Trunk

    {
    "name" : "export-TestNewProject"
    }

  2. Update application version

    The application ids, for the cases with the current application id "export-TestOldProject:0.0-Trunk", are updated to "export-TestOldProject:0.1-Trunk". 

    PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/export-TestOldProject:0.0-Trunk

    {
    "version" : "0.1-Trunk"
    }

  3. Update application id (both name and version)

    The application ids, for the cases with the current application id "export-TestOldProject:0.0-Trunk", are updated to "export-TestNewProject:0.1-Trunk". 

    PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/export-TestOldProject:0.0-Trunk

    {
    "name" : "export-TestNewProject",
    "version" : "0.1-Trunk"
    }

  4. Update application id for a specific case
    1. Update application name

      The application id, for the case with the current application id "export-TestOldProject:0.0-Trunk" and case id 1, is updated to "export-TestNewProject:0.0-Trunk". 

      PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/export-TestOldProject:0.0-Trunk?caseId=1

      {
      "name" : "export-TestNewProject"
      }

    2. Update application version

      The application id, for the case with the current application id "export-TestOldProject:0.0-Trunk" and case id 1, is updated to "export-TestOldProject:0.1-Trunk". 

      PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/export-TestOldProject:0.0-Trunk?caseId=1

      {
      "version" : "0.1-Trunk"
      }

    3. Update application id

      The application id, for the case with the current application id "export-TestOldProject:0.0-Trunk" and case id 1, is updated to "export-TestNewProject:0.1-Trunk". 

      PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/export-TestOldProject:0.0-Trunk?caseId=1

      {
      "name" : "export-TestNewProject",
      "version" : "0.1-Trunk"
      }

Usage

The following steps should be followed for using this endpoint:

  1. Make sure that there exists a runtime user with a role that has the permission SCHEDULER_MANAGER.
  2. Check that blueriq.oauth2.client-id and blueriq.oauth2.secret are defined in application.properties file. If they are missing, please define them.

  3. Access Runtime Swagger Interface: 

    http://<server>:<port>/<runtime>/api/v1/docs/index.html
  4. Fill the username and the password and press Generate Token in order to obtain a new token.
  5. Expand scheduler.
  6. Expand the endpoint you want to use. Available options are:
    • PUT /scheduler/maintenance/tasks/cancelStarted
    • PUT /scheduler/maintenance/applications/{currentApplicationId}
  7. Specify the request parameters.
  8. Press Try it out!
  • No labels

Didn't find the answer you were looking for? Try the advanced search!