Class SShipmentTableInfo

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

Inheritance
Object
TableInfo
SShipmentTableInfo
Implements
Inherited Members
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

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

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

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

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

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

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

Definition

Definition of the table as described in the deployed runtime dictionary

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

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

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

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

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

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

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

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

GeneratedDocumentId

Field 'generated_document_id' in table 's_shipment': Dictionary type FK, .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

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

MessageId

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

The id of the message that is sent in this shipment

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

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>

ProjectId

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

Set if this shipment should be related to a Project

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

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>

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

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

RegisteredAssociateId

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

Registered by whom

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

RegisteredAssociateId_InnerJoin_Associate

Generated join from the foreign key RegisteredAssociateId in this table, to its target table AssociateTableInfo.

Declaration
public TargetedInnerJoin<AssociateTableInfo> RegisteredAssociateId_InnerJoin_Associate { get; }
Property Value
Type Description
TargetedInnerJoin<AssociateTableInfo>

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

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

SelectionId

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

Set if this shipment should be related to a Selection

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

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>

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

ShipmenttypeId

Field 'shipmenttype_id' in table 's_shipment': Dictionary type FK, .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

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>

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

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

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

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

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

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

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

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

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

UpdatedAssociateId

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

Last updated by whom

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

UpdatedAssociateId_InnerJoin_Associate

Generated join from the foreign key UpdatedAssociateId in this table, to its target table AssociateTableInfo.

Declaration
public TargetedInnerJoin<AssociateTableInfo> UpdatedAssociateId_InnerJoin_Associate { get; }
Property Value
Type Description
TargetedInnerJoin<AssociateTableInfo>

UpdatedCount

Field 'updatedCount' in table '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

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)