Class CreateScheduledJobAction

Create Scheduled Job action. Creates a new scheduled job with the specified configuration.

Example

await RunAction({
  ActionName: 'Create Scheduled Job',
  Params: [
    { Name: 'Name', Value: 'Daily Data Sync' },
    { Name: 'JobTypeID', Value: 'F3C4A5B6-...' },
    { Name: 'CronExpression', Value: '0 0 * * *' },
    { Name: 'IsActive', Value: 'true' }
  ]
});

Hierarchy (View Summary)

BaseJobAction
- CreateScheduledJobAction

Index

Constructors

constructor

Methods

addOutputParam buildJobFilter getBooleanParam getDateParam getNumericParam getParamValue InternalRunAction isValidStatus loadJob Run validateCronExpression

Constructors

constructor

new CreateScheduledJobAction(): CreateScheduledJobAction
Returns CreateScheduledJobAction
Inherited from BaseJobAction.constructor

Methods

`Protected`addOutputParam

addOutputParam(params: RunActionParams, name: string, value: unknown): void
Add an output parameter to the result
Parameters
- params: RunActionParams
  The action parameters
- name: string
  Output parameter name
- value: unknown
  Output parameter value
Returns void
Inherited from BaseJobAction.addOutputParam
- Defined in Scheduling/actions/src/BaseJobAction.ts:197

`Protected`buildJobFilter

buildJobFilter(
    filters: {
        createdAfter?: Date;
        createdBefore?: Date;
        isActive?: boolean;
        jobTypeId?: string;
        status?: string;
    },
): string
Build filter expression for job queries
Parameters
- filters: {
      createdAfter?: Date;
      createdBefore?: Date;
      isActive?: boolean;
      jobTypeId?: string;
      status?: string;
  }
  Object containing optional filter criteria
Returns string
SQL WHERE clause string
Inherited from BaseJobAction.buildJobFilter
- Defined in Scheduling/actions/src/BaseJobAction.ts:97

`Protected`getBooleanParam

getBooleanParam(
    params: RunActionParams,
    name: string,
    defaultValue: boolean,
): boolean
Get boolean parameter with default value
Parameters
- params: RunActionParams
  The action parameters
- name: string
  Parameter name to find
- defaultValue: boolean
  Default value if parameter is missing
Returns boolean
The boolean parameter value or default
Inherited from BaseJobAction.getBooleanParam
- Defined in Scheduling/actions/src/BaseJobAction.ts:162

`Protected`getDateParam

getDateParam(params: RunActionParams, name: string): Date
Get date parameter
Parameters
- params: RunActionParams
  The action parameters
- name: string
  Parameter name to find
Returns Date
The date value or undefined
Inherited from BaseJobAction.getDateParam
- Defined in Scheduling/actions/src/BaseJobAction.ts:181

`Protected`getNumericParam

getNumericParam(
    params: RunActionParams,
    name: string,
    defaultValue: number,
): number
Get numeric parameter with default value
Parameters
- params: RunActionParams
  The action parameters
- name: string
  Parameter name to find
- defaultValue: number
  Default value if parameter is missing or invalid
Returns number
The numeric parameter value or default
Inherited from BaseJobAction.getNumericParam
- Defined in Scheduling/actions/src/BaseJobAction.ts:145

`Protected`getParamValue

getParamValue(params: RunActionParams, name: string): string
Get parameter value by name (case-insensitive)
Parameters
- params: RunActionParams
  The action parameters
- name: string
  Parameter name to find
Returns string
The parameter value or undefined
Inherited from BaseJobAction.getParamValue
- Defined in Scheduling/actions/src/BaseJobAction.ts:132

`Protected`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Creates a new scheduled job record
Parameters
- params: RunActionParams
  The action parameters containing:
  
  Name (required): Job name
  
  JobTypeID (required): ID of the job type
  
  CronExpression (required): Cron schedule expression
  
  IsActive (optional): Whether job is active (default: true)
  
  Status (optional): Job status (default: Active)
  
  IntervalMinutes (optional): Polling interval in minutes
  
  IntervalDays (optional): Polling interval in days
  
  Description (optional): Job description
Returns Promise<ActionResultSimple>
ActionResultSimple with:
- Success: true if job was created successfully
- ResultCode: SUCCESS, VALIDATION_ERROR, or FAILED
- Params: Output parameter 'JobID' contains the ID of the created job
Overrides BaseJobAction.InternalRunAction
- Defined in Scheduling/actions/src/CreateJobAction.ts:45

`Protected`isValidStatus

isValidStatus(status: string): boolean
Validate job status value
Parameters
- status: string
  The status value to validate
Returns boolean
True if the status is valid
Inherited from BaseJobAction.isValidStatus
- Defined in Scheduling/actions/src/BaseJobAction.ts:86

`Protected`loadJob

loadJob(
    jobId: string,
    contextUser: UserInfo,
    provider?: IMetadataProvider,
): Promise<{ error?: ActionResultSimple; job?: MJScheduledJobEntity }>
Load a scheduled job entity by ID with error handling
Parameters
- jobId: string
  The ID of the job to load
- contextUser: UserInfo
  The user context for the operation
- Optionalprovider: IMetadataProvider
Returns Promise<{ error?: ActionResultSimple; job?: MJScheduledJobEntity }>
Object with either the loaded job or an error result
Inherited from BaseJobAction.loadJob
- Defined in Scheduling/actions/src/BaseJobAction.ts:47

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseJobAction.Run
- Defined in Actions/Engine/dist/generic/BaseAction.d.ts:37

`Protected`validateCronExpression

validateCronExpression(
cronExpression: string,
): { error?: string; valid: boolean }
Validate cron expression format
Parameters
- cronExpression: string
  The cron expression to validate
Returns { error?: string; valid: boolean }
Object with valid flag and optional error message
Inherited from BaseJobAction.validateCronExpression
- Defined in Scheduling/actions/src/BaseJobAction.ts:21

Class CreateScheduledJobAction

Example

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns CreateScheduledJobAction

Methods

ProtectedaddOutputParam

Parameters

Returns void

ProtectedbuildJobFilter

Parameters

Returns string

ProtectedgetBooleanParam

Parameters

Returns boolean

ProtectedgetDateParam

Parameters

Returns Date

ProtectedgetNumericParam

Parameters

Returns number

ProtectedgetParamValue

Parameters

Returns string

ProtectedInternalRunAction

Parameters

Returns Promise<ActionResultSimple>

ProtectedisValidStatus

Parameters

Returns boolean

ProtectedloadJob

Parameters

Returns Promise<{ error?: ActionResultSimple; job?: MJScheduledJobEntity }>

Run

Parameters

Returns Promise<ActionResultSimple>

ProtectedvalidateCronExpression

Parameters

Returns { error?: string; valid: boolean }

Settings

On This Page

`Protected`addOutputParam

`Protected`buildJobFilter

`Protected`getBooleanParam

`Protected`getDateParam

`Protected`getNumericParam

`Protected`getParamValue

`Protected`InternalRunAction

`Protected`isValidStatus

`Protected`loadJob

`Protected`validateCronExpression