- Preface
- New and Changed Information for this Release
- Overview
- Getting Started
- Developing and Deploying Modules
- Working with a Module
- Adding a New Workflow Task to a Module
- Adding Custom Account Type and Pod Type
- Developing Your Own Inventory Collector
- Developing a New Menu
- Developing Your Own Reports
- Developing Schedule Tasks
- Developing a Trigger Condition
- Developing New Resource Limits
- Developing Report Actions
- Developing CloudSense Reports
- Change Tracking API
- Appendix A
- Appendix B
Cisco UCS Director Open Automation Developer Guide, Release 5.3
- Updated:
- May 11, 2015
Chapter: Developing Report Actions
Developing Report Actions
This chapter contains the following sections:
About Report Actions
When developing reports, you can also include actions to go with those reports.
Developing a report action requires the following things:
-
A form object—Describes what inputs the user can provide.
-
A handler—Handles setting data in the form and what happens when the user hits the submit button.
This structure is similar to workflow tasks because workflows use the same framework. The difference is that your handler will extend from a different class.
Form Object
The form object is a POJO with JDO and FormField annotations. It should look very similar to the config objects that you developed for your workflow tasks. The only difference is that there is no need to implement any interface. You might want to use the JDO annotations if the form has data that you want persisted; they make it easier to retrieve and persist the POJO from the database. Use the FormField annotations to specify which user interface (UI) control to display to the user.
Form Handler
You should place the logic for your report action in a handler. The handler extends com.cloupia.service.cIM.inframgr.reports.simplified.CloupiaPageAction.
-
definePage—Defines the layout of the form. You want to bind your form object to the page, and the UI will generate a form as defined by your form object.
-
loadDataToPage—Handles loading data that you might want to show in the form when it is first displayed to the user.
-
validatePageData—Handles whatever logic that you want to execute when the user presses the submit button.
For examples of the form object and the form handler, see the com.cloupia.feature.foo.actions.SimpleDummyAction in the sample code.
Registering Actions with Report
After completing the development of actions, you must associate them with a report, such as a report of type com.cloupia.service.cIM.inframgr.reports.simplified.CloupiaReportWithActions. To associate them with a report, you must implement a getActions method and provide instances of your CloupiaReportAction.
Feedback