Go to documentation repository
The settings panel of the Web server 2.0 system object is shown in the figures. The table describes the setting parameters of the Web-server 2.0 system object.
The Events subscription tab:
No. | Parameter | Method for setting the parameter value | Parameter description | Representation | Default value | Value range |
1 | The Identification number* | Automatically | Displays the identification number of the Web server 2.0 system object | Sequence of numbers | NA | From 1 to 2147483647. Depends on the number of the Web server 2.0 objects in the video surveillance system with the distributed architecture |
2 | The Name* | Enter the value in the field | Sets the name of the Web server 2.0 object in the video surveillance system with the distributed architecture | Latin alphabet, Cyrillic, digits 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 | The Disable | Set the checkbox | Disables the Web server 2.0 object in the video surveillance system with the distributed architecture | 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 | The Computer | Select the value from the list | Sets the Computer parent object for the given Web server 2.0 object | Names 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 | The Web-server drop-down list | Select the value from the list | Sets the Web-server object whose settings must be used for the operation of the Web-server 2.0 | Names of the Web-server objects registered in the system | NA | Depends on the number of the Web-server objects registered in the system |
6 | The Maps | Select the value from the list | 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 | NA | Depends on the number of the Map objects registered in the system |
7 | The Apply changes immediately checkbox | Set the checkbox | Enables the function to apply the changes to the user permissions immediately | Boolean type | Clear | Set—the Web-server 2.0 object will immediately apply changes to the user permissions Clear—when user permissions are changed (adding or removing permissions to objects in permissions/from permissions), access permissions aren't 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 | The Response type "JSON" by default checkbox | 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 isn't specified explicitly in the request Clear—the response is sent in the XML format if the format isn't specified explicitly in the request |
9 | The 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 | NA | Depends on the number of the User permissions objects registered in the system |
10 | The Object type | Select the value from the list | Sets the type of objects the events from which must be sent to the clients | Names of the types of objects registered in the system that are allowed by the selected user permissions | NA | Depends on the selected user permissions |
11 | The Name | Select the value from the list | Sets the name of the object the events from which must be sent to the clients | Names of the objects of the selected type that are registered in the system | NA | Depends on the number of objects of the selected type that are registered in the system |
12 | The Event | Select the value from the list | Sets the event type that must be sent to the clients | Names of the events that are available for the objects of the selected type | NA | Depends on the selected object type |
13 | The Add. info list | Enter the value in the field | Enters an additional information about the transmitted event in the field | Latin alphabet, Cyrillic, digits and service characters | NA | A line containing a sequence of any characters (letters, digits, service characters) |
14 | The Push-messages | Set the checkbox | Specifies whether to send push messages about the events of the selected type | Boolean | Clear | Set—push-messages are sent Clear—push-messages aren't sent |
The HTTPS settings tab:
No. | Parameter | Method for setting the parameter value | Parameter description | Representation | Default value | Value range |
1 | The Use HTTPS protocol checkbox | 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 |
2 | The Key field | Enter the value in the field | Specifies the path to the key file for transferring data over the HTTPS protocol | Latin alphabet, Cyrillic, and service characters | Clear | Depends on the location of the key for encrypting data when you transfer data over the HTTPS protocol |
The Select file button* | Click the button | Sets the path to the key file for transferring data over the HTTPS protocol | NA | NA | NA | |
3 | The Certificate field | Enter the value in the field | Specifies the path to the certificate file for transferring data over the HTTPS protocol | Latin alphabet, Cyrillic, and service characters | Clear | Depends on the location of the certificate file when you transfer data over the HTTPS protocol |
The Select file button* | Click the button | Sets the path to the certificate file for transferring data over the HTTPS protocol | NA | NA | NA |
*Name of the element isn't displayed in the settings panel of the given object