Class ErpFieldTableInfo
Table 'ErpField': Store the metadata describing the fields that belong to an actor/connection combination, as described by the Erp Connector
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
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
Properties
Access
Field 'Access' in table 'ErpField': Dictionary type Enum, .NET type: FieldAccess
Access restrictions for the fieldDeclaration
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
CrmFieldKey
Field 'CrmFieldKey' in table 'ErpField': Dictionary type String[255], .NET type: String
The CRM field name, as implemented by the Sync entitiesDeclaration
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
DefaultValue
Field 'DefaultValue' in table 'ErpField': Dictionary type String[255], .NET type: String
Default value, stored using CultureDataFormatter format if it is not a stringDeclaration
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
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
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 |
---|---|
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
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
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
ErpConnectionActorTypeId
Field 'ErpConnectionActorTypeId' in table 'ErpField': Dictionary type FK, target: ErpConnectionActorType, .NET type: Int32
Link to Erp Connection/Actor typeDeclaration
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
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
ErpFieldId
Field 'erpfield_id' in table 'ErpField': Dictionary type PK, .NET type: Int32
Primary keyDeclaration
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
ErpFieldKey
Field 'ErpFieldKey' in table 'ErpField': Dictionary type String[255], .NET type: String
The ERP field keyDeclaration
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
FieldType
Field 'FieldType' in table 'ErpField': Dictionary type Enum, .NET type: FieldMetadataType
Field typeDeclaration
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
FirstSyncDefaultValue
Field 'FirstSyncDefaultValue' in table 'ErpField': Dictionary type String[255], .NET type: String
The default value to be set, can be blankDeclaration
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
HasFirstSyncDefaultValue
Field 'HasFirstSyncDefaultValue' in table 'ErpField': Dictionary type Bool, .NET type: Int16
Should a default value be set on first syncDeclaration
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
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
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 ConnectorDeclaration
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
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 numbersDeclaration
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
Mandatory
Field 'Mandatory' in table 'ErpField': Dictionary type Bool, .NET type: Int16
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
MaxLength
Field 'MaxLength' in table 'ErpField': Dictionary type Int, .NET type: Int32
Maximum size of the field, if there is a limitDeclaration
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
MissingInERP
Field 'MissingInERP' in table 'ErpField': Dictionary type Bool, .NET type: Int16
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
PromptUser
Field 'PromptUser' in table 'ErpField': Dictionary type Bool, .NET type: Int16
Should the field be shown in the first-sync GUI; independent of whether a default value should be setDeclaration
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
Rank
Field 'Rank' in table 'ErpField': Dictionary type Int, .NET type: Int32
Rank order of lines in GUI, relevant if ShowInGui is trueDeclaration
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
Registered
Field 'registered' in table 'ErpField': Dictionary type UtcDateTime, .NET type: DateTime
Registered whenDeclaration
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 'ErpField': Dictionary type FK, target: Associate, .NET type: Int32
Registered by whomDeclaration
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
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
ShowInGui
Field 'ShowInGui' in table 'ErpField': Dictionary type Bool, .NET type: Int16
Should this field be shown as a (read-only!) field in the CRM GuiDeclaration
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
ShowInSearch
Field 'ShowInSearch' in table 'ErpField': Dictionary type Bool, .NET type: Int16
Should this field be shown in searchesDeclaration
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
SyncToCrm
Field 'SyncToCrm' in table 'ErpField': Dictionary type Bool, .NET type: Int16
Should value changes in ERP be automatically transferred to CRMDeclaration
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
SyncToErp
Field 'SyncToErp' in table 'ErpField': Dictionary type Bool, .NET type: Int16
Should value changes in CRM be automatically transferred to ERPDeclaration
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
Updated
Field 'updated' in table 'ErpField': Dictionary type UtcDateTime, .NET type: DateTime
Last updated whenDeclaration
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 'ErpField': Dictionary type FK, target: Associate, .NET type: Int32
Last updated by whomDeclaration
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 'ErpField': Dictionary type UShort, .NET type: Int16
Number of updates made to this recordDeclaration
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
IdxErpConnectionActorTypeId(Int32)
Shortcut method for looking up using the database index ErpConnectionActorTypeId, which spans the following fields:
Field | Description |
---|---|
ErpConnectionActorTypeId | Link to Erp Connection/Actor type |
Declaration
public Restriction IdxErpConnectionActorTypeId(int erpConnectionActorTypeId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | 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