Role application (roleapp)

Description

Descriptor of a web application installed by an administrator in a «Incoplax» domain and available to domain users through the web interface. Users who can access the application are determined by the intersection of roles assigned to the user and in the role application descriptor.

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

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

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

Display name of the application in the root web application manager.

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

Installation folder of the role application.
Application

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

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

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

List of user roles that can access the application.

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

Code of the service script run to process incoming HTTP requests from the application to the /exec page.

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.recv_timeout
Mode: in
Type: int
Default: 0

Maximum svcscript execution time in seconds. 0 means the value determined by the web server is used (10 sec.). The maximum allowed value is 60 sec.

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

Whether the role application is visible in the root application for users

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

Attachment file metadata

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

See also

Logical roles

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

  • ws hosts applications and provides the API interface for them, including authorization.