API Scheduler

From Hornbill
Revision as of 12:46, 27 March 2019 by SteveGoldthorpe (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Contents

Hornbill API Scheduler

The utility provides a quick and easy way to schedule the running of Hornbill API’s.

Installation

Windows

  • Download the Operating System specific ZIP archive from the latest release, that contain the executables, configuration file and license;
  • Extract the ZIP archive into a folder you would like the application to run from e.g. ’C:\hornbill_scheduler'.

Configuration

Example JSON File:


{
  "APIKey": "apikeygoeshere",
  "InstanceID": "instanceIDgoeshere",
  "Schedule": [
    {
      "Enabled":true,
      "CronSchedule":"0 1 23 * * 1-6",
      "DayOfMonthANDDayOfWeek":false,
      "ScheduleFrom":"2016-11-12T00:00:00.000Z",
      "ScheduleTo":"2017-01-01T00:00:00.000Z",
      "Service":"apps/com.hornbill.servicemanager/Incidents",
      "API":"logIncident",
      "APIParams":{
        "0":
        {
          "Type":"Content",
          "Parameter":"summary",
          "Content":"Request Summary"
        },
        "1":
        {
          "Type":"Content",
          "Parameter":"description",
          "Content":"Request Description"
        },
        "2":
        {
          "Type":"Content",
          "Parameter":"customerId",
          "Content":"alanc"
        }
      }
    },
    {
      "Enabled":true,
      "CronSchedule":"0 25 19 * * 1-5",
      "DayOfMonthANDDayOfWeek":false,
      "ScheduleFrom":"2016-11-12T00:00:00.000Z",
      "ScheduleTo":"2017-01-01T00:00:00.000Z",
      "Service":"apps/com.hornbill.servicemanager/Requests",
      "API":"updateReqTimeline",
      "APIParams":{
        "0":
        {
          "Type":"Content",
          "Parameter":"requestId",
          "Content":"IN0000018"
        },
        "1":
        {
          "Type":"Content",
          "Parameter":"content",
          "Content":"This is an auto update"
        }
      }
    }
  ]
}
  • "APIKey" - a Hornbill API key for a user account with the correct permissions to carry out all of the required API calls
  • "InstanceId" - the ID of your Hornbill instance
  • "Schedule" - A JSON array, where each object within this array contains the configuration for one scheduled and repeatable task:
    • "Enabled" - set to true to enable the schedule item
    • "CronSchedule" - A Cron compatible schedule expression to schedule the API call by. See https://godoc.org/github.com/hornbill/cron for details on how to build Cron expressions for this tool.
    • "DayOfMonthANDDayOfWeek" - Boolean true or false. When true, the content of BOTH Day of Week and Day of Month parts of the expression will be enforced, rather than the crontab standard of either.
      • NOTE: the following special characters are supported in these parts of the expression when this is set to true
        * , - ?
    • "ScheduleFrom" - An RFC3339 formatted time string, to specify the date & time to start running any instances of the particular schedule entry. This can contain an empty string to allow you to not specify a date/time to start the schedule from
    • "ScheduleTo" - An RFC3339 formatted time string, to specify the date & time to stop running any more instances of the particular schedule entry. This can contain an empty string, should you wish the schedule to run indefinitely
    • "Service" - The Hornbill Service that contains the API you wish to running
    • "API" - The name of the API to run
    • "APIParams" - A JSON object, containing one or more other JSON objects, allowing you to specify the Order that the parameter should be presented to the API, the parameter type, the parameter ID and the content to write:
      • "Type" - Can be set to:
        • 'Content' - To write a parameter name (Parameter) and value (Content);
        • 'Open' - Allows for complex parameters to be written to the API, within the element specified in this node - must be matched with a parameter type of 'Close'
        • 'Close' - Allows for complex parameters to be written to the API, within the element specified in this node - must be matched with a parameter type of 'Open'
      • 'Parameter' - The name of the parameter
      • 'Content' - the string that should be written within the Parameter node

For API parameters in Hornbill that require a Date/Time string value, rather than a hard-coding this date/time within the configuration, you can specify an expression to write a date/time string whose value is the number of minutes/hours/days/months/years AFTER the date/time the scheduled event runs. This can be particularly useful when scheduling the raising of tasks within Hornbill, and you need to specify a targeted time of completion for the task.

The expression should be written in this format:

nowPlus::X::Y

Where X is an integer value, and Y is the unit of time. So for example:

nowPlus::2::minutes - would return the scheduled time plus 2 minutes nowPlus::4::days - would return the scheduled time plus 4 days nowPlus::1::years - would return the scheduled time plus 1 year

The units of time currently supported are:

minutes hours days months years

Execute

Command Line Parameters

  • file: This should point to your JSON configuration file and by default looks for a file in the current working directory called conf.json. If this is present you don't need to have the parameter.
  • dryrun: Defaults to `false`. Set to `true` to run the tool in dry-run mode, which outputs all API call details (service, method and payload) to the log without actually firing the API calls
  • debug: Defaults to `false`. Set to `true` to run the tool in debug mode, which outputs the API call request and response XML payload to the log file when not in dryrun mode

'goAPIScheduler.exe -file=conf.json -dryrun=true'

When you are ready to start the scheduler:

  • Open conf.json and add in the necessary configuration;
  • Open Command Line Prompt as Administrator;
  • Change Directory to the folder containing the scheduler executables and configuration file 'C:\hornbill_scheduler\';
  • Run the command relevant to your OS:
    • Windows: goAPIScheduler.exe
    • OSX/Linux: ./goAPIScheduler
  • Follow all on-screen prompts, taking careful note of all prompts and messages provided.

When the scheduler is executed, you will be presented with a list of all active schedule items from the configuration file, and these items will be executed as per the config at the relevant dates/times.

Exit

To end the scheduler app, press CTRL+C in the Command Prompt window where the scheduler is running.

HTTP Proxies

If you use a proxy for all of your internet traffic the HTTP_PROXY Environment variable should be set in the command line using the following:

set HTTP_PROXY=HOST:PORT

Change Log

1.3.0 27/03/2019

Features

  • Added support to allow Day Of Month and Day Of Week parts of expression to both be enforced
  • Additional parsing of the cron schedules, better logging when incorrect expression provided

1.2.1 12/03/2019

Fixed

  • Updated third-party cron library to fix duplicate API call issue in certain Windows builds

1.2.0 21/01/2019

Features

  • Added "debug" mode, to allow the scheduler to output API call payloads to the log file

1.1.0 13/12/2018

Features

  • Added "dryrun" mode, to allow the scheduler to output API call details out to the log without actually firing the API calls
  • Removed need to specify instance zone in configuration
  • General tidy up of the code

1.0.3 04/07/2017

Fixed

  • Updated third-party cron library to fix duplicate API call issue

1.0.2 07/02/2017

Fixed

  • Unable to use non-default configuration file name

1.0.1 14/11/2016

Features

  • Added ability to generate dynamic date strings for insertion into API parameters

v1.0.0 - 12/11/2016

  • Initial Release
Personal tools
Namespaces

Variants
Views
Actions
Navigation
Tools