Domain (domain)

Description

A data structure element that defines the boundaries between data within the deployed «Incoplax» system.
Domains form a hierarchical domain tree where each child domain inherits the name of its parent domain.

The system’s operating logic uses domains and the objects belonging to them when implementing functionality and determining access for individual users. Any object accessible from outside through the API belongs to some domain. In particular, any system user belongs to one specific domain and can operate only on data within the domain. All data within a domain is closed by default. An entity belonging to one domain cannot belong to another domain. With rare exceptions in the vertical hierarchy, domains, their users, processes, and objects do not have access to each other’s data.

Domains participate in the distribution of quantitative licenses across the tree. Each domain reserves part of the licenses received from its parent domain for its own use and can pass the rest to child domains.

Limitations

  • The collection is available in any domain.

  • Licensed by a quantitative parameter: a license is consumed for domains.

Fields

Entity structure
{
  "id": uuid,
  "name": str,
  "dbdefaultconn": int,
  "dbhost": str,
  "dbport": int,
  "dblogin": str,
  "dbpwd": str,
  "lic": object,
  "opts": {
    "title": str,
    "comment": str,
    "isblocked": bool,
    "script_pause_between_components": int,
    "script_limit_component_count": int,
    "script_limit_site_count": int,
    "script_duration_sec": int,
    "script_allow_global_variables": bool
  },
  "ext": {
    "ct": date,
    "lwt": date
  }
}
Table 1. Fields
Specification Description

Field: id
Mode: inout
Type: uuid
Default: generated

Identifier. Can be specified at creation, otherwise generated by the system.

Field: name
Mode: in
Type: str
Default: required

Domain name. Must match the parent domain name (under special conditions, except first-level domains). Follows FQDN rules but prohibits uppercase letters. Allowed characters: [a-z0-9_-.]

Field: lic
Mode: in
Type: object
Default: generated

Composition of quantitative licenses issued to the child domain from the current domain’s free licenses.
The available amount of free licenses of each type in a domain is determined as X = Total – Owned – Sub, where Total is the number of licenses received from the parent domain, Owned is the number of licenses reserved for own needs, and Sub is the number of licenses passed to child domains.
More about licenses.

Field: dbdefaultconn
Mode: in
Type: int
Default: 1

Service field. Not used.

Field: dbhost
Mode: in
Type: str
Default: empty

Service field. Not used.

Field: dbport
Mode: in
Type: int
Default: empty

Service field. Not used.

Field: dblogin
Mode: in
Type: str
Default: empty

Service field. Not used.

Field: dbpwd
Mode: in
Type: str
Default: empty

Service field. Not used.
Secret: plaintext when read; via the mcp channel it is returned as the mask *****; not encrypted with the installation key (Encryption and keys).

Field: opts
Mode: in
Type: object
Compound field

Field: opts.title
Mode: in
Type: str
Default: empty

Arbitrary title

Field: opts.comment
Mode: in
Type: str
Default: empty

Arbitrary comment

Field: opts.isblocked
Mode: in
Type: bool
Default: false

Domain enable/disable

Field: opts.script_pause_between_components
Mode: in
Type: int
Default: 0

Script execution limit: pause between script components, in milliseconds.

Field: opts.script_limit_component_count
Mode: in
Type: int
Default: -1

Script execution limit: maximum number of components executed in a script handler.

Field: opts.script_duration_sec
Mode: in
Type: int
Default: -1

Script execution limit: maximum script execution duration within the domain, in seconds.

Field: opts.script_limit_site_count
Mode: in
Type: int
Default: -1

(Not used) Script execution limit: maximum number of simultaneously executing scripts in the domain on one site.

Field: opts.script_allow_global_variables
Mode: in
Type: bool
Default: true

(Not used) Script execution limit: whether global variables may be used within the domain.
If disabled, they cannot be selected in the script editor application.

Field: ext
Mode: inout
Type: object
Compound field

Allows extending the compound with arbitrary keys and values

Field: ext.ct
Mode: out
Type: date
Default: generated

Object creation time

Field: ext.lwt
Mode: out
Type: date
Default: generated

Time of last modification of the object

Field: ext.licblocked
Mode: out
Type: bool

Domain is blocked because it does not fit the license (not persisted; removed when the license is increased or the administrator clears opts.isblocked)