1 / 26

IDA 7.6 – New Features: Pluglets (“Macros for Eclipse”)

IDA 7.6 – New Features: Pluglets (“Macros for Eclipse”). Contents. New Pluglets Feature in IDA 7.6 Pluglets, some background Install option “Run Pluglets” menu Installed Sample pluglets Develop Custom pluglets Trouble Shooting & Known Limitations Extra Slides Sample pluglet enablement

mulan
Download Presentation

IDA 7.6 – New Features: Pluglets (“Macros for Eclipse”)

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. IDA 7.6 – New Features:Pluglets (“Macros for Eclipse”)

  2. Contents • New Pluglets Feature in IDA 7.6 • Pluglets, some background • Install option • “Run Pluglets” menu • Installed Sample pluglets • Develop Custom pluglets • Trouble Shooting & Known Limitations • Extra Slides • Sample pluglet enablement • Useful resources

  3. Pluglets – Background Need for scripting/macros: • Automate common tasks and task flows • Execute tasks in bulk (batch mode) • Customize existing product functions • Overcome product short-comings or missing links in particular workflows • Adding very specialized functionality

  4. Pluglets – Background (2) “Macros for Eclipse” • A pluglet is a simple Java source file with plugletmain(…) method • pluglet.xml lists Eclipse/IDA plug-ins are required by the pluglets  this controls the pluglet classpath, both at compile and at runtime • Compile and run in the same workspace (Java perspective) • Pluglet output in console view

  5. Pluglets – Background (3) pluglet.xml: • specifies which Eclipse plug-ins are visible to the pluglets in the pluglets project • controls the pluglet classpath, both at compile and at runtime

  6. IDA 7.6 Pluglet Install Option

  7. Run Pluglet menu • Run pluglets from selection in Data Project Explorer (DPE) or on a Data Diagram (IE notation only) • Task groups contain installed sample pluglets • Register Pluglets to run custom Pluglets on the objects selected in DPE or on Diagram Note! • Pluglets are enabled based on the selected objects in DPE or on Diagram

  8. Pluglet Task Groups • Connectivity Tasks • Deployment Tasks • Diagram Tasks (IE notation diagrams only, not UML diagrams) • Model Navigation Tasks • Model Tasks • Reporting Tasks • Transformation Tasks • Custom Tasks

  9. Installed Sample Pluglets • Diagram Tasks • Apply Domain Entity Color (enabled on: logical diagram) • Color Logical Only Attributes (enabled on: logical diagram) • Model Navigation Tasks • Select Objects By Name (enabled on: DPE or diagram (IE notation)) • Model Tasks • Change Owning Schema For All Indexes/ ~ Tables / ~ Views (enabled: PDM or database - LUW/Z) • Change Table Space For All Tables (enabled on: PDM or database - LUW/Z) • Name Indexes (enabled on: PDM, database, schema) • Remove All Auxiliary Tables (enabled on: physical data model, database, schema – DB2 for Z) • Set Attributes of Selected Entities to Required (enabled on: entities) • Set Selected Tables Columns Not Null (enabled on: base tables – not Views, MQTs) • Set Default Values (enabled on: tables, columns) • Update Foreign Key Documentation from Primary Key (on entities, base tables – not Views, MQTs) • Reporting Tasks • Calculate Table and Column Length (enabled on: PDM, database - LUW/Z)

  10. Developing Custom Pluglets

  11. Developing Custom Pluglets Java perspective: • File > New > Pluglet  New Pluglet wizard • Select from existing pluglet templates:Modeling Tasks > Data Pluglet... basic code stubs with //TODO: tags will be created automatically

  12. Developing Custom Pluglets (2)

  13. Registering Custom Pluglets Data Perspective: • Run Pluglet > Register Pluglets… new pluglet is added to Task Group

  14. Run simple pluglet (Java perspective)

  15. Browse sample pluglets (Java pers.) • Click Edit Pluglet to show Sample Pluglet source code

  16. Browse sample pluglets (2)

  17. IDA 7.6 Pluglet plugins and source • com.ibm.datatools.pluglets.samples – Sample pluglets (+source code) • com.ibm.datatools.pluglets.tasks – Common tasks and dialogs (APIs) • com.ibm.datatools.pluglets.ui – UI integration (‘Run Pluglet’ menu)

  18. Importing Sample Pluglet source plugins

  19. Debugging Pluglets See RSA v8 Documentation (link on last slide): • Add the debug arguments to the “eclipse.ini” file after the “-vmargs” workbench argument-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=8000 • Modify your desktop shortcut, add the “-vmargs” workbench argument as above • Start your Product (IDA) • Run Pluglet Debugger from the Internal Tools menu • The workbench that will come up actually drives the debug session start debugging by selecting the pluglet from the Internal Tools shortcuts

  20. What can go wrong?

  21. Trouble Shooting & Known Limitations • No Sample Pluglets show • check install option, is selected object enabled for pluglets? • Custom pluglets can't compile • pluglets.xmlmust contain the referenced plugins • Registering pluglets doesn't work • no plugletmain() method • not implemented getName() method? …each pluglet needs unique name • no task group set? …implement getTaskGroups() method • Check Error Log for error messages (Window > Show View > Error Log) Known defects & limitations: • Pluglets not available on UML diagrams (only on IE notation diagrams) • Compilation Error in CalculateTableColumnLenghtPluglet when importing sample pluglet plugin • Set Default Values pluglet: • only enabled for physical models • throws NPE when columns in table have User Defined Type • Select Objects By Name pluglet: • only selects immediate children of selected object in DPE • selected object in DPE need to be expanded in order to select any children • on diagram, when selected columns in multiple tables, right-click on selected column will lose selection

  22. Known issues (cont’d) • Problem: Compilation error in imported Sample Pluglets source plugin • Work-around: import the missing plugin into the Java workspace

  23. Pluglet Name, Enablement, Description (1)

  24. Pluglet Name, Enablement, Description (2)

  25. Pluglet Name, Enablement, Description (3)

  26. Helpful Resources • RSA v8 Pluglets Documentation:http://publib.boulder.ibm.com/infocenter/rsahelp/v8/index.jsp?topic=/com.ibm.xtools.pluglets.ui.doc/topics/c_whypluglets.html • Developer Works article:http://www.ibm.com/developerworks/rational/library/06/1114_kelsey/index.html • Video tutorial:“Create Pluglets”:http://publib.boulder.ibm.com/infocenter/rsahelp/v8/index.jsp?topic=/com.ibm.xtools.pluglet.creating.tutorial.doc/topics/exercise2_pluglets.html • Developer works – Code examples:http://www.ibm.com/developerworks/wikis/display/RSA/Pluglets+Developer+Guide

More Related