Skip to main content
Version: 2.2.0

Class Diagram

Class Diagram

attachment

  • The attachment table is used to store the attachments metadata and the file information.
NameTypeDescription
iduuid.UUIDThe id of the attachment.
file_namestringThe name of the file, include the extension.
file_sizeint64The size of the file in bytes.
mime_typestringThe MIME type of the file.
storage_keystringThe key of the file in the storage.
descriptionstringThe description of the attachment.
is_activeboolWhether the attachment is active.
scan_statusstringThe status of the scan, for example: pending, success, failed, and NA when the scan is not enabled.
index_statusstringThe status of the index, for example: pending, success, failed, and NA when the index is not enabled.
modulestringThe module of the attachment, for example: resource, task, document
entity_iduuid.UUIDThe reference to the entity this row belongs to
entity_typestringThe type of the entity this row belongs to
checksumstringThe checksum when the file is uploaded.
tenant_idstringThe reference to the tenant this row belongs to
occ_lockintThis integer must match on all update queries to ensure the user is not trying to update a row with outdated data.
created_attime.TimeThe UTC timestamp when this record was first created.
created_bystringThe reference to the user who created this record
updated_attime.TimeThe UTC timestamp when this record was last updated, use database triggers.
updated_bystringThe reference to the user who last modified this record
deleted_attime.TimeThe UTC timestamp when this record was deleted.

data_access

  • Data Access can be associated with Attachment to restrict access by the users to specific attachment.
  • When Data Access entry is created for an Attachment, Attachment Management Module will restrict user access at the functional level and data level, i.e., the user will need to have both function access right and data access right.
NameTypeDescription
attachment_iduuid.UUIDThe reference to the attachment this row belongs to
resource_namestringThe name of the resource
scopestringThe scope of the data access, for example: edit, view
created_attime.TimeThe UTC timestamp when this record was first created.
created_bystringThe reference to the user who created this record
updated_attime.TimeThe UTC timestamp when this record was last updated, use database triggers.
updated_bystringThe reference to the user who last modified this record

secure_download_id

  • The secure download id is used to generate a secure download link for the attachment.
  • Each attachment can have multiple secure download ids, and each secure download id is only valid for user who generated the secure download id.
NameTypeDescription
attachment_iduuid.UUIDThe reference to the attachment this row belongs to
download_iduuid.UUIDThe download id
user_iduuid.UUIDThe reference to the user this row belongs to
expire_attime.TimeThe UTC timestamp when this record will expire

attachment_tag

  • The attachment tag is used to tag the attachment with a tag.
NameTypeDescription
attachment_iduuid.UUIDThe reference to the attachment this row belongs to
tag_iduuid.UUIDThe reference to the tag this row belongs to
created_attime.TimeThe UTC timestamp when this record was first created.