Skip to content
DatAscend

System entities

What are system entities?

System entities are all internal entities required for the application to work, for example: user and permissions entities. These entities work similarly to the rest of entities on the application, but they do not use jsonb columns and are only editable via their respective endpoints (normal entity/ endpoints can’t be used)

List of system entities

  • action: List of action that any permission has. Default are Manage, Get, Update, Create and Delete.
  • address: Address belonging to a person.
  • category_menu: List of categories that group menus. Ej: If there is a “menu” for each country in a list of countries, the category_menu would be “Countries”.
  • custom_queries: Custom queries that can be stored on the database to be used at a later time. These queries can retrieve data from the entities using generated sql based on the queries.
  • custom_view: Custom views store filters, groups or sorts for any group of entities and allow to use those views later.
  • domain: List of domains. Domain are logical ways of separating the data in a hierarchical way. Ej: For an store with three locations, each location could be a domain.
  • menu: List of menus. Menus are used to display different entities depending on a role.
  • menu_has_category_menu: relation between menus and categories for menus.
  • object: List of all (system and internal) entities.
  • object_has_custom_view: Relation between objects and custom views.
  • permission: Relation between objects and the actions that can be executed on them. Ej: An entity “car” can be “updated”.
  • person: Personal information of an user.
  • phone_number: Phone information.
  • phone_type: List of phone types. Defaults are home, mobile, work, fax and other.
  • role: List of roles an user can have. The roles an user has define what permissions they have.
  • role_domain: Relation between roles and domains. Access to a certain domain can be restricted via roles.
  • role_has_category_menu: Relation between roles and menu categories. Access to certain menu categories can be restricted via roles.
  • role_has_object: Relation between roles and objects (also includes if relation has a view). Access to certain objects can be restricted via roles.
  • role_has_permission: Relation between roles and permissions. Each role has certain permissions attached.
  • session: Client sessions on the application.
  • state: List of logical states. Logical states are used to store possible actions that can be executed on an entity with that state
  • user: List of users.
  • user_domain: Relation between users and domains. Users can created and restricted to a certain domain.
  • user_log: List of logs that an user has created.
  • user_role: Relation between user and roles. Users will be assigned a role that handles most of what they can do in the app.