Schedule jobs

Introduction

A scheduled job is a job that is scheduled to run at specific moments in time. The Scheduled Jobs plugin allows you to schedule jobs. You can find it in the Admin menu, under Scheduled Jobs. The table at the top shows you all of the scheduled jobs on your server.

Add a scheduled job

You can add a new scheduled job by pressing the green plus button and filling in the form. The parameters field of the form should be entered as a JSON object, with a name-value pair for each parameter. The format of the JSON depends on the type of the job you're scheduling. The job type determines what will happen when the job is triggered.

File ingest

Downloads and imports data from a CSV file to a single existing table. The file's columns should match the table's attribute names.

parameters

So for example:

{
  "url"            : "http://filesource.mydomain.example/city.csv",
  "loader"         : "CSV",
  "targetEntityId" : "base_city"
}

Script

Runs an existing Script, defined in the Script plugin.

parameters

So for instance, to run a Script named "concat" with parameters a = "foo" and b="bar, you'd fill in

{
  "name"       : "concat",
  "parameters" : "{\"a\" : \"foo\", \"b\" : \"bar\"}"
}

Mapping

Runs an existing Mapping Service project.

parameters

For instance:

{
    "mappingProjectId": "<mapping project id>",
    "targetEntityTypeId": "new_target_entity",
    "packageId": "base",
    "label": "Scheduled Mapping Job Target",
    "addSourceAttribute": true
}

Amazon Bucket file ingest

Files stored in an Amazon Bucket can be imported automatically using a Bucket Job.

parameters

For example:

 {
    "bucket":"[BUCKET NAME]",
    "key":"testplan/emx",
    "expression":false,
    "accessKey":"[ACCESS_KEY]",
    "secretKey":"[SECRET_KEY]",
    "region":"eu-west-1"
 }

Last updated