Class ErpFieldTableInfo

Table 'ErpField': Store the metadata describing the fields that belong to an actor/connection combination, as described by the Erp Connector

Inheritance
object
TableInfo
ErpFieldTableInfo
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("ErpField")]
public class ErpFieldTableInfo : 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.GetErpFieldInfo().

Fields

DictionaryTableName

Conceptual name of table ErpField in the database dictionary: ErpField

Declaration
public const string DictionaryTableName = "ErpField"
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.GetErpFieldInfo().

Properties

Access

Field 'Access' in table 'ErpField': Dictionary type Enum, .NET type: FieldAccess

Access restrictions for the field
Declaration
public FieldAccessFieldInfo Access { get; }
Property Value
Type Description
FieldAccessFieldInfo
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.GetErpFieldInfo().

CrmFieldKey

Field 'CrmFieldKey' in table 'ErpField': Dictionary type String[255], .NET type: string

The CRM field name, as implemented by the Sync entities
Declaration
public StringFieldInfo CrmFieldKey { 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.GetErpFieldInfo().

DefaultValue

Field 'DefaultValue' in table 'ErpField': Dictionary type String[255], .NET type: string

Default value, stored using CultureDataFormatter format if it is not a string
Declaration
public StringFieldInfo DefaultValue { 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.GetErpFieldInfo().

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration
public override SoTable Definition { get; }
Property Value
Type Description
SoTable
Overrides
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.GetErpFieldInfo().

DictionaryTableNumber

Table number for table ErpField 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.GetErpFieldInfo().

DisplayDescription

Field 'DisplayDescription' in table 'ErpField': Dictionary type String[255], .NET type: string

Tooltip for the field name.
Declaration
public StringFieldInfo DisplayDescription { 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.GetErpFieldInfo().

DisplayName

Field 'DisplayName' in table 'ErpField': Dictionary type String[255], .NET type: string

Localized field name – shown in the GUI as the label for the control.
Declaration
public StringFieldInfo DisplayName { 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.GetErpFieldInfo().

ErpConnectionActorTypeId

Field 'ErpConnectionActorTypeId' in table 'ErpField': Dictionary type FK, target: ErpConnectionActorType, .NET type: int

Link to Erp Connection/Actor type
Declaration
public Int32FieldInfo ErpConnectionActorTypeId { 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.GetErpFieldInfo().

ErpConnectionActorTypeId_InnerJoin_ErpConnectionActorType

Generated join from the foreign key ErpConnectionActorTypeId in this table, to its target table ErpConnectionActorTypeTableInfo.

Declaration
public TargetedInnerJoin<ErpConnectionActorTypeTableInfo> ErpConnectionActorTypeId_InnerJoin_ErpConnectionActorType { get; }
Property Value
Type Description
TargetedInnerJoin<ErpConnectionActorTypeTableInfo>
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.GetErpFieldInfo().

ErpFieldId

Field 'erpfield_id' in table 'ErpField': Dictionary type PK, .NET type: int

Primary key
Declaration
public Int32FieldInfo ErpFieldId { 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.GetErpFieldInfo().

ErpFieldKey

Field 'ErpFieldKey' in table 'ErpField': Dictionary type String[255], .NET type: string

The ERP field key
Declaration
public StringFieldInfo ErpFieldKey { 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.GetErpFieldInfo().

FieldType

Field 'FieldType' in table 'ErpField': Dictionary type Enum, .NET type: FieldMetadataType

Field type
Declaration
public FieldMetadataTypeFieldInfo FieldType { get; }
Property Value
Type Description
FieldMetadataTypeFieldInfo
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.GetErpFieldInfo().

FirstSyncDefaultValue

Field 'FirstSyncDefaultValue' in table 'ErpField': Dictionary type String[255], .NET type: string

The default value to be set, can be blank
Declaration
public StringFieldInfo FirstSyncDefaultValue { 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.GetErpFieldInfo().

HasFirstSyncDefaultValue

Field 'HasFirstSyncDefaultValue' in table 'ErpField': Dictionary type Bool, .NET type: short

Should a default value be set on first sync
Declaration
public UInt16FieldInfo HasFirstSyncDefaultValue { 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.GetErpFieldInfo().

LeftOuterJoin_ErpListItemMapping_ErpFieldId

Generated left outer join from the primary key ErpFieldId on this table, to ErpListItemMapping.ErpFieldId.

Declaration
public TargetedLeftOuterJoin<ErpListItemMappingTableInfo> LeftOuterJoin_ErpListItemMapping_ErpFieldId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<ErpListItemMappingTableInfo>
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.GetErpFieldInfo().

ListName

Field 'ListName' in table 'ErpField': Dictionary type String[255], .NET type: string

The ERP list name, if the field has a list of values supplied by the ERP Connector
Declaration
public StringFieldInfo ListName { 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.GetErpFieldInfo().

ListReference

Field 'ListReference' in table 'ErpField': Dictionary type String[255], .NET type: string

Reference to CRM list, if a mapping exists. Format: table=<table name>[&<extra id>=<value>], to make it independent of actual table numbers
Declaration
public StringFieldInfo ListReference { 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.GetErpFieldInfo().

Mandatory

Field 'Mandatory' in table 'ErpField': Dictionary type Bool, .NET type: short

Should the user be forced to set a value (the Erp Connector may declare fields mandatory as well)
Declaration
public UInt16FieldInfo Mandatory { 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.GetErpFieldInfo().

MaxLength

Field 'MaxLength' in table 'ErpField': Dictionary type Int, .NET type: int

Maximum size of the field, if there is a limit
Declaration
public Int32FieldInfo MaxLength { 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.GetErpFieldInfo().

MissingInERP

Field 'MissingInERP' in table 'ErpField': Dictionary type Bool, .NET type: short

Set to true if this field has previously been defined, but was no longer in the 'supported fields' response from the connector. This typically happens if the target ERP system changes, and means the field needs to be unmapped.
Declaration
public UInt16FieldInfo MissingInERP { 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.GetErpFieldInfo().

PromptUser

Field 'PromptUser' in table 'ErpField': Dictionary type Bool, .NET type: short

Should the field be shown in the first-sync GUI; independent of whether a default value should be set
Declaration
public UInt16FieldInfo PromptUser { 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.GetErpFieldInfo().

Rank

Field 'Rank' in table 'ErpField': Dictionary type Int, .NET type: int

Rank order of lines in GUI, relevant if ShowInGui is true
Declaration
public Int32FieldInfo Rank { 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.GetErpFieldInfo().

Registered

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

RegisteredAssociateId

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

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

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

ShowInGui

Field 'ShowInGui' in table 'ErpField': Dictionary type Bool, .NET type: short

Should this field be shown as a (read-only!) field in the CRM Gui
Declaration
public UInt16FieldInfo ShowInGui { 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.GetErpFieldInfo().

ShowInSearch

Field 'ShowInSearch' in table 'ErpField': Dictionary type Bool, .NET type: short

Should this field be shown in searches
Declaration
public UInt16FieldInfo ShowInSearch { 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.GetErpFieldInfo().

SyncToCrm

Field 'SyncToCrm' in table 'ErpField': Dictionary type Bool, .NET type: short

Should value changes in ERP be automatically transferred to CRM
Declaration
public UInt16FieldInfo SyncToCrm { 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.GetErpFieldInfo().

SyncToErp

Field 'SyncToErp' in table 'ErpField': Dictionary type Bool, .NET type: short

Should value changes in CRM be automatically transferred to ERP
Declaration
public UInt16FieldInfo SyncToErp { 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.GetErpFieldInfo().

Updated

Field 'updated' in table 'ErpField': 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.GetErpFieldInfo().

UpdatedAssociateId

Field 'updated_associate_id' in table 'ErpField': 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.GetErpFieldInfo().

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

UpdatedCount

Field 'updatedCount' in table 'ErpField': 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.GetErpFieldInfo().

Methods

IdxErpConnectionActorTypeId(int)

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

FieldDescription
ErpConnectionActorTypeIdLink to Erp Connection/Actor type
Declaration
public Restriction IdxErpConnectionActorTypeId(int erpConnectionActorTypeId)
Parameters
Type Name Description
int erpConnectionActorTypeId
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.GetErpFieldInfo().

Implements

Extension Methods