Web application admin metadata for /api/crud/v1
Table of Contents
Location path
| Path in the assembly catalog | Assignment |
|---|---|
|
|
|
Overview
Metadata file for the "Object Administration" web application". Defines the structure of object classes to be administered in the application and the composition of their fields. For each field, defines the value types and constraints, as well as the control applied for editing.
Provides the web application with a description of the correct up-to-date representation of the entities being edited.
Pending editing via API /api/crud/v1/<OBJECT>/<METHOD> where <METHOD> takes the values create, read, update, delete and metadata.
The "Incoplax" is not used directly by the system, it is only used for output via API. On this basis, the content of the files is arbitrary, including the internal structure.
It is deprecated for use in REST.
Entity list
A list of entities that can be edited in the domain through the administration web application.
Each of these types should have a separate file in the objects folder describing the composition of the fields to be migrated.
Must be named identically to the name of the entity type available via API /api/crud/v1/<OBJECT>/<METHOD>.
Format:
[
{
"object": str,
"name": str,
"order": int,
"params": {
"sub": {
"ref": str,
"type": str
}
}
},
...
]
-
object– entity type name in API/api/crud/v1/<OBJECT>/<METHOD>. -
name– header in the navigation bar of the web application. -
order– order in the navigation bar of the web application. -
params– object-list of additional parameters. Key - parameter name, value –
Specific entity descriptor
Defines the composition of fields, their order, display and editing methods, value types and restrictions for values.
Format:
{
"id_field": str,
"key_field": str,
"label_fields": array<str>,
"fields": object,
"filters: array<str>,
"composites": array<str>
}
-
id_field– name of the identifier field. -
key_field– The name of the key field that supports uniqueness. -
label_fields– A list of field names containing the names and titles required for human display and identification. -
fields– object-list of fields -
filters– list of field names to be filtered. -
composites– list of composite field names.
Example for domain.json:
{
"id_field": "id",
"key_field": "name",
"label_fields": [
"name"
],
"fields": {
"id": {
"title": "id",
"view": {
"viewName": "id",
"viewParams": {
"disabled": true
}
},
"hidden": true,
"order": 50
},
"name": {
"title": "Domain name",
"descr": "The name of the first level FC. The name must be entered in the cfg file of the main configuration",
"view": {
"viewName": "text",
"viewParams": {}
},
"order": 100
},
"solution": {
"title": "Domain type",
"descr": "Domain type",
"view": {
"viewName": "select",
"viewParams": {
"items": [
{
"title": "Omni-channel communications",
"value": "oce"
},
{
"title": "IP-ATC",
"value": "sipssw"
},
{
"title": "License management",
"value": "submaster"
},
{
"title": "Alert system",
"value": "alert"
},
{
"title": "Single queue",
"value": "ssq"
}
]
}
},
"default": "oce",
"order": 105
},
"template": {
"title": "Copy from CD",
"view": {
"viewName": "domains",
"viewParams": {}
},
"order": 120,
"hidden": false
},
"seperateLicSIP": {
"view": {
"viewName": "separator",
"viewParams": {
"title": "Licenses SIP"
}
},
"order": 200
},
"seperateLicScript": {
"view": {
"viewName": "separator",
"viewParams": {
"title": "Licenses Scripts"
}
},
"order": 300
},
"seperateLicWebservice": {
"view": {
"viewName": "separator",
"viewParams": {
"title": "Licenses WebService"
}
},
"order": 400
},
"seperateLicHunt": {
"view": {
"viewName": "separator",
"viewParams": {
"title": "Queue Licenses"
}
},
"order": 500
},
"seperateLicCommon": {
"view": {
"viewName": "separator",
"viewParams": {
"title": "Licenses of Subsidiary CDs"
}
},
"order": 600
},
"lic": {
"type": "fields",
"fields": {
"devices": {
"title": "Internal SIP devices",
"descr": "Maximum number of simultaneously registered SIP devices",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 210
},
"siptrunks": {
"title": "External SIP channels",
"descr": "Maximum number of external SIP channels",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 220
},
"ivrscripts": {
"title": "Scenarios IVR",
"descr": "Maximum number of created IVR scripts",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 320
},
"svcscripts": {
"title": "Scenarios SVC",
"descr": "Maximum number of created SVC scenarios",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 310
},
"webservice_public": {
"title": "Public channel WebService",
"descr": "Maximum number of public integration channels to be connected WebService",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 410
},
"webservice_subscr": {
"title": "Event subscription channel Web Eventing",
"descr": "Maximum number of external systems allowed to subscribe to events",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 420
}
"webservice_telegram": {
"title": "External channel Telegram",
"descr": "Maximum number of preconfigured channels to be connected Telegram",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 440
},
"domains": {
"title": "Total domains",
"descr": "Maximum number of child CDs regardless of the base product",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 610
},
"solution_oce": {
"title": "Subsidiary CDs by type Omnicanal Communications",
"descr": "Maximum number of child CDs with the ICS domain type",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 615
},
"solution_sipssw": {
"title": "Subsidiary CDs by domain type IP-ATC",
"descr": "Maximum number of child CDs with domain type IP-ATC",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 616
},
"solution_submaster": {
"title": "Subsidiary CDs by domain type License management",
"descr": "Maximum number of child CDs with the License Management domain type",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 618
},
"solution_alert": {
"title": "Subsidiary CDs by domain type Notification system",
"descr": "Maximum number of child CDs with the Alarm system domain type",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 619
},
"solution_ssq": {
"title": "Subsidiary CDs by domain type Single queue",
"descr": "Maximum number of child CDs with domain type Single queue",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 621
},
"userqueue": {
"title": "Operators in chat queues",
"descr": "Maximum number of users (user) that can be assigned to service text queues",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 520
},
"sipqueue": {
"title": "Operators in voice queues",
"descr": "Maximum number of internal numbers (sipuser) that can be assigned to voice queue service",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 510
}
}
},
"seperateDoS": {
"view": {
"viewName": "separator",
"viewParams": {
"title": "Security parameters"
}
},
"order": 700
},
"seperateComment": {
"view": {
"viewName": "separator",
"viewParams": {
"title": "Comments"
}
},
"order": 800
},
"opts": {
"type": "fields",
"fields": {
"script_allow_global_variables": {
"title": "Allow the use of global variables",
"descr": "Defines access to the 'Global Shared' variable type. If prohibited, applies to all child domains.",
"view": {
"viewName": "toggle",
"viewParams": {}
},
"default": true,
"order": 710
},
"script_pause_between_components": {
"title": "Additional delay between scenario components, ms",
"descr": "The average timeout between script component executions. Default is unbounded (0). Cannot be set less than the parent domain.",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": 0,
"order": 740
},
"script_limit_component_count": {
"title": "Maximum executable components in a scenario (-1 = unlimited)",
"descr": "The number of executable components in each running scenario instance. Nested ones are counted separately. When interrupted, 200 components are added for the post-processing branch. Cannot be set to more than in the parent domain. Not limited by default (-1)",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": -1,
"order": 730
},
"script_duration_sec": {
"title": "Maximum duration of a scenario instance, sec (-1 = unlimited)",
"descr": "The duration of the script execution in seconds, including all nested scripts. Defaults to unlimited (-1). Cannot be set longer than the parent domain. If exceeded, it gives another 60 seconds to execute the post-processing branch.",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": -1,
"order": 750
},
"script_limit_site_count": {
"title": "Maximum of simultaneously running CD scenarios on the site (-1 = unlimited)",
"descr": "Limits the number of executable scripts per domain per site. The default is no limit (-1). Cannot be assigned to more than the parent domain.",
"view": {
"viewName": "number",
"viewParams": {}
},
"default": -1,
"order": 720
},
"comment": {
"title": "Comments",
"view": {
"viewName": "textarea",
"viewParams": {
"line": 3
}
},
"default": "",
"order": 810
}
}
}
},
"filters": [
"id",
"solution",
"title",
"dbdefaultconn",
"dbhost",
"dbport",
"dblogin",
"dbpwd",
"lic",
"opts"
],
"composites": [
"lic",
"opts"
]
}