Go to documentation repository
The settings panel of the Web server 2.0 system object is shown in the figures.
The Events subscription tab:
The HTTPS settings tab:
Table describes the setting parameters of the Web-server 2.0 system object.
No. | Parameter | Method for setting the parameter value | Parameter description | Representation | Default value | Value range |
1 | Identification number | Automatically | Displays the identification number of the Web server 2.0 system object in the system | Sequence of numbers | - | Depends on the number of the Web server 2.0 objects in the system |
2 | Name | Enter the value into the field | Sets the name of the Web server 2.0 object in the system | Latin, Cyrillic and service characters | Web-server 2.0 | A line containing a sequence of any characters (letters, digits, service characters except > and < characters), case-insensitive. Number of characters—from 1 to 60 |
3 | Disable | Set the checkbox | Sets the state (enabled or disabled) of the Web server 2.0 object in the system | Boolean | Clear | Set—the Web server 2.0 object is disabled and isn't used Clear—the Web server 2.0 object is enabled and used |
4 | Computer | Select the value from the list | Sets the Computer parent object for the given Web server 2.0 object | Name of the Computer objects registered in the system | Name of the Computer parent object | Depends on the number of the Computer objects in the system |
5 | Web-server | Select the value from the list | Sets the Web-server object whose settings will be used for the Web-server 2.0 operation | Names of the Web-server objects registered in the system | - | Depends on the number of the Web-server objects registered in the system |
6 | Maps | Set the checkbox | Sets the list of Maps used by the Web-server 2.0 module and available on the mobile clients | Names of the Map objects registered in the system | No maps is selected | Depends on the number of the Map objects registered in the system |
7 | Apply changes immediately | Set the checkbox | Enables the function to apply the changes to the user rights immediately | Boolean type | Clear | Set—the Web-server 2.0 object will immediately apply the changes to the user rights Clear—when user rights are changed, access rights are not changed in the Web-server 2.0 object until the Apply button is clicked on the settings panel of the Web-server 2.0 object or Axxon PSIM is restarted |
8 | Response type "JSON" by default | Set the checkbox | Sets the default HTTP API response type | Boolean type | Clear | Set—the response is sent in the JSON format if the format is not specified explicitly in the request Clear—the response is sent in the XML format if the format is not specified explicitly in the request |
9 | User permissions | Select the value from the list | Sets the User permissions object for which the events filter is configured | Names of the User permissions objects registered in the system | - | Depends on the number of the User permissions objects registered in the system |
10 | Object type | Select the value from the list | Sets the type of objects the events from which are sent to the clients | Names of the types of objects registered in the system that are included in the selected user rights | - | Depends on the selected user rights |
11 | Name | Select the value from the list | Sets the name of object the events from which are sent to the clients | Names of the objects of the selected type that are registered in the system | - | Depends on the number of objects of the selected type that are registered in the system |
12 | Event | Select the value from the list | Sets the event type that should be sent to the clients | Names of the events that are available for the objects of the selected type | - | Depends on the selected object type |
13 | Add. info | Enter the value into the field | You can enter the additional information about the event that should be sent into the field | Latin, Cyrillic and service characters | - | - |
14 | Push-messages | Set the checkbox | Specifies whether to send push messages to the clients about the events of the selected type | Boolean | Clear | Set—push-messages are sent Clear—push-messages aren't sent |
15 | Use HTTPS protocol | Set the checkbox | Enables the use of the HTTPS protocol when transferring data via the Web-server 2.0 | Boolean | Clear | Set—the HTTPS protocol is used Clear—the HTTPS protocol isn't used |
16 | Key | Enter the value into the field | Sets the path to the key file for transferring data over the HTTPS protocol | Latin, Cyrillic and service characters | No | Depends on the location of the key for encrypting data when transferring data over the HTTPS protocol |
17 | Certificate | Enter the value into the field | Sets the path to the certificate file for transferring data over the HTTPS protocol | Latin, Cyrillic and service characters | No | Depends on the location of the certificate file when transferring data over the HTTPS protocol |