Show / Hide Table of Contents

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

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 .

Properties

ActivePane

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

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 .

ActualCount

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

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 .

ActualRate

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

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 .

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 .

AreStatisticsDirty

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

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 .

ClickNum

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

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 .

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 .

Configuration

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

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 .

CurrentSender

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

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 .

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 .

DeliveredNum

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

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 .

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 .

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
Int32
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 .

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 .

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 .

Flags

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

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 .

FolderId

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

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 .

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 .

GeneratedDocumentId

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

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 .

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 .

HardbounceNum

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

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 .

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 .

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 .

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 .

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 .

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 .

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 .

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 .

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 .

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 .

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 .

MessageId

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

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 .

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 .

OpenNum

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

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 .

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 .

ProjectId

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

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 .

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 .

Recipients

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

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 .

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 .

RegisteredAssociateId

Field 'registered_associate_id' in table 's_shipment': Dictionary type FK, target: Associate, .NET type: Int32

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 .

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 .

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 .

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration
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 .

SelectionId

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

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 .

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 .

SendRate

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

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 .

SentNum

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

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 .

ShipmenttypeId

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

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 .

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 .

SmtpPort

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

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 .

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 .

SoftbounceNum

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

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 .

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 .

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 .

SShipmentId

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

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 .

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 .

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 .

TicketCategory

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

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 .

TicketOwner

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

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 .

TotalbounceNum

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

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 .

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 .

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 .

UpdatedAssociateId

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

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 .

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 .

UpdatedCount

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

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 .

Methods

IdxAreStatisticsDirty(Int16)

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

FieldDescription
AreStatisticsDirtyIndicates 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
Int16 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 .

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