Class BatchTaskRecordData

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the BatchTask table.

Inheritance
object
BatchTaskRecordData
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class BatchTaskRecordData
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Constructors

BatchTaskRecordData()

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the BatchTask table.

Declaration
public BatchTaskRecordData()
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Fields

BatchTaskDefinitionId

Batch task definition, which is populated from code attributes

Declaration
public int BatchTaskDefinitionId
Field Value
Type Description
int
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

BatchTaskId

Primary key

Declaration
public int BatchTaskId
Field Value
Type Description
int
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

DbTag

Database tag that this task applies to, to ensure tasks are execute on the correct database only

Declaration
public string DbTag
Field Value
Type Description
string
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Description

Description of task (for monitoring and debugging)

Declaration
public string Description
Field Value
Type Description
string
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

DetailsRecord

Optional record containing further details that will not fit in the standard request/response fields

Declaration
public int DetailsRecord
Field Value
Type Description
int
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

DetailsTable

Optional table containing further details that will not fit in the standard request/response fields

Declaration
public short DetailsTable
Field Value
Type Description
short
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FileName

The filename related to the batchtask.

Declaration
public string FileName
Field Value
Type Description
string
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

LastStarted

When was this job last started

Declaration
public DateTime LastStarted
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ProgressDescription

Descriptive text for the current stage

Declaration
public string ProgressDescription
Field Value
Type Description
string
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ProgressPercent

Task progress, in percent of estimated total

Declaration
public short ProgressPercent
Field Value
Type Description
short
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Registered

Registered when in UTC.

Declaration
public DateTime Registered
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegisteredAssociateId

Registered by whom

Declaration
public int RegisteredAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Request

The batch request, specifying what to do

Declaration
public string Request
Field Value
Type Description
string
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Response

The response from the batch task processor

Declaration
public string Response
Field Value
Type Description
string
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

StartCount

Number of times this batch task has been started (0 for tasks that have never been executed)

Declaration
public int StartCount
Field Value
Type Description
int
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

State

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

Declaration
public int State
Field Value
Type Description
int
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Updated

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

Declaration
public DateTime Updated
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedAssociateId

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

Declaration
public int UpdatedAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedCount

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

Declaration
public short UpdatedCount
Field Value
Type Description
short
Remarks

Please use this class instead of a full BatchTaskRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding BatchTaskTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Extension Methods