Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • specify the JITL job class andcom.sos.jitl.jobs.checklicense.CheckLicenseJob Java class name and add arguments specifying what order states to transition..

Example for Alert Workflow

The CheckLicenseJob template can be used to implement a workflow to alert about license expiration:

  • Jobs based on the CheckLicenseJob template do not fail if the underlying check proves an expired license.
  • Instead, the CheckLicenseJob template provides Return Variables that can be inspected to determine further execution of jobs in a workflow.
  • JS7 offers the JS7 - If Instruction to check the values of Return Variables and to decide what instructions to execute next.

Download (upload .json): pduCheckLicenseJITL.workflow.json

The workflow implements

  • The license check from its first job,
  • followed by an If Instruction that checks the returnCode variable to determine if an e-mail should be send,
  • finally will send an e-mail if return code 2 or 3 indicate license expiration.


Image Added


Users can start from uploading the above example and users can start to create the job from scratch using You can use the job wizard like this:

Explanation:

  • Add an empty job from the instruction panel.
  • Specify a name and a label for the job.
  • Select an Agent.

In a next step invoke the job wizard that you find in the upper right corner of the job property editor. The wizard brings up the following popup window:

Image Modified


Explanation:

...

Then hit the Next button to make the job wizard display available arguments:


Image Modified


Explanation:

...

When hitting the Submit button the wizard adds the selected arguments to the job which can look like this:

Image Modified

The job arguments can be specified:

  • from individual variables as configured using the job wizard,
  • by using use of JS7 - Job Resources.

Documentation

The Job Documentation including the full list of arguments can be found from: https://www.sos-berlin.com/doc/JS7-JITL/CheckLicenseJob.xml

Authentication

The Job makes use of the JS7 - REST Web Service API that is available from JOC Cockpit. 

  • The job is executed with an Agent and requires a network connection to JOC Cockpit.
  • The job has to authenticate with JOC Cockpit, for the related configuration see JS7 - JITL Common Authentication.

Anchor
arguments
arguments
Arguments

...

Anchor
return_variables
return_variables
Return Variables

The CheckLicenseJob template template returns the following variables :that can be used by subsequent jobs and instructions.

Return VariableData TypePurposeExample
returnCodenumber

Signals the license check result:

  • Return code 3 signals that the license will expire within the given number of days.
  • Return code 2 signals that the license is expired.


subjectstring

The subject for an e-mail that can be send from a subsequent job:

  • For return code 3 the subject variable  holds the following value:
    JS7 JobScheduler Notification: license expiration warning
  • For return code 2 the subject variable  holds the following value:
    JS7 JobScheduler Notification: license expired


bodystring

The body for an e-mail that can be send from a subsequent job. The body return variable holds the output of the CheckLicenseJob  job.

.. Licence tpye: COMMERCIAL_VALID
.. license valid: true
.. License valid from: Wed May 05 12:22:41 GMT 2021
.. License valid to: Mon May 04 12:22:41 GMT 2026

Alert Workflow

The CheckLicenseJob template can be used to implement a workflow to alert about license expiration:

  • Jobs based on the CheckLicenseJob template do not fail if the underlying check proves an expired license.
  • Instead, the CheckLicenseJob template provides Return Variables that can be inspected to determine further execution of jobs in a workflow.
  • JS7 offers the JS7 - If Instruction to check the values of Return Variables and to decide what instructions to execute next.

...

The workflow implements

...

Further Resources

...