WebNMS IoT Platform 6.0 Eclipse Guide. Table of Contents

Transcription

1

2 Table f Cntents Quick Tur... 1 Welcme t WebNMS IT Framewrk Eclipse Plugin... 1 Abut Eclipse... 2 Getting Started with Eclipse... 3 Technical Supprt... 4 Setting up Develpment Envirnment... 5 Setting up Develpment Envirnment... 5 Creating a Prject in Eclipse... 6 Viewing Prject Details... 8 Wrking with Files Wrking with External Tls Integrating WebNMS Studi help Custmizing Services Custmizing Services Mdeling Resurce Mdeling Resurce Creating Managed Resurce User-Object Mdeling Fault Management Fault Management Extending Events Extending Alerts Creating Custm Ntificatin fr Alert Filter and Event Filter Perfrmance Management Perfrmance Management Creating Pll Filter Cnfiguring Threshld Server Cnfiguratin Server Cnfiguratin Intrductin Editing NmsPrcessesBE.cnf Editing NmsPrcessesFE.cnf Cnfiguring Threads Editing Server Parameters Cnfiguring Plicies Setting Lgging Parameters Cnfiguring Backup Service Setting Failver Parameters Debugging Applicatins Built in Eclipse Rebranding WebNMS Deplying Eclipse Applicatins Deplying Eclipse Applicatins Packaging the Prject Integrating Cmmand Line Packager with Build Script Installing Eclipse Prject in WebNMS Uninstalling Eclipse Prject frm WebNMS Upgrading the Prject Frequently Asked Questins Knwn Issues & Limitatins... 59

3 Quick Tur Welcme t WebNMS IT Framewrk Eclipse Plugin The dcumentatin fr Eclipse Plugin is arranged in a manner that makes infrmatin easily accessible and understandable in the fllwing way. Quick Tur sectin prvides an intrductin t the Eclipse Plugin. Setting up Develpment Envirnment prvides the basics f wrking with the Eclipse such as creating and wrking with Prjects, multi user envirnment, mdifying the generated Surce t the requirements, etc. Custmizing Services sectin prvides all the details required by develpers t custmize their WebNMS IT applicatin using the Eclipse Plugin. Deplying Eclipse Applicatin sectin prvides infrmatin n hw t deply the applicatin created using Eclipse ver WebNMS IT Knwn Issues and Limitatins sectin prvides knwn prblems and assciated wrkarunds fr the Eclipse Plugin. FAQ sectin prvides frequently asked questins abut the Eclipse Plugin. As always, we welcme yur feedback n the prduct and will be happy t reslve any technical queries that yu may have with the prduct. Just send us a mail t WebNMS Supprt at itsupprt@webnms.cm 1

4 Abut Eclipse Intrductin What des the Eclipse Studi Plug-in cnsist f? Intrductin Eclipse, Integrated Develpment Envirnment is a widely used pen surce develpment envirnment. WebNMS nw prvides WebNMSEclipsePlugin which will seamlessly plug int the Eclipse IDE and prvide yu with a pwerful suite f Wizards and Tls that help yu t develp yur IT applicatin very fast. What des the Eclipse Studi Plug-in cnsist f? The Plugin cmes with an intuitive set f wizards and tls fr custmizing the varius services ffered by WebNMS. These tls supprt the entire develpment cycle f an management applicatin frm mdeling the gateway cmpnent as a managed resurce t custmizing services t finally packaging and installing the applicatin ver WebNMS IT Framewrk. Sme f the salient functins ffered by the Plug-in are: Mdeling the resurces such as IT regins, sites, gateways, sensrs etc, that can be managed by WebNMS IT. Defining fault management fr the device and prcessing them based n the required criteria t generate events r alarms. Creating screens fr perfrming cnfiguratins n the device. Defining perfrmance management fr the device in terms f data cllectin, status plling. Packaging the applicatin as a dwnladable NAR (NMS Archive) that can be installed n any WebNMS. The Eclipse Plugin is built n the extensible and platfrm-independent Java Technlgy and has a highly intuitive graphical user interface. This is sure t enhance the prductivity f the IT applicatin building teams. The plugin has been designed keeping in mind the develper and dmain expert wh nrmally frm part f the develpment teams f IT vendrs r large enterprises. Take a peep int WebNMS IT's latest ffering fr creating management applicatins easily and quickly. We are cnfident yu will find it f immense use. T make yur task easier, the dcumentatin bundled will help yu walk yu thrugh the varius features ffered in the plugin alng with real-time illustratins f the key features and services. As always, we welcme yur feedback and will be very glad t supprt yu thrughut yur evaluatin f the prduct and the develpment f yur applicatins. 2

5 Getting Started with Eclipse Pre requisites fr Eclipse IDE Sftware requirements Prcedure t start Eclipse IDE Pre requisites fr Eclipse IDE The pre requisites fr WebNMS IT applicatin develpment using Eclipse. Sftware requirements Eclipse versin Kepler r higher JDK versin 1.7 r higher WebNMS IT 6.0 WebNMS Eclipse Plugin Prcedure t start Eclipse IDE Install the recmmended Eclipse (versin Kepler r higher) in yur machine. Get the latest WebNMS - Eclipse plugin (WebNMSEclipsePlugin.jar file) frm <WebNMS IT Hme>/StudiTls/Studi/jars directry and unzip this jar file in the <Eclipse Installed directry.> Start Eclipse IDE. Use the script with the - vm ptin as given belw: Cmmand fr Linux machine./eclipse -vm <JDK 1.7 Hme>/bin/java Cmmand fr Windws machine eclipse -vm <JDK 1.7 Hme>\bin\java If yu are installing a newer versin f ur plug-in ver, please use the "-clean" ptin in the cmmand line while starting Eclipse IDE: Example:./eclipse -vm <JDK 1.7 Hme>/bin/java -clean 3

6 Technical Supprt Technical Supprt prvides answers t yur technical questins abut the WebNMS Eclipse plugin. We prvide the best supprt and specialize in reslving the mst cmplex prblems encuntered during the prcess f wrking with the plug-in. The hallmark f ur supprt is rapid and knwledgeable respnse t custmer queries frm ur prduct develpers-cum-supprt specialists. Fr supprt and bug-reprt, please send s t it-supprt@webnms.cm Please prvide the fllwing infrmatin while sending supprt mails: 1. Eclipse Prject Details 2. Lgs and Debug messages. (Eclipse lgs cntained in a ".lgs" file can be fund in <Eclipse Wrkspace>/.metadata directry) Tell us als what yu think f the plugin. We value yur feedback and will use it t prvide better services and prducts fr ur custmers. 4

7 Setting up Develpment Envirnment Setting up Develpment Envirnment The first step in building an applicatin is setting up the develpment envirnment. The Eclipse supprts cncurrent prject develpment whereby many peple in a team can wrk tgether n develpment envirnment. Please fllw the steps belw t setup the develpment envirnment fr wrking with the Eclipse. Creating a New prject Viewing Prject Details Wrking with Files Wrking with External Tls Integrating Help 5

8 Creating a Prject in Eclipse Overview Creating the IT Develpment Prject Wrking with Surce Flders Existing default surce flders in the prject Prcedure t create new surce flder in the prject Prcedure t cpy surce files in the WEBACTIONCLASSES flder Overview The first step in wrking with the Eclipse is creating a Prject. A Prject created in Eclipse cpies the necessary surce files and cnfiguratin files frm the reference WebNMS IT t the wrkspace where the prject will be stred. The Eclipse wrkspace is created t separate the develpment envirnment frm the runtime WebNMS and make it easier fr gruping the necessary infrmatin while packaging the prject. T create WebNMS IT applicatin develpment prject in Eclipse fllw the prcedure given belw: Creating the IT Develpment Prject In the Eclipse IDE screen, select File > New > Create IT Prject menu. Alternatively, yu can click the Create IT Prject tlbar buttn. IT Develpment Prject Wizard screen pps up. In the Prject Prperties screen, enter a name fr the prject in Prject Name text field and use the Brwse buttn t select the WebNMS IT Hme directry. WebClient supprt can als be enabled in the same wizard. Click the Finish buttn. Yu will find the created prject under the Package Explrer tree. 6

9 Wrking with Surce Flders Existing default surce flders in the prject By default the fllwing surce flders will be available in the IT Develpment Prject: SERVER WEBACTIONCLASSES (This flder is created if the Enable WebClient Develpment ptin is selected in the abve screen) Yu can als create new surce flders using the prcedure given belw: Prcedure t create new surce flder in the prject Select yur prject in the Package Explrer. Right-click and select File > New > Surce Flder menu. "New Surce Flder" wizard screen pps up. In the screen, prject name is pre-filled in Prject Name text field and enter a name fr the flder in Flder Name text field r use the Brwse buttn t select frm the existing directries. Click Finish buttn. Yu will find the new surce flder created under yur prject in the Package Explrer tree. The utput flder fr the newly created surce flders will be autmatically set t the default utput flder cnfigured fr the prject. The default utput flder is classes flder present in the prject. Yu can use the existing default surce flders f the prject r new surce flders created by yu t create surce files. Prcedure t cpy surce files in the WEBACTIONCLASSES flder Cpy the cntent f the webclient related java surce file. Select the WEBACTIONCLASSES in the Prject Explrer tree. Right click and select the Paste ptin. The surce file will be cpied alng with the package structure name. 7

10 Viewing Prject Details Overview Prject Prperties Mdifying WebNMS Hme Details Deplyment Jar Cnfiguratin Overview Prperties fr the prject created in Eclipse are set based n the infrmatin prvided in the New Prject Wizard. The prperties are applied fr the cmplete prject. T mdify/edit the WebNMS IT Hme Details, invke the Prject Prperties dialg. By default, the Prject Prperties dialg displays all the infrmatin set in the Prject Wizard at the time f the creatin f the Prject. Prject Prperties Mdifying WebNMS Hme Details Deplyment Jar Cnfiguratin Prject Prperties is used t view the Prject Details. Prject Prperties Select the prject in the Package Explrer, yu can ntice Prject Prperties menu and icn get enabled. Select WebNMS > Prject Prperties menu. Alternatively, yu can click the Prject Prperties tlbar buttn. Click OK. IT Prject Prperties screen pps up. In the IT Prject Prperties screen, Prject Details such as Prject Name, WebNMS Installatin Directry, WebNMS Cntext, WebNMS Versin, ServicePack Versin are displayed. Mdifying WebNMS Hme Details Click Brwse t mdify the WebNMS Installatin Directry. Classpath/Buildpath fr the prject will be autmatically updated with the newly specified WebNMS IT Hme. 8

11 Click the Edit buttn t cnfigure the deplyment jar and type fr the surce flder. Click the OK buttn t save the changes in the PrjectDetails.xml file. Deplyment Jar Cnfiguratin The Deplyment Jar Cnfiguratin ptin is als available in the Prject Prperties dialg. T change the deplyment jar and type f the surce flder, select the Surce flder rw and click the Edit buttn. Frm the dialg, select the jar and type frm the drp dwn list bxes. The deplyment jar and type can be mdified fr SOURCE. Fllw the steps given belw t create a new jar: 1. In the Select jar and type fr surce flder dialg, click the Create New Jar buttn. The Create New Jar dialg will be displayed. 2. Enter the name f the jar t be created. 3. Click OK. The jar name gets added t the cmb bx. 4. Click OK in the Select jar and type fr surce flder dialg. The details will be updated in the rw f surce flder. Nte: While packaging the prject, the class files present in the utput class f the surce flder will be packaged with the newly created jar name. 9

12 Nte: In the Deplyment Jar Cnfiguratin, if the Cmmn.jar is selected as the deplyment jar fr the surce flder, the class files present in the utput classes f the surce flder will get packaged int the Server.jar. Therefre, when there is requirement t have the class file in the server classpath, then the Cmmn.jar ptin can be selected. 10

13 Wrking with Files Overview Steps t imprt WebNMS cnfiguratin files t Eclipse Overview In Eclipse, files (xml, java, cnf, txt, etc.) can be created and edited. All surce files generated in the Prject and cnfiguratin files cpied t the wrkspace can be viewed, edited and user cde can be added as required. Steps t imprt WebNMS cnfiguratin Files t Eclipse In Eclipse, it is pssible t Imprt a file frm the lcal file system int the wrkspace. T Imprt the WebNMS Cnfiguratin files t Eclipse, it is necessary t perfrm the fllwing steps. Right Click the Package Explrer Windw and select Imprt ptin. "Imprt" Dialg screen is displayed. In the "Imprt" Dialg screen, Select Imprt WebNMS Cnf File frm Cnf File Imprt. Click Next buttn t view the " WebNMS Cnf File Imprt " wizard. In the Imprt WebNMS Cnf File screen, imprt a file frm the given WebNMS IT installatin directry int the IT Develpment prject. In the Select File text field, Click Brwse t select the file that is t be imprted. Select the Parent Flder t where the files are t be imprted. (By default the file will be placed inside the "<prjname>/resurces" directry in the same directry structure as present in WebNMS.) Click Finish buttn. The file gets imprted t the Parent Flder in the Package Explrer Windw. 11

14 12

15 Wrking with External Tls Deply the Develped Applicatin n WebNMS Perfrming Security Administratin Operatins Yu can develp applicatins and deply the applicatins frm the Eclipse IDE itself. The prcedure invlved in deplying the applicatin n WebNMS using Deplyment Wizard menu. Deply the Develped Applicatin n WebNMS After develping the IT applicatin and packaging it as a NAR file, yu need t deply it in WebNMS. Use the Deplyment Wizard t install the NAR file ver WebNMS. The Deplyment Wizard autmatically takes care f cnf files and resurce related changes. Yu can invke the Deplyment Wizard by using the WebNMS > Tls > Deplyment Wizard menu. Fr details n deplying develped Applicatin read the sectin Develper Guide > Designer Tls > Deplyment Tl. Perfrming Security Administratin Operatins The Security Administratin User Interface can be invked frm Eclipse, and used t cnfigure the security infrmatin in the WebNMS. Yu can invke the Security Administratins UI by using the WebNMS > Tls > Security Admin Tl menu. Fr mre details n Security Administratin, please refer t the Security Services sectin in the Develper Guide. 13

16 Integrating WebNMS Studi help The Eclipse InfCenter ffers an actively maintained utput fr WebNMS EclipsePlugin Help. It enable users t access the WebNMS Eclipse Plugin help cntents. Fr this the WebNMS Eclipse Plugin help cntents have t be integrated int Eclipse InfCenter. This helps the custmers (develpers) t view the infrmatin at ffline r at a remte client site. It guides the user t wrk with Eclipse Plugin and ther related external tls. Fllw the belw steps t integrate WebNMS Eclipse Plugin help int Eclipse InfCenter. Apply the WebNMSEclipsePlugin in yur eclipse installatin by unzipping the WebNMSEclipsePlugin.jar in the <Eclipse Install Hme>. Please refer Prcedure t start Eclipse IDE fr mre details. Inside the <Eclipse Install Hme>/plugins directry the help plugin archive (cm.adventnet.nms.itdevelpment.help_1.3.1.jar) will be available. Extract this jar file int a flder with name as 'cm.adventnet.nms.itdevelpment.help_1.3.1'. Nw the help plugin is cnverted frm Archive frmat t explded frmat. Dwnlad the Eclipse Plugin Help dcumentatin Zip frm Rename the zip as "dc.zip" and place it in the <Eclipse installed directry>/plugins/cm.adventnet.nms.itdevelpment.help_ Nw Restart Eclipse with the "-clean" ptin. T invke Eclipse InfCenter in Eclipse Plugin, Click Help->Help Cntents. 14

17 Custmizing Services Custmizing Services In rder t build a cmplete IT slutin, yu need t custmize the varius services ffered by WebNMS IT. In this sectin, yu will see hw Eclipse Plugin helps yu custmize each f these services and what are the varius tls Eclipse Plugin ffers t custmize each f these services. T start custmizing the varius services, the first step is mdeling the resurces t be managed. Accrdingly, this sectin starts with mdeling resurces and ges n t custmizing the management services f WebNMS. The tpics are arranged in a fashin that is typical f the rder in which Services are custmized in an IT building cycle. Resurce Mdeling Fault Management Perfrmance Management Server Cnfiguratin Cnfiguring Plicies Setting Lgging Parameters Cnfiguring Backup Service Setting Failver Parameters Debugging Applicatins Built in Eclipse Rebranding 15

18 Mdeling Resurce Mdeling Resurce Mdeling yur resurces is made very easy and cmprehensive with the Mdel Managed Object Wizard. With the Wizard, yu can mdel yur device as a managed resurce fr WebNMS IT in fur easy steps. The Managed Object Wizard generates the hibernate mapping file fr the managed resurce. The Generate Java Surce menu can be used t aut-generate the java cde fr the Managed Object. Frm the Mdel Managed Object Wizard, yu can Extend Base Objects frm a set f parent resurces. Cnfigure field sizes fr attributes depending n the database. T wrk with the Managed Object Wizard fr creating managed resurces, please read Creating Managed Resurce. T mdel ther resurces such as extended Alert, Event, and User-Object (that d nt extend any f the ManagedObject base classes) als the same Mdel Managed Object Wizard cab be used. Please refer the fllwing sectins fr mre details: Extending Events Extending Alert User-Object Mdeling 16

19 Creating Managed Resurce Overview Mdel a Managed Object Generate a Java Surce Cde Actins fr Mdifying and Deleting the MO Overview The first step in creating an IT applicatin is Mdeling the Managed Resurces, this is dne using the Mdel Managed Object Wizard. This wizard will guide yu thrugh the steps f defining the ManagedObject prperties. The final utput f this wizard is the hibernate mapping file. This file can in turn be used t generate the bean class using the Generate Java Surce menu. The key feature f the wizard is the MIB supprt prvided t simplify the task f defining unique prperties fr the Managed Resurce. Mdel a Managed Object Select the prject r surce flder in the Package Explrer, yu can ntice Mdel Object menu and icn get enabled. Select WebNMS > Mdeling > Mdel Object menu. Alternatively, yu can click the Mdel Object tlbar buttn. Package Structure Editr screen pps up. In the Package Structure Editr screen, enter the package name f the managed bject in the Package Name text field and enter mdeled r extended bject name in the Mdeled/Extended Object Name text field. Click Next buttn. Cmpnent MO Table Details screen pps up. In the Cmpnent MO Table Details screen, select Tp fr the Select Mdule ptin, select cm.adventnet.nms.tpdb.managedobject (r ther default ManagedObject class) frm the drp dwn list fr the Parent MO/Extended Object Name ptin. Refer t the tpic WebNMS Default Managed Objects in NMS Develper Guide fr mre details. Fill the Discriminatr Value. This is a string that uniquely represents this bject. By default, this is the same as the Managed Object name. The Generate Java Surce ptin will be selected by default. On cmpleting the wizard, the java surce will be autmatically generated fr the mdeled MO with this ptin selected. If the ptin is de-selected, the java surce will nt be generated. The generated surce file will be placed under the SERVER surce flder. T stre the file in a different surce flder in the prject, select the flder frm the drp dwn bx. 17

20 Hibernate advanced prperties that crrespnds t each f the extended managed resurce is shwn belw. The default value is false. Yu can enable these prperties nly if yu need t cnfigure sme advanced fetching strategy at the hibernate persistence level. Is dynamic update required: This crrespnds t "dynamic-update (ptinal, defaults t false): Specifies that UPDATE SQL shuld be generated at runtime and cntain nly thse clumns whse values have changed." Is select befre update required : This crrespnds t "selectbefre-update (ptinal, defaults t false): Specifies that Hibernate shuld never perfrm an SQL UPDATE unless it is certain that an bject is actually mdified. In certain cases (actually, nly when a transient bject has been assciated with a new sessin using update()), this means that Hibernate will perfrm an extra SQL SELECT t determine if an UPDATE is actually required." Enable lazy fetching: This crrespnds t "lazy (ptinal): Setting lazy="true" is a shrtcut equivalent t specifying the name f the class itself as the prxy interface.the ptinal prxy attribute enables lazy initializatin f persistent instances f the class. Hibernate will initially return prxies which implement the named interface. The actual persistent bject will be laded when a methd f the prxy is invked." Is dynamic Insert required:"dynamic-insert (ptinal, defaults t false): Specifies that INSERT SQL shuld be generated at runtime and cntain nly the clumns whse values are nt null." Mark superclass as abstract:if yur superclass is abstract, map it with abstract="true". Of curse, if it is nt abstract, an additinal table is needed t hld instances f the superclass. Refer the sectin Table per cncrete class fr mre details. Click the Cnfigure ther Mapping Prperties buttn t cnfigure additinal mapping prperties fr the MO. When the buttn is clicked, Jin-SubClass Attribute Viewer screen pps up. Fr mre details regarding the hibernate prperties refer the hibernate dcumentatin In the Jin-SubClass Attribute Viewer screen, enter the Attribute Value against the Attribute Name fr the required attributes. The attributes are given belw: entity-name nde subselect persister check catalg batch-size schema prxy 18

21 In the Jin-SubClass Attribute Viewer screen, click the Save buttn t save the additinal attributes fr the MO and Cancel buttn t cancel the additinal attribute cnfiguratin. Click Next buttn t view the MO Prperty Details screen In the MO Prperty Details screen, click Add buttn t add prperties fr the MO. The clumns name, type, clumn, length will becme editable. Enter the apprpriate values. Select the rw f the prperty and click Delete buttn t delete the prperty. While mdelling the MO, hibernate specific prperties can be added as clumn t the table. On clicking the Additinal Prperty buttn, the hibernate specific prperties will be listed. T add a prperty t the table, select the check bx fr the prperty and click the Save buttn. T remve the added prperty frm the table, de-selected the prperty and click the Save buttn. 19

22 Nte: The additinal hibernate specific prperties is nt mandatry, and the wizard can be cmpleted by prviding values fr the default clumns (PrpertyName,Clumn,Type,Length). Click Finish buttn t cmplete MO Mdeling. Yu will find the mdeled MO under <Yur Prject>/Referenced Libraries/resurces/classes/hbnlib/<Package f MO>/ <Mdeled MO> in the Prject Explrer windw. The next step is t generate the Java surce cde fr the Mdeled MO using Java Surce Generatr. Generate a Java Surce Cde Generate Java Surce is t create the surce cde fr the Mdeled MO frm the Xml file. Select the prject r surce flder in the Package Explrer, yu can ntice Generate Java Surce menu and icn get enabled. Select WebNMS > Mdeling > Generate Java Surce menu. Alternatively, yu can click the Generate Java Surce tlbar buttn. Java Surce Generatr screen pps up. In Java Surce Generatr screen, select the Xml file (multiple Xml files can als be selected) fr Generating Java Surce and click >> buttn. Select the surce flder t generate the Java surce. Click OK. It will generate the Java surce cde fr the hibernate mapping files that are selected. Mdifying an Managed Object There are tw ways in which an Managed Object can be mdified. Directly frm the Prject Tree Using the Mdify Object Wizard Directly frm the Prject Tree Edit the <Mdeled MO>.hbm.xml generated under <Yur Prject>/Referenced Libraries/resurces/classes/hbnlib/<Package f MO> in the Prject Explrer windw. Mdify/Add the required prperties and save the changes. Nw generate the Java Surce using WebNMS > Mdeling > Generate Java Surce menu fr the mdified XML. Select the mdified <Mdeled MO>.hbm.xml file and click OK. It will ask a prmpt message t replace the file. 20

23 Click OK. It will generate the Java surce cde fr the hibernate mapping file that is mdified. Using the Mdify Object Wizard Select WebNMS > Mdeling > Mdify Object frm the main menu. Alternatively, yu can click the Mdify Object tlbar buttn. Mdify XML file screen pps up. Select the XML file and click the >> buttn. Click the Mdify buttn. The MO Mdeling wizard will be invked with the ppulated values. The Package Name and Mdelled/Extended Object Name text field will be nn-editable. In the MO table details page,the Mdule Selectin will be nneditable. All the ther fields will be editable and the values can be mdified. Click the Next buttn t g t MO Prperty Details page. The prperties can als be edited. Click the Mdify buttn t cmplete the Mdify Object Wizard. Deleting an Managed Object Directly frm the Prject Tree Using the Delete Managed Object Wizard Directly frm the Prject Tree T Delete the Managed Object, delete the generated.java file and <Mdeled MO>.hbm.xml file in the Package Explrer windw in the eclipse. Remve the crrespnding entry frm the <Yur Prject>/Referenced 21

24 Libraries/resurces/classes/hbnlib/<Package f MO>\hibernate.cfg.xml file. Fr Example, The steps t delete managed bject say sampleobj is shwn belw, Right Click sampleobj.java file present in Package Explrer windw under <Yur Prject>/SERVER/<Package f MO>/sampleObj.java and select delete. Right Click sampleobj.hbm.xml file present in Package Explrer windw under <Yur Prject>/Referenced Libraries/resurces/classes/hbnlib/<Package f MO>/sampleObj.hbm.xml and select delete. Remve the entry sampleobj.hbm.xml frm the <YurPrject>/ReferencedLibraries/resurces/classes/hbnlib/<Package f MO>\hibernate.cfg.xml file. Befre deleting the Managed Object sampleobj, the entry in hibernate.cfg.xml file will be as shwn belw <mapping resurce="cm/adventnet/nms/tutrials/ems/testobj.hbm.xml"/> <mapping resurce="cm/adventnet/nms/tutrials/ems/sampleobj.hbm.xml"/> After deleting the Managed Object Card, Card.hbm.xml entry will nt be present in hibernate.cfg.xml. <mapping resurce="cm/adventnet/nms/tutrials/ems/testobj.hbm.xml"/> Using the Delete Managed Object Wizard Select WebNMS > Mdeling > Delete Object menu. Alternatively, yu can click the Delete Object tlbar buttn. The Delete Managed Object dialg pps up. Select the XML file that needs t be deleted. Click the Delete buttn. Nte: When all the Managed Objects under a particular package <Package f MO> are deleted, the package <Package f MO> will als be deleted frm the Prject Explrer windw. 22

25 User-Object Mdeling The Prcedure t Mdel a User Object is similar t the steps fllwed in Mdelling a Managed Object except that in the Cmpnent MO Table Details screen, select user-strage fr the Select Mdule ptin instead f tp. Once the user-strage is selected, Parent MO/Extended Object Name gets disabled. Fr further details, refer t the sectin, Mdel a Managed Object. In the case f user-strage ptin, it is necessary t specify the primary key. If single prperty is selected as Primary key, then select the Generatr types frm the list. Native Assigned Sequence User-defined By default, Native type is selected. nly in the case f User-defined type, it is necessary t Specify the User class. If mre than ne prperty (cmpsite key) is selected as Primary key, then it is necessary t enter the Cmpsite Identifier Class Name. Click Finish Buttn. T generate the Java surce cde fr the Mdeled user bject frm the Xml file, refer t the sectin Java Surce Generatr fr mre details. 23

26 Nte: When the data type is String fr a clumn, the Generatr types available in the list are Assigned and User-defined nly. Fr ther data types all fur Generatr types will be displayed fr selectin. 24

27 Fault Management Fault Management Fault management fcuses n prblem detectin, diagnsis and rectificatin. WebNMS IT ffers cmprehensive fault management services such as event and alert management, alarm crrelatin etc. Frm Eclipse, it is pssible t custmize Fault service t specific requirements. Using the Mdel Managed Object Wizard, yu can define yur wn event bject extending IT cmpnent event. Similarly yu can define yur wn alert bject extending alert. The relevant hibernate mapping file and the bean surce are generated autmatically. Please read the tpics Extending Events and Extending Alerts t knw mre. Fr further details regarding extending Events and Alerts, please refer the sectin Fault Management in WebNMS Dcumentatin. 25

28 Extending Events Events are the basic units f fault management. The event bject has certain prperties defined t identify the events. Users can have additinal user prperties fr their cnvenience. Mre number f user prperties degrade perfrmance as database queries increases with the number f user prperties. Users shuld understand the fact that user prperties feature is prvided fr adding a few prperties in the event bject withut extending the event bject. If the user wishes t have mre number f user prperties, then it is better t extend the event bject and add the desired prperties. Need t Extend Events Based n the device types and the need fr additinal prperties, the decisin whether t extend the events r nt is t be taken. If the IT netwrked envirnment includes specific devices which need mre prperties t represent an event bject, then it is recmmended t extend the events. Extending Event Object The Prcedure t Extend Event Object is similar t the steps fllwed in Mdelling a Managed Object except that in the Cmpnent MO Table Details screen, select event fr the Select Mdule ptin instead f tp, select cm.adventnet.nms.eventdb.event frm the drp dwn list fr the Parent MO/Extended Object Name ptin. The generated surce fr the Event bject has the parent resurce extending an event class. Fr mre details, refer t Mdel a Managed Object. Extending the Event Class While extending the Event class, the fllwing pints are t be nted: The id is the primary key in the Event table. All extended Events will have id as primary key. Refer t Writing Extended Event Class in WebNMS Develper Guide fr further details. 26

29 Extending Alerts An Alert represents a failure r fault in an asset with a cnditin that may need attentin. Alerts can be extended fr incrprating additinal prperties. Users can have additinal user prperties fr their cnvenience. Mre number f user prperties may result in lesser perfrmance as database queries increases with the number f user prperties. Users shuld understand the fact that user prperties feature is prvided fr adding a few prperties in the alert bject withut extending the alert bject. If the user wishes t have mre number f user prperties, then it is better t extend the alert bject and add the desired prperties. Steps Invlved in Extending Alerts The Prcedure t Extend Alert Object is similar t the steps fllwed in Mdelling a Managed Object except that in the Cmpnent MO Table Details screen, select alert fr the Select Mdule ptin instead f tp and select cm.adventnet.nms.alertdb.alert frm the drp dwn list fr the Parent MO/Extended Object Name ptin. The generated surce fr the Alert bject has the parent resurce extending an alert class. Fr mre details, refer t Mdel a Managed Object Extending the Alert class While extending the Alert class the fllwing pints are t be nted. The id is the primary key in the Alert table. All extended Alerts will have id as primary key. Refer t Extending Alerts in WebNMS Develper Guide fr further details. 27

30 Creating Custm Ntificatin fr Alert Filter and Event Filter Overview Creating Event Filter Creating Alert Filter Overview Event / Alert filters allw the users t perfrm sme actin when a event / alert matching the specified criteria is received. In WebNMS IT there are pre-defined actins like: Suppress Actin: Suppress all r sme f the Events / Alerts matching this criteria. Run Cmmand Actin: Run a system cmmand n the WebNMS IT server. Send Actin: Intimate the Administratr thrugh . Custm Filter: Invke yur wn Java class fr addressing applicatin specific needs. In case f Event Filters, the Filter entry specifying the match criteria and the actin t be perfrmed is cnfigured in the event.filters cnfiguratin file present in the <WebNMS IT Hme>/cnf directry. Fr defining the first 4 pre-defined actins, the Event Filter Cnfiguratin Tl can be used. Please refer the dcumentatin Cnfiguring Event Filters. In case f Alert Filters, the cnfiguratin details are persisted in the alert.filters file present in the <WebNMS IT Hme>/cnf directry. The pre-defined actins can be cnfigured using the Alert Filter Admin Tl. Fr mre details regarding using this tl, please refer the Cnfiguring Alert Filters dcumentatin. When a custm actin / ntificatin is t be cnfigured, the custm filter class needs t be created. Please refer the sectins belw fr creating custm ntificatin class fr Event and Alert filters. Creating Event Filter Select the prject r surce flder in the Package Explrer, yu can ntice Create Event Filter menu and icn get enabled. Alternatively, yu can click the Create Event Filter tlbar buttn. Select WebNMS > Filters > Fault > Create Event Filter menu. Click Finish buttn. "EventFilter Creatin Wizard" screen pps up. In the Event Filter Prperties screen, enter the package name f the event filter in the Package Name text field, enter the event filter class name in the Filter Class Name text field. 28

31 Yu will find the <Event Filter class> under <Yur Prject>/surce flder in the Prject Explrer windw. Creating Alert Filter Select the prject r surce flder in the Package Explrer, yu can ntice Create Alert Filter menu and icn get enabled. Alternatively, yu can click the Create Alert Filter tlbar buttn. Select WebNMS > Filters > Fault > Create Alert Filter menu. Click Finish buttn. "AlertFilter Creatin Wizard" screen pps up. In the Alert Filter Prperties screen, enter the package name f the alert filter in the Package Name text field, enter the alert filter class name in the Filter Class Name text field. Yu will find the <Alert Filter class> under <Yur Prject>/surce flder in the Prject Explrer windw. 29

32 Nte: The entry fr the custm class created will be appended in the event.filters and alert.filters file fr the Event Filter and Alert Filter respectively. 30

33 Perfrmance Management Perfrmance Management Perfrmance mdule is made up f three main functinal cmpnents, namely Data cllectin and strage, Mnitring, and Reprting. All these are cntrlled frm a single pint which is called Plling Engine. The Plling Engine is respnsible fr applying data cllectin cnfiguratin, cllecting data, applying threshlds n cllected data and mnitring,sending ntificatins n threshld rule vilatin, and cntrlling Reprt generatin. The perfrmance related cde generatin / cnfiguratin that can be dne in Eclipse are as fllws: A Tl t create Pll Filter. Pll Filter allws manipulatin f PlledData bjects befre they are added t the database. The manipulatins will be f additin, mdificatin, r deletin f PlledData bjects. An XML editr t edit the cnfiguratin files, Threshlds.cnf, and Reprts.cnf. Fllw the links t get details n what can be defined in each f these cnf files. Threshlds.cnf cntains definitin f Threshlds t be applied ver cllected data. The fllwing sectin cntains dcuments explaining hw t use the abve mentined tls. Creating Pll Filter Cnfiguring Threshlds 31

34 Creating Pll Filter Overview Creating a pll Filter Overview Pll Filter is used t fine-tune the Data cllectin cnfiguratin. When Managed Objects are discvered, user can cnfigure cllectin f perfrmance data by using Pll Filter. Pll Filter essentially allws yu t add/mdify/delete PlledData which are created as a result f plling bjects creatin. Pll Filters can perfrm the fllwing : Existing PlledData can be mdified. New PlledData can be added fr the Managed bject. Existing PlledData can be remved. The Pll Filter Creatin Wizard allws yu t generate the stub cde fr the pll filter and will place the apprpriate entry in the plling.filters file fr invking this filter in WebNMS IT. Fr mre details n need fr Pll Filter, refer t Writing Pll Filter in WebNMS IT Develper Guide. Creating a pll Filter Select the prject r surce flder in the Package Explrer, yu can ntice Create Pll Filter menu and icn get enabled. Alternatively, yu can click the Create Pll Filter tlbar buttn. Select WebNMS > Filters > Perfrmance > Create Pll Filter menu. Click Finish buttn. "Pll Filter Creatin Wizard" screen pps up. In the Pll Filter Prperties screen, enter the package name f the pll filter in the Package Name text field, enter the pll filter class name in the Filter Class Name text field. 32

35 Yu will find the <Pll Filter class> under <Yur Prject>/surce flder in the Prject Explrer windw. This generated class is just the stub cde implementing the PllFilter interface. The applypllfilter methd needs t be verwritten t manipulate the plled data as per yur requirement. Als the apprpriate entry fr invking this filter class is appended t the pll.filters file placed in <Yur Prject>/resurces/cnf directry. 33

36 Cnfiguring Threshld Threshlds are baselines established t mnitr data cllectin. If cllected data ges beynd the Threshld value, it indicates that the cllected value is nt a recmmended value. Threshld.cnf file stres the definitin f Threshld bjects, with a minimum r maximum value t be cmpared with the cllected netwrk data. T Imprt Threshld.cnf file, please refer t the sectin Wrking with Files Fr detailed explanatin n defining threshlds refer t Defining Threshld in WebNMS IT Develper Guide. 34

37 Server Cnfiguratin Server Cnfiguratin Intrductin This sectin prvides an verview f Server Cnfiguratin files. Fr cnfiguring the new prcesses r mdifying the parameters t existing prcesses and fr changing server parameters, fllwing Server Cnfiguratin files can be edited in Eclipse by imprting them int the prject. The files discussed are NMSPrcessesBE.cnf NMSPrcessesFE.cnf threads.cnf serverparameters.cnf 35

38 Editing NmsPrcessesBE.cnf NmsPrcessesBE.cnf is the main cnfiguratin file which cntains the list f all the prcesses (als called "mdules") that get started when WebNMS BE Server is started. The values fr the varius parameters f the mdules are als specified in this file. When yu want t add yur wn mdule int WebNMS BE, yu can d s by specifying the fully qualified class name f yur implementatin f cm.adventnet.nms.util.runprcessinterface and the parameters t be passed t it in the NmsPrcessesBE.cnf. Imprt the cnfiguratin file NmsPrcessesBE.cnf frm <WebNMS IT Hme>/cnf directry int the Eclipse Prject. Open the file in the prject. Edit the file and click Save t save the changes. Read the sectin Wrking with Files fr mre details. Fr mre details, read WebNMS Mdule Dependency in WebNMS IT Develper Guide. 36

39 Editing NmsPrcessesFE.cnf This is the main cnfiguratin file which cntains the list f all the prcesses (als called as"mdules") that get started when WebNMS FE Server is started. The values fr the varius parameters f the mdules are als specified in this file. When yu want t add yur wn mdule int WebNMS FE, yu can d s by specifying the fully qualified class name f yur implementatin f cm.adventnet.nms.util.runprcessinterface and the parameters t be passed t it in the NmsPrcessesFE.cnf. If a value is nt given fr a parameter in NmsPrcessesFE.cnf file, then the same is taken frm serverparameters.cnf file. Overall functining f FE Server can be cnfigured by changing sme f the cmmand line parameters fr the prcess "NmsMainFE". This has t be specified in NmsPrcessesBE.cnf file, if FE Server is started in the same JVM as that f BE Server. Otherwise, these parameters can be specified in startnmsfe.bat/sh file. Imprt the cnfiguratin file NmsPrcessesFE.cnf frm <WebNMS IT Hme>/cnf directry int the Eclipse Prject. Open the file in the prject. Edit the file and click Save t save the changes. Read the sectin Wrking with Files fr mre details. Fr mre details, read WebNMS Mdule Dependency in WebNMS IT Develper Guide. 37

40 Cnfiguring Threads Yu can cnfigure the number f threads allcated fr a particular scheduler in the threads.cnf file. Entries are present fr all the schedulers emplyed in Scheduling Service. Imprt the cnfiguratin file threads.cnf frm <WebNMS IT Hme>/cnf directry int the Eclipse Prject. Open the file in the prject. Edit the file and click Save t save the changes. Read the sectin Wrking with Files fr mre details. Fr mre details read the sectin Scheduling Service in WebNMS IT Develper Guide. 38

41 Editing Server Parameters The serverparameters.cnf is a cmmn file where all the cnfiguratin infrmatin related t WebNMS IT server are kept. By default, this file cntains the server-related cnfiguratin details f varius mdules present in WebNMS IT. When yu add yur wn mdule int WebNMS and if yu wish t prvide sme cnfiguratin infrmatin relating t the server, yu may d s by making entries in serverparameters.cnf. The parameter and its value have t be entered as a Key-Value pair. Imprt the cnfiguratin file serverparameters.cnf frm <WebNMS IT Hme>/cnf directry int the Eclipse Prject. Open the file in the prject. Edit the file and click Save t save the changes. Read the sectin Wrking with Files fr mre details Fr mre details, read Server Parameters in WebNMS IT Develper Guide. 39

42 Cnfiguring Plicies Plicies are tasks that are executed by WebNMS IT at a system level, at a specified time. This plicy framewrk enables scalable administratin f the WebNMS IT server and the IT mdeled bjects managed by it. The primary gal f the plicy engine is t enable administratin f cmplex functins easily. In WebNMS IT, plicies are used t custmize the behavir f the applicatin and t prvide a framewrk fr adding plicies fr different IT bjects. WebNMS IT plicies can be bradly classified int tw categries : Peridic Plicies : Plicies are triggered peridically by the server at the specified time interval. By default, the peridic plicies are cnfigured t be executed in the interval f 10 secnds. Nnperidic Plicies : Plicies are executed at the specified time. In this case, there is n fixed time interval. Yu need t specify the time at which the plicy has t be executed. N default value is assigned fr nnperidic plicies. Imprt the cnfiguratin file serverparameters.cnf frm <WebNMS ITHme>/cnf directry int the Eclipse Prject. Open the file in the prject. Edit the file and click Save t save the changes. Read the sectin Wrking with Files fr mre details. Refer t Plicy in WebNMS IT Develper Guide fr mre details. 40

43 Setting Lgging Parameters Lgging acquires paramunt imprtance in a develpment cycle as it help in debugging purpses. The Lgging Service can be used t pinpint bugs, display cnfiguratin errrs, identify perfrmance blckades etc. The lg4j.xml file will have entries fr all the default LOG_USER entries. If yu have added sme custm LOG_USER entries in yur applicatin, make sure the crrespnding entries are added t lg4j.xml. It is pssible t change the LgLevel in lg4j.xml file. Imprt the cnfiguratin file lg4j.xml frm <WebNMS IT Hme>/cnf directry int the Eclipse Prject. Open the file in the prject. Edit the file and click Save t save the changes. Read the sectin Wrking with Files fr mre details. Als refer t Lgging Service in WebNMS IT Develper Guide fr mre details. 41

44 Cnfiguring Backup Service During any develpment cycle, the data relating t the applicatin stred in the database acquires imprtance. The imprtance f data becmes multifld in data-centric applicatins such as WebNMS IT Framewrk. Human errr, system crash, and ther disasters can result in the lss f valuable data which culd prve cstly. T vercme any such eventuality, WebNMS IT prvides Backup Service. As the name itself indicates, backup refers t the prcess f taking a cpy f the data and keeping it separately. In case, any data lss ccurs, the backup cntents can be restred t the database and made use f. The backup f the database can be taken during any f the fllwing scenaris : Taking backup when the WebNMS IT Server is nt running Taking backup (nce r at peridic intervals) when the WebNMS IT Server is running When WebNMS IT Server is running, backup can be taken by specifying the time at which backup is t be taken, in the BackUp.cnf file. At the time when backup is scheduled t be taken, the runbackup() methd in BackupInterface is internally invked. Yu are actually scheduling when the backup has t be taken. Imprt the file BackUp.cnf frm <WebNMS IT Hme>/cnf directry int the Eclipse Prject. Open the file in the prject. Edit the file and click Save t save the changes. Read the sectin Wrking with Files fr mre details. Refer t Backup Service in WebNMS IT Develper Guide fr mre details. 42

45 Setting Failver Parameters WebNMS IT Framewrk is designed t run in missin-critical envirnments which require cntinuus and uninterrupted access t WebNMS IT. Generally, sudden failure f the server is quite ften the reasn fr interruptin f service. Failver mechanism prvides a slutin fr this. "Failver" refers t the prcess in which all the functins being perfrmed by the primary server (i.e., currently active-server) are autmatically assumed by a redundant r standby server upn the failure r sudden terminatin f the primary server as a result f which uninterrupted access is ensured. Failver makes the WebNMS IT systems fault-resilient. The prcess f switching has been designed t be highly smth and autmatic that the end user des nt feel the impact f the failure f the primary server r the subsequent taking ver by the standby. Fr the failver prcess t take effect, yu need t make sme entries in the FailOver.xml file. Imprt the file FailOver.xml frm <WebNMS IT Hme>/cnf directry int the Eclipse Prject. Open the file in the prject. Edit the file and click Save t save the changes. Read the sectin Wrking with Files fr mre details. Refer t FailOver in WebNMS IT Develper Guide fr mre details. 43

46 Debugging Applicatins Built in Eclipse Testing the IT Management Applicatin Eclipse IDE has a prvisin t start the WebNMS IT server and Applicatin client within the envirnment. This prvisin can be used t test the cde while develping. Yu can test the newly added classes and yu can mdify sme f the files and restart the WebNMS server t reflect the changes made in the surce. This can be effectively used t test the cde during develpment f the prject itself. Start the server using WebNMS > Launch > Start WebNMS Server menu. Once the server and the client are started, yu can debug yur surces with the server using Run > Debug Histry > Start WebNMS Server_<Prject name> menu. Yu can als run yur surces with the server using Run > Run Histry > Start WebNMS Server_<Prject name> menu. Once the prject is cmpiled successfully, it is necessary t bundle all the mdified applicatin and files f yur prject int a single file called a NAR. This can be dne by Packaging the Prject. T Package the Prject, refer t the sectin Packaging the Prject fr mre details. T view the changes in WebNMS IT, the NAR shuld be installed ver WebNMS. This task can be perfrmed using the Nar Installer present in the Deplyment Wizard. Yu can invke the Deplyment Wizard by using the WebNMS > Tls > Deplyment Wizard menu. Fr mre details, refer t the sectin Installing Eclipse Prject in WebNMS 44

47 Rebranding WebNMS Overview WebNMS IT Platfrm is highly custmizable and permits rebranding t cater t the end user requirements. Rebranding is typically dne after custmizing WebNMS IT and befre deplyment. Rebranding dentes changing the fllwing using the Rebranding Tl: WebNMS references in the prduct Release Versin reference WebNMS icn, lg All images with either AdventNet r WebNMS references WebNMS URL Invking the Tl Rebranding cannt be dne with respect t Eclipse Prject. It has t be dne directly in the WebNMS IT Installatin. T d Rebranding, invke <WebNMS IT Hme>\bin\develpertls>startRebrandingTl.bat Fr mre details read the sectin Rebranding Tl in WebNMS IT Develper Guide. 45

48

49 Deplying Eclipse Applicatins Deplying Eclipse Applicatins After creating yur prject, yu will need t package it fr installing it ver WebNMS. The Package Prject Wizard in the Eclipse packages all the resurces f a Prject (any custmized, generated r edited files) int a.nar file, with the Applicatin name. Packaging utility is als available in Cmmand Line Mde The.nar file created in the Package Prperties Wizard shuld be installed ver WebNMS using the Installer Wizard f the Deplyment Tl. Nar installed ver WebNMS can als be uninstalled using the Uninstaller Wizard f the Deplyment Tl. 47

50 Packaging the Prject Overview The Package Prject enables yu t bundle all the custmized/ mdified applicatin and files f yur Prject int a single file called a NAR ( NMS archive). T view the changes in WebNMS, the NAR shuld be installed ver WebNMS. Prerequisites fr Packaging a Prject The Eclipse Prject shuld be cmplete. The Eclipse Prject shuld be saved. The Eclipse Prject shuld be cmpiled successfully. Prcedure fr Packaging a Prject Select the prject in the Package Explrer, yu can ntice Package Prject menu and icn get enabled. Select WebNMS > Package Prject menu. Alternatively, yu can click the Package Prject tlbar buttn. "Package Prject" screen pps up. In the Package Prperties screen, enter the name with which the NAR file shuld be created in the NAR File Name text field, enter the directry name/path in which the generated NAR file shuld be stred (Alternatively, yu can use Brwse buttn t select the utput directry and path) and enter the versin f the NAR file in the NAR File Versin text field. Click Finish buttn. Yu will find the NAR file <Yur Prject><NAR File Versin>.nar in the utput directry. 48

51 Integrating Cmmand Line Packager with Build Script Overview The fllwing sectin will guide yu t package yur Eclipse Prject in cmmand line mde. The final utput is a NAR f the Prject. The NAR file can be installed ver WebNMS IT using the Installer Tl f the Deplyment Wizard. Prcedure t Package using Build Script Fllw the steps given belw t integrate cmmand line Packager with the scripts fr Build at Build time. In the Build machine, set up WebNMS 6.0 inclusive f the Eclipse Prject. Say fr example the Eclipse prject can be placed under <WebNMS IT Hme>/StudiTls/Studi/prjects directry. Prceed t <WebNMS IT Hme>/ StudiTls/Studi directry t edit the file setcmmnenv.bat/sh t set up required classpath. Please nte that the plugin jar cm.adventnet.nms.itdevelpment_1.3.1.jar is required in the classpath fr CmmandLine Packager. Step 1 Fr CmmandLinePackager, yu need a Packager.xml file. This file is generated by eclipse when the prject is packaged frm the GUI using the Package Prject. In rder t generate the packager.xml, yu have t package the prject using Package Prject wizard atleast nce. The Package Prject wizard will create packager.xml file and place it in <Eclipse Prject>.This xml fle has t be given as a cmmand line parameter fr the CmmandLinePackager script. Step 2 T mdify values f the prperties f the Prject befre creating the NAR, edit the Packager.xml file lcated in <Eclipse Prject> directry. Fr example fr the Prject "myprject" the existing Entry is as fllws utputdir=c:/prjects/nardestinatin The abve can be changed t utputdir=./newnardest If the directry "newnardest" des nt exist a new directry will be created in the same name. 49

52 In the Packager.xml file the path f ther files can als be made relative t the prject hme t facilitate cmmandlinepackaging. Step 3 T create a NAR run the java.cm.adventnet.studi.framewrk.cmmandlinepackager with arguments -cnf and prvide the path t the cnfiguratin file Packager.xml. java.cm.adventnet.studi.framewrk.cmmandlinepackager -cnf./prjects/it/packager.xml In case f using the abslute path fr the cnfiguratin file, all path entries in the Packager.xml cnfiguratin file must be abslute r relative t the wrking directry f the cmmandlinepackager. The NAR file fr the Prject will be available in the utput directry specified in the Packager.xml file. 50

53 Installing Eclipse Prject in WebNMS Overview Getting Started Step 1 : Lcating Eclipse Nar Step 2 : Selecting Installatin lcatin Step 3 : Installing NAR Cmmand Line Nar Installatin Develper Tips Overview The nar fr Prject created using the Package Prject Wizard in the Eclipse Plugin has t be installed ver WebNMS IT. This task can be perfrmed using the Nar Installer present in the Deplyment Wizard. The Installer wizard with an easy- t- use interface helps yu walk thrugh the prcess f installing the nar. Getting Started Yu can invke the Deplyment Wizard by using the WebNMS > Tls > Deplyment Wizard menu. Alternatively yu can invke the Deplyment Wizard frm <WebNMS IT Hme>/ bin/develpertls/deplymentwizard.bat/sh file. An intuitive GUI cmes up. Prvide the fllwing infrmatin at each step in the Wizard. Nte: Befre installing a Eclipse NAR ensure the WebNMS IT Server is shut dwn befre prceeding with the NAR Installatin Step 1 : Lcating Eclipse Nar Click n the NarInstall/UnInstall tab f the Deplyment Tl. Click n the Install buttn. Select the Eclipse nar file t be installed using the Brwse ptin. Click n the OK buttn. Step 2 : Selecting Installatin Lcatin Check the ReadMe fr mre details abut the nar. Click Next t prceed. 51

54 Step 3 : Installing NAR WebNMS IT Platfrm 6.0 Eclipse Guide In the final screen click Install t install the nar. Nte: The NAR Installer f the Deplyment Wizard allws nly ne nar (created in Eclipse) t be installed ver WebNMS. T install the secnd nar in the same WebNMS IT, uninstall the first nar using the Un-Installer wizard and then install the secnd nar. In shrt WebNMS Allws Installatin f ne NAR fr ne cpy f WebNMS IT Reasn Cnfiguratin files are cpied frm the WebNMS int the Prject wrkspace. After installing a Eclipse NAR ver WebNMS the cnfiguratin files f WebNMS are verwritten by the NAR installed. If yu have created a secnd NAR in Eclipse, the NAR when installed will have the cnfiguratin files f the previus versin f WebNMS. Hence the Eclipse will nt allw the NAR t be installed because f the difference in Versin f the cnfiguratin files in WebNMS Cmmand Line Eclipse Nar Installatin Fllw the steps give belw t Install a Eclipse NAR in Cmmand Line Mde Step 1 T install a deplyed Eclipse NAR run the script CmmandLineStudiNarInstaller.bat\sh lcated in <WebNMS IT Hme>/bin/develpertls directry. Step 2 Specify as argument the abslute path f the Eclipse NAR. T prvide the relative path as argument, the path specified has t be relative t WebNMS IT Hme and nt relative t the current directry. Step 3 Specify the database fr yur Resurce t be stred after specifying the abslute path f the Eclipse NAR. Example Fr example if the abslute path f the applicatin nar is c:\webnms\archive.nar and the database is Oracle the argument f the Eclipse NAR t be installed shuld be CmmandLineStudiNarInstaller.bat C:\WebNMS\Archive.nar racle Fr details regarding uninstalling a Eclipse NAR in the cmmand line mde read the sectin Uninstalling Eclipse Prject in WebNMS. 52

55 Develper Tips Issue: If yu have installed Eclipse NAR, in Windws OS there is a pssibility f "Input line t lng" errr while starting WebNMS Server, Tip: The abve issue ccurs as Eclipse NAR file has new JARs, and, when they are added t WebNMS, the classpath settings are eventually lengthened. Hence, use the WebNMS NmsMainBtstrap class lader mechanism. Fr mre details read the sectin Trubleshting Tips - Input Line t Lng and add the Eclipse related jars, t the NMS_EXT_DIRS variables. Example: Fr adding a jar set NMS_EXT_DIRS= NetMnitr/build/EclipsePrject.jar Example: Fr adding all the Eclipse related jars set NMS_EXT_DIRS= %MOPATH%;%CUSTOMPATH% 53

56 Uninstalling Eclipse Prject frm WebNMS Overview Getting Started Uninstallatin f Eclipse NAR using Deplyment Wizard Cmmand Line Eclipse NAR Uninstallatin Overview In the deplyment scenari, the nar is created by the Package Prject Wizard in Eclipse and installed/uninstalled ver WebNMS using the NAR Installer/Uninstaller f the Deplyment Wizard. Getting Started Yu can invke the Deplyment Wizard by using the WebNMS > Tls > Deplyment Wizard menu. Alternatively yu can Invke the Deplyment Wizard frm <Web NMS Hme>/ bin/develpertls/deplymentwizard.bat/sh file. An intuitive GUI cmes up. Uninstallatin f Eclipse NAR using Deplyment Wizard T uninstall, click n the Eclipse Nar in the main screen f the Installer/Uninstaller Wizard. A dialg appears. Click n the Uninstall buttn t uninstall the Eclipse Nar. 1. Befre Uninstalling the NAR, it is necessary t Reinitialize the Database. 2. The Uninstaller wizard allws un-installatin f ne nar at ne instance. Cmmand Line Eclipse NAR Uninstallatin T uninstall a Eclipse NAR run the script CmmandLineStudiNarUninstaller.bat\sh lcated in <Web NMS Hme>/bin/develpertls directry and specify as argument the Eclipse NAR name. Fr example if the name f the Eclipse NAR is Archive.nar the argument shuld be CmmandLineStudiNarUninstaller.bat Archive.nar 54

57 Upgrading the Prject The eclipse prject created in a previus versin f WebNMS IT can be upgraded using the Upgrade Prject ptin under WebNMS menu. Fllw the belw steps t upgrade the prject. Select the prject. Select WebNMS > Upgrade Prject menu item. The Cnfiguratin Updater dialg will be displayed. Use the Brwse buttn t select the new WebNMS IT Hme directry. The Prduct Versin and the Service Pack Versin will be displayed. Click the Update buttn. Cnfirmatin dialg is displayed. Click the OK buttn t upgrade the prject. 55