Role application (roleapp)

Description

Descriptor of a web application that is installed by the administrator in the "Incoplax" system domain and is available to domain users through the web interface. The users to whom the application is available are defined by the intersection of the roles assigned to the user and in the role application descriptor.

The web application itself is created separately to solve a specific business problem, then packaged into an archive. An archive is attached to the created descriptor (uploaded via the API).

An application can use the system’s API to solve its tasks. The application has access to those REST API-endpoints that are allowed by IAM to the currently logged in user. The application also has access to API via URL "/exec" to execute custom methods implemented at the project level (running a service script of a role application).

Limitations

  • The collection is available in any domain.

Fields

Entity structure
{
  "id": uuid,
  "title": str,
  "archive": {
    "_links": {
      "self": {
        "href": str
      }
    }
  },
  "folder": str,
  "roles": array<str>,
  "svcscriptcode": str,
  "opts": {
    "title": str,
    "comment": str,
    "recv_timeout": int,
    "visible": bool,
    "attachment_info": object
  },
  "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: title
Mode: in
Type: str
Default: empty

Displayed application name in the root web application manager.

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

Role Application Installation Folder.
appendix

Field: archive
Mode: out
Type: object
Default: generated

Constant link to archive file URL.
{"_links": {"self": {"href": "/rest/v1/domain/roleapps/<id>/attachment"}}}
The identifier of the given object is substituted in place of <id>.

Field: roles
Mode: in
Type: array<str>
Default: empty

List of user roles to which the application is available.

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

The code of the service script that is run to process incoming HTTP requests from the application to the page /exec.

Field: opts
Mode: in
Type: object
Composite field

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

Arbitrary header

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

Arbitrary comment

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

Maximum svcscript execution time in seconds. 0 means that the value defined by the web server (10 seconds) will be applied. The maximum allowed value is 60 sec.

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

Indication that the role application is visible in the root application to users

Field: opts.attachment_info
Mode: out
Type: object
Default: empty

Attachment file metadata

Field: ext
Mode: inout
Type: object
Compound field

Allows you to extend 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

See also

Logical roles

  • mware manages the transfer of correctly downloaded applications to the web server.

  • ws Hosts applications and provides an API interface to them, including authorization.