| Table of Contents |
|---|
Summary
ClinSpark supports a unique ability to create and deploy asynchronous utilities, also known as asynch jobs or tasks, to meet a wide variety of use cases and support needs. Asynch jobs are created and maintained by engineering team members. Jobs exist much like other configuration based entities in ClinSpark, where they can be modified by engineering without the need for a new build of ClinSpark to be deployed or a code change to influence their behavior.
The ‘Asynch Job’ dashboard component was therefore built as a way to allow superadmin users an ability manage the deployment and configuration of asynch utilities in a given environment. The intended purpose of the component is to quickly see what jobs exist, edit any existing, and add new jobs as needed. The component is not intended to be exposed to or used by customers, and therefore expected to be accessible and maintained only by superadmin via the Administration > Support component.
System Setting
A system setting called Async Job Manager maintains the dashboard component. By default, it’s expected to be role action restricted to Superadmin users and setup with a type of ‘Support’. This will ensure the component is only available in Administration > Support, accessible by superadmin.
Features
The component allows users to perform the following tasks:
Verify the name of any configured jobs
Confirm archived status
Confirm associated user
Confirm Poll Interval Seconds
Confirm script MD5
Add a new job
Edit existing job
Adding a new Job
New jobs can be added through the component. All jobs required at minimum a unique name and a data script.
Data Scripts are the underlying logic/code provided by engineering team members to execute the job. The job script is dynamically invoked on configured timed interval.
By default, jobs are setup to run every 60 seconds. They can be configured to run anywhere between 1 and 300 seconds.
Depending on the job purpose, other values may be necessary to configure. Job configurations allow for additional input parameters to be considered or used when the job runs. Additionally, jobs can be setup to associate a ClinSpark user with the job, typically an API user. However, it can be any user necessary to attribute to certain actions in the system. For example, if a job is expected to produce an audit record for a change applied through script logic, the user associated with the automated change would be the user configured for the job.
Job Script MD5
Once saved, each job will have a script value which is represented back to the user as a calculated MD5 value in the summary view. This will allow users at a quick glance to verify if the script contents between jobs.
Edit existing Jobs
Users can modify existing jobs as needed. On edit, users can also optionally choose to Archive a given script. If archived, the script will be removed from use and ignored by the system or any active pollers. Archived jobs will still appear to users in the dashboard list view.
