Skip to main content

records

Module: main

Activity feed records with comments, files, and monitor entries.

Meta data

You can utilize the meta column to store additional meta data about the site or element you are referencing - this works similar to Twitter Cards or Facebook's Open Graph API.

The following attributes are supported

Parameter nameDescription
urlThe website URL
siteThe website name
titleThe website title
descriptionContent description
imagePreview image
videoEmbedded video
iconIcon for external application 16x16px

Monitor entries

Records are also being used to store information about changes that occured with the related object. Those records are flagged as "Monitor entry" (flag: 3)

The record text represents the changeset that occured. The text value consists of the following elements:

Text
{ACTION} {entity} {index} {name}

For instance, when an object (in the following example a "task") is created, ZeyOS automatically creates a record with the following text:

Text
CREATE tasks 123 Sample task

The following action labels exist:

  • CREATE
  • MODIFY
  • DELETE
  • ACTIVATE
  • DEACTIVATE
  • ARCHIVE
  • RESTORE
NameTypeNullableDefault ValueNotes
PKID
bigintRecord ID
fork
forks.ID
integerFork ID (`null` for base module); inherited from entity
owneruser
users.ID
integerOwner user ID (PUBLIC if `owneruser`=`null` and `ownergroup`=`null`)
ownergroup
groups.ID
integerOwner group ID (PUBLIC if `owneruser`=`null` and `ownergroup`=`null`)
creator
integerCreator user ID (defaults to authenticated user on creation)
assigneduser
users.ID
integerAssigned user (recipient) ID; must be distinct from `creator`
creationdate
bigintdate_part('epoch', now())Creation date and time as a Unix timestamp (defaults to current date and time on creation)
lastmodified
bigintdate_part('epoch', now())Last modification date and time as a Unix timestamp (auto-reset on modification)
entity
t_entityCanonical entity
index
integerEntity ID; is required if `entity` is not `null`, otherwise must be `null`
channel
channels.ID
integerChannel ID
flag
smallint0Flag (`0`=REGULAR, `1`=ASSOCONLY, `2`=MINDLOGONLY, `3`=MONITOR, `4`=FEED); must be REGULAR or FEED if `entity` is `null`
date
bigintdate_part('epoch', now())Designated date and time as a Unix timestamp (defaults to current date and time on creation)
stickydate
bigintSticky date and time as a Unix timestamp
sender
text''Sender
location
text''Location (e.g. coordinates)
text
text''Record text (Markdown for rich text representation)
meta
jsonJSON-encoded metadata (object)
NameUniqueNulls DistinctPrimaryPartialMethodKeys
fk_records_assigneduserginassigneduser
fk_records_channelbtreechannel
fk_records_forkginfork
fk_records_ownergroupginownergroup
fk_records_owneruserginowneruser
i_records_creatorgincreator
i_records_datebtreedate
i_records_entity_indexbtreeentity, index
i_records_noownerginownergroup
i_records_stickydatebtreestickydate
pk_recordsbtreeID
s_records_senderginsender
s_records_textgintext
NameType
c_records_associationcheck
c_records_ownercheck
dc_records_flagcheck
dc_records_locationcheck
dc_records_metacheck
dc_records_sendercheck
dc_records_textcheck
fk_records_assigneduserforeign_key
fk_records_channelforeign_key
fk_records_forkforeign_key
fk_records_ownergroupforeign_key
fk_records_owneruserforeign_key
pk_recordsprimary_key
Loading...