Class BatchTaskTableInfo

Table 'BatchTask': Batch task request details, corresponding to the message body of a batch request message

Inheritance
object
TableInfo
BatchTaskTableInfo
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("BatchTask")]
public class BatchTaskTableInfo : 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.GetBatchTaskInfo().

Fields

DictionaryTableName

Conceptual name of table BatchTask in the database dictionary: BatchTask

Declaration
public const string DictionaryTableName = "BatchTask"
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.GetBatchTaskInfo().

Properties

BatchTaskDefinitionId

Field 'BatchTaskDefinition_id' in table 'BatchTask': Dictionary type FK, target: BatchTaskDefinition, .NET type: int

Batch task definition, which is populated from code attributes
Declaration
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.GetBatchTaskInfo().

BatchTaskDefinitionId_InnerJoin_BatchTaskDefinition

Generated join from the foreign key BatchTaskDefinitionId in this table, to its target table BatchTaskDefinitionTableInfo.

Declaration
public TargetedInnerJoin<BatchTaskDefinitionTableInfo> BatchTaskDefinitionId_InnerJoin_BatchTaskDefinition { get; }
Property Value
Type Description
TargetedInnerJoin<BatchTaskDefinitionTableInfo>
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.GetBatchTaskInfo().

BatchTaskId

Field 'BatchTask_id' in table 'BatchTask': Dictionary type PK, .NET type: int

Primary key
Declaration
public Int32FieldInfo BatchTaskId { 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.GetBatchTaskInfo().

DbTag

Field 'dbTag' in table 'BatchTask': Dictionary type String[40], .NET type: string

Database tag that this task applies to, to ensure tasks are execute on the correct database only
Declaration
public StringFieldInfo DbTag { 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.GetBatchTaskInfo().

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.GetBatchTaskInfo().

Description

Field 'description' in table 'BatchTask': 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.GetBatchTaskInfo().

DetailsRecord

Field 'detailsRecord' in table 'BatchTask': Dictionary type RecordId, .NET type: int

Optional record containing further details that will not fit in the standard request/response fields
Declaration
public Int32FieldInfo DetailsRecord { 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.GetBatchTaskInfo().

DetailsTable

Field 'detailsTable' in table 'BatchTask': Dictionary type TableNumber, .NET type: short

Optional table containing further details that will not fit in the standard request/response fields
Declaration
public UInt16FieldInfo DetailsTable { 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.GetBatchTaskInfo().

DictionaryTableNumber

Table number for table BatchTask 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.GetBatchTaskInfo().

FileName

Field 'FileName' in table 'BatchTask': Dictionary type String[261], .NET type: string

The filename related to the batchtask.
Declaration
public StringFieldInfo FileName { 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.GetBatchTaskInfo().

LastStarted

Field 'lastStarted' in table 'BatchTask': Dictionary type DateTime, .NET type: DateTime

When was this job last started
Declaration
public DateTimeFieldInfo LastStarted { 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.GetBatchTaskInfo().

ProgressDescription

Field 'progressDescription' in table 'BatchTask': Dictionary type String[255], .NET type: string

Descriptive text for the current stage
Declaration
public StringFieldInfo ProgressDescription { 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.GetBatchTaskInfo().

ProgressPercent

Field 'progressPercent' in table 'BatchTask': Dictionary type UShort, .NET type: short

Task progress, in percent of estimated total
Declaration
public UInt16FieldInfo ProgressPercent { 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.GetBatchTaskInfo().

Registered

Field 'registered' in table 'BatchTask': Dictionary type UtcDateTime, .NET type: DateTime

Registered when
Declaration
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.GetBatchTaskInfo().

RegisteredAssociateId

Field 'registered_associate_id' in table 'BatchTask': Dictionary type FK, target: Associate, .NET type: int

Registered by whom
Declaration
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.GetBatchTaskInfo().

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.GetBatchTaskInfo().

Request

Field 'request' in table 'BatchTask': Dictionary type String[255], .NET type: string

The batch request, specifying what to do
Declaration
public StringFieldInfo Request { 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.GetBatchTaskInfo().

Response

Field 'response' in table 'BatchTask': Dictionary type String[255], .NET type: string

The response from the batch task processor
Declaration
public StringFieldInfo Response { 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.GetBatchTaskInfo().

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.GetBatchTaskInfo().

StartCount

Field 'startCount' in table 'BatchTask': Dictionary type Id, .NET type: int

Number of times this batch task has been started (0 for tasks that have never been executed)
Declaration
public Int32FieldInfo StartCount { 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.GetBatchTaskInfo().

State

Field 'state' in table 'BatchTask': Dictionary type Int, .NET type: int

0=Unknown; 1=New; 2=Assigned; 3=Started; 4=Succeeded; 5=Failed
Declaration
public Int32FieldInfo State { 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.GetBatchTaskInfo().

Updated

Field 'updated' in table 'BatchTask': Dictionary type UtcDateTime, .NET type: DateTime

'heartbeat' that is updated once a minute by the batch task process
Declaration
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.GetBatchTaskInfo().

UpdatedAssociateId

Field 'updated_associate_id' in table 'BatchTask': Dictionary type FK, target: Associate, .NET type: int

'heartbeat' that is updated once a minute by the batch task process
Declaration
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.GetBatchTaskInfo().

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.GetBatchTaskInfo().

UpdatedCount

Field 'updatedCount' in table 'BatchTask': Dictionary type UShort, .NET type: short

'heartbeat' that is updated once a minute by the batch task process
Declaration
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.GetBatchTaskInfo().

Methods

IdxBatchTaskDefinitionId(int)

Shortcut method for looking up using the database index BatchTaskDefinitionId, which spans the following fields:

FieldDescription
BatchTaskDefinitionIdBatch task definition, which is populated from code attributes
Declaration
public Restriction IdxBatchTaskDefinitionId(int batchTaskDefinitionId)
Parameters
Type Name Description
int batchTaskDefinitionId
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.GetBatchTaskInfo().

Implements

Extension Methods