@sap/jobs-client

Node.js client for XS Advanced Job Scheduler service.

This is a small Node.js module to integrate jobs in your Node.js application. The module contains utilities to create REST calls in the request format expected by the job scheduler service to register/unregister jobs in job scheduler service, update job schedules and job status.

Usage

General

This module works with job descriptor objects, having the properties as expected by the respective service in JobScheduler.

Constructor

The constructor instantiates a job scheduler client object.

If there is exactly one service binding to the job scheduler service, all necessary information is read from the binding information: if OAuth is configured, the client requests an access token from the bound identity provider; otherwise, user name and password are taken from the cloud environment.

In other cases, the constructor requires an options object that must at least contain the base URL of the job scheduler service and the necessary authentication information, either an OAuth token or user name and password.

The following properties can be set in the constructor options:

name | description ---- | ----------- baseURL | the base URL of the job scheduler service timeout | HTTP request timeout in milliseconds, default 15000 token | OAuth access token for the job scheduler service user | user name for the job scheduler service (if basic authentication is used) password | password for the job scheduler service (if basic authentication is used)

Example usage with bound job scheduler service:

  const JobSchedulerClient = require('@sap/jobs-client');
  const scheduler = new JobSchedulerClient.Scheduler();

Example usage with Basic Authentication:

  const JobSchedulerClient = require('@sap/jobs-client');

  const options = {
    baseURL: 'https://apphost:port/',
    user: '<username>',
    password: '<password>'
  };
  const scheduler = new JobSchedulerClient.Scheduler(options);

Example usage with OAuth:

  const JobSchedulerClient = require('@sap/jobs-client');

  const options = {
    baseURL: 'https://apphost:port/',
    token: '<token>'
  };
  const scheduler = new JobSchedulerClient.Scheduler(options);

Create job

  var myJob = { /* according to job scheduler documentation */ };
  var scJob = { job: myJob };

  scheduler.createJob(scJob, function (error, body) {
    if (error) {
      return console.log('Error registering new job %s', error);
    }
    // job was created successfully
    job.id = body._id;
  });

Update job

  var req = {
    jobId: 33,
    job: {
      user : 'John',
      password : 'secret',
      active : 1
    }
  };
  scheduler.updateJob(req, function(err, result) {
    if (err) {
      return console.log('Error updating job: %s', err);
    }
    //job was updated successfully
  });

Delete job

  var req = {
    jobId: 33
  };
  scheduler.deleteJob(req, function(err, result) {
    if (err) {
      return console.log('Error deleting job: %s', err);
    }
    //job was deleted successfully
  });

Get job Details

  var req = {
    //by Id
    jobId: 33
  };
  scheduler.fetchJob(req, function(err, result) {
    if (err) {
      return console.log('Error retrieving job: %s', err);
    }
    //job details retrieved successfully
  });
  var req = {
    //by name
    name: 'my job'
  };
  scheduler.fetchJob(req, function(err, result) {
    if (err) {
      return console.log('Error retrieving job: %s', err);
    }
    //job details retrieved successfully
  });

Create job schedule

  var mySchedule = { /* according to job scheduler documentation */ }
  var req = {
    jobId: 33,
    schedule: mySchedule
  };
  scheduler.createJobSchedule(req, function(err, result) {
    if (err) {
      return console.log('Error creating job schedule: %s', err);
    }
    //Schedule created successfully
  });

Update job schedule

  var req = {
    jobId: 33,
    scheduleId: 'ABC-DEF',
    schedule: {
      cron: "* * * * 4"
    }
  };
  scheduler.updateJobSchedule(req, function(err, result) {
    if (err) {
      return console.log('Error updating job schedule: %s', err);
    }
    //Schedule updated successfully
  });

###Delete job schedule

  var req = {
    jobId: 33,
    scheduleId: 'ABC-DEF'
  };
  scheduler.deleteJobSchedule(req, function(err, result) {
    if (err) {
      return console.log('Error deleting schedule: %s', err);
    }
    //Schedule deleted successfully
  });

Get all jobs

  var req = {};
  scheduler.fetchAllJobs(req, function(err, result) {
    if (err) {
      return console.log('Error retrieving jobs: %s', err);
    }
    //Jobs retrieved successfully
  });

Get job schedule details

  var req = {
    jobId: 33,
    scheduleId: 'ABC-DEF',
    displayLogs: false
  };
  scheduler.fetchJobSchedule(req, function(err, result) {
    if (err) {
      return console.log('Error retrieving schedule: %s', err);
    }
    //Schedule retrieved successfully
  });

Get schedules of job

  var req = {
    jobId: 33
  };
  scheduler.fetchJobSchedules(req, function(err, result) {
    if (err) {
      return console.log('Error retrieving all schedules: %s', err);
    }
    //All schedules retrieved successfully
  });

Update run log of schedule

  var req = {
    jobId: 33,
    scheduleId: 'ABC-DEF',
    runId: 1,
    data: data
  };
  scheduler.updateJobRunLog(req, function(err, result) {
    if (err) {
      return console.log('Error updating run log: %s', err);
    }
    //Run log updated successfully
  });

Get run logs of schedule

  var req = {
    jobId: 33,
    scheduleId: 'ABC-DEF',
    page_size: 15,
    offset: 0
  };
  scheduler.getRunLogs(req, function(err, result) {
    if (err) {
      return console.log('Error retrieving run logs: %s', err);
    }
    //Run log retrieved successfully
  });

Delete all schedules of job

  var req = {
    jobId: 3
  };
  scheduler.deleteAllJobSchedules(req, function(err, result) {
    if (err) {
      return console.log('Error deleting schedules: %s', err);
    }
    //All schedules deleted successfully
  });

Bulk activation of schedules of job

  var req = {
    jobId: 3
  };
  scheduler.activateAllSchedules(req, function(err, result) {
    if (err) {
      return console.log('Error activating bulk schedules: %s', err);
    }
    //All schedules activated successfully
  });

Bulk deactivation of schedules of job

  var req = {
    jobId: 3
  };
  scheduler.deactivateAllSchedules(req, function(err, result) {
    if (err) {
      return console.log('Error deactivating bulk schedules: %s', err);
    }
    //All schedules deactivated successfully
  });

Get action logs of job

  var req = {
    jobId: 3
  };
  scheduler.getJobActionLogs(req, function(err, result) {
    if (err) {
      return console.log('Error retrieving action logs: %s', err);
    }
    //All actionlogs logs retrieved successfully
  });

Get action logs of schedule

  var req = {
    jobId: 3,
    scheduleId: "ABC-DEF"
  };
  scheduler.getScheduleActionLogs(req, function(err, result) {
    if (err) {
      return console.log('Error retrieving action logs: %s', err);
    }
    //All actionlogs logs retrieved successfully
  });

Get active and inactive jobcount

  var req = {
    activeStatus: true // true- for getting active number of jobs and false- for getting inactive number of jobs
  };
  scheduler.getJobCount(req, function(err, result) {
    if (err) {
      return console.log('Error retrieving jobcount: %s', err);
    }
    //Active Job count retrieved successfully
  });

Search API

Search can be done in both job and schedule entities. Here in the client 'q' contains the query parameter, you need to provide the query in decoded format, the client will decode the query. And filtering parameters can be provided as shown below:

var searchToken = {
    q : 'job startTime:>2011-02-18 active:false',
    displaySchedules : 'false',
    offset : 0,
    page_size : 5
  };

  scheduler.searchJobs(searchToken,function(error,result) {
      if (error) {
        return console.log('Error during Job search: %s',error);
      }
      console.log(JSON.stringify(result));
  });

For schedule search:

var searchScheduleToken = {
  q : 'startTime:>2011-02-18 active:false',
  offset : 0,
  page_size : 5
};

scheduler.searchSchedules(searchScheduleToken,function(error,result) {
    if (error) {
      return console.log('Error during Schedule search %s',error);
    }
    console.log(JSON.stringify(result));
});