Class SShipmentTableInfo

Table 's_shipment': Contains info about one shipment. The addresses are stored in s_shipment_addr

Inheritance

object

TableInfo

SShipmentTableInfo

Implements

ICloneable

Inherited Members

TableInfo.ToString()

TableInfo.RegisterFields(params 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.this[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("s_shipment")]
public class SShipmentTableInfo : 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.GetSShipmentInfo().

Fields

DictionaryTableName

Conceptual name of table SShipment in the database dictionary: s_shipment

Declaration

public const string DictionaryTableName = "s_shipment"

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

Properties

ActivePane

Field 'active_pane' in table 's_shipment': Dictionary type Int, .NET type: int

The currently active pane in the mailing wizard

Declaration

public Int32FieldInfo ActivePane { 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.GetSShipmentInfo().

ActualCount

Field 'actual_count' in table 's_shipment': Dictionary type Int, .NET type: int

Number of emails sent at the last checkpoint

Declaration

public Int32FieldInfo ActualCount { 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.GetSShipmentInfo().

ActualRate

Field 'actual_rate' in table 's_shipment': Dictionary type Int, .NET type: int

The actual rate of messages per minute. can be lower than send_rate

Declaration

public Int32FieldInfo ActualRate { 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.GetSShipmentInfo().

ActualTime

Field 'actual_time' in table 's_shipment': Dictionary type DateTime, .NET type: DateTime

The time of the last checkpoint

Declaration

public DateTimeFieldInfo ActualTime { 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.GetSShipmentInfo().

AreStatisticsDirty

Field 'are_statistics_dirty' in table 's_shipment': Dictionary type Bool, .NET type: short

Indicates if shipment needs statistics calculation, set by code that changes the shipment or receives clicks/opens

Declaration

public UInt16FieldInfo AreStatisticsDirty { 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.GetSShipmentInfo().

ClickNum

Field 'click_num' in table 's_shipment': Dictionary type Int, .NET type: int

Number of links clicked

Declaration

public Int32FieldInfo ClickNum { 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.GetSShipmentInfo().

ClickRate

Field 'click_rate' in table 's_shipment': Dictionary type Double, .NET type: double

Click rate % (click_num / delivered_num)

Declaration

public DoubleFieldInfo ClickRate { get; }

Property Value

Type	Description
DoubleFieldInfo

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

Configuration

Field 'configuration' in table 's_shipment': Dictionary type Int, .NET type: int

This field indicates what kind of shipment this is.

Declaration

public Int32FieldInfo Configuration { 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.GetSShipmentInfo().

CurrentSender

Field 'current_sender' in table 's_shipment': Dictionary type Int, .NET type: int

Timestamp to identify which ejsender that owns this shipment

Declaration

public Int32FieldInfo CurrentSender { 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.GetSShipmentInfo().

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

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

DeliveredNum

Field 'delivered_num' in table 's_shipment': Dictionary type Int, .NET type: int

Number of mails sent minus bounces

Declaration

public Int32FieldInfo DeliveredNum { 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.GetSShipmentInfo().

Description

Field 'description' in table 's_shipment': Dictionary type String[256], .NET type: string

Describes the shipment

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

DictionaryTableNumber

Table number for table SShipment 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.GetSShipmentInfo().

EndDate

Field 'end_date' in table 's_shipment': Dictionary type DateTime, .NET type: DateTime

Is set when this shipment is ended

Declaration

public DateTimeFieldInfo EndDate { 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.GetSShipmentInfo().

EnvelopeFrom

Field 'envelope_from' in table 's_shipment': Dictionary type String[256], .NET type: string

Email address for the MTA envelope (where bounces are returned)

Declaration

public StringFieldInfo EnvelopeFrom { 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.GetSShipmentInfo().

Flags

Field 'flags' in table 's_shipment': Dictionary type UInt, .NET type: uint

Various flags for a shipment

Declaration

public FieldInfo Flags { get; }

Property Value

Type	Description
FieldInfo

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

FolderId

Field 'folder_id' in table 's_shipment': Dictionary type Int, .NET type: int

The folder which this shipment belongs to. -1 indicates that the shipment is on the root

Declaration

public Int32FieldInfo FolderId { 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.GetSShipmentInfo().

FromAddr

Field 'from_addr' in table 's_shipment': Dictionary type String[256], .NET type: string

Email address to put in the From header of the messages

Declaration

public StringFieldInfo FromAddr { 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.GetSShipmentInfo().

GeneratedDocumentId

Field 'generated_document_id' in table 's_shipment': Dictionary type FK, target: Document, .NET type: int

ID of the merged document that is the result of the shipment

Declaration

public Int32FieldInfo GeneratedDocumentId { 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.GetSShipmentInfo().

GeneratedDocumentId_InnerJoin_Document

Generated join from the foreign key GeneratedDocumentId in this table, to its target table DocumentTableInfo.

Declaration

public TargetedInnerJoin<DocumentTableInfo> GeneratedDocumentId_InnerJoin_Document { get; }

Property Value

Type	Description
TargetedInnerJoin<DocumentTableInfo>

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

HardbounceNum

Field 'hardbounce_num' in table 's_shipment': Dictionary type Int, .NET type: int

Number of hard bounces

Declaration

public Int32FieldInfo HardbounceNum { 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.GetSShipmentInfo().

HardbounceRate

Field 'hardbounce_rate' in table 's_shipment': Dictionary type Double, .NET type: double

Hard bounce rate % (hardbounce_num / number_transmitted)

Declaration

public DoubleFieldInfo HardbounceRate { get; }

Property Value

Type	Description
DoubleFieldInfo

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

LeftOuterJoin_Form_ResponseShipmentId

Generated left outer join from the primary key SShipmentId on this table, to Form.ResponseShipmentId.

Declaration

public TargetedLeftOuterJoin<FormTableInfo> LeftOuterJoin_Form_ResponseShipmentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<FormTableInfo>

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

LeftOuterJoin_SBounceShipment_ShipmentId

Generated left outer join from the primary key SShipmentId on this table, to SBounceShipment.ShipmentId.

Declaration

public TargetedLeftOuterJoin<SBounceShipmentTableInfo> LeftOuterJoin_SBounceShipment_ShipmentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<SBounceShipmentTableInfo>

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

LeftOuterJoin_SLinkCustomerStatical_ShipmentId

Generated left outer join from the primary key SShipmentId on this table, to SLinkCustomerStatical.ShipmentId.

Declaration

public TargetedLeftOuterJoin<SLinkCustomerStaticalTableInfo> LeftOuterJoin_SLinkCustomerStatical_ShipmentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<SLinkCustomerStaticalTableInfo>

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

LeftOuterJoin_SLinkCustomer_ShipmentId

Generated left outer join from the primary key SShipmentId on this table, to SLinkCustomer.ShipmentId.

Declaration

public TargetedLeftOuterJoin<SLinkCustomerTableInfo> LeftOuterJoin_SLinkCustomer_ShipmentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<SLinkCustomerTableInfo>

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

LeftOuterJoin_SListShipment_ShipmentId

Generated left outer join from the primary key SShipmentId on this table, to SListShipment.ShipmentId.

Declaration

public TargetedLeftOuterJoin<SListShipmentTableInfo> LeftOuterJoin_SListShipment_ShipmentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<SListShipmentTableInfo>

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

LeftOuterJoin_SSentMessage_ShipmentId

Generated left outer join from the primary key SShipmentId on this table, to SSentMessage.ShipmentId.

Declaration

public TargetedLeftOuterJoin<SSentMessageTableInfo> LeftOuterJoin_SSentMessage_ShipmentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<SSentMessageTableInfo>

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

LeftOuterJoin_SShipmentAddr_ShipmentId

Generated left outer join from the primary key SShipmentId on this table, to SShipmentAddr.ShipmentId.

Declaration

public TargetedLeftOuterJoin<SShipmentAddrTableInfo> LeftOuterJoin_SShipmentAddr_ShipmentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<SShipmentAddrTableInfo>

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

LeftOuterJoin_SSmtpServers_ShipmentId

Generated left outer join from the primary key SShipmentId on this table, to SSmtpServers.ShipmentId.

Declaration

public TargetedLeftOuterJoin<SSmtpServersTableInfo> LeftOuterJoin_SSmtpServers_ShipmentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<SSmtpServersTableInfo>

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

LeftOuterJoin_Sms_ShipmentId

Generated left outer join from the primary key SShipmentId on this table, to Sms.ShipmentId.

Declaration

public TargetedLeftOuterJoin<SmsTableInfo> LeftOuterJoin_Sms_ShipmentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<SmsTableInfo>

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

MessageId

Field 'message_id' in table 's_shipment': Dictionary type FK, target: SMessage, .NET type: int

The id of the message that is sent in this shipment

Declaration

public Int32FieldInfo MessageId { 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.GetSShipmentInfo().

MessageId_InnerJoin_SMessage

Generated join from the foreign key MessageId in this table, to its target table SMessageTableInfo.

Declaration

public TargetedInnerJoin<SMessageTableInfo> MessageId_InnerJoin_SMessage { get; }

Property Value

Type	Description
TargetedInnerJoin<SMessageTableInfo>

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

OpenNum

Field 'open_num' in table 's_shipment': Dictionary type Int, .NET type: int

Number of opened emails count

Declaration

public Int32FieldInfo OpenNum { 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.GetSShipmentInfo().

OpenRate

Field 'open_rate' in table 's_shipment': Dictionary type Double, .NET type: double

Open rate % (open_num / delivered_num)

Declaration

public DoubleFieldInfo OpenRate { get; }

Property Value

Type	Description
DoubleFieldInfo

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

ProjectId

Field 'project_id' in table 's_shipment': Dictionary type FK, target: Project, .NET type: int

Set if this shipment should be related to a Project

Declaration

public Int32FieldInfo ProjectId { 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.GetSShipmentInfo().

ProjectId_InnerJoin_Project

Generated join from the foreign key ProjectId in this table, to its target table ProjectTableInfo.

Declaration

public TargetedInnerJoin<ProjectTableInfo> ProjectId_InnerJoin_Project { get; }

Property Value

Type	Description
TargetedInnerJoin<ProjectTableInfo>

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

Recipients

Field 'recipients' in table 's_shipment': Dictionary type Int, .NET type: int

The total number of recipients to send message to.

Declaration

public Int32FieldInfo Recipients { 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.GetSShipmentInfo().

Registered

Field 'registered' in table 's_shipment': 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.GetSShipmentInfo().

RegisteredAssociateId

Field 'registered_associate_id' in table 's_shipment': 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.GetSShipmentInfo().

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

ReplyAddr

Field 'reply_addr' in table 's_shipment': Dictionary type String[256], .NET type: string

Email address to put in the Reply To: header of the messages

Declaration

public StringFieldInfo ReplyAddr { 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.GetSShipmentInfo().

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

SShipmentId

Field 'id' in table 's_shipment': Dictionary type PK, .NET type: int

Primary key

Declaration

public Int32FieldInfo SShipmentId { 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.GetSShipmentInfo().

SelectionId

Field 'selection_id' in table 's_shipment': Dictionary type FK, target: Selection, .NET type: int

Set if this shipment should be related to a Selection

Declaration

public Int32FieldInfo SelectionId { 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.GetSShipmentInfo().

SelectionId_InnerJoin_Selection

Generated join from the foreign key SelectionId in this table, to its target table SelectionTableInfo.

Declaration

public TargetedInnerJoin<SelectionTableInfo> SelectionId_InnerJoin_Selection { get; }

Property Value

Type	Description
TargetedInnerJoin<SelectionTableInfo>

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

SendRate

Field 'send_rate' in table 's_shipment': Dictionary type Int, .NET type: int

Maximum number of messages sent per minute.

Declaration

public Int32FieldInfo SendRate { 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.GetSShipmentInfo().

SentNum

Field 'sent_num' in table 's_shipment': Dictionary type Int, .NET type: int

Number of mails sent

Declaration

public Int32FieldInfo SentNum { 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.GetSShipmentInfo().

ShipmenttypeId

Field 'shipmenttype_id' in table 's_shipment': Dictionary type FK, target: ShipmentType, .NET type: int

Id of subscriptionType that this shipment has, so we may check for reservations

Declaration

public Int32FieldInfo ShipmenttypeId { 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.GetSShipmentInfo().

ShipmenttypeId_InnerJoin_ShipmentType

Generated join from the foreign key ShipmenttypeId in this table, to its target table ShipmentTypeTableInfo.

Declaration

public TargetedInnerJoin<ShipmentTypeTableInfo> ShipmenttypeId_InnerJoin_ShipmentType { get; }

Property Value

Type	Description
TargetedInnerJoin<ShipmentTypeTableInfo>

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

SmtpPort

Field 'smtp_port' in table 's_shipment': Dictionary type Int, .NET type: int

The port of the SMTP server to use for this shipment.

Declaration

public Int32FieldInfo SmtpPort { 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.GetSShipmentInfo().

SmtpServ

Field 'smtp_serv' in table 's_shipment': Dictionary type String[256], .NET type: string

The server to use for this shipment.

Declaration

public StringFieldInfo SmtpServ { 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.GetSShipmentInfo().

SoftbounceNum

Field 'softbounce_num' in table 's_shipment': Dictionary type Int, .NET type: int

Number of soft bounces

Declaration

public Int32FieldInfo SoftbounceNum { 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.GetSShipmentInfo().

SoftbounceRate

Field 'softbounce_rate' in table 's_shipment': Dictionary type Double, .NET type: double

Soft bounce rate % (softbounce_num / number_transmitted)

Declaration

public DoubleFieldInfo SoftbounceRate { get; }

Property Value

Type	Description
DoubleFieldInfo

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

Sorting

Field 'sorting' in table 's_shipment': Dictionary type Enum, .NET type: RecipientSorting

Which sorting should be used on the document mailing recipient list, used when generating PDF

Declaration

public RecipientSortingFieldInfo Sorting { get; }

Property Value

Type	Description
RecipientSortingFieldInfo

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

StartDate

Field 'start_date' in table 's_shipment': Dictionary type DateTime, .NET type: DateTime

The date and time when to start this shipment

Declaration

public DateTimeFieldInfo StartDate { 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.GetSShipmentInfo().

Status

Field 'status' in table 's_shipment': Dictionary type Enum, .NET type: ShipmentStatus

Sending/stopped/failed etc.

Declaration

public ShipmentStatusFieldInfo Status { get; }

Property Value

Type	Description
ShipmentStatusFieldInfo

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

TicketCategory

Field 'ticket_category' in table 's_shipment': Dictionary type Int, .NET type: int

The category of tickets created while sending out if any. -1 if no ticket should be created

Declaration

public Int32FieldInfo TicketCategory { 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.GetSShipmentInfo().

TicketOwner

Field 'ticket_owner' in table 's_shipment': Dictionary type Int, .NET type: int

The owner of the ticket if any is created while sending out a shipment. -1 if no ticket should be automatically delegated, 1 if the ticket is unassigned, >1 for all others

Declaration

public Int32FieldInfo TicketOwner { 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.GetSShipmentInfo().

TotalbounceNum

Field 'totalbounce_num' in table 's_shipment': Dictionary type Int, .NET type: int

Total number of bounces

Declaration

public Int32FieldInfo TotalbounceNum { 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.GetSShipmentInfo().

TotalbounceRate

Field 'totalbounce_rate' in table 's_shipment': Dictionary type Double, .NET type: double

Total bounce rate % (totalbounce_num / number_transmitted)

Declaration

public DoubleFieldInfo TotalbounceRate { get; }

Property Value

Type	Description
DoubleFieldInfo

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

Updated

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

Last updated when

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

UpdatedAssociateId

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

Last updated by whom

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

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

UpdatedCount

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

Number of updates made to this record

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

Methods

IdxAreStatisticsDirty(short)

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

Field	Description
AreStatisticsDirty	Indicates if shipment needs statistics calculation, set by code that changes the shipment or receives clicks/opens

Declaration

public Restriction IdxAreStatisticsDirty(short areStatisticsDirty)

Parameters

Type	Name	Description
short	areStatisticsDirty

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

Implements

ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)