Internal Errigal Collaboration Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Remote Discovery Configuration Scripts ======
Author: Eoin Joy\\ \\
The scripts contained in the RemoteDiscoveryConfiguration are used in some of the basic EMS widgets like Config and Performance view, as well as the remote Alarm History. It also contains the entirely defunct active alarm and disabled alarm scripts which can be ignored.
===== Retrieve Config Params =====
This script aims to retrieve both editable and non-editable configuration parameters for a single network element. These parameters are then displayed in the EMS and those that are editable are shown in the Config Edit widget where the Update Config script may be used to update them.
==== Returned Value ====
//Set< ConfigDTO >// – The set of ConfigDTO objects representing the configuration values that are present for this network element.
==== Inserted Variables ====
**networkElement** – //NetworkElement// – The element for which you want to retrieve the configuration values.\\
**cancelable** – //Object// – The task that can possibly be cancelled, eg. the HTTP request.
===== Retrieve Performance Values =====
This script aims to retrieve performance values that are measuring parameters such as instantaneous power or temperature. They are returned as the same type of object as Configuration parameters, but are never editable. Their display relies on thresholds existing to compare against these values. The results are shown in the Performance View widget of the EMS.
==== Returned Value ====
//Set< ConfigDTO >// – The set of ConfigDTO objects representing the performance values that are present for this network element.
==== Inserted Variables ====
**networkElement** – //NetworkElement// – The element for which you want to retrieve the performance values.\\
**cancelable** – //Object// – The task that can possibly be cancelled, eg. the HTTP request.
===== Update Config =====
This script takes the configuration values that were editable, and updates those that the user chose to change in the EMS and provided a comment for. 
==== Returned Value ====
//List< ConfigDTO >// – The list of ConfigDTO objects representing the configuration values that were desired by the user to change for this network element. This also shows their success or failure.
==== Inserted Variables ====
**networkElement** – //NetworkElement// – The element for which you want to retrieve the configuration values.\\
**cancelable** – //Object// – The task that can possibly be cancelled, eg. the HTTP request.\\
**changes** – //List< ConfigChangeDTO >// – The list of editable configuration values that were changed in the EMS and given a comment. 
===== Retrieve Alarm History =====
This script retrieves a page of alarm results from the controller and does not look at the local database at all. These alarms show as they would on the controller, alarms and clears together.
==== Returned Value ====
//RemoteDiscoveredAlarmHistoryDataSuite// – An object containing a List< RemoteDiscoveredAlarm > and some metadata about whether there exist more pages to scroll to previous or next.
==== Inserted Variables ====
**networkElement** – //NetworkElement// – The controller for which you want to retrieve the alarm history values.\\
**cancelable** – //Object// – The task that can possibly be cancelled, eg. the HTTP request.\\
**number** – //String// – The page number of the results you wish to retrieve.\\
**action** – //RemoteActionType// – The type of action performed, ie. Which button was pushed. NORMAL, DEFAULT, NEXT, or PREVIOUS.
===== Retrieve Remote Disabled Alarm =====
This script is not used.
===== Retrieve Remote Active Alarm =====
This script is not used.
Sidebar

Internal Errigal Collaboration Wiki

User Tools

Site Tools

Page Tools
