Table of Contents

"Meta" data model

Media-iBox was modeled to use a flexible, expandable data model. As such, we use a set of “Meta-Tables” that describe how the CMS will expose and manipulate the data model.

There’s a few core tables for this meta data model:

  • MEDIA_TYPES
  • ADM_FIELDS
  • ADM_RELATEDS
  • ADM_ENUMTYPES
  • ADM_ENUMVALUES
  • ADM_FILEEXTENSIONS

All tables above are also Media Types, and therefore contain the basic fields described in the section above (ID, DATEINS, NAME, OWNER).

MEDIA_TYPES

This table lists the Media Types present in the system. Its basic structure is:

  • ID (int, not null)
    • Unique registration identification number.
  • DATEINS (datetime, not null)
    • Record creation date and time.
  • NAME (varchar, nullable)
    • Name of the physical table to be mapped in the database.
  • OWNER (int, not null)
    • Numerical identifier of the creator user (referring to table [ADM_USERS].[ID]).
  • MIBINDEX (int, not null)
    • Numeric identifier for this Media Type. Examples of references:
      • ADM_FIELDS with MEDIATYPE
      • ADM_FILEEXTENSIONS with SOURCETABLE
      • ADM_RELATEDS with LOCALTABLE or REMOTETABLE
      • LINKOBJECTS with VLOCAL or TLOCAL or VREMOTE or TREMOTE
      • DMM_JOBS with CONTENT_MEDIATYPE
      • DMM_JOBS_ACTIONS with MIB_TYPE
  • TITLE (varchar, not null)
    • Visible (user-friendly) name for the Media Type.
  • BLOCK_WRITE (int, nullable)
    • Write permission. This permission is superior to user permissions, so a user with write permission for a media type whose "BLOCK_WRITE" value is true cannot perform writing.
  • BLOCK_DELETE (int, nullable)
    • Deletion permission. This permission is higher than user permissions, so that a user with delete permission for a media type whose value of "BLOCK_DELETE" is true cannot perform the deletion.
  • BLOCK_CREATE (int, nullable)
    • Creation permission. This permission is superior to the user's permissions, so that a user with permission to create on a media type whose value of "BLOCK_CREATE" is true cannot perform the creation of a new record.
  • MIB_LAST_UPDATE (datetime, not null)
    • Date and time of the last modification performed.
  • PARENT_MEDIA_TYPE (int, nullable)
    • Generate content based on [MIB3UX_PAGE_COMPONENT_CONFIGURATIONS] table according to [COMPONENT_KEY]. Through this option it is possible to extend this table without the need to include of new columns, informing only which will be the extension table with the additional fields.
  • HISTORY_TABLE (varchar(max), nullable)
    • Discontinued (legacy use only).
  • BLOCK_DEFAULT_LIST (bit, nullable)
    • Discontinued (legacy use only).
  • BLOCK_DEFAULT_EDIT (bit, nullable)
    • Discontinued (legacy use only).
  • FILE_HASH_COLUMN (varchar(max), nullable)
    • Discontinued (legacy use only).
  • LIST_DOWNLOAD_ENABLED (bit, nullable)
    • Discontinued (legacy use only).

Due to historical reasons, while this table also contains an “ID” field, media types are referred to in the system using the manually-assigned MIBINDEX field.

This is the ONLY table that uses this convention. Everything else on the system is referred to using the ID field. In most installations, this is not an issue as typically ID and MIBINDEX contain the same values, but there are exceptions.

All Media Types used in the system, even those not exposed to the end-users and only accessed with the .NET library must be present in this table. Again, this is an exception, and other Meta tables in the system only need to include data that needs to be exposed to end-users through the CMS.

ADM_FIELDS

This table describes which fields from a particular table will be editable in the CMS/API, and also how they’ll be exposed.

  • MEDIATYPE (int, not null, relation to MEDIA_TYPES.MIBINDEX)
    • MibIndex of the Media Type this field belongs to.
  • COLUMNNAME (varchar, not null)
    • Name of the column.
  • TYPE (int, not null, enumeration)
    • Display type of the field, values are listed below.
  • READONLY (bit, null)
    • Informs if this field is read-only.
  • ENUMTYPE_ID (int, null, relation to ADM_ENUMTYPES.ID)
    • Only needed if type is Enum (8).
    • Refers to the enumeration values used in this field.
  • RELATEDTABLE (int, null, relation to MEDIA_TYPES.MIBINDEX)
    • Only needed if type is Related (9) or DropRelated (14), which means this column contains a reference to another table.
    • Informs the table this column refers to.
  • RELATEDCOLUMN (varchar, null)
    • Only used if type is Related (9) or DropRelated (14), which means this column contains a reference to another table.
    • Informs the column on the related table the value stored refers to, defaults to “ID”.
  • RELATEDCOLUMNNAME
    • Only used if type is Related (9) or DropRelated (14)
    • Informs the column on the related table used for display in the CMS, defaults to “NAME” .
  • DEFAULT_VALUE
    • Initial value when creating a new record.
  • ORDEREDIT
    • Order in edition pages.
  • ORDERLIST
    • Order in listing pages.
  • REGEX
    • Regex for validation of values.
  • FIELD_DESCRIPTION
    • Longer description for this field, will be displayed as a tooltip near the field name.

The TYPE field corresponds to a value from this enumeration.

  • Varchar = 1
    • Rendered a single-line text field.
  • Text = 2
    • Rendered as a multi-line text field.
  • Html = 3
    • Rendered as a multi-line text field with an HTML editor.
  • Integer = 4
    • Rendered as a short single-line text field with an input mask.
  • Date = 5
    • Rendered as a short single-line text field with a Date picker plugin.
  • DateTime = 6
    • Rendered as a short single-line text field with a Date and Time picker plugin.
  • Source = 7
    • Rendered as a treeview for Source selection, more details in later in the document.
  • Enum = 8
    • Rendered as a dropdown.
  • Related = 9
    • Rendered as a button to select a record from the related table.
  • Boolean = 11
    • Rendered as a dropdown.
  • Long = 12
    • Rendered as a short single-line text field with an input mask.
  • Float = 13
    • Rendered as a short single-line text field with an input mask.
  • DropRelated = 14
    • Rendered as a dropdown containing all records from the related table.
  • PasswordPlain = 15
    • Rendered as a hidden field, data will be stored to the database in plain text, however password security rules will be enforced.
  • Link = 16
    • Rendered identical to varchar in the edition pages, but rendered as a link in the list pages.
  • Time = 17
    • Rendered as a short single-line text field with a Time picker plugin.
  • Hidden = 18
    • Rendered as a hidden field, data will be stored to the database in plain text.
  • Ipv4 = 19
    • Rendered as a short single-line text field with an input mask.
  • UtcDateTime = 20
    • Rendered as a short single-line text field with a Date and Time picker plugin.
  • Keyword = 23
    • Rendered as a tag-style setup with each value saved to the text field with a separator
  • Json = 28
    • Rendered as a Json editor (React) or as a multi-line text field (Legacy).

The following field types are for internal use and should not be used when declaring a Media Type.

  • Password = 10
    • Used in ADM_USERS for the user password, stores a hashed and salted password.
  • OsTimezone = 22
    • Used in ADM_USERS for the user timezone, stores a Windows timezone ID.
  • RowVersion = 21
    • Used to expose rowversion columns from MS-SQL as binary data in the API.

ADM_RELATEDS

This table describes relationships between Media Types.

  • LOCALTABLE (varchar, not null)
    • Left table of the relationship.
  • REMOTETABLE (varchar, not null)
    • Right table of the relationship.
  • ISLINKOBJECT (bit, null)
    • Informs this is a N:N relationship using the LINKOBJECTS table.
  • IS_RELATIONSHIP_TABLE (bit, null)
    • Informs this is a N:N relationship using a custom N:N mapping table.
  • LINKUNIDIRECTIONAL (bit, null)
    • On a LINKOBJECTS-based N:N relation, informs if the relation is treated as unidirectional or bidirectional.
  • REMOTECOLUMN (varchar, null)
    • If the relationship is 1:N, informs the column in the right table used for the relationship.
  • LOCAL_COLUMN (varchar, null)
    • Local column used as key in the relation, defaults to “ID”.
  • RELATIONSHIP_TABLE (varchar, null)
    • Custom relation table for N:N relations.
  • FOREIGNKEY_RELATIONSHIP_TYPE (int, null)
    • On a 1:N relation, informs the type of FK present.
  • REMOVE_BUTTON_BEHAVIOR_TYPE (int, null)
    • On a 1:N relation, informs how the CMS will act when removing the related object.
  • MIB_COPY_TYPE (int, null)
    • Informs how objects from this relationship will be copied when using the Clone functionality of the CMS.
  • ORDERCOLUMN (varchar, null)
    • Determines by which field the values ​​of the relationship table will be ordered. For linked objects you must inform the default value: ID.

The FOREIGNKEY_RELATIONSHIP_TYPE field corresponds to values from this enumeration:

  • NoForeignKey = 0
  • RegularForeignKey = 1
  • CascadeDeleteForeignKey = 2

The REMOVE_BUTTON_BEHAVIOR_TYPE field corresponds to values from this enumeration:

  • SetNull = 0,
  • DoNotAllowRemoval = 1
  • DeleteChildObject = 2

The MIB_COPY_TYPE field corresponds to values from this enumeration:

  • Undefined = 0 (Disables Clone functionality)
  • DoNotCopy = 1
  • UseSameIDs = 2
  • CopyObjects = 3

LINKOBJECTS

The LINKOBJECTS table is a “general use” table for N:N relations. It’s a legacy table, we currently recommend usage of custom N:N tables for each particular relation, but it’s still supported on both the API and the .NET library.

  • VLOCAL (int, not null)
    • ID of the record in the left side of the relation
  • TLOCAL (int, not null)
    • MibIndex of the Media Type in the left side of the relation
  • VREMOTE (int, not null)
    • ID of the record in the right side of the relation
  • TREMOTE (int, not null)
    • MibIndex of the Media Type in the right side of the relation

When querying this table, simply filter by TLOCAL and TREMOTE according to the tables in the relation and select the VLOCAL and TLOCAL values. This will give you the N:N mapping table for this particular relation.

ADM_ENUMTYPES

Describes enumerations used in the CMS interface. This table only contains the default fields for a Media Type.

ADM_ENUMVALUES

Describes the values for a particular enumeration.

  • ENUMTYPE_ID (int, not null, reference to ADM_ENUMTYPES.ID)
    • Reference to the enumeration.
  • VALUE (varchar, not null)
    • Value for this enumeration.
    • On very old MIB2 installations, this field will be integer. This was changed a few years ago to varchar for more flexibility.
  • MIB_ORDER (int, null)
    • If set, allows ordering how the enumeration values will be displayed in the CMS dropdown.

ADM_FILEEXTENSIONS

Describes extensions that we allow uploading to Media-iBox.

  • SOURCETABLE (int, not null)
    • MibIndex for the Media Type this extension will be uploaded to.
  • TYPE (int, not null, enumeration)
    • Type of file, may trigger additional behavior from MIB.
  • TITLE (varchar, not null)
    • User-friendly name for this record.

For this particular table, it’s required that the NAME column be the file extension, including the “dot”. An example record for this table would be.

NAME = ‘.jpg’ 
SOURCETABLE = MibIndex for “IMAGES” 
TYPE = 1 
TITLE = ‘JPEG Image’

The TYPE field corresponds to values from this enumeration:

  • Document = 0
  • Image = 1
  • Video = 2

If Type = Image, MIB will attempt to extract Width and Height from the file and save them to the column.

If Type = Movie, MIB will attempt to extract Width, Height and Duration from file and save them to the column. Notice that this is dependant on the Directshow video codecs installed on the server, and also that this only applies to single-file medias (MP4, MOV, WMV). This behavior is skipped for mutil-file medias such as Smooth Streaming, DASH and HLS packages.

Edit this page