NAME

      mxreport - Systems Insight Manager report file format


SYNOPSIS

      mxreport


DESCRIPTION

      The mxreport command supports reading and writing report and report
      category information in the eXtensible Markup Language (XML) format.
      You can use this capability to add or remove reports or report
      categories in the Systems Insight Manager environment.  Each file may
      contain the definitions of one or more reports or one or more report
      categories.

    Document Type Definition
      The Document Type Definition (DTD) file defines the constraints for an
      XML file. These constraints include the valid element tags,
      attributes, and the cardinality of elements in an XML file. The report
      DTD file is named mxReports.dtd and is included in the following
      paragraph. Note that due to man page formatting, the DTD contents may
      not appear the same as in the file.

       <?xml version="1.0" encoding="UTF-8"?>
       <!ELEMENT displayName (#PCDATA)>
       <!ATTLIST displayName
	 displayLocale CDATA #REQUIRED
       >
       <!ELEMENT group EMPTY>
       <!ATTLIST group
	 groupLocale CDATA #REQUIRED
	 parent CDATA #REQUIRED
	 child CDATA #REQUIRED
       >
       <!ELEMENT item EMPTY>
       <!ATTLIST item
	 viewColName CDATA #REQUIRED
	 viewName CDATA #REQUIRED
       >
       <!ELEMENT privilege (#PCDATA)>
       <!ELEMENT query (#PCDATA)>
       <!ATTLIST query
	 queryType CDATA #REQUIRED
	 queryLocale CDATA #REQUIRED
       >
       <!ELEMENT report (group, displayName, query, item+, viewOption, privilege)>
       <!ATTLIST report
	 reportName CDATA #REQUIRED
	 reportId CDATA #IMPLIED
	 displayFlag CDATA #REQUIRED
	 editFlag CDATA #REQUIRED
	 creatorId CDATA #IMPLIED
	 plugin CDATA #IMPLIED
	 displayOrder CDATA #IMPLIED
       >
       <!ELEMENT reportList (report+)>
       <!ELEMENT viewOption (#PCDATA)>


    Elements
      As defined in the DTD, the report XML file may contain the following
      elements.

      The first line of a report XML file must be in the following format:

      <?xml version="1.0" encoding="encoding-value" ?>

      where the user substitutes a recognized encoding value for the
      encoding-value parameter.	 The recognized encoding values may be found
      at the following web site:

      http://www.iana.org/assignments/character-sets

      If no XML header line is specified, the system defaults encoding to
      "UTF-8".

      The "report-list" element must appear once in a report XML file and
      wraps the list of report information. The "report-list" element may
      contain zero or more "report" elements.  Note if the "report-list"
      element contains no "report" or "category" elements, the associated
      mxreport command will have no effect.

      The "report" element may appear zero or more times in a report XML
      file.  The "report" element has the following attributes.

      The "reportName" attribute is mandatory and specifies the report name.
      The user may change the name of an existing report by specifying the
      new name in the "reportName" attribute with the id of the existing
      report in the "reportId" attribute.  The "reportName" must be unique
      in the CMS.

      The "displayName" attribute is mandatory and specifies the report
      display name. The "displayName" must be unique in the CMS.

      The "reportId" attribute is optional and specifies the unique report
      ID. The system always outputs the "id" attribute when listing an
      existing report to an XML file. The user does not need to specify the
      "reportId" attribute as it is ignored for adding a report.

      The "displayFlag" attribute is required and specifies the display type
      of the report.  It is required to be set to "1" to always display the
      report.

      The "editFlag" attribute is required and specifies whether the report
      can be edited.  A value of "0" indicates that a report is not
      editable.	 A value of "1" indicates that a report can be edited.

      The "creatorId" attribute is optional and is for future use.

      The "plugin" attribute is optional.  A value of "0" specifies a
      system-defined report.  If this attribute is not specified, the
      default value is "10".

      The "displayOrder" attribute is optional and is for future use.

      The "viewOption" attribute is required.  A value of "0" specifies that
      the report should display all systems in the same table.	A value of
      "1" specifies that the report should show each system in a separate
      table.

      The "queryType" attribute is required.  It should always be set to a
      value of "0".

      The "queryLocale" attribute is required.	It specifies the language
      locale of the query.

      The "displayLocale" attribute is required.  It specifies the language
      locale of the report display.

      The "groupLocale" attribute is required.	It specifies the language
      locale of the report group display.

      The "parent" attribute is required.  It specifies the group name of a
      set of reports.

      The "category-name" attribute is required and assigns the report to a
      specific category. The category specified by the "category-name"
      attribute must exist in the system.

      The "child" attribute is required.  It must be set to "" (e.g.
      child="") for this release.

      The "viewColName" attribute is required.	It specifies the
      DbViewColName in the hpmxItem table.

      The "viewName" attribute is required.  It specifies the DbViewName in
      the hpmxItem table.

    Commenting
      Comments may be included in XML files.  The comment must begin with
      the characters "<!--" and end with the characters "-->". Comments may
      span multiple lines within the beginning and ending character tags.


    Examples
      This section contains some examples of report XML files.

      This example shows a file containing the definition of a report that
      reports inventory.

      <?xml version="1.0" encoding="UTF-8"?>
      <reportList>
	<report reportName="Inventory 7 - Servers" displayFlag="0" creatorId="1" editFlag="1">
	<group groupLocale="en_US" parent="System reports" child=""/>
	<displayName displayLocale="en_US">Inventory 7 - Servers</displayName>
	<query queryType="0" queryLocale="en_US">All Servers</query>
	  <item viewColName="DeviceName" viewName="R_Inventory"/>
	  <item viewColName="ProductType" viewName="R_Inventory"/>
	  <item viewColName="ProductName" viewName="R_Inventory"/>
	  <item viewColName="SerialNumber" viewName="R_Inventory"/>
	  <item viewColName="AssetTag" viewName="R_Inventory"/>
	  <item viewColName="MemorySize" viewName="R_Inventory"/>
	  <item viewColName="OSName" viewName="R_Inventory"/>
	  <item viewColName="OSVendor" viewName="R_Inventory"/>
	  <item viewColName="Location" viewName="R_Inventory"/>
	  <item viewColName="DeviceOwner" viewName="R_Inventory"/>
	<viewOption>0</viewOption>
	<privilege>0</privilege>
      </report>
      </reportList>


LIMITATIONS

      This command may only be run on the CMS.


AUTHOR

      mxreport was developed by the Hewlett-Packard Company.


SEE ALSO for HP-UX

      mxreport(1M), mxcategoryitem(4)


SEE ALSO for Linux

      mxreport(8), mxcategoryitem(4)