No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

eSight V300R010C00SPC200, 300, and 500 Self-Service Integration Guide 10

Rate and give feedback:
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
Preparing for Web Message Notification

Preparing for Web Message Notification

To receive web message notifications from eSight, a third-party system must serve as a web server to implement the web Servlet processing message notification requests, receive HTTPS or HTTP requests, and respond with execution results.

Invoke an open API login interface as an OpenAPI user to log in to eSight and obtain the openID. Subscribe to message notification to be received. Subscription messages must carry the third-party systemID, web Servlet URL for receiving and processing message notifications, and openID for the third-party system to authenticate validity of received request messages.

Figure 3-6 Web message notification process
  1. A subscription interface must carry the systemID that allows eSight to identify the third-party system. If a third-party system invokes eSight resources twice with the same systemID to change the subscription interface, the second invoking is used to update subscription information.
  2. When information about the third-party system changes, resubscribe to the web message notification interface, which only updates subscription information. Messages cached in the to-be-sent message queue are not discarded. The third-party system needs to ensure validity of the URL and openID carried in received web message notifications.
  3. Messages that carry the systemID can be pushed to all clients with the systemID. If each client wants to focus on the contents of itself, specify filter criteria and domain sites for message notification when subscribing to messages. If domain sites are not specified, messages are pushed by systemID.
  4. When the third-party system does not want to process message notifications of a type or wants to clear messages to be sent by eSight, the third-party system needs to unsubscribe the interface. Then eSight clears messages on the original subscription interface and all messages in the to-be-sent message queue. The third-party system will not receive change notifications of such resources from eSight.
  5. When a message is unsubscribed, the messages with the push service for the messages with the same systemID will be canceled on all domain sites.
  6. eSight uses HTTPS or HTTP to send change notifications to third-party systems. If the URL of received message notifications registered on the interface subscribed by the third-party system is in HTTPS format, eSight and the third-party system set up an SSL connection in anonymous authentication mode, and the data field in HTTP packets is not encrypted. Data security is ensured by transmission channel encryption of HTTP packets. If the URL of received message notifications is in HTTP mode, the eSight does not encrypt the notifications by default, but allows users to configure http-encryption.key and http-encryption.iv to encrypt the data fields in HTTP packets using the AES128 algorithm. The third-party system must decrypt the received data.
    1. Choose System > System Settings > Northbound Integration from the main menu.
    2. In the navigation tree, select Local System Settings. Configure System ID, System name, and Notification Parameters.
    3. In the navigation tree, select Third-party System Settings and select the HTTP protocol. The IP addresses of the third-party systems are written to the ip-white-list-openapi.properties whitelist, and the system nodes with system IDs being NMSinfo1-20 are generated. The third-party systems can subscribe for eSight notifications by using the IDs.
    In addition, you can configure <Installation directory>/eSight/etc/oms.ros/ros.web.notification.xml to send change notifications to third-party systems.
    Table 3-3 Configuration items in ros.web.notification.xml

    Parameter

    Description

    Mandatory/Optional

    Setting

    Effective Mode

    enable-ip-white-list

    Indicates whether to enable the IP address whitelist to allow eSight to send message notifications to IP addresses in the whitelist. This IP address whitelist is also used by open APIs. The configuration file is in <Installation directory>/eSight/etc/iemp.framework/ip.white.list/ip-white-list-openapi.properties.

    NOTE:

    The changed whitelist configuration file takes effect immediately after being saved, without the need to restart eSight.

    Mandatory

    Data type: Boolean

    Value range: true or false

    Default value: true

    Restart

    http-encryption.key

    Indicates the AES128 key for encrypting the data field in HTTP packets sent by the third-party system in plain text. The key is a hexadecimal 128-bit character string.

    The key is stored in cipher text in the configuration file. If the default password before encryption is changed, use the <Installation directory>/eSight/tools/bmetool/encrypt/encrypt.bat or <Installation directory>/eSight/tools/bmetool/encrypt/encrypt.sh file to encrypt the new password and update the configuration file. The character string of password before encryption must contain digits, uppercase letters (A to Z), and lowercase letters (a to z).

    For example:

    The value for @010200000000d63c07cfbe4c8edefb0b602cb8d749e487f4d57ffad38a90050655d3866b2ed8e316ef4ae895b415e86c2de822e20fe83547d6948be070bd5fd31c9b4c97a447 before encryption is E5DF96DE53ED56CBAE25368624DC25af.

    Optional

    Data type: String

    Value range: 6 to 32 characters

    Per-character value: digits (0-9), lowercase letters (a-z) and uppercase letters (A-Z)

    Default value: no default value

    NOTE:

    The preceding value range is for the value before encryption.

    Restart

    http-encryption.iv

    Indicates the AES128 Random number generator (RNG) iv for encrypting the data field in HTTP packets sent by the third-party system in plain text. The key is a hexadecimal 128-bit character string.

    The key is stored in cipher text in the configuration file. If the default IV value of password before encryption is changed, use the <Installation directory>/eSight/tools/bmetool/encrypt/encrypt.bat or <Installation directory>/eSight/tools/bmetool/encrypt/encrypt.sh file to encrypt the new IV value and update the configuration file. The character string of password before encryption must contain digits, uppercase letters (A to Z), and lowercase letters (a to z).

    For example:

    The value for @010200000000d63c07cfbe4c8edefb0b602cb8d749e487f4d57ffad38a90050655d3866b2ed8e316ef4ae895b415e86c2de822e20fe83547d6948be070bd5fd31c9b4c97a447 before encyrption is E5DF96DE53ED56CBAE25368624DC25af.

    Optional

    Data type: String

    Value range: 6 to 32 characters

    Per-character value: digits (0-9), lowercase letters (a-z) and uppercase letters (A-Z)

    Default value: no default value

    NOTE:

    The preceding value range is for the value before encryption.

    Restart

    message-queue.queue.size

    Indicates the maximum length of the to-be-sent message queue in a third-party system.

    Mandatory

    Data type: Integer

    Value range: 1 to 30000

    Default value: 20000

    Restart

    message-queue.queue.overflow.alarm-threshold-percent

    Indicates the overflow prewarning threshold of the to-be-sent message queue in a third-party system, in percentages.

    Mandatory

    Data type: Integer

    Value range: 1 to 100

    Default value: 95

    Restart

    message-queue.queue.overflow.strategy

    Indicates the policy for processing messages after the to-be-sent message queue overflows.

    Mandatory

    Data type: Enumeration

    Value range: discard_new_event and store_in_temp_file

    Default value: discard_new_event

    Restart

    message-queue.sender.response-timeout-second

    Indicates the timeout period for sending message notifications to third-party systems, in seconds.

    Mandatory

    Data type: Integer

    Value range: 1 to 60

    Default value: 3

    Restart

    message-queue.sender.retry-times

    Indicates the number of times message notifications are resent to third-party systems.

    Mandatory

    Data type: Integer

    Value range: 1 to 10

    Default value: 3

    Restart

    message-queue.sender.send-interval-millisecond

    Indicates the interval for sending continuous message notifications to third-party systems, in milliseconds.

    Mandatory

    Data type: Integer

    Value range: 1 to 60000

    Default value: 0

    Restart

    message-queue.keep-alive.interval-minute

    Indicates the period during which eSight does not proactively send keepalive messages to a third-party system, in minutes.

    Mandatory

    Data type: Integer

    Value range: 1 to 30

    Default value: 5

    Restart

    platform.version-file

    Indicates the position of the version file. <Installation directory>/eSight/etc is used as the relative path of the root path.

    Mandatory

    Data type: String

    Value range: File name

    Default value: platformversion.xml

    Restart

    platform.id

    Indicates the platform ID.

    Mandatory

    Data type: String

    Value range: Digits (0-9), lowercase letters (a-z), uppercase letters (A-Z), and special characters @ _ - ( ) , . ^ $ ~ ` ! (The maximum length is 100.)

    Default value: HuaweiPlatform

    Restart

    platform.name

    Indicates the name of the product version attribute read in the version file.

    Mandatory

    Data type: String

    Value range: visible character string

    Default value: HuaweiPlatform

    Restart

    max-system-number

    Indicates the maximum number of third-party systems that can receive message notifications from eSight.

    NOTE:

    The UI can configure 20 third-party systems. Number of manually configured third-party systems = max-system-number - 20

    Mandatory

    Data type: Integer

    Value range: 30 to 50

    Default value: 50

    Restart

    system-list.system.id

    Indicates the systemID that is configured in each third-party system.

    NOTE:

    The 20 IDs ranging from NMSinfo1 to NMSinfo20 have been occupied by the UI. Do not set these 20 IDs to avoid a conflict.

    Mandatory

    Data type: String

    Value range: Digits (0-9), lowercase letters (a-z), uppercase letters (A-Z), and special characters @ _ - ( ) , . ^ $ ~ ` ! (The maximum length is 64.)

    Default value:example@system

    Restart

    system-list.system.system-up-url

    Indicates the URL that receives power-on notifications from eSight. It is configured in each third-party system. (Authentication based on openID is not executed.)

    Mandatory

    Data type: String

    Value range: URL

    Default value: no default value

    Restart

    system-list.system.max-event-aggregation-number

    Indicates the maximum number of aggregated message notifications of the same type and same resource in an HTTP packets. It is configured in each third-party system.

    Mandatory

    Data type: Integer

    Value range: 1 to 100

    Default value: 10

    Restart

Translation
Download
Updated: 2019-10-30

Document ID: EDOC1100044386

Views: 15630

Downloads: 83

Average rating:
This Document Applies to these Products
Related Version
Related Documents
Share
Previous Next