ISPFSchedulerTask interface - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

This is a generic interface for each scheduled task and holds the task settings (that is, is task to be run and how and when to run).

The following properties are found on this interface.

Name

Description

Set on

SPFSchTskEnabled

Task is enabled.

Code

SPFSchTskFailureMsg

If a task fails an error message is written back to the scheduler. If this property is set the message can be viewed.

Code

SPFSchTskTag

Generic data store

Code

SPFSchTskRetryCount

The number of times the task has retried, if it failed.

Code

SPFSchTskAllowRetry

Number of retry attempts allowed

Code

SPFSchTskStartDate

Task start date

Code

SPFSchTskStatus

The current status of the task.

Code

SPFSchTskNotifyUser

Notify user on completion of task.

Code

SPFSchTskDoNotProcessSubTasksOnFailure

Do not process sub tasks is parent task fails.

Code

SPFSchTskFrequency

The number of times to repeat a task. (If set to -1 the task will repeat indefinitely.)

Code

SPFSchTskInterval

The time interval for recurring tasks set to be processed after a specific number of milliseconds.

Code

SPFSchTskContextUser

The user credentials to use when the task executes. For example, super user admin user, view user.

Code

SPFSchTskRetryLimit

The number of times to retry a task.

Code

SPFSchTskContextRoles

The role to use when the task executes.

Code

SPFSchTskContextQueryConfig

The query configuration to use when the task executes.

Code

SPFSchTskSubmitter

The user who submitted the task.

Code

SPFSchTskContextIncludeHigherConfig

For query configuration, include the higher configurations as well.

Code

SPFSchTskFailOnSubTaskFailure

Parent ask failed due to a sub task failure.

Code

SPFSchTskContextEffectivityDate

The date to use for old data.

Code

SPFSchTskLocked

Set to lock the task when it is being processed.

Code

SPFSchTskContextCreateConfig

The configuration that any items created will go into.

Code

Functionality configured on ISPFSchedulerTask

The following commands are configured on this interface; Delete, Retry Task, Show Task Failure, Terminate and Update.