Class DashboardTileDefinitionTableInfo
Table 'dashboard_tile_definition': Describes the contents of a tile
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("dashboard_tile_definition")]
public class DashboardTileDefinitionTableInfo : 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 DashboardTileDefinition in the database dictionary: dashboard_tile_definition
Declaration
public const string DictionaryTableName = "dashboard_tile_definition"
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
CurrencyCode
Field 'currency_code' in table 'dashboard_tile_definition': Dictionary type String[4], .NET type: String
Currency codeDeclaration
public StringFieldInfo CurrencyCode { 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
CurrencyMode
Field 'currency_mode' in table 'dashboard_tile_definition': Dictionary type Enum, .NET type: DashTileCurrencyMode
Dashboard currency modeDeclaration
public DashTileCurrencyModeFieldInfo CurrencyMode { get; }
Property Value
Type | Description |
---|---|
DashTileCurrencyModeFieldInfo |
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
DashboardTileDefinitionId
Field 'dashboard_tile_definition_id' in table 'dashboard_tile_definition': Dictionary type PK, .NET type: Int32
Primary keyDeclaration
public Int32FieldInfo DashboardTileDefinitionId { 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
DefaultHeight
Field 'default_height' in table 'dashboard_tile_definition': Dictionary type Int, .NET type: Int32
Default height when added to a dashboardDeclaration
public Int32FieldInfo DefaultHeight { 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
DefaultWidth
Field 'default_width' in table 'dashboard_tile_definition': Dictionary type Int, .NET type: Int32
Default width when added to a dashboardDeclaration
public Int32FieldInfo DefaultWidth { 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
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 'dashboard_tile_definition': Dictionary type String[4001], .NET type: String
Detailed descriptionDeclaration
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 DashboardTileDefinition 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
EntityName
Field 'entity_name' in table 'dashboard_tile_definition': Dictionary type String[256], .NET type: String
The entity measured by this tile, defines what provider to useDeclaration
public StringFieldInfo EntityName { 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
EntityType
Field 'entity_type' in table 'dashboard_tile_definition': Dictionary type Enum, .NET type: DashTileEntityType
Dashboard entity typeDeclaration
public DashTileEntityTypeFieldInfo EntityType { get; }
Property Value
Type | Description |
---|---|
DashTileEntityTypeFieldInfo |
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
LayoutConfig
Field 'layout_config' in table 'dashboard_tile_definition': Dictionary type Clob, .NET type: String
The JSON formatted layout configDeclaration
public StringFieldInfo LayoutConfig { 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
LeftOuterJoin_DashboardTile_DashboardTileDefinitionId
Generated left outer join from the primary key DashboardTileDefinitionId on this table, to DashboardTile.DashboardTileDefinitionId.
Declaration
public TargetedLeftOuterJoin<DashboardTileTableInfo> LeftOuterJoin_DashboardTile_DashboardTileDefinitionId { get; }
Property Value
Type | Description |
---|---|
TargetedLeftOuterJoin<DashboardTileTableInfo> |
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_DashboardTileField_DashboardTileDefinitionId
Generated left outer join from the primary key DashboardTileDefinitionId on this table, to DashboardTileField.DashboardTileDefinitionId.
Declaration
public TargetedLeftOuterJoin<DashboardTileFieldTableInfo> LeftOuterJoin_DashboardTileField_DashboardTileDefinitionId { get; }
Property Value
Type | Description |
---|---|
TargetedLeftOuterJoin<DashboardTileFieldTableInfo> |
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_Selection_DashboardTileDefinitionId
Generated left outer join from the primary key DashboardTileDefinitionId on this table, to Selection.DashboardTileDefinitionId.
Declaration
public TargetedLeftOuterJoin<SelectionTableInfo> LeftOuterJoin_Selection_DashboardTileDefinitionId { get; }
Property Value
Type | Description |
---|---|
TargetedLeftOuterJoin<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
Measure
Field 'measure' in table 'dashboard_tile_definition': Dictionary type Enum, .NET type: DashTileMeasure
Dashboard measure type (Count, Sum, Avg, etc.)Declaration
public DashTileMeasureFieldInfo Measure { get; }
Property Value
Type | Description |
---|---|
DashTileMeasureFieldInfo |
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
MeasureByField
Field 'measure_by_field' in table 'dashboard_tile_definition': Dictionary type String[256], .NET type: String
Field to group byDeclaration
public StringFieldInfo MeasureByField { 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
MeasureField
Field 'measure_field' in table 'dashboard_tile_definition': Dictionary type String[256], .NET type: String
Field to be measuredDeclaration
public StringFieldInfo MeasureField { 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
Name
Field 'name' in table 'dashboard_tile_definition': Dictionary type String[4001], .NET type: String
The name of the tileDeclaration
public StringFieldInfo Name { 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
Registered
Field 'registered' in table 'dashboard_tile_definition': 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 'dashboard_tile_definition': 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
SecondarySelectionId
Field 'secondary_selection_id' in table 'dashboard_tile_definition': Dictionary type FK, target: Selection, .NET type: Int32
Selection holding the replaced or changed criterias (period comparisons etc)Declaration
public Int32FieldInfo SecondarySelectionId { 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
SecondarySelectionId_InnerJoin_Selection
Generated join from the foreign key SecondarySelectionId in this table, to its target table SelectionTableInfo.
Declaration
public TargetedInnerJoin<SelectionTableInfo> SecondarySelectionId_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
SelectionId
Field 'selection_id' in table 'dashboard_tile_definition': Dictionary type FK, target: Selection, .NET type: Int32
Selection holding the criterias for the tile definitionDeclaration
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
SortBy
Field 'sort_by' in table 'dashboard_tile_definition': Dictionary type String[256], .NET type: String
Sort by fieldDeclaration
public StringFieldInfo SortBy { 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
TileType
Field 'tile_type' in table 'dashboard_tile_definition': Dictionary type Enum, .NET type: DashTileType
Dashboard tile typeDeclaration
public DashTileTypeFieldInfo TileType { get; }
Property Value
Type | Description |
---|---|
DashTileTypeFieldInfo |
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 'dashboard_tile_definition': 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 'dashboard_tile_definition': 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 'dashboard_tile_definition': 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
Usage
Field 'usage' in table 'dashboard_tile_definition': Dictionary type Enum, .NET type: DashTileUsage
Where this tile can be usedDeclaration
public DashTileUsageFieldInfo Usage { get; }
Property Value
Type | Description |
---|---|
DashTileUsageFieldInfo |
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