Class ScheduleTableInfo
Table 'schedule': Generic scheduled tasked handling time scheduling, locking and error messages
Implements
Inherited Members
Namespace: SuperOfficeCRMData
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("schedule")]
public class ScheduleTableInfo : TableInfo, ICloneable
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetScheduleInfo().
Fields
DictionaryTableName
Conceptual name of table Schedule in the database dictionary: schedule
Declaration
public const string DictionaryTableName = "schedule"
Field Value
| Type | Description |
|---|---|
| string |
Properties
AfterScheduleId
Field 'after_schedule_id' in table 'schedule': Dictionary type FK, target: Schedule, .NET type: int
Run after another schedule have completed
Declaration
public Int32FieldInfo AfterScheduleId { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |
AfterScheduleId_InnerJoin_Schedule
Generated join from the foreign key AfterScheduleId in this table, to its target table ScheduleTableInfo.
Declaration
public TargetedInnerJoin<ScheduleTableInfo> AfterScheduleId_InnerJoin_Schedule { get; }
Property Value
| Type | Description |
|---|---|
| TargetedInnerJoinScheduleTableInfo |
Asap
Field 'asap' in table 'schedule': Dictionary type Bool, .NET type: short
Run schedule ASAP
Declaration
public UInt16FieldInfo Asap { get; }
Property Value
| Type | Description |
|---|---|
| UInt16FieldInfo |
DayOfMonth
Field 'day_of_month' in table 'schedule': Dictionary type Int, .NET type: int
What day of month to run
Declaration
public Int32FieldInfo DayOfMonth { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |
Definition
Definition of the table as described in the deployed runtime dictionary
Declaration
public override SoTable Definition { get; }
Property Value
| Type | Description |
|---|---|
| SoTable |
Overrides
DictionaryTableNumber
Table number for table Schedule in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database
Declaration
public int DictionaryTableNumber { get; }
Property Value
| Type | Description |
|---|---|
| int |
Disabled
Field 'disabled' in table 'schedule': Dictionary type Bool, .NET type: short
Disable the schedule
Declaration
public UInt16FieldInfo Disabled { get; }
Property Value
| Type | Description |
|---|---|
| UInt16FieldInfo |
Domain
Field 'domain' in table 'schedule': Dictionary type Enum, .NET type: short
Type of scheduled task
Declaration
public UInt16FieldInfo Domain { get; }
Property Value
| Type | Description |
|---|---|
| UInt16FieldInfo |
ErrorMessage
Field 'error_message' in table 'schedule': Dictionary type Clob, .NET type: string
Last error message
Declaration
public StringFieldInfo ErrorMessage { get; }
Property Value
| Type | Description |
|---|---|
| StringFieldInfo |
ExecutionTime
Field 'execution_time' in table 'schedule': Dictionary type Int, .NET type: int
Amount of time in seconds used by last execution
Declaration
public Int32FieldInfo ExecutionTime { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |
Frequency
Field 'frequency' in table 'schedule': Dictionary type Enum, .NET type: short
Type of schedule algorithm to use
Declaration
public UInt16FieldInfo Frequency { get; }
Property Value
| Type | Description |
|---|---|
| UInt16FieldInfo |
LastError
Field 'last_error' in table 'schedule': Dictionary type DateTime, .NET type: DateTime
Time of last error
Declaration
public DateTimeFieldInfo LastError { get; }
Property Value
| Type | Description |
|---|---|
| DateTimeFieldInfo |
LastExecution
Field 'last_execution' in table 'schedule': Dictionary type DateTime, .NET type: DateTime
Last execution
Declaration
public DateTimeFieldInfo LastExecution { get; }
Property Value
| Type | Description |
|---|---|
| DateTimeFieldInfo |
LeftOuterJoin_DbiAgentSchedule_ScheduleId
Generated left outer join from the primary key ScheduleId on this table, to DbiAgentSchedule.ScheduleId.
Declaration
public TargetedLeftOuterJoin<DbiAgentScheduleTableInfo> LeftOuterJoin_DbiAgentSchedule_ScheduleId { get; }
Property Value
| Type | Description |
|---|---|
| TargetedLeftOuterJoinDbiAgentScheduleTableInfo |
LeftOuterJoin_ScheduledTask_ScheduleId
Generated left outer join from the primary key ScheduleId on this table, to ScheduledTask.ScheduleId.
Declaration
public TargetedLeftOuterJoin<ScheduledTaskTableInfo> LeftOuterJoin_ScheduledTask_ScheduleId { get; }
Property Value
| Type | Description |
|---|---|
| TargetedLeftOuterJoinScheduledTaskTableInfo |
LockExpire
Field 'lock_expire' in table 'schedule': Dictionary type DateTime, .NET type: DateTime
Lock preventing the same schedule to run simultaniously
Declaration
public DateTimeFieldInfo LockExpire { get; }
Property Value
| Type | Description |
|---|---|
| DateTimeFieldInfo |
LockPid
Field 'lock_pid' in table 'schedule': Dictionary type Int, .NET type: int
PID preventing the same schedule to run simultaniously
Declaration
public Int32FieldInfo LockPid { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |
LockTtl
Field 'lock_ttl' in table 'schedule': Dictionary type Int, .NET type: int
Lock time to live
Declaration
public Int32FieldInfo LockTtl { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |
MinOfHour
Field 'min_of_hour' in table 'schedule': Dictionary type Int, .NET type: int
Run at a given minute in an hour
Declaration
public Int32FieldInfo MinOfHour { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |
MinuteInterval
Field 'minute_interval' in table 'schedule': Dictionary type Int, .NET type: int
Interval in minutes, used by Minutely
Declaration
public Int32FieldInfo MinuteInterval { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |
Months
Field 'months' in table 'schedule': Dictionary type Int, .NET type: int
Bitfield: which months of the year to run
Declaration
public Int32FieldInfo Months { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |
Name
Field 'name' in table 'schedule': Dictionary type String[256], .NET type: string
Name of the schedule
Declaration
public StringFieldInfo Name { get; }
Property Value
| Type | Description |
|---|---|
| StringFieldInfo |
NextExecution
Field 'next_execution' in table 'schedule': Dictionary type DateTime, .NET type: DateTime
Next execution
Declaration
public DateTimeFieldInfo NextExecution { get; }
Property Value
| Type | Description |
|---|---|
| DateTimeFieldInfo |
OnceAt
Field 'once_at' in table 'schedule': Dictionary type DateTime, .NET type: DateTime
Execute once at
Declaration
public DateTimeFieldInfo OnceAt { get; }
Property Value
| Type | Description |
|---|---|
| DateTimeFieldInfo |
Retries
Field 'retries' in table 'schedule': Dictionary type Int, .NET type: int
Number of retries since last successfull execution
Declaration
public Int32FieldInfo Retries { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |
RetryInterval
Field 'retry_interval' in table 'schedule': Dictionary type Int, .NET type: int
Number of minutes between each retry
Declaration
public Int32FieldInfo RetryInterval { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |
RuntimeDefinition
Definition of the table as described in the deployed runtime dictionary
Declaration
[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }
Property Value
| Type | Description |
|---|---|
| SoTable |
ScheduleId
Field 'id' in table 'schedule': Dictionary type PK, .NET type: int
Primary key
Declaration
public Int32FieldInfo ScheduleId { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |
Status
Field 'status' in table 'schedule': Dictionary type Enum, .NET type: short
Schedules current status
Declaration
public UInt16FieldInfo Status { get; }
Property Value
| Type | Description |
|---|---|
| UInt16FieldInfo |
Stop
Field 'stop' in table 'schedule': Dictionary type Bool, .NET type: short
Signal to stop schedule
Declaration
public UInt16FieldInfo Stop { get; }
Property Value
| Type | Description |
|---|---|
| UInt16FieldInfo |
TimeOfDay
Field 'time_of_day' in table 'schedule': Dictionary type DateTime, .NET type: DateTime
Time of day to execute if not specified.
Declaration
public DateTimeFieldInfo TimeOfDay { get; }
Property Value
| Type | Description |
|---|---|
| DateTimeFieldInfo |
Weekdays
Field 'weekdays' in table 'schedule': Dictionary type Int, .NET type: int
Bitfield: which days of the week to run
Declaration
public Int32FieldInfo Weekdays { get; }
Property Value
| Type | Description |
|---|---|
| Int32FieldInfo |