Class BatchTaskDefinitionTableInfo
Table 'BatchTaskDefinition': Batch task definitiopns, populated from the SuperOffice.CRM.BatchProcessing.BatchTask attribute
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("BatchTaskDefinition")]
public class BatchTaskDefinitionTableInfo : 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.GetBatchTaskDefinitionInfo().
Fields
DictionaryTableName
Conceptual name of table BatchTaskDefinition in the database dictionary: BatchTaskDefinition
Declaration
public const string DictionaryTableName = "BatchTaskDefinition"
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 TablesInfo.GetBatchTaskDefinitionInfo().
Properties
AssemblyVersion
Field 'assemblyVersion' in table 'BatchTaskDefinition': Dictionary type String[50], .NET type: string
Version of the assembly that contains the code this batch task definition was populated fromDeclaration
public StringFieldInfo AssemblyVersion { 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 TablesInfo.GetBatchTaskDefinitionInfo().
AutoRestartCount
Field 'autoRestartCount' in table 'BatchTaskDefinition': Dictionary type Int, .NET type: int
Number of times the whole batch task should be restarted; -1 means infinite, which is useful for things like Travel Gateway that should 'always' be availableDeclaration
public Int32FieldInfo AutoRestartCount { 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 TablesInfo.GetBatchTaskDefinitionInfo().
BatchTaskDefinitionId
Field 'BatchTaskDefinition_id' in table 'BatchTaskDefinition': Dictionary type PK, .NET type: int
Primary keyDeclaration
public Int32FieldInfo BatchTaskDefinitionId { 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 TablesInfo.GetBatchTaskDefinitionInfo().
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 TablesInfo.GetBatchTaskDefinitionInfo().
Description
Field 'description' in table 'BatchTaskDefinition': Dictionary type String[255], .NET type: string
Description of task (for monitoring and debugging)Declaration
public StringFieldInfo Description { 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 TablesInfo.GetBatchTaskDefinitionInfo().
DictionaryTableNumber
Table number for table BatchTaskDefinition 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 |
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.GetBatchTaskDefinitionInfo().
IsMultiPass
Field 'isMultiPass' in table 'BatchTaskDefinition': Dictionary type Bool, .NET type: short
Is this a multipass job (inner implementationis run repeatedly by the batch task framework)Declaration
public UInt16FieldInfo IsMultiPass { 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 TablesInfo.GetBatchTaskDefinitionInfo().
LeftOuterJoin_BatchTask_BatchTaskDefinitionId
Generated left outer join from the primary key BatchTaskDefinitionId on this table, to BatchTask.BatchTaskDefinitionId.
Declaration
public TargetedLeftOuterJoin<BatchTaskTableInfo> LeftOuterJoin_BatchTask_BatchTaskDefinitionId { get; }
Property Value
Type | Description |
---|---|
TargetedLeftOuterJoin<BatchTaskTableInfo> |
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.GetBatchTaskDefinitionInfo().
MinimumSleepTime
Field 'minimumSleepTime' in table 'BatchTaskDefinition': Dictionary type Int, .NET type: int
Minimum sleep interval between the end of one run and start of the next oneDeclaration
public Int32FieldInfo MinimumSleepTime { 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 TablesInfo.GetBatchTaskDefinitionInfo().
Name
Field 'name' in table 'BatchTaskDefinition': Dictionary type String[255], .NET type: string
Name of task (for monitoring and debugging)Declaration
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 TablesInfo.GetBatchTaskDefinitionInfo().
Registered
Field 'registered' in table 'BatchTaskDefinition': Dictionary type UtcDateTime, .NET type: DateTime
Registered whenDeclaration
public DateTimeFieldInfo Registered { 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 TablesInfo.GetBatchTaskDefinitionInfo().
RegisteredAssociateId
Field 'registered_associate_id' in table 'BatchTaskDefinition': Dictionary type FK, target: Associate, .NET type: int
Registered by whomDeclaration
public Int32FieldInfo RegisteredAssociateId { 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 TablesInfo.GetBatchTaskDefinitionInfo().
RegisteredAssociateId_InnerJoin_Associate
Generated join from the foreign key RegisteredAssociateId in this table, to its target table AssociateTableInfo.
Declaration
public TargetedInnerJoin<AssociateTableInfo> RegisteredAssociateId_InnerJoin_Associate { get; }
Property Value
Type | Description |
---|---|
TargetedInnerJoin<AssociateTableInfo> |
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.GetBatchTaskDefinitionInfo().
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 |
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.GetBatchTaskDefinitionInfo().
StartInterval
Field 'startInterval' in table 'BatchTaskDefinition': Dictionary type Int, .NET type: int
Minimum interval between successive starts; starts never overlapDeclaration
public Int32FieldInfo StartInterval { 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 TablesInfo.GetBatchTaskDefinitionInfo().
Timeout
Field 'timeout' in table 'BatchTaskDefinition': Dictionary type Int, .NET type: int
Maximum allowed execution time; jobs are killed if they exceed their timeout; 0=no timeoutDeclaration
public Int32FieldInfo Timeout { 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 TablesInfo.GetBatchTaskDefinitionInfo().
Updated
Field 'updated' in table 'BatchTaskDefinition': Dictionary type UtcDateTime, .NET type: DateTime
'heartbeat' that is updated once a minute by the batch task processDeclaration
public DateTimeFieldInfo Updated { 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 TablesInfo.GetBatchTaskDefinitionInfo().
UpdatedAssociateId
Field 'updated_associate_id' in table 'BatchTaskDefinition': Dictionary type FK, target: Associate, .NET type: int
'heartbeat' that is updated once a minute by the batch task processDeclaration
public Int32FieldInfo UpdatedAssociateId { 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 TablesInfo.GetBatchTaskDefinitionInfo().
UpdatedAssociateId_InnerJoin_Associate
Generated join from the foreign key UpdatedAssociateId in this table, to its target table AssociateTableInfo.
Declaration
public TargetedInnerJoin<AssociateTableInfo> UpdatedAssociateId_InnerJoin_Associate { get; }
Property Value
Type | Description |
---|---|
TargetedInnerJoin<AssociateTableInfo> |
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.GetBatchTaskDefinitionInfo().
UpdatedCount
Field 'updatedCount' in table 'BatchTaskDefinition': Dictionary type UShort, .NET type: short
heartbeat' that is updated once a minute by the batch task processDeclaration
public UInt16FieldInfo UpdatedCount { 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 TablesInfo.GetBatchTaskDefinitionInfo().
Methods
IdxName(string)
Shortcut method for looking up using the database index Name, which spans the following fields:
Field | Description |
---|---|
Name | Name of task (for monitoring and debugging) |
Declaration
public Restriction IdxName(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name |
Returns
Type | Description |
---|---|
Restriction |
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.GetBatchTaskDefinitionInfo().