Class ScheduleTableInfo
Table 'schedule': Generic scheduled tasked handling time scheduling, locking and error messages
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
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
Fields
DictionaryTableName
Conceptual name of table Schedule in the database dictionary: schedule
Declaration
public const string DictionaryTableName = "schedule"
Field Value
Type | Description |
---|---|
String |
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
Properties
AfterScheduleId
Field 'after_schedule_id' in table 'schedule': Dictionary type FK, target: Schedule, .NET type: Int32
Run after another schedule have completedDeclaration
public Int32FieldInfo AfterScheduleId { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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
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 |
---|---|
TargetedInnerJoin<ScheduleTableInfo> |
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
Asap
Field 'asap' in table 'schedule': Dictionary type Bool, .NET type: Int16
Run schedule ASAPDeclaration
public UInt16FieldInfo Asap { get; }
Property Value
Type | Description |
---|---|
UInt16FieldInfo |
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
DayOfMonth
Field 'day_of_month' in table 'schedule': Dictionary type Int, .NET type: Int32
What day of month to runDeclaration
public Int32FieldInfo DayOfMonth { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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
Definition
Definition of the table as described in the deployed runtime dictionary
Declaration
public override SoTable Definition { get; }
Property Value
Type | Description |
---|---|
SoTable |
Overrides
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
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 |
---|---|
Int32 |
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
Disabled
Field 'disabled' in table 'schedule': Dictionary type Bool, .NET type: Int16
Disable the scheduleDeclaration
public UInt16FieldInfo Disabled { get; }
Property Value
Type | Description |
---|---|
UInt16FieldInfo |
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
Domain
Field 'domain' in table 'schedule': Dictionary type Enum, .NET type: Int16
Type of scheduled taskDeclaration
public UInt16FieldInfo Domain { get; }
Property Value
Type | Description |
---|---|
UInt16FieldInfo |
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
ErrorMessage
Field 'error_message' in table 'schedule': Dictionary type Clob, .NET type: String
Last error messageDeclaration
public StringFieldInfo ErrorMessage { get; }
Property Value
Type | Description |
---|---|
StringFieldInfo |
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
ExecutionTime
Field 'execution_time' in table 'schedule': Dictionary type Int, .NET type: Int32
Amount of time in seconds used by last executionDeclaration
public Int32FieldInfo ExecutionTime { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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
Frequency
Field 'frequency' in table 'schedule': Dictionary type Enum, .NET type: Int16
Type of schedule algorithm to useDeclaration
public UInt16FieldInfo Frequency { get; }
Property Value
Type | Description |
---|---|
UInt16FieldInfo |
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
LastError
Field 'last_error' in table 'schedule': Dictionary type DateTime, .NET type: DateTime
Time of last errorDeclaration
public DateTimeFieldInfo LastError { get; }
Property Value
Type | Description |
---|---|
DateTimeFieldInfo |
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
LastExecution
Field 'last_execution' in table 'schedule': Dictionary type DateTime, .NET type: DateTime
Last executionDeclaration
public DateTimeFieldInfo LastExecution { get; }
Property Value
Type | Description |
---|---|
DateTimeFieldInfo |
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
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 |
---|---|
TargetedLeftOuterJoin<DbiAgentScheduleTableInfo> |
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
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 |
---|---|
TargetedLeftOuterJoin<ScheduledTaskTableInfo> |
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
LockExpire
Field 'lock_expire' in table 'schedule': Dictionary type DateTime, .NET type: DateTime
Lock preventing the same schedule to run simultaniouslyDeclaration
public DateTimeFieldInfo LockExpire { get; }
Property Value
Type | Description |
---|---|
DateTimeFieldInfo |
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
LockPid
Field 'lock_pid' in table 'schedule': Dictionary type Int, .NET type: Int32
PID preventing the same schedule to run simultaniouslyDeclaration
public Int32FieldInfo LockPid { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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
LockTtl
Field 'lock_ttl' in table 'schedule': Dictionary type Int, .NET type: Int32
Lock time to liveDeclaration
public Int32FieldInfo LockTtl { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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
MinOfHour
Field 'min_of_hour' in table 'schedule': Dictionary type Int, .NET type: Int32
Run at a given minute in an hourDeclaration
public Int32FieldInfo MinOfHour { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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
MinuteInterval
Field 'minute_interval' in table 'schedule': Dictionary type Int, .NET type: Int32
Interval in minutes, used by MinutelyDeclaration
public Int32FieldInfo MinuteInterval { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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
Months
Field 'months' in table 'schedule': Dictionary type Int, .NET type: Int32
Bitfield: which months of the year to runDeclaration
public Int32FieldInfo Months { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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
Name
Field 'name' in table 'schedule': Dictionary type String[256], .NET type: String
Name of the scheduleDeclaration
public StringFieldInfo Name { get; }
Property Value
Type | Description |
---|---|
StringFieldInfo |
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
NextExecution
Field 'next_execution' in table 'schedule': Dictionary type DateTime, .NET type: DateTime
Next executionDeclaration
public DateTimeFieldInfo NextExecution { get; }
Property Value
Type | Description |
---|---|
DateTimeFieldInfo |
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
OnceAt
Field 'once_at' in table 'schedule': Dictionary type DateTime, .NET type: DateTime
Execute once atDeclaration
public DateTimeFieldInfo OnceAt { get; }
Property Value
Type | Description |
---|---|
DateTimeFieldInfo |
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
Retries
Field 'retries' in table 'schedule': Dictionary type Int, .NET type: Int32
Number of retries since last successfull executionDeclaration
public Int32FieldInfo Retries { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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
RetryInterval
Field 'retry_interval' in table 'schedule': Dictionary type Int, .NET type: Int32
Number of minutes between each retryDeclaration
public Int32FieldInfo RetryInterval { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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
RuntimeDefinition
Definition of the table as described in the deployed runtime dictionary
Declaration
public static SoTable RuntimeDefinition { get; }
Property Value
Type | Description |
---|---|
SoTable |
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
ScheduleId
Field 'id' in table 'schedule': Dictionary type PK, .NET type: Int32
Primary keyDeclaration
public Int32FieldInfo ScheduleId { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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
Status
Field 'status' in table 'schedule': Dictionary type Enum, .NET type: Int16
Schedules current statusDeclaration
public UInt16FieldInfo Status { get; }
Property Value
Type | Description |
---|---|
UInt16FieldInfo |
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
Stop
Field 'stop' in table 'schedule': Dictionary type Bool, .NET type: Int16
Signal to stop scheduleDeclaration
public UInt16FieldInfo Stop { get; }
Property Value
Type | Description |
---|---|
UInt16FieldInfo |
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
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 |
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
Weekdays
Field 'weekdays' in table 'schedule': Dictionary type Int, .NET type: Int32
Bitfield: which days of the week to runDeclaration
public Int32FieldInfo Weekdays { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
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