Define Custom Groups and Reports in Dell EMC OpenManage Enterprise This technical white paper provides information about using the query builder feature to manage your Query Groups and Reports in managing your data center. Abstract This technical paper discusses how to effectively define custom query groups and report definitions in Dell EMC OpenManage Enterprise 3.0 and later versions.
Revisions Date Description January 2019 Initial release Acknowledgements This paper was produced by the following members of the Dell EMC storage engineering team: Author—Reg Stumpe Support—Sheshadri PR Rao (InfoDev) The information in this publication is provided “as is.” Dell Inc. makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose.
Contents Revisions.............................................................................................................................................................................2 Acknowledgements .............................................................................................................................................................2 Terminology ...................................................................................................................................
Terminology Acronym 4 List of terminologies used in this technical white paper Expanded form API Application Program Interface EMM Enclosure Management Module FRU Field Replaceable Unit GUI Graphical User Interface NIC Network Interface Card Define Custom Groups and Reports in Dell EMC OpenManage Enterprise
Executive summary OpenManage Enterprise 3.0 and later versions provide the ability for customers to define their own device groups and reports, which are respectively referred to in the OpenManage Enterprise as Custom Groups and Custom Reports. Custom Groups can be either a static set of selected devices (referred to as a “Static Group”) or a dynamic set of devices (referred to as a “Query Group”) that satisfies selection criteria constraints (such as name or status) specified by the customer.
Managing Custom Query groups and Reports in OpenManage Enterprise 1 Managing Custom Query groups and Reports in OpenManage Enterprise This section describes some basic terms related to the interface pages for creating Query Groups and report definitions. Topics you can read about in this section: 1.
Each report definition uses a query to identify which output rows to include in the report, the output columns for the report, and in which output rows are listed. 1.3 Query Builder in OpenManage Enterprise The functional component in OpenManage Enterprise that provides support for defining custom query groups and report definitions is referred to as the Query Builder. The Query Builder component is used for both custom queries and report definitions.
Creating Query Groups and Report Definitions 2 Creating Query Groups and Report Definitions This section provides more in-depth information about creating the queries to use for Query Groups and Report Definitions. Topics you can read about in this section: 2.
Creating Query Groups and Report Definitions 2.2 The first page contains the group name and description (the same as for the Query Groups interface). The second page is used to select the Query Category and the set of output columns wanted. The third page is used to define the query selection criteria for the report output rows.
Creating Query Groups and Report Definitions Also, note the Columns control on this page, which is used for selecting the output columns for the report. The working pane displays an example of what the report will look like. As output columns are selected for a report definition, their names appear at the top of the sample output display. These headings can be dragged to change the column order or clicked to specify the required sort order for output rows when the report is generated.
Creating Query Groups and Report Definitions 2.3.1 Copy an existing query The top control on the Query Criteria Selection page may be used, if necessary, to copy the selection criteria from another query. It essentially provides a starting point for defining a new query. For example, it could be used to create a query that is similar to an existing query. The control displays a drop-down menu of queries which can be selected. It includes only queries defined by using the Query Builder.
Creating Query Groups and Report Definitions In some cases, when an option is selected in the Operator control, the Value control appears to the right of the Operator control, allowing a required value to be entered or selected. The Value control also varies depending on the data type of the selected Field Name. For example, if a numeric field is selected, the Value control allows only numbers to be entered. Some fields, such as Status fields, are required to have specific values.
Creating Query Groups and Report Definitions Specify query criteria with mulitple contiditions for generating a report in OpenManage Enterprise Conditions may also be grouped within parentheses to specify precedence for applying the “AND” and “OR” conditions. By default, each condition begins with an open parentheses and ends with a close parentheses, which implies that it is not grouped with any other condition.
Creating Query Groups and Report Definitions The user actually wanted a report that lists all Servers and Network Switches whose model name begins with “PowerEdge”. However, because every condition above is in its own set of parentheses, they are evaluated in the order listed.
Creating Query Groups and Report Definitions Note that the only changes made to the first query were to remove (a) the right parenthesis on the second condition, and (b) the left parenthesis on the third condition. As a result, the second and third conditions are evaluated together as a composite condition.
Advanced topics about Query Groups and Report Definitions 3 Advanced topics about Query Groups and Report Definitions This section discusses a few advanced topics related to creating queries and report definitions. 3.1 Field structure The Query Builder displays a list of fields to choose from in the following places: Custom Query Group–Selection Criteria Report Builder–Output Columns Report Builder–Selection Criteria The GUI page shows a list of possible fields.
Advanced topics about Query Groups and Report Definitions Memory Manufacturer Memory Name Some headers contain fields that apply to several or all types of devices: General Device Data headers—Device FRU, Device License Info, Device Location, etc. Alert headers—Alert, Alert Catalog, Alert Definition, Alert Sub-Category Storage headers—Storage Device EMM, Storage Enclosure, Storage Physical Disk, etc.
Advanced topics about Query Groups and Report Definitions The blue boxes with white text indicate groups of fields that may have multiple occurrences per device. These headers are discussed later in Avoid multiple multiples. 3.2 Report Definition Categories Custom Query Groups always query for devices. Therefore, the Devices category is implicitly used for all these groups. However, report definitions support several additional categories and the necessary category may be selected for each report.
Advanced topics about Query Groups and Report Definitions The Jobs category may be used to build reports on jobs run by the application. The Jobs category in OpenManage Enterprise Observe that the Job Execution and Job Execution Detail boxes are in blue with white text. Each job may have multiple executions, and each execution may have multiple execution detail entries. The Alerts category may be used to build reports about alerts received by the application.
Advanced topics about Query Groups and Report Definitions 3.3 Best practices and guidelines This section lists a few pitfalls that must be avoided when creating custom query groups and report definitions. 3.3.1 Avoid conflicting conditions This guideline applies to both Custom Query Groups and Report Definitions. It pertains primarily to the Devices category.
Advanced topics about Query Groups and Report Definitions Bottom line •For a report definition, it is best to select fields from zero or more headings where a single occurrence is possible, along with fields from only one heading where multiple occurrences are possible.
Advanced topics about Query Groups and Report Definitions A Technical support and resources Dell.com/support is focused on meeting customer needs with proven services and support.
