Job Management Service

IJobManagerService in assembly SanteDB.Core.Api version 3.0.1980.0

Summary

Job Management Service

Description

In SanteDB, developers can create IJobarrow-up-right implementations which represent background jobs for the system. Uses of these classes involve:

  • Performing routine maintenance tasks like compression, backup, etc.

  • Performing indexing tasks or managing long-running tasks

  • Exposing packaged batch operations to users (who can run them manually from the UI)

The job manager is the service which manages the master list of IJobarrow-up-right instances and allows other plugins to register new jobs, start jobs, and even schedule job execution based on a schedule or interval.

Properties

Property
Type
Access
Description

Jobs

IEnumerable<IJob>

R

Gets the status of all jobs

Operations

Operation
Response/Return
Input/Parameter
Description

AddJob

void

IJob jobType TimeSpan elapseTime JobStartType startType

Add a job to the job manager

RegisterJob

IJob

Type jobType

Adds a job by type to the job manager

AddJob

void

IJob jobType JobStartType startType

Add a job to the job manager

IsJobRegistered

Boolean

Type jobType

Returns true if the job is registered

StartJob

void

IJob job Object[] parameters

Starts the specified

StartJob

void

Type jobType Object[] parameters

Starts the specified

GetJobInstance

IJob

Guid jobKey

Get this manager's instance of a job

GetJobInstance

IJob

Type jobType

Get this manager's instance of a job

GetJobSchedules

IEnumerable<IJobSchedule>

IJob job

Get the schedule for the specified job

SetJobSchedule

IJobSchedule

IJob job DayOfWeek[] daysOfWeek DateTime scheduleTime

Schedule a job to start at a specific time with a specific repetition

SetJobSchedule

IJobSchedule

IJob job TimeSpan intervalSpan

Schedule a job to start at a specific time with a specific repetition

ClearJobSchedule

void

IJob job

Clear the schedule of a job.

GetAvailableJobs

IEnumerable<Type>

none

TODO

Implementations

UpstreamJobManager - (SanteDB.Client)

Represents a IJobManagerServicearrow-up-right which operates only on the upstream jobs service

Service Registration

Default Job Manager - (SanteDB.Core.Api)

SanteDB's default implementation of the IJobManagerServicearrow-up-right

Description

Service Registration

Example Implementation

References

Last updated

Was this helpful?