Professional Documents
Culture Documents
Ver. 2.0
410 LSM-R
User Manual
COPYRIGHT
This manual is proprietary to SAMSUNG Electronics Co., Ltd. and is protected by copyright.
No information contained herein may be copied, translated, transcribed or duplicated for any commercial
purposes or disclosed to the third party in any form without the prior written consent of SAMSUNG Electronics
Co., Ltd.
TRADEMARKS
Product names mentioned in this manual may be trademarks and/or registered trademarks of their respective
companies.
This manual should be read and used as a guideline for properly installing and operating the product.
This manual may be changed for the system improvement, standardization and other technical reasons
without prior notice.
Updated manuals are available at:
https://systems.samsungwireless.com/
INTRODUCTION
Purpose
This Long Term Evolution (LTE) evolved UTRAN Node-B (eNB) Element Management
System (EMS) user manual describes the information necessary for using the LTE eNB
EMS, e.g., how to register and manage users and how to use the menus.
Conventions
The following symbols are used in this manual. The following types of paragraphs contain
special information that must be carefully read and thoroughly understood.
Checkpoint
Provides the operator with checkpoints for stable system operation.
Note
Provides references for additional information.
Revision History
Version Date of Issue Remarks
TABLE OF CONTENTS
PurposeI
Content and Organization .......................................................................................................................... I
Conventions............................................................................................................................................... II
Revision History ........................................................................................................................................ II
LIST OF FIGURES
This chapter describes the Graphic User Interface (GUI) of the EMS and the basic method
needed for the operation of the system.
1.1.1 Login
The log-in procedure for the EMS operation is explained below:
2) Enter the IP address of the EMS server in the address field of the Internet Explorer and
press Enter to bring up the log-in window. (https ://{ ip.address})
3) Enter the operator‟s User id and Password in the input fields of the login window and
click the Login button.
4) Once the log-in information is verified, the EMS will be executed and the main
window will be displayed.
1.1.2 Logout
The EMS logout procedure is as follows:
1) Among the buttons shown on the upper right corner of the EMS window, click Logout.
A log-out confirmation message will be displayed.
2) Click „OK‟ to log-out.
Menu Frame
: Project title
: User menu
Button Description
Toolbar Buttons
Buttons for the direct link to the principal menus are as follows:
Button Description
Button Description
Button Description
1.3.1 Button
The command buttons used in EMS are designed to run the same functions in different
window. The command buttons commonly used in the EMS are as follows:
Button Description
The date can either be directly entered in the text box in the required format or be selected
in the calendar by clicking the calendar button and click „Apply‟ button.
1.3.3 Sitemap
EMS provides a site map to assist the operator through the operation menu.
The site map gives an overall view of the menu configuration and allows the operator to
execute the desired function directly from the map.
Network Elements
Network elements are called „nodes‟, and they are classified by hierarchy.
Node Description
EMS A node used to indicate the top parent class in the Tree Viewer.
Group A node used to manage NE by grouping them
NE A node representing a specific system.
Rack The rack class of the NE.
Shelf The shelf class of the NE.
Board A node the represents the board, which is the unit of the NE.
Select a specific node in the tree viewer, then right-click it. A popup menu for the
corresponding node will be displayed within the tree viewer.
Icons
The tree viewer uses the following icons to indicate the parent-child relationship between
the networks and to display the alarms.
The tree viewer of the main window will display up to the shelf level. In the function
window, it will display up to the board level as necessary.
Rack - - - - -
Shelf - - - - -
Board -
NE Sorting
1) Select „Sort‟ from the top of the tree viewer (available by name and IP).
2) The NE of the tree viewer will be sorted accordingly.
NE Search
Toolbox
Refresh
Gets the tree list of the main window again to re-display the status map.
Legend
Provides the description of the alarms and symbols used in the status map.
The information shown in legend is as follows:
Server Time
Shows the time of the EMS server, not the time of the device logged in with the WEB
EMS (web client).
Status
Displays the status and alarm information of the eNB shown in the status map.
Status Description
Total Number of all eNBs registered to the LSM (LTE System Manager).
In svc Number of eNB in normal call processing.
SH.down Number of eNB which wireless resource is preparing to be blocked.
Lock Number of eNB which wireless resource is currently blocked.
Dis conn Number of eNB in ping down state.
Not init Number of eNB in SNMP up state, for which the initialization is not complete.
Cri Number of eNB which representative alarm is in critical state.
Maj Number of eNB which representative alarm is in major state.
Min Number of eNB which representative alarm is in minor state.
Normal Number of eNB with no alarm.
Grid Viewer
Tooltip
Shows a brief description of the eNB that the mouse cursor is pointing at.
Menu Description
Menu Description
Cell Status
The grid viewer displays the eNB alarms in following colors:
The grid viewer displays the eNB status with the following symbols:
Status Description
1) Select and right-click the board in the left pane of the Rack Viewer.
2) Select „Reset‟ in the context menu.
3) A window will pop up to display the command execution result.
1) Select and right-click the board in the left pane of the Rack Viewer.
3) The Alarm Inhibit/Allow dialog window will pop up to display the command
execution result.
4) Click on the „Status‟ item of the alarm type you wish to modify from the displayed list,
then select „INHIBIT/ALLOW‟.
6) A dialog window will pop up to display the application result for each corresponding item.
Registering Groups
1) Right-click the EMS node of the tree viewer to display a popup menu, then select
„Create Network‟.
2) When the information Input Window is displayed, enter the name and position and
click „OK‟.
3) If the command is successful, the corresponding group will be added to the tree viewer.
Deleting Groups
1) Select „Network Information‟ from the group node popup menu of the tree viewer or
map viewer.
2) When the password Input Window is displayed, enter the password of your log-in account.
3) Enter the password and click „OK‟.
4) If the command is successful, the corresponding group will be deleted from the tree
1.5 Help
The Help allows to view the information of the EMS server. The server information
provided by the Help menu is as follows:
Sever version
Sever copyright
Server‟s management target
CHAPTER 2. Configuration
Management
The configuration management allows the operator to view, modify, add and/or delete the
NE information. The operator can check the current configuration and/or setup or control
the NE with the functions provided in the configuration management.
Also, the configuration management offers a CLI window supporting the operator commands.
2.1 CLI
The CLI can be executed by selecting „Configuration‟ „CLI‟. The CLI is a module
which allows the operator to execute the commands for the NE through the GUI.
Layout Selection
You can select the layout using the following three methods:
From the menu, click Layout. A sub-menu will be displayed as shown on the left.
Select the desired layout. The layout of the window will be adjusted accordingly.
Select the desired layout icon in the toolbar. The layout of the window will be
adjusted accordingly.
Ctrl-1, 2, 3 In the CLI window, press Ctrl+1 (Layout 1), Ctrl+2 (Layout 2), or Ctrl+3
(Layout 3). The layout of the window will be adjusted accordingly.
Selecting a Target
In the initial CLI window, select the combo list of the target to select the target ID.
The following tree will be displayed. Select the NE you wish to execute the command on.
Command Window
: Click the corresponding button to activate the command tree input window.
The command tree allows the operator to select the desired command from the tree.
If you select a command from the command tree, the corresponding parameter attribute
values will be displayed in the command parameter input window in the right pane.
Input Window
To enter a command, proceed as follows:
1) Select a command from command tree, then enter the parameter. The command will be
automatically created in the Input Window below command tree.
2) Use the ↑ and ↓ keys to select a command from the command list.
Button Description
History Window
You can re-execute the previously executed command as follows:
Response Window
The result of the command executed by the operator will be displayed as illustrated below.
Autonomous Window
The alarm and status messages generated during the system operation will be displayed as
illustrated below.
Copying a Message
1) Select a specific area of the Response Window.
2) Right-click the Response Window to display the context menu.
3) Select „Copy‟ to copy the selected message.
Saving a Message
1) Select a specific area of the Response Window.
2) Right-click the Response Window to display the context menu.
3) Select „Save‟, designate a path in the dialog window, then click „OK‟.
4) The selected message will be saved in the designated path.
Clearing a Message
1) Right-click the Response Window to display the context menu.
2) Select „Clear‟.
3) All messages in the Response Window will be cleared.
4) The background of the Response Window will be displayed in the specified color.
Pause On
1) Right-click the Response Window to display the context menu.
2) Selecting „Pause‟ will pause the response message at current state.
Pause Off
1) Right-click the Response Window in „PauseOn‟ state to display the context menu.
2) Selecting „PauseOff‟ will resume the paused response message.
Adding Filter
1) Right-click the event window to display the context menu.
2) Select „Add Filter‟.
3) Select a target in the Add Filter window.
4) The filter window of the corresponding target will be added.
5) The added window will only display the events of the selected target.
Copying Event
1) Select a specific area of the event window.
2) Right-click the event window to display the context menu.
3) Select „Copy‟.
Saving Event
1) Select a specific area of the event window.
2) Right-click the event window to display the context menu.
3) Select „Save‟.
4) Designate a path to save the event.
Clearing Event
1) Right-click the event window to display the context menu.
2) Select „Clear‟.
3) All messages in the event window will be cleared.
Pause On
1) Right-click the event window to display the context menu.
2) Selecting „Pause‟ will pause the output event at current state.
Pause Off
1) Right-click the event window in „PauseOn‟ state to display the context menu.
2) Selecting „Pause Off‟ will resume the paused event.
Changing Font
1) Right-click the event window to display the context menu.
2) Select „Change Font‟.
3) Select the desired font in the dialog window.
4) The message will be displayed in the specified font.
Changing Background
1) Right-click the event window to display the context menu.
2) Select „Change Background‟.
3) Select the desired color in the dialog window.
4) The background of the event window will be displayed in the specified color.
If an invalid command is entered in the Input Window while adding the commands in
the batch job, the following error dialog will be displayed.
3) Click „Start‟.
3) Click „Save‟.
4) The commands in the Batch Window will be saved in the specified file.
4) Click „OK‟.
5) The icon will be changed to the corresponding command in the macro list.
2.2 NE Grow/Degrow
The tree viewer and map viewer provide a popup menu to register, modify and/or delete the NE.
2.2.1 NE Grow
There are two methods to register the NE. One method is to select „Configuration‟
„Grow‟, the other method is to select the „Grow‟ context menu from the group node of the
tree viewer or map viewer. A window to register the NE will then be displayed.
1) Select „Grow‟ from the NE Node popup menu of the tree viewer or map viewer, or
select „Configuration‟ „Grow‟ from the main menu.
2) Once the grow window appears, enter the NE information, then click „Next‟.
3) In the second step window, enter the cell information. Click on each grid in the cell
information window to add or delete a cell.
4) When you have finished entering all the cell information, click „Finish‟. A progress bar
will be displayed to show the progress of the grow process. The process will be
completed when the progress reached 100%.
2.2.2 NE Degrow
If you select „Delete NE‟ from the NE node popup menu of the tree viewer or map viewer,
a password Input Window will be displayed. Enter the password and click „OK‟ to delete
the corresponding NE.
2) Upon the initial cell management window launch, the cells in the cell information will
be displayed in the following two types:
Cells in Grow status: The cells are displayed in yellow. If you right-click a cell and select
„Cell Delete‟ from the popup window, the text „Delete‟ will appear in red in the State
column of the Detail Cell Information section.
Cells not in Grow status: The cells are displayed in white. If you click a cell, the color will
be changed to pale yellow. A new row for the selected cell will be added to the Detail
Cell Information section, and the text „Add‟ will appear in blue in the State column.
Enter the information of the cell to add in each column of the newly added row.
3) When you have finished entering all the delete/add information of each cell in the
Detail Cell Information section, click „Apply‟. A progress bar will be displayed to
show the progress of the cell grow/degrow process.
2.4 Neighbor
2.4.1 Neighbor Management
Double-click a station from the tree at the left of the window to display the neighbor
information of the corresponding station.
Adding a Neighbor
1) Double-click the eNB you wish to add the neighbor from the tree at the left of the window.
2) In Neighbor Relation Info, select the tab corresponding to the network (LTE, WCDMA,
CDMA1XRTT, CDMAHPRD) you wish to add the neighbor, then click „Add‟.
3) Enter each and every parameter in the popup window, then click „Add‟ in the popup
window to execute the command.
4) The execution result will be updated to the neighbor operation history.
Modifying a Neighbor
1) Select a neighbor in Neighbor Relation Info. The „Change‟ button at the top of the
table will be activated.
2) Click the activated „Change‟ button, then modify the parameters as necessary in the
popup window.
3) Click „Change‟ in the popup window.
4) The execution result will be updated to the neighbor operation history.
Deleting a Neighbor
1) Select a neighbor in Neighbor Relation Info. The „Delete‟ button at the top of the table
will be activated.
2) Click on the enabled „Delete‟ button. A warning popup will be displayed. Click „OK‟
in the warning popup.
3) The execution result will be updated to the neighbor operation history.
Additional Functions
The neighbor GUI allows the operator to easily view the related information.
If you select a neighbor relation in the Neighbor Relation Info, the information of the
source eNB of the corresponding relation will be highlighted, and the information of
the cell of the corresponding eNB will be displayed.
The Status in the Neighbor Relation Info represents the status of the corresponding
neighbor.
Green: Bi-directional neighbor
Yellow: Uni-directional neighbor
Red: Neighbor which related cell has been deleted
White: Neighbor which target eNB does not exist in the LSM (remote neighbors and
other PLMN neighbors will also be shown in white)
With the Neighbor Relation Info containing valid data, select a number in the Cell Num
selection combo box at the top of the window. The neighbor relation having the selected
number‟s cell as the source cell will change to blue, and when you select a relation in
blue color, the information of the corresponding source cell in the Cell Detail Info will
be displayed in green.
Right-click the Neighbor Operation History to delete the information in the table.
Neighbor Import/Export
(This function allows to import/export the neighbor information, and can be executed
from the menu bar at the top of the window.)
Import
1) Click „File‟ to import the file from the PC.
2) The imported data will be displayed in the table.
3) Make the desired modification to the table, then select one of the commands at the top
of the window.
4) Check on the relation you wish to execute the selected command, then click „Apply‟.
Export
1) Check on the station to view the neighbor from the tree at the left of the window, then
click „Inquiry‟ at the top of the window. (If you checked on bi-direction, each neighbor
relation will be viewed in both directions.)
2) The neighbor relation of the selected eNB will be displayed on the table. Click „Save‟
to save it to the PC (.csv or .xls).
3) You can also view and modify the data in the table, then apply to the server.
2.5 Software
The „UI_SWM (UI_SW Management)‟ provides the user interface for the commands
necessary to perform the package upgrade, software (SW) update and firmware (FW)
update through the GUI. In addition, the UI_SWM provide the functions for the eNB to
download and activate the package, SW and FW, as well as the functions to verify the
package installation of the LSM/NE.
The UI_SWM provides the package upgrade, software update and firmware update functions,
as well as the functions to schedule their execution and save the execution history.
The operator can perform the package upgrade, software update and firmware update at the
desired time.
Tree Viewer: Displays all NEs registered to the EMS in tree structure.
The check tree option allows the selection of multiple NEs.
The NEs in the tree can be displayed selectively, per NE type or NE version. If you
check on a NE in the tree, the check will also be applied to the NE status table.
NE Status Table: Provides the information of the current and download package versions of
each NE. Click on the right buttons of the table ( ) to display the information of the
package, active software and firmware applied to each eNB. If the information of both
current and download package versions exist, the package status will be displayed
with the priority given to the download package version.
Upgrade Information: Executes the command based on the selections in the Command
Type, Package Version, Mode, Execute Type and Execute Schedule options.
2.5.2 Verify
Compares the package and firmware between the LSM and NE.
Tree Viewer: Displays all NEs registered to the EMS in tree structure.
Verification Criteria: Sets the criteria for the verification.
Verification Information: A list of NEs to perform the verification. Provides the Compare
( ) icon to view the verification result and detailed information. Click the Compare
icon of the corresponding NE to view the detailed information.
Parameter Description
Tree Viewer: Displays all NEs registered to the EMS in tree structure.
Software List: Displays a downloadable list based on the NEs selected in the tree viewer.
The [2.0.0] next to the title represents the version of the checked eNBs.
Download Software: The list of the actual tasks to be performed, added from the software
list.
Download Information: Executes the command based on the Command Type, Execute
Type or Execute Schedule.
Tree Viewer: Displays all NEs registered to the EMS in tree structure.
Firmware List: Displays a downloadable list corresponding to the version selected in the
version combo box. The [2.0.0] next to the title represents the version of the checked
eNBs.
Download Firmware: The list of the actual tasks to be performed, added from the firmware
list.
Download Information: Executes the command based on the Command Type: Reboot,
Execute Type or Execute Schedule.
2.5.5 History
Views the Command History
Tree Viewer: Displays all NEs registered to the EMS in tree structure.
Search Criteria: Allows you to select the history search criteria.
Command History: Displays the search result. The results of the command executed
based on the EMS will be displayed in the table. Double-click the table to display the
details of the command execution for each NE in „Detail‟. (Clicking the Detail ( )
icon will generate the same result as above.)
Detail: Displays the command execution result for the NE upon clicking „Command
History‟.
Parameter Description
(Continued)
Parameter Description
2.5.6 Schedule
Views the scheduled task.
Tree Viewer: Displays all NEs registered to the EMS in tree structure.
Search Criteria: Allows you to select the schedule search criteria.
Schedule List: Displays the search result. The results of the command executed based on
the EMS will be displayed in the table. Double-click the Detail ( ) in the table to
display the details in „Detail‟.
Detail: From „Schedule List‟, click the Detail ( ) icon to view the details.
Parameter Description
Tree Viewer: Displays all NEs registered to the EMS in tree structure.
Data Audit: Allows the operator to view the eNB data version and LSM data version of the
NE registered to the EMS and decide whether to perform the Data Audit.
Network Group: The name of the network group where the eNB belongs to.
eNB Name: The name of the eNB registered by the operator.
eNB Id: The eNB‟s independent, unique ID.
eNB Data Version: The eNB data version checked in the eNB through the cdd.
LSM Data Version: The data version managed in the LSM DB.
Result: Result of the execution.
Scheduler: instead of performing the Data Audit manually, the operator can schedule the
EMS to perform it periodically by registering the task to the scheduler and view the
corresponding information in the scheduler.
Synchronize Data
1) From the LSM main window, select the „Configuration‟ „Data Audit‟ menu.
3) In the tree view, select an eNB as illustrated below to launch the Data Audit.
4) Once an eNB is selected from the tree, the same eNB information will be selected
from Synchronize Data as below:
Figure 2.56 Verifying the eNB infor4-mation selected from Sync Data
5) Click „Execute‟.
Adding Scheduler
1) From the LSM main window, select the „Configuration‟ „Data Audit‟ menu.
3) The tree and the data version of the eNB will be displayed as illustrated below.
6) Enter the desired start date, end date and period as below:
You can also use the calendar to enter the start date and end date.
7) Click „Execute‟.
Deleting Scheduler
1) From the LSM main window, select the „Configuration‟ „Data Audit‟ menu.
2) The Data Audit window will be displayed.
3) Select the Scheduler tab to view the scheduler information.
4) Select the scheduler information to delete.
Click „Delete‟ to delete the selected scheduler information.
2.8.1 Backup
„PLD Backup‟ window and procedure are as follows:
Tree Viewer: Displays all NEs registered to the EMS in tree structure.
System Backup : Register PLD Backup schedule or execute PLD Backup immediately.
2.8.2 Restore
„PLD Restore‟ window and procedure are as follows:
1) From the LSM main window, select the „Configuration‟ „System Backup‟ menu.
2) Select the eNB to restore PLD in Tree Viewer.
3) Click the „File‟ button of the corresponding eNB in Restore table.
1) From the LSM main window, select the „Configuration‟ „System Backup‟ menu.
2) Select the eNB to view execution history in Tree Viewer.
3) Select Backup/Restore „Type‟ field.
4) Select Success/Failed „Result‟ field.
4) Click the „Search‟ button.
The fault management provides various functions to manage the faults occurring in the
system.
Parameter Description
Severity Indicates an event grade.
- Critical: critical fault
- Major: major fault
- Minor: minor fault
- Warning: fault information
- Indeterminate: fault whose severity is not defined
- Status: general information
Code The event code.
Group Displays the event groups in the following types:
- Communication: communication process/procedure
- Processing: software/processing procedure
- Environment: external equipment environment
- QoS: degradation of service quality
- Equipment: fault in equipment
- etc.: other faults & statuses.
Location Location of the event.
Probable Cause Cause of the event.
Pausing/Receiving Events
If you click the „Play‟ button ( ) at the top of the „Event Viewer‟, the „Play‟ button will be
changed to „Pause‟ ( ) and the events will not be displayed anymore. If you click the
„Pause‟ button again, it will be changed back to „Play‟ and all the events not displayed
during the pause will be displayed.
Printing Events
Click the „Print‟ button ( ) at the top of the „Event Viewer‟ to print the events currently
displayed on the „Event Viewer‟.
Saving Events
Click the „Save‟ button ( ) at the top of the „Event Viewer‟ to save the events currently
displayed on the „Event Viewer‟ in an Excel file.
Event Details
Double-click a data in the „Event Viewer‟ to display the detailed information of the
corresponding data on the popup window as below.
Parameter Description
(Continued)
Parameter Description
Clearing a Fault
1) From the result table, select the fault you wish to clear.
2) Click „Clear‟.
3) Check the background color of the „Severity‟ column and the „Clear Time‟ column of
the table to see if the selected fault has been successfully cleared.
Parameter Description
If you double-click the data on „Current Alarm‟ or select „Show Details‟ on the popup menu,
the detailed information of the corresponding data will be displayed on a popup window.
If you click the „Code Information‟ button, the information of the corresponding alarm
code will be displayed on a popup window.
A „Severity‟ column which color is in „Clear‟ state represents an alarm that has been
cleared. The time the alarm was cleared will be displayed along with its clearance type.
Parameter Description
Parameter Description
Parameter Description
8) Click „Search‟ to display the alarm code information of the selected NE type.
9) Select the alarm code to be displayed as a visible alarm (by checking on the check-
box), then click „Add‟.
10) If you click „Add‟ button, the code selection window disappears.
12) If an alarm that meets the criteria occurs, the visible alarm window will automatically
appear.
CHAPTER 4. Performance
Management
The performance management manages the functions related to the performance of the
network resource.
The following key functions are provided by the performance management:
Performance Statistics
Collection Results
PI Monitoring
On Demand
Call Trace
To manage the performance, select „Performance Management‟ from the main menu.
Statistics Family
Selection Area Statistics Result
View Area
Parameter Area
Search Criteria
Area
Selecting Parameters
Enter the following values to the „Parameter‟ field according to the data type of the LLOC:
Type Description
enum If the data type is enum, a combo list will automatically appear when you click the
mouse button.
Ipv4 Enter the IPV4 type.
enbID Enter the ID of the eNB.
String Enter all other data as string type.
Item Description
(Statistics) Type
Selection Area Chart Area
Command
Execution Area
Chart Area
(Statistics) Type
Selection Area
Item Description
System Selection
Area
Collection Results Area
Search Criteria
Item Description
4.3 PI Monitoring
PI monitors specific performance data by assigning threshold values. The PI monitoring
utility will alert the operator by triggering an alarm when the corresponding threshold is
met. If you click the „PI Management‟ button on the PI monitoring window, a registration
window will appear as below. You can set and manage the PI items through the following
registration procedure.
Performance PI Monitoring
4.3.1 PI Search
PI Management View
Item Description
System selection The units displayed in the system selection area at the bottom depend on the
NE Type and NE on the tab menu at the top.
- NE Type: Displays the items to allow the selection by NE type.
- NE: Displays all NE lists.
PI item selection The PI items selection area.
The PI items are displayed according to the NE type or NE selected in the
system selection area. The same data as the statistics family are displayed.
‘Search’ Button Select the system and statistics items, then click ‘View’ to display the data from
the PI settings in the result window on the right.
Search Result The window showing the results of the search on the left pane.
Window
‘Register’ Button Used to set new PI management items
‘Modify’ Button Used to modify the PI search results and apply the modification.
‘Delete’ Button Used to delete the selected PI items.
PI Search Procedures
1) Select whether to search by NE or NE type in the system selection area using the tab
menu.
2) Select the tab, select the desired system or type in the NE Type or NE list, then click
„Search‟ to display all items that meet the corresponding system or type on the result
area.
3) To search for specific PI items, select the PI item or group and click „Search‟ to search
within the selected range.
4.3.2 PI Registration
In the PI search window, select the desired system or type and click „Register‟ to display a
registration window as shown below. You can set the PI items through the following
registration procedure.
(Statistics) Type Displays the (Statistics) Type that belong to the selected Statistics Family.
Threshold Info Threshold setting area.
Direction Selects the direction for the threshold range.
- UP: Alarms are triggered when the thresholds are exceeded.
- DOWN: Alarms are triggered when the thresholds are not met.
Values Area to enter the threshold values.
For the up direction, the order is Critical > Major > Minor.
For the down direction, the order is Critical < Major < Minor.
Register A button used to register and execute the threshold value.
PI Registration Procedure
1) Click the NE Type or NE tab on the PI management screen.
2) Select the system type or system in the system area.
3) Select the statistics family to register, then click „Register‟ to display the „PI
Registration‟ screen.
4) Select the (Statistics) Type that belongs to the statistic family.
5) Select the threshold direction between UP and DOWN.
6) Enter the Critical/Major/Minor values.
4.3.3 PI Modification
The procedure to modify the registered PI value is given below. To register the change,
select the corresponding item in the search result area of the PI management window and
click „Modify‟.
PI Modification Procedure
1) Modify the values of items you want to change in the search result area of the PI
management window.
2) Once you change the values and move the mouse cursor, the corresponding fields will
turn red and the check boxes on the left will be checked on.
3) When the modification is complete, click „Modify‟.
4) When the change is registered, the registration result window will be displayed.
5) After the modification has been registered successfully, the statistics will be collected
and the levels will be defined to automatically trigger/restore the alarms and display
the alarm history in the event viewer.
4.3.4 PI Deletion
Registered PI values can be deleted by selecting the corresponding item in the search result
area of the PI management window and click „Delete‟.
PI Deletion Procedure
1) Select the check box of the item you wish to delete in the search result area of the PI
management window.
2) Select all items you wish to delete, then click „Delete‟.
3) When the deletion is complete, the registration result window will be displayed.
4) Once the deletion is complete, all active alarms related to the PI will be cleared
automatically..
4.3.5 PI Monitoring
1) When the statistics collection for the PI is complete, the PI status is automatically
refreshed in the PI monitoring window, and the highest levels for each statistic item
are calculated and displayed.
2) Click on each item to display the list of the faults occurred on the right pane.
3) When an error occurs in the fault occurrence status, click the „Refresh‟ button to
display the latest status.
PI Monitoring Buttons
Item Description
Performance On Demand
Parameter Area
Statistics Family
Selection Area
Condition Input
Area
Selecting Parameters
Enter the following values to the „Parameter‟ field according to the data type of the LLOC:
Type Description
enum If the data type is enum, a combo list will automatically appear when you click the
mouse button.
Ipv4 Enter the IPV4 type.
enbID Enter the ID of the eNB.
long Enter the integer type. Position the mouse cursor on ‘Property’ to view the allowed
range in tooltip.
String Enter all other data as string type.
Entering Criteria
In the criteria input area, select the „Collection Cycle‟ and the „Duration‟ from the
respective combo lists.
(Statistics) Type
Selection Area Graph Output Area
Start
Click „Start‟ to request the NE to start monitoring the corresponding On Demand statistics.
Stop
Click „Stop‟ to request the NE to stop the current monitoring of the On Demand statistics.
Graph Output
Outputs the monitoring data to the graph in the predefined collection cycle interval.
Table Output
Outputs the monitoring data to the table in the predefined collection cycle interval.
State Display
Displays the monitoring status change history, command execution results, monitoring data
collection history, etc.
Save
Click „Save‟ to save the graph and table as file.
The first screen allows to save the graph in a PDF file, and the second screen allows to save
the table in a CSV or Excel file.
Item Description
The Trace List window allows to view/register/delete the call trace from the NE via the
trace commands, and provides real-time monitoring in the LSM.
Item Description
Button Description
2) Click „Register‟ in the trace list window to display the registration window.
4) Click „Execute‟.
5) If you click „Execute‟, a trace registration request will be sent to the NE.
If the result is successful, the trace list will be displayed with the newly registered
trace job.
Trace Chart
Trace monitoring
1) The data monitoring allows the client to poll the data saved in the server file
periodically (every second) and displays them on the window.
2) To view the details of a specific message, click the corresponding message in the chart
or table.
Trace Chart
Button Description
Clears the data displayed on the window, and displays the data collected
afterwards.
Resume the monitoring.
Stop the monitoring temporarily to click the message to view its details.
Trace Chart
The general management monitors various functional blocks an resources on the EMS
server. It also provides additional features to the operator to control the operating
environment on the EMS.
Item Description
Item Description
(Continued)
Item Description
General Monitoring
5.4.1 CPU
„CPU‟ management functionality allows to view the EMS server‟s CPU usage rate by CPU
ID and to set the threshold values.
For servers with more than 2 CPUs, the usage rate is displayed for each CPU.
The threshold is used to trigger an alarm if the CPU usage rate of the EMS server exceeds a
specific value.
The current CPU status table is renewed automatically in every designated period.
Click „Get‟ to view the thresholds and cycles.
Item Description
5.4.2 Memory
„Memory‟ management feature allows to view the EMS server‟s memory usage rates and to
set the threshold values. The memory usage rate is displayed as the percentage of the total
memory used by the server. The threshold is used to trigger an alarm if the memory usage
rate of the EMS server exceeds a specific value.
The current memory status table is renewed automatically in every designated period.
Click „Get‟ to view the thresholds and cycles.
Item Description
The current file system status table is renewed automatically in every designated period.
Click „Get‟ to view the thresholds and cycles.
The parameters of the file system are as follows:
Item Description
(Continued)
Item Description
Used size (Kbytes) The size of the file system in use in Kbytes.
Free size (Kbytes) The size of the remaining file system in Kbytes.
5.4.4 Database
„Database‟ management feature allows to view the EMS server‟s database information and
set the threshold values. The threshold is used to trigger an alarm if the database usage rate
of the EMS server exceeds a specific value.
The current database status table is renewed automatically in every designated period.
Click „Get‟ to view the thresholds and cycles.
Item Description
Item Description
1) Select the resources to search for in the „Resource Type‟ field of the settings table.
2) Select the name to search for in the „Resource Name‟ field.
3) Select the statistics type to search for in the „Statistics Type‟ field.
4) Select the period to search for in the „Period‟ field.
5) Click „Get‟.
5.6 Database
5.6.1 Log Management
„Log Management‟ allows to set the storing cycle of the PM, FM, and SM raw data, and the
hourly, daily and monthly statistics data. It also allows to automatically deletes the data
according to the predefined cycle.
General Database
Parameter Description
1) Select the „Self-Diagnosis‟ menu to display the status of the database connection and
RMI connection for each process in the results table.
2) The connection status will be displayed as if normal, and if abnormal.
3) Click the „Test‟ button in the window to test the status and refresh the window.
Item Description
1) Select the „Self Diagnosis‟ menu to display the event channel status in the result table.
2) The event channel will be displayed as if normal, and if abnormal.
3) Click the „Test‟ button in the window to test the status and refresh the window.
Click „1 Hour‟, „12 Hours‟, „1 Day‟, or „Search‟ to perform the search by time or by
message. The following illustrates the search by time. The LSM‟s log file is created by time,
and thus only requires the search time to be provided by the user. Click the „Save‟ button to
save the displayed information to the PC. If there‟s no search result, the „Save‟ button will
be disabled.
The following illustrates the search by message. The search by message is a feature
specific to the log file created in the LSM. (The search may not be performed correctly if
the format of the file is incorrect.)
The log message created in the LSM uses the „;‟ symbol to distinguish between each log.
The search by message will display all the log messages containing the keyword provided
by the operator.
Check the „special‟ option to perform a conditional search. The conditional search uses
special characters (&&, ||) between the keywords to add conditions (AND, OR) when
performing the search.
„&&‟ implies the AND condition, and „||‟ implies the OR condition.
ABC && DEF: Search only the messages containing both ABC and DEF.
ABC || DEF: Search the messages containing either ABC or DEF.
Up to three keywords can be entered per search. A space must be provided between the
keyword and the special characters.
The security management feature allows to the operator to register, modify, search and/or
delete user accounts. The security management module ensure the authorized access to the
EMS system. Also this module will maintain the operation history for all the operators on
the system.
Parameter Description
Searching Operators
1) If you select the Operator Management function, the currently registered operator
information will be displayed in the result table.
2) The detailed information of the selected operator is displayed on the right.
3) Click the „Get‟ button at the bottom of the window to refresh the operator information.
Operator Registration
1) Click „Add‟ at the bottom of the window.
2) The operator registration window appears on the right.
3) Enter the operator information and click „OK‟.
4) If the registration was successful, it will be shown in the result table.
Parameter Description
Modifying Operator
1) Select an operator to modify from the result table.
2) Click on the „Modify‟ button to display the operator information change window on
the right.
3) Modify the operator information, then click „OK‟.
4) The changed information is reflected and displayed in the result table.
Deleting Operator
1) Select an operator to delete from the result table.
2) Click the „Delete‟ button at the bottom of the window.
3) When the password input screen appears, enter the password of the operator currently
logged in.
4) In the password confirmation window, click „OK‟.
5) If the operator is successfully deleted, it will be reflected in the result table.
6) If a client was logged in with the deleted operator ID, it will be terminated forcefully.
3) Click on the „Modify‟ button to display the operator information change window on
the right.
5) The changed information will be reflected and displayed in the result table.
Parameter Description
Changing Password
1) Click „Change Password‟ to change the password of the current operator.
2) Fill in the „Old Password‟, „Password‟, and „Re-Password‟ fields then click „OK‟ to
change the password.
Parameter Description
Searching Groups
1) If you click the „Group Management‟ menu, the information on the currently registered
groups are searched and displayed on the result table.
2) Click the „View‟ button to refresh the registered group information.
Adding a Group
1) Click „Add‟ at the bottom of the window.
2) Enter the group name in the window displayed on the right and select a group element.
3) Click the „OK‟ button in the window. Check if the registered group information is
displayed on the result table.
Deleting Groups
1) Select the group to delete from the result table. Note: you cannot delete the default group.
2) Click the „Delete‟ button at the bottom of the window.
3) In the deletion confirmation window, click „OK‟.
4) You cannot delete the group if the group has an operator assigned to it.
6.4 IP Manager
The „IP Manager‟ menu allows to manage the login authorization by client IP address and
the number of sessions allowed for simultaneous access.
Security IP Manager
Parameter Description
Viewing the IP
1) The information of the currently registered IP is displayed on the result table.
2) To search by Login Allowance or IP, enter the search criteria in the search input table,
then click „Search‟.
Registering IP
1) Click „Add‟ at the bottom of the window.
2) The IP registration window appears on the right.
3) Enter the IP registration information and click the „OK‟ button.
4) If the information is processed successfully, the registered IP information will be
displayed on the result table.
Note: If Login Allowance is set to Deny, the client running in the corresponding IP
address will be terminated forcefully.
Deleting IP
1) Click the IP to delete in the result table.
2) Check if the detailed information of the selected IP is displayed on the right.
3) Click on the „Delete‟ button at the bottom of the window.
4) In the deletion confirmation window, click „OK‟.
5) If the IP is successfully deleted, it will be reflected in the result table.
Note: If an IP is deleted, the client running in the corresponding IP address will be
terminated forcefully.
6.5.1 History
„History‟ window allows the operator to view the login and logout history.
Parameter Description
Viewing History
1) Enter the search criteria in the search input table. The available search criteria are
Operator ID, IP Address, Login Success/Fail, and Login Time.
2) Click the „Search‟ button to search for login history.
3) The login history search results will be displayed in the result table.
Saving/Printing
1) Search the history data with the login history search function.
2) Click the „Save‟ button in the window to save the searched data in an Excel file.
3) To print the saved data, use the print function in Microsoft Excel.
Parameter Description
Parameter Description
Saving/Printing
1) Search the history data with the operation history search function.
2) Click the „Save‟ button in the window to save the searched data in an Excel file.
3) To print the saved data, use the print function in Microsoft Excel.
CHAPTER 7. SON
SON Management feature on the LSMR provides the menu for the operation of the Self
Organizing Networks (SON), including the monitoring of the DHCP and SON statuses and
the setting of the variables used in the SON algorithm.
Tree Viewer: Displays all NEs registered to the LSM in tree structure.
eNB SON Option: Retrieves the registered eNB‟s SON Option information.
eNB Name: The name registered by the operator during the eNB expansion.
LSM.NRT: Whether to create the initial neighbor information during the expansion.
LSM.PCID: Whether to automatically allocate the physical cell id during the
expansion.
LSM.RACH: Whether to automatically allocation the RootSequenceIndex during the
expansion.
eNB.Pcid: Whether to use the pcid Enable function in he eNB.
eNB.Delay Compensation: Whether to use the Delay Compensation function in the
eNB.
eNB.Rpt Delay Compensation: Whether to use the Rpt Delay Compensation function
in the eNB
Result: Execution result.
Cell SON Option: Retrieves the registered cell‟s SON Option information.
eNB Name: The name registered by the operator during the eNB expansion.
Cell Number: Number of the cell.
Anr: Whether to use the anr function.
Energy Saving: Whether to use the energy saving function.
Mobility Robustness: Whether to use the Mobility Robustness function.
Mobility Load Balance: Whether to use the Mobility Load Balance function.
Rach Opt: Whether to use the Rach Optimize function.
Cnc Opt: Whether to use the Cnc Optimize function.
Parameter Description
Parameter Description
Some software components of this product incorporate source code covered under the
GNU General Public License (GPL), Apache License etc.
Acknowledgement:
This product includes software developed by the Apache Software Foundation
(http: //www.apache.org/).
This product includes software developed by the JDOM Project (http: //www.jdom.org/)
The software included in this product contains copyrighted software that is licensed under
the GPL/LGPL. You may obtain the complete Corresponding Source code from us for a
period of three years after our last shipment of this product by sending email to:
oss.request@samsung.com
If you want to obtain the complete Corresponding Source code in the physical medium
such as CD-ROM, the cost of physically performing source distribution may be charged.
This offer is valid to anyone in receipt of this information.
Below is the list of components covered under GNU General Public License (GPL),
Apache License etc.
(Continued)
Everyone is permitted to copy and distribute verbatim copies of this license document, but
changing it is not allowed.
Preamble
The licenses for most software are designed to take away your freedom to share and change
it. By contrast, the GNU General Public License is intended to guarantee your freedom to
share and change free software--to make sure the software is free for all its users.
This General Public License applies to most of the Free Software Foundation‟s software
and to any other program whose authors commit to using it. (Some other Free Software
Foundation software is covered by the GNU Library General Public License instead.)
You can apply it to your programs, too.
To protect your rights, we need to make restrictions that forbid anyone to deny you these
rights or to ask you to surrender the rights. These restrictions translate to certain
responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must
give the recipients all the rights that you have. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they know their rights.
If the software is modified by someone else and passed on, we want its recipients to know
that what they have is not the original, so that any problems introduced by others will not
reflect on the original authors‟ reputations.
The precise terms and conditions for copying, distribution and modification follow.
Thus, it is not the intent of this section to claim rights or contest your rights to work
written entirely by you; rather, the intent is to exercise the right to control the
distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the
Program (or with a work based on the Program) on a volume of a storage or
distribution medium does not bring the other work under the scope of this License.
3) You may copy and distribute the Program (or a work based on it, under Section 2) in
object code or executable form under the terms of Sections 1 and 2 above provided
that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source code,
which must be distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give any third
party, for a charge no more than your cost of physically performing source
distribution, a complete machine-readable copy of the corresponding source code,
to be distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute
corresponding source code. (This alternative is allowed only for noncommercial
distribution and only if you received the program in object code or executable
form with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making
modifications to it. For an executable work, complete source code means all the
source code for all modules it contains, plus any associated interface definition
files, plus the scripts used to control compilation and installation of the executable.
However, as a special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary form) with the
major components (compiler, kernel, and so on) of the operating system on which
the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the source code
from the same place counts as distribution of the source code, even though third
parties are not compelled to copy the source along with the object code.
4) You may not copy, modify, sublicense, or distribute the Program except as expressly
provided under this License. Any attempt otherwise to copy, modify, sublicense or
distribute the Program is void, and will automatically terminate your rights under this
License. However, parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such parties remain in full
compliance.
5) You are not required to accept this License, since you have not signed it.
However, nothing else grants you permission to modify or distribute the Program or its
derivative works. These actions are prohibited by law if you do not accept this License.
Therefore, by modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and all its terms and
conditions for copying, distributing or modifying the Program or works based on it.
6) Each time you redistribute the Program (or any work based on the Program), the
recipient automatically receives a license from the original licensor to copy, distribute
or modify the Program subject to these terms and conditions.
You may not impose any further restrictions on the recipients‟ exercise of the rights
granted herein. You are not responsible for enforcing compliance by third parties to
this License.
7) If, as a consequence of a court judgment or allegation of patent infringement or for any
other reason (not limited to patent issues), conditions are imposed on you (whether by
court order, agreement or otherwise) that contradict the conditions of this License, they
do not excuse you from the conditions of this License.
If you cannot distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may not
distribute the Program at all. For example, if a patent license would not permit royalty-
free redistribution of the Program by all those who receive copies directly or indirectly
through you, then the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular
circumstance, the balance of the section is intended to apply and the section as a whole
is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other
property right claims or to contest validity of any such claims; this section has the sole
purpose of protecting the integrity of the free software distribution system, which is
implemented by public license practices. Many people have made generous
contributions to the wide range of software distributed through that system in reliance
on consistent application of that system; it is up to the author/donor to decide if he or
she is willing to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence
of the rest of this License.
8) If the distribution and/or use of the Program is restricted in certain countries either by
patents or by copyrighted interfaces, the original copyright holder who places the
Program under this License may add an explicit geographical distribution limitation
excluding those countries, so that distribution is permitted only in or among countries
not thus excluded. In such case, this License incorporates the limitation as if written in
the body of this License.
9) The Free Software Foundation may publish revised and/or new versions of the General
Public License from time to time. Such new versions will be similar in spirit to the
present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a
version number of this License which applies to it and „any later version‟, you have
the option of following the terms and conditions either of that version or of any later
version published by the Free Software Foundation.
If the Program does not specify a version number of this License, you may choose any
version ever published by the Free Software Foundation.
10) If you wish to incorporate parts of the Program into other free programs whose
distribution conditions are different, write to the author to ask for permission.
For software which is copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this.
Our decision will be guided by the two goals of preserving the free status of all
derivatives of our free software and of promoting the sharing and reuse of software
generally.
NO WARRANTY
11) BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM
„AS IS‟ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU
ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
12) IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO
MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED
ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF
THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT
LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
<one line to give the program’s name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program;
if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-
1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this when it starts in an
interactive mode:
Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with
ABSOLUTELY NO WARRANTY; for details type „show w‟.
This is free software, and you are welcome to redistribute it under certain conditions; type
„show c‟ for details.
The hypothetical commands „show w‟ and „show c‟ should show the appropriate parts of
the General Public License. Of course, the commands you use may be called something
other than „show w‟ and „show c‟; they could even be mouse-clicks or menu items--
whatever suits your program.
You should also get your employer (if you work as a programmer) or your school, if any, to
sign a „copyright disclaimer‟ for the program, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program „Gnomovision‟
(which makes passes at compilers) written by James Hacker.
This General Public License does not permit incorporating your program into proprietary
programs.
If your program is a subroutine library, you may consider it more useful to permit linking
proprietary applications with the library. If this is what you want to do, use the GNU Lesser
General Public License instead of this License.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must include the
following acknowledgment:
„This product includes software developed by the Apache Software Foundation
(http://www.apache.org/).‟
Alternately, this acknowledgment may appear in the software itself, if and wherever such
third-party acknowledgments normally appear.
4. The names „Apache‟ and „Apache Software Foundation‟ must not be used to endorse or
promote products derived from this software without prior written permission.
For written permission, please contact apache@apache.org.
5. Products derived from this software may not be called „Apache‟, nor may „Apache‟
appear in their name, without prior written permission of the Apache Software
Foundation.
Portions of this software are based upon public domain software originally written at the
National Center for Supercomputing Applications, University of Illinois, Urbana-Champaign.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
„Licensor‟ shall mean the copyright owner or entity authorized by the copyright owner that
is granting the License.
„Legal Entity‟ shall mean the union of the acting entity and all other entities that control,
are controlled by, or are under common control with that entity. For the purposes of this
definition, „control‟ means (i) the power, direct or indirect, to cause the direction or
management of such entity, whether by contract or otherwise, or (ii) ownership of fifty
percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
„You‟ (or „Your‟) shall mean an individual or Legal Entity exercising permissions granted
by this License. „Source‟ form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation source, and configuration
files.
„Object‟ form shall mean any form resulting from mechanical transformation or translation
of a Source form, including but not limited to compiled object code, generated
documentation, and conversions to other media types.
„Work‟ shall mean the work of authorship, whether in Source or Object form, made
available under the License, as indicated by a copyright notice that is included in or
attached to the work (an example is provided in the Appendix below).
„Derivative Works‟ shall mean any work, whether in Source or Object form, that is based
on (or derived from) the Work and for which the editorial revisions, annotations,
elaborations, or other modifications represent, as a whole, an original work of authorship.
For the purposes of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of, the Work and
Derivative Works thereof.
„Contribution‟ shall mean any work of authorship, including the original version of the
Work and any modifications or additions to that Work or Derivative Works thereof, that is
intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by
an individual or Legal Entity authorized to submit on behalf of the copyright owner.
For the purposes of this definition, „submitted‟ means any form of electronic, verbal, or
written communication sent to the Licensor or its representatives, including but not limited
to communication on electronic mailing lists, source code control systems, and issue
tracking systems that are managed by, or on behalf of, the Licensor for the purpose of
discussing and improving the Work, but excluding communication that is conspicuously
marked or otherwise designated in writing by the copyright owner as „Not a Contribution.‟
„Contributor‟ shall mean Licensor and any individual or Legal Entity on behalf of whom a
Contribution has been received by Licensor and subsequently incorporated within the Work.
4. Redistribution.
You may reproduce and distribute copies of the Work or Derivative Works thereof in any
medium, with or without modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or Derivative Works a copy of this
License; and
(b) You must cause any modified files to carry prominent notices stating that You changed
the files; and
(c) You must retain, in the Source form of any Derivative Works that You distribute, all
copyright, patent, trademark, and attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of the Derivative Works; and
(d) If the Work includes a „NOTICE‟ text file as part of its distribution, then any Derivative
Works that You distribute must include a readable copy of the attribution notices
contained within such NOTICE file, excluding those notices that do not pertain to any
part of the Derivative Works, in at least one of the following places: within a NOTICE
text file distributed as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or, within a display
generated by the Derivative Works, if and wherever such third-party notices normally
appear. The contents of the NOTICE file are for informational purposes only and do not
modify the License. You may add Your own attribution notices within Derivative Works
that You distribute, alongside or as an addendum to the NOTICE text from the Work,
provided that such additional attribution notices cannot be construed as modifying the
License.
You may add Your own copyright statement to Your modifications and provide additional
or different license terms and conditions use, reproduction, or distribution of Your
modifications, or any such Derivative Works as a whole, provided Your use, production,
and distribution of the Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions.
Unless You explicitly state otherwise, Contribution intentionally submitted for inclusion in
the Work by You to the Licensor shall be under the terms and conditions of this License,
without any additional terms or conditions. Notwithstanding the above, nothing herein shall
supersede or modify the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks.
This License does not grant permission to use the trade names, trademarks, service marks,
or product names of the Licensor, except as required for reasonable and customary use in
describing the origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty.
Unless required by applicable law or agreed to in writing, Licensor provides the Work (and
each Contributor provides its Contributions) on an „AS IS‟ BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including,
without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
responsible for determining the appropriateness of using or redistributing the Work and
assume any risks associated with Your exercise of permissions under this License.
8. Limitation of Liability.
In no event and under no legal theory, whether in tort (including negligence), contract, or
otherwise, unless required by applicable law (such as deliberate and grossly negligent acts)
or agreed to in writing, shall any Contributor be liable to You for damages, including any
direct, indirect, special, incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the Work (including but not
limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or
any and all other commercial damages or losses), even if such Contributor has been
advised of the possibility of such damages.
Licensed under the Apache License, Version 2.0 (the ‘License’); you may not use this file
except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License
is distributed on an ‘AS IS’ BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied. See the License for the specific language governing permissions and
limitations under the License
BSD License
Copyright (c) <YEAR>, <OWNER>
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions
and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.
Neither the name of the <ORGANIZATION> nor the names of its contributors may be
used to endorse or promote products derived from this software without specific prior
written permission.
2. License Grants.
2.1. The Initial Developer Grant.
Conditioned upon Your compliance with Section 3.1 below and subject to third party
intellectual property claims, the Initial Developer hereby grants You a world-wide, royalty-
free, non-exclusive license:
(a) under intellectual property rights (other than patent or trademark) Licensable by Initial
Developer, to use, reproduce, modify, display, perform, sublicense and distribute the
Original Software (or portions thereof), with or without Modifications, and/or as part of
a Larger Work; and
(b) under Patent Claims infringed by the making, using or selling of Original Software, to
make, have made, use, practice, sell, and offer for sale, and/or otherwise dispose of the
Original Software (or portions thereof).
(c) The licenses granted in Sections 2.1 (a) and (b) are effective on the date Initial
Developer first distributes or otherwise makes the Original Software available to a third
party under the terms of this License.
(d) Notwithstanding Section 2.1 (b) above, no patent license is granted: (1) for code that
You delete from the Original Software, or (2) for infringements caused by: (i) the
modification of the Original Software, or (ii) the combination of the Original Software
with other software or devices.
2.2. Contributor Grant.
Conditioned upon Your compliance with Section 3.1 below and subject to third party
intellectual property claims, each Contributor hereby grants You a world-wide, royalty-free,
non-exclusive license:
(a) under intellectual property rights (other than patent or trademark) Licensable by
Contributor to use, reproduce, modify, display, perform, sublicense and distribute the
Modifications created by such Contributor (or portions thereof), either on an unmodified
basis, with other Modifications, as Covered Software and/or as part of a Larger Work; and
(b) under Patent Claims infringed by the making, using, or selling of Modifications made
by that Contributor either alone and/or in combination with its Contributor Version (or
portions of such combination), to make, use, sell, offer for sale, have made, and/or
otherwise dispose of: (1) Modifications made by that Contributor (or portions thereof);
and (2) the combination of Modifications made by that Contributor with its Contributor
Version (or portions of such combination).
(c) The licenses granted in Sections 2.2 (a) and 2.2 (b) are effective on the date Contributor
first distributes or otherwise makes the Modifications available to a third party.
(d) Notwithstanding Section 2.2 (b) above, no patent license is granted: (1) for any code
that Contributor has deleted from the Contributor Version; (2) for infringements caused
by: (i) third party modifications of Contributor Version, or (ii) the combination of
Modifications made by that Contributor with other software (except as part of the
Contributor Version) or other devices; or (3) under Patent Claims infringed by Covered
Software in the absence of Modifications made by that Contributor.
3. Distribution Obligations.
3.1. Availability of Source Code.
Any Covered Software that You distribute or otherwise make available in Executable form
must also be made available in Source Code form and that Source Code form must be
distributed only under the terms of this License. You must include a copy of this License
with every copy of the Source Code form of the Covered Software You distribute or
otherwise make available. You must inform recipients of any such Covered Software in
Executable form as to how they can obtain such Covered Software in Source Code form in
a reasonable manner on or through a medium customarily used for software exchange.
3.2. Modifications.
The Modifications that You create or to which You contribute are governed by the terms of
this License. You represent that You believe Your Modifications are Your original creation(s)
and/or You have sufficient rights to grant the rights conveyed by this License.
3.3. Required Notices.
You must include a notice in each of Your Modifications that identifies You as the
Contributor of the Modification. You may not remove or alter any copyright, patent or
trademark notices contained within the Covered Software, or any notices of licensing or
any descriptive text giving attribution to any Contributor or the Initial Developer.
3.4. Application of Additional Terms.
You may not offer or impose any terms on any Covered Software in Source Code form that
alters or restricts the applicable version of this License or the recipients rights hereunder.
You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability
obligations to one or more recipients of Covered Software. However, you may do so only
on Your own behalf, and not on behalf of the Initial Developer or any Contributor.
You must make it absolutely clear that any such warranty, support, indemnity or liability
obligation is offered by You alone, and You hereby agree to indemnify the Initial Developer
and every Contributor for any liability incurred by the Initial Developer or such Contributor
as a result of warranty, support, indemnity or liability terms You offer.
3.5. Distribution of Executable Versions.
You may distribute the Executable form of the Covered Software under the terms of this
License or under the terms of a license of Your choice, which may contain terms different
from this License, provided that You are in compliance with the terms of this License and
that the license for the Executable form does not attempt to limit or alter the recipient‟s
rights in the Source Code form from the rights set forth in this License. If You distribute the
Covered Software in Executable form under a different license, You must make it
absolutely clear that any terms which differ from this License are offered by You alone, not
by the Initial Developer or Contributor. You hereby agree to indemnify the Initial
Developer and every Contributor for any liability incurred by the Initial Developer or such
Contributor as a result of any such terms You offer.
3.6. Larger Works.
You may create a Larger Work by combining Covered Software with other code not
governed by the terms of this License and distribute the Larger Work as a single product.
In such a case, You must make sure the requirements of this License are fulfilled for the
Covered Software.
5. DISCLAIMER OF WARRANTY.
COVERED SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN „AS IS‟
BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED
SOFTWARE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR
PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE COVERED SOFTWARE IS WITH YOU. SHOULD ANY
COVERED SOFTWARE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE
INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF
ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF
WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF
ANY COVERED SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER
THIS DISCLAIMER.
6. TERMINATION.
6.1. This License and the rights granted hereunder will terminate automatically if You fail
to comply with terms herein and fail to cure such breach within 30 days of becoming
aware of the breach. Provisions which, by their nature, must remain in effect beyond
the termination of this License shall survive.
6.2. If You assert a patent infringement claim (excluding declaratory judgment actions)
against Initial Developer or a Contributor (the Initial Developer or Contributor against
whom You assert such claim is referred to as „Participant‟) alleging that the Participant
Software (meaning the Contributor Version where the Participant is a Contributor or
the Original Software where the Participant is the Initial Developer) directly or
indirectly infringes any patent, then any and all rights granted directly or indirectly to
You by such Participant, the Initial Developer (if the Initial Developer is not the
Participant) and all Contributors under Sections 2.1 and/or 2.2 of this License shall,
upon 60 days notice from Participant terminate prospectively and automatically at the
expiration of such 60 day notice period, unless if within such 60 day period You
withdraw Your claim with respect to the Participant Software against such Participant
either unilaterally or pursuant to a written agreement with Participant.
6.3. In the event of termination under Sections 6.1 or 6.2 above, all end user licenses that
have been validly granted by You or any distributor hereunder prior to termination
(excluding licenses granted to You by any distributor) shall survive termination.
7. LIMITATION OF LIABILITY.
UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER
TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU,
THE INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR
OF COVERED SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE
LIABLE TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT
LIMITATION, DAMAGES FOR LOST PROFITS, LOSS OF GOODWILL, WORK
STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER
COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE
BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION
OF LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL
INJURY RESULTING FROM SUCH PARTY‟S NEGLIGENCE TO THE EXTENT
APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO
NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR
CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT
APPLY TO YOU.
9. MISCELLANEOUS.
This License represents the complete agreement concerning subject matter hereof.
If any provision of this License is held to be unenforceable, such provision shall be
reformed only to the extent necessary to make it enforceable. This License shall be
governed by the law of the jurisdiction specified in a notice contained within the Original
Software (except to the extent applicable law, if any, provides otherwise), excluding such
jurisdiction‟s conflict-of-law provisions. Any litigation relating to this License shall be
subject to the jurisdiction of the courts located in the jurisdiction and venue specified in a
notice contained within the Original Software, with the losing party responsible for costs,
including, without limitation, court costs and reasonable attorneys‟ fees and expenses.
The application of the United Nations Convention on Contracts for the International Sale of
Goods is expressly excluded. Any law or regulation which provides that the language of a
contract shall be construed against the drafter shall not apply to this License. You agree that
You alone are responsible for compliance with the United States export administration
regulations (and the export control laws and regulation of any other countries) when You
use, distribute or otherwise make available any Covered Software.
jaxen License
Copyright 2003 (C) The Werken Company. All Rights Reserved.
Redistribution and use of this software and associated documentation („Software‟), with or
without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain copyright statements and notices.
Redistributions must also contain a copy of this document.
Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.
The name „jaxen‟ must not be used to endorse or promote products derived from this
Software without prior written permission of The Werken Company.
For written permission, please contact bob@werken.com.
Products derived from this Software may not be called „jaxen‟ nor may „jaxen‟ appear in
their names without prior written permission of The Werken Company. „jaxen‟ is a
registered trademark of The Werken Company.
Due credit should be given to The Werken Company. (http://jaxen.werken.com/).
jdom License
Copyright (C) 2000-2004 Jason Hunter & Brett McLaughlin.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions,
and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of
conditions, and the disclaimer that follows these conditions in the documentation and/or
other materials provided with the distribution.
The name „JDOM‟ must not be used to endorse or promote products derived from this
software without prior written permission. For written permission, please contact
{request_AT_jdom_DOT_org}.
Products derived from this software may not be called „JDOM‟, nor may „JDOM‟ appear in
their name, without prior written permission from the JDOM Project Management
{request_AT_jdom_DOT_org}.
In addition, we request (but do not require) that you include in the end-user documentation
provided with the redistribution and/or in the software itself an acknowledgement
equivalent to the following:
„This product includes software developed by the JDOM Project (http://www.jdom.org/).‟
Alternatively, the acknowledgment may be graphical using the logos available at
http://www.jdom.org/images/logos.
THIS SOFTWARE IS PROVIDED „AS IS‟ AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
License of SACK
COPYRIGHT AND PERMISSION NOTICE for Simple AJAX Code Kit (SACK).
Copyright © 2005 Gregory Wild-Smith
Authors Website: http://www.twilightuniverse.com/
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the „Software‟), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify, merge,
publish, distribute, and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, provided that the above copyright notice(s), authors website
url, and this permission notice appear in all copies of the Software and that the above
copyright notice(s), authors url, and this permission notice appear in supporting
documentation.
Except as contained in this notice, the name of a copyright holder shall not be used in
advertising or otherwise to promote the sale, use or other dealings in this Software without
prior written authorization of the copyright holder.