Page History
...
Display feature availability | ||
---|---|---|
|
Display feature availability | ||
---|---|---|
|
...
- 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.
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:
Explanation:
...
Then hit the Next button to make the job wizard display available arguments:
Explanation:
- Optional Arguments
validity_days
: Specifies the number of days for which the license should be valid.- The job will terminate with return code 3 if the license will expire within the given number of days.
- The job will terminate with return code 2 if the license is expired.
- Note that the the check box checkbox provided with each argument has to be selected the argument is to be added to to add the arguments of to the CheckHistoryJob templatejob.
When hitting the Submit button the wizard adds the required selected arguments to the job which should can look like this:
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 | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
The CheckHistoryJob template CheckLicenseJob template returns the following variables :that can be used by subsequent jobs and instructions.
Return Variable | Data Type | Purpose | Example |
---|---|---|---|
returnCode | number | Signals the license check result:
| |
subject | string | The subject for an e-mail that can be send from a subsequent job:
| |
body | string | The body for an e-mail that can be send from a subsequent job. The | .. 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 CheckHistoryJob template do not fail if the underlying query does not return results.
- Instead, the CheckHistoryJob 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.
...
Explanation:
...
Further Resources
...