Show / Hide Table of Contents

Class BatchTaskTableInfo

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

Inheritance
Object
TableInfo
BatchTaskTableInfo
Implements
ICloneable
Inherited Members
TableInfo.ToString()
TableInfo.RegisterFields(FieldInfo[])
TableInfo.FieldInfoFromSoField(SoField)
TableInfo.Clone()
TableInfo.IsSameTable(TableInfo)
TableInfo.FindField(String)
TableInfo.ProtAll
TableInfo.HashCheckFields
TableInfo.TableName
TableInfo.DbName
TableInfo.IsDictionaryTable
TableInfo.All
TableInfo.Item[String]
TableInfo.PrimaryKeyField
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
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 .

Fields

DictionaryTableName

Conceptual name of table BatchTask in the database dictionary: BatchTask

Declaration
public const string DictionaryTableName = "BatchTask"
Field Value
Type Description
String

Properties

BatchTaskDefinitionId

Field 'BatchTaskDefinition_id' in table 'BatchTask': Dictionary type FK, .NET type: Int32

Batch task definition, which is populated from code attributes

Declaration
public Int32FieldInfo BatchTaskDefinitionId { get; }
Property Value
Type Description
Int32FieldInfo

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>

BatchTaskId

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

Primary key

Declaration
public Int32FieldInfo BatchTaskId { get; }
Property Value
Type Description
Int32FieldInfo

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

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration
public override SoTable Definition { get; }
Property Value
Type Description
SoTable
Overrides
TableInfo.Definition

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

DetailsRecord

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

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

DetailsTable

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

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

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
Int32

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

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

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

ProgressPercent

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

Task progress, in percent of estimated total

Declaration
public UInt16FieldInfo ProgressPercent { get; }
Property Value
Type Description
UInt16FieldInfo

Registered

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

Registered when

Declaration
public DateTimeFieldInfo Registered { get; }
Property Value
Type Description
DateTimeFieldInfo

RegisteredAssociateId

Field 'registered_associate_id' in table 'BatchTask': Dictionary type FK, .NET type: Int32

Registered by whom

Declaration
public Int32FieldInfo RegisteredAssociateId { get; }
Property Value
Type Description
Int32FieldInfo

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>

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

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

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

StartCount

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

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

State

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

0=Unknown; 1=New; 2=Assigned; 3=Started; 4=Succeeded; 5=Failed

Declaration
public Int32FieldInfo State { get; }
Property Value
Type Description
Int32FieldInfo

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

UpdatedAssociateId

Field 'updated_associate_id' in table 'BatchTask': Dictionary type FK, .NET type: Int32

'heartbeat' that is updated once a minute by the batch task process

Declaration
public Int32FieldInfo UpdatedAssociateId { get; }
Property Value
Type Description
Int32FieldInfo

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>

UpdatedCount

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

'heartbeat' that is updated once a minute by the batch task process

Declaration
public UInt16FieldInfo UpdatedCount { get; }
Property Value
Type Description
UInt16FieldInfo

Methods

IdxBatchTaskDefinitionId(Int32)

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
Int32 batchTaskDefinitionId
Returns
Type Description
Restriction

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top