HP Database Views In Web Jetadmin ENWW C02079122

User Manual: HP HP Web Jetadmin - Database Views in HP Web Jetadmin

Open the PDF directly: View PDF PDF.
Page Count: 27

DownloadHP Database Views In Web Jetadmin - ENWW C02079122
Open PDF In BrowserView PDF
DATABASE VIEWS
in HP Web Jetadmin

CONTENTS
Overview ............................................................................................................................. 2
Database Connectivity license ................................................................................................. 2
Database views ..................................................................................................................... 2
Data exports ......................................................................................................................... 2
Accuracy of exported data .................................................................................................. 2
Select the data to be exported .............................................................................................. 3
Schedule the exports ........................................................................................................... 3
Select the devices to be exported .......................................................................................... 4
Select the destination .......................................................................................................... 4
Export the data to the database views ................................................................................... 4
Reports to database views ...................................................................................................... 5
Use the database views .......................................................................................................... 6
HP Eco Solutions reports ......................................................................................................... 7
Device settings and capabilities ............................................................................................ 7
Copy and digital send capabilities exception ......................................................................... 8
Device paper usage and digital processing ............................................................................ 8
Top 5 paper usage ............................................................................................................. 8
Summary .............................................................................................................................. 9
Appendix A—Configure the default poller ............................................................................... 10
Appendix B—Data dictionaries for database views .................................................................. 12
Media size and color usage utilization view (PUBLIC_MEDIA_COLOR_USE_VW) ...................... 12
Job type utilization view (PUBLIC_JOB_TYPE_USE_VW) .......................................................... 13
Consumables utilization view (PUBLIC_CONSUMABLES_USE_VW) ......................................... 14
Consumables information view (PUBLIC_CONSUMABLES_INFO_VW) ..................................... 14
Device attributes view (PUBLIC_DEV_INFO_VW) ................................................................... 16
Connection attributes view (PUBLIC_CONN_INFO_VW) ........................................................ 17
All attributes view (PUBLIC_DEV_CON_INFO_VW) ............................................................... 17
Group membership view (PUBLIC_DEVICE_GROUP_VW) ....................................................... 18
Media charge view (PUBLIC_MEDIA_CHARGE_VW) ............................................................. 18
Appendix C—Naming schema .............................................................................................. 19

OVERVIEW
HP Web Jetadmin is a printer management solution that gathers information from devices and
presents the data in a multitude of formats to meet customer needs. Information pertaining to device
assets, consumables, and page counts can be displayed in device lists or reports. This same data can
be stored in Microsoft® SQL database views if an optional Database Connectivity license is installed.
Through database views, users can directly access exported device list or report data stored in a SQL
database. This allows for building business intelligence reports, such as Crystal Reports, directly on
the device data exposed by the HP Web Jetadmin database views. Administrators can use the
exposed database views of the device data to extract, transform, and load (ETL) the data into an
enterprise’s data warehouse.

DATABASE CONNECTIVITY LICENSE
HP Web Jetadmin 10.2 SR6 and later automatically includes the ability to store data collections to
SQL database views without the need for a license. Data that is collected for reports in HP Web
Jetadmin is written to a database view on a scheduled basis. Either the HP Web Jetadmin
background poller or the scheduled data collections for reports generates the data that is populated in
these database views. However, user-defined exports of column data to database views still require a
license for all versions of HP Web Jetadmin. The license can be obtained by browsing to
www.hp.com/go/wja, and clicking the Web Jetadmin Extended Modules link. This module allows
HP Web Jetadmin users to do the following:
•

Export device lists and store data collections to SQL database views

The licenses are node-locked to an IP address. A separate license is needed for each HP Web
Jetadmin server. A Connectivity Welcome Letter and an Instructions document is supplied when a
license is requested from HP. These documents explain how to obtain and install a license.

DATABASE VIEWS
HP Web Jetadmin collects data from devices and stores the data in SQL database tables. Device lists
display the data the user requires in columns that can be sorted or filtered. Device data can be
exported to .csv or .xml files for viewing and manipulating in applications such as Microsoft Excel.
Device data can be displayed in canned or custom reports that HP Web Jetadmin generates to meet
user needs. In addition, this same data can be written to SQL database views and accessed by asset
and reporting tools if the optional Database Connectivity license is installed. Data in the following
areas can be written to the database views in HP Web Jetadmin:
•

Data exports

•

Reports data collections

DATA EXPORTS
Device data can be exported from any device list or device group by selecting the devices, rightclicking the selection, and selecting Export. The Export Devices wizard can also be launched from
Tools > Export devices. Data exports can be scheduled to run at any interval. No matter which
technique is used, the user can dictate the devices, data, and accuracy of the data that is written to a
database view.

Accuracy of exported data
When the Export Devices wizard is launched, a threshold level can be set to specify the accuracy of
the data that is exported (Figure 1). The following threshold levels can be selected:

2

•

Database only: Data is
gathered only from the
database and not from the
device, no matter how old
the data might be.

•

Missing items only: Data is
gathered from the database
if the data exists. Otherwise,
the data is gathered directly
from the device.

•

From device only: Data is
gathered directly from the
device regardless of whether
data exists in the database,
ensuring the most accurate
data.

•

1 hour: Data in the database Figure 1—Select columns
older than 1 hour is updated directly from the device.

•

3 hours: Data in the database older than 3 hours is updated directly from the device.

•

6 hours: Data in the database older than 6 hours is updated directly from the device.

•

24 hours: Data in the database older than 24 hours is updated directly from the device.

A default poller runs in the background and collects data from devices depending on a variety of
factors, such as which devices and columns are displayed and how frequently the poller is configured
to collect data. The more frequently data is collected from devices, the more accurate the data in the
database. However, the drawback is increased network traffic when data is continuously collected
from devices.

Select the data to be exported
The Selected columns table is prepopulated with a default set of data elements when the wizard is
launched from the Tools menu. If the wizard is launched by right-clicking selected devices, the
columns that are present in the device view are preselected. The Available columns table consists of
data elements that are still available. The number of items in the list can be adjusted by selecting one
of the following options:
•

Favorites: Displays the most commonly used columns.

•

All: Displays all the available columns, except obsolete columns. To display only a specific
category of columns, expand All, and then select the category.

•

Obsolete: Displays columns that are still available in HP Web Jetadmin, but have been replaced
by new columns or will not be supported in the future.

Schedule the exports
A device list export can be scheduled to occur at a specific time and frequency by selecting the
Schedule device list export checkbox on the Select Columns page (Figure 1). A flexible set of
scheduler options are presented to launch a one-time or recurring Export devices process. Each
schedule is given a schedule name for future editing of the time and frequency. Only the time and
frequency of a scheduled export can be edited, not the devices or columns to be exported. If new
devices or columns are required, a new scheduled export must be created.

3

Select the devices to be
exported
If the Export Devices wizard is
launched from Tools > Export
devices, the Select Devices page
is displayed for selecting the
devices that are included in the
export. If the Export Devices
wizard is launched by rightclicking and selecting Export
from the device list, only the
devices that are already selected
in the device list are included in
the export.

Select the destination
After the columns and devices
are selected, the destination for
outputting the data can be
selected (Figure 2). Selections
include the following:

Figure 2—Specify destination settings

•

Local file: Exports to a local file on the client PC. The user is prompted for a file name and
location after the data is collected and is ready to be written.

•

Email: Sends the data to an email address. Enter the email address on this page or browse for the
correct email address. For the file format, select CSV or XML. The file is added to the email as an
attachment.

•

Server file: Exports the device list to a specific file name and path on the HP Web Jetadmin
server. The location cannot be edited. If a file of the same name already exists in the location, a
timestamp is added to the name of the export file.

•

Database: Stores the data in a SQL database view.

Export the data to the database views
If Database is selected as the export destination, HP Web Jetadmin prompts for a database view
name. After the name is entered, a view is created in the SQL database that contains the data for all
the devices and columns selected for the export. Using Microsoft SQL Server Management Studio
Express, log in to the HP Web
Jetadmin instance, open the
Views folder, right-click the view
name that was entered in HP
Web Jetadmin (the name is
preceded by dbo), and select
Open View to see the data that is
stored for each device and
column that was selected for the
export (Figure 3). Enterprise
tools, such as Crystal Reports,
can be easily instructed to open
this view and retrieve the
Figure 3—Database view in SQL Studio Express

4

contents for displaying a custom
report.
If the data export is scheduled to
occur at a regular frequency, a
date/time column is
automatically stored in the view
to dictate when the data was
exported. However, if an
exported device list contains new
columns or deleted columns and
the server attempts to use the
same database view name,
HP Web Jetadmin recognizes
that the columns in the view no
longer match and forces a new
name to be used for the view. If
the same view name is
required—but with different
columns—the database table and Figure 4—Programmatic names vs. display names
matching view can be edited by
using SQL Studio Express to match the columns that HP Web Jetadmin is attempting to export.
Column headers in a data export use programmatic names vs. the friendly names that are displayed
in the HP Web Jetadmin user interface. A matching view name in Studio Express with _LOC
appended to the view name contains a schema or mapping to match the display names to the
programmatic names (Figure 4). For a complete list, see Appendix C—Naming schema.

REPORTS TO DATABASE VIEWS
Data that is collected for reports in HP Web Jetadmin can be written to a database view on a
scheduled basis. There are several canned reports stored in SQL database views after the optional
database connection module license is installed. Either the HP Web Jetadmin background poller or
the scheduled data collections generates the data that is populated in these reports.
The HP Web Jetadmin device list background poller is responsible for collecting the data that
represents device attributes. A configuration file is available to turn attributes on or off that are
collected by the background poller. For the location of the file and the attributes that are collected,
see Appendix A—Configure the default poller.
Reports data collections can be enabled to collect the remaining data, typically the data that
represents page counts and consumables usage. Reports data collections are run once per day.
HP Web Jetadmin offers several types of data collections for reports. However, only the following
data collections are responsible for gathering data to be stored in database views:
•

Device Utilization Data—Collected daily, this data contains page counts, such as simplex,
duplex, monochrome, color, media size (such as Letter legal, and A4), and job type (such as
copy, digital send, incoming fax, outgoing fax, and scan).

•

Supply Utilization—Collected daily, this data contains metrics on consumable usage, such as level
value, percent remaining, supply coverage, pages remaining, and current page count. Additional
data, if supported, might include installation date, removal date, initial level, initial page count,
product information (such as serial number, part number, maximum capacity, maximum pages,
and manufacturing date) and consumable type (such as toner, fuser kit, and ink).

5

Figure 5—SQL Studio Express database views

USE THE DATABASE VIEWS
After data resides in the database views, SQL Server Studio Express can be used to browse the
contents of each view (Figure 5). Simply log in to the HPWJA SQL instance and navigate to the
Databases > HPWJA > Views folder. Any views created by using the export feature of HP Web
Jetadmin are displayed by the name that was provided for the view during the export. Right-clicking a
view and selecting Open View displays the contents of that view. Each column that was set to be
included in the export is displayed with a programmatic name as the column header. For a schema to
match programmatic names to names as they are displayed in the HP Web Jetadmin user interface,
see Appendix C—Naming schema.
The following database views also appear in the list of views as a result of data being collected either
by the background poller or, optionally, reports data collections. For more information, see Appendix
B—Data dictionaries for database views.
•

PUBLIC_CON_INFO

•

PUBLIC_CONSUMABLES_INFO—Requires Supplies Utilization data collections

•

PUBLIC_CONSUMABLES_USE—Requires Supplies Utilization data collections

•

PUBLIC_DEV_CON_INFO

•

PUBLIC_DEV_INFO

•

PUBLIC_DEVICE_GROUP_PUBLIC_JOB_TYPE_USE—Requires Data Utilization data collections

•

PUBLIC_MEDIA_CHARGE—Requires Data Utilization data collections

•

PUBLIC_MEDIA_COLOR_USE—Requires Data Utilization data collections

6

Business intelligence reports,
such as Crystal Reports, can be
built directly on the data exposed
by the database views. A System
DSN connection to the HP Web
Jetadmin database (HPWJA) can
be created under Data Sources
(ODBC). Crystal Reports can then
link to the appropriate HP Web
Jetadmin database (HPWJA),
allowing users to select available
columns contained within the
view using the Standard Report
Figure 6—Selecting DB View columns
Creation Wizard (Figure 6).
A variety of custom reports can be created in a multitude of formats based on the data stored in the
database views (Figure 7).

Figure 7—Report using Crystal Reports

HP ECO SOLUTIONS REPORTS
HP Eco Solutions reports are preconfigured SAP Crystal Reports 2008 that display the environmental
settings for a print fleet. These reports pull information contained in the database views described in
previous sections. They are included in a .zip file with the Database Connectivity Module. HP Eco
Solutions reports provide an intuitive presentation of environmentally relevant data from HP Web
Jetadmin, allowing IT managers to quickly assess opportunities to reduce the environmental impact of
their organization’s printing and track progress toward green IT goals over time.
The four HP Eco Solutions reports include the following detailed information.

Device settings and capabilities
Reports the availability of paper-saving features as well as the availability and use of energy-saving
features.
•

Device count—Quantity of devices that HP Web Jetadmin can detect.

•

Duplex-capable devices—Percentage of all reported devices with the automatic duplex feature
installed listed by individual device status. This shows your total opportunity to drive paper
savings via duplexing.

•

Powersave-capable devices—Devices that have the Powersave capability. Highlights your
potential to further decrease energy consumption.

7

•

Powersave-enabled devices—Percentage of devices with the Powersave capability that have the
Powersave features enabled listed by individual device status. Shows the untapped potential to
decrease energy consumption by enabling Powersave on capable devices.

•

Average time to sleep—Average of the time-to-sleep settings across a selected group in minutes.
Shorter time-to-sleep settings reduce the energy consumed by moving devices out of higher energy
states, such as Ready mode.

Copy and digital send capabilities exception
Reports devices without the copy or digital send capability. The addition of digital send capability
enables digital—rather than paper-based—information management, reducing paper consumption.
This report can assist in uncovering alternatives to paper-based processes. Using digital, green
alternatives to printing or copying and sharing documents can help speed processes and decrease
paper consumption.
•

Device count—Quantity of devices that HP Web Jetadmin can detect.

•

Copy-capable devices—Devices with the copy capability. These devices can also scan to locally
connected devices.

•

Digital send-capable devices—Devices capable of scanning to a file and digital sending.

Device paper usage and digital processing
Reports device use, showing both paper-based and digital information management. This allows
comparison of simplex and duplex printing, as well as the use of the digital send capability rather
than copy.
•

Total count—Paper throughput in sheets.

•

Simplex sheets—Number of single-sided prints.

•

Duplex sheets—Number of sheets of paper printed in duplex (double-sided) mode, including the
sheets printed on one side while the device is in duplex mode.

•

Simplex versus duplex—Percentages of one-sided and two-sided printing. A higher percentage of
simplex pages indicates the potential to save paper with duplex printing.

•

Copy impressions—Number of impressions processed in copy mode. Each impression counts
once, regardless of whether it is copied to a single-sided or double-sided copy.

•

Digital send impressions—Number of impressions processed in digital send mode.

•

Copy versus digital send—Percentage of copy count and digital sends presented as a graph. The
higher the copy percentage, the greater the potential to save paper and reduce waste by moving
to digital processes.

•

Paper usage (sheets)/total impressions—Ratio indicating how much information (impressions) is
managed with paper. The lower the ratio, the more efficiently the device is being used (for
example, less paper is used to transfer information).

Top 5 paper usage
Reports the printers with the greatest paper usage among selected groups, enabling prioritized
follow-up.
•

Simplex count—Number of single-sided prints.

•

Duplex count—Number of sheets of paper printed in duplex (double-sided) mode, including the
sheets printed on one side while the device is in duplex mode.

•

Total count—Paper throughput in sheets.

•

Copy impressions—Number of impressions processed in copy mode. Each impression counts
once, regardless of whether it is copied to a single-sided or double-sided copy.

8

For more information about HP Eco Solutions reports, download the HP Eco Solutions with HP Web
Jetadmin white paper. For instructions on generating HP Eco Solutions reports, download the HP Web
Jetadmin Installation and Setup Guide. Both of these documents are available on the HP Web
Jetadmin support page.

SUMMARY
The optional Database Connectivity Module provides a license that can be installed in HP Web
Jetadmin to enable administrators to do the following:
•

Use a remote SQL database in place of a local SQL Express database.

•

Export device lists and store data collections to SQL database views.

•

Generate HP Eco Solutions reports to quickly assess opportunities to reduce the environmental
impact of their organization’s printing and track progress toward green IT goals over time.

Through database views, users can directly access exported device list or report data stored in a SQL
database from enterprise tools. This allows for building business intelligence reports, such as Crystal
Reports, directly on the device data exposed by HP Web Jetadmin database views. Administrators
can use the exposed database views of the device data to extract, transform, and load (ETL) the data
into an enterprise’s data warehouse.

9

APPENDIX A—CONFIGURE THE DEFAULT POLLER
The HP Web Jetadmin service automatically adds the following attributes to the background poller in
cases where the Database Connectivity Module license is installed. Users can choose to stop polling
for any of these attributes through a configuration file named ReportsDataViewPoller.config.xml found
in the C:\Windows\ServiceProfiles\NetworkService\AppData\Local\HP Inc\HPWebJetadmin\
WjaService\config directory. For each attribute in this file, a value of true indicates that daily polling
occurs and a value of false indicates that no polling occurs for that attribute.


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


10


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


HP.Imaging.Wjp.Sdk.Core.Framework.ConfigurationItemString
true


Figure 8—ReportsDataViewPoller.config.xml

11

APPENDIX B—DATA DICTIONARIES FOR DATABASE VIEWS
The following tables include all the attributes contained in each database view that is generated by
either reports data collections for Device Utilization and Supplies Utilization or by the attributes polled
in the configuration file described in Appendix A—Configure the default poller.

Media size and color usage utilization view
(PUBLIC_MEDIA_COLOR_USE_VW)
Attribute name

Data type

Description

device_guid

varchar(36) A GUID that serves as a unique identifier for the device.

connection_guid varchar(36) A GUID that serves as a unique identifier for a communication
interface.
media_size

varchar(64) A string representation of the media size that is associated with the
page counts. A value of ”Total” indicates that the page count column
values represent the total page counts for all media sizes. See
below1 for the list of valid values.

color_usage

varchar(64) Describes whether or not these were monochrome pages or color
pages and, if color, what type of color was used. Possible values
are: “Mono”, ”Color”, “GeneralOffice”, “GeneralOfficeAccent”,
“Professional”, “ProfessionalAccent”, or “Total”.

simplex_count

int

The number of single-sided sheets of pages printed by the printer.2

duplex_count

int

The number of sheets of paper printed with an impression on both
sides of the sheet.2

dimplex_count

int

The number of blank sides of paper printed as the final page of a
duplex job that contains an odd number of pages.2 If a duplex job
has an odd number of pages, the last page of the job is a sheet of
paper with only one impression on it (the other side is blank).

total_count

int

The total number of page impressions printed (simplex_count + 2
times the duplex_count).2

___________________

Valid values for media_size column: “Total”, “Other”, “eUSExecutive”, “eUSLetter”, “eUSLegal”, “eUSEDP”, “eEuropeanEDP”,
“eUSGovernmentLetter”, “eUSGovernmentLegal”, “eFolio”, “eFoolscap”, “eLedger”, “eCSize”, “eDSize”, “eESize”,
“eStatement”, “eSuperB”, “eROC16K”, “eJISExecutive”, “eROC8K”, “eISOandJISA10”, “eISOandJISA9”, “eISOandJISA8”,
“eISOandJISA7”, “eISOandJISA6”, “eISOandJISA5”, “eISOandJISA4”, “eISOandJISA3”, “eISOandJISA2”, “eISOandJISA1”,
“eISOandJISA0”, “eISOandJIS2A0”, “eISOandJIS4A0”, “ePRC8K270X390”, “eROC16K195X270”, “ePRC8K260x368”,
“eISORA4”, “eISOSRA4”, “eISOSRA3”, “eISORA3”, “eJISB10”, “eJISB9”, “eJISB8”, “eJISB7”, “eJISB6”, “eJISB5”, “eJISB4”,
“eJISB3”, “eJISB2”, “eJISB1”, “eJISB0”, “eISOB10”, “eISOB9”, “eISOB8”, “eISOB7”, “eISOB6”, “eISOB5”, “eISOB4”,
“eISOB3”, “eISOB2”, “eISOB1”, “eISOB0”, “eJapansePostcardSingle”, “eJapansePostcardDouble”, “eISOA6Postcard”,
“eIndexCard4x6”, “eIndexCard5x8”, “ePhoto4x6”, “eJapanesePostcardWithTab”, “eIndexCard3x5”, “eMonarch”,
“eCommercial10”, “eCatalog”, “eNo10Envelope”, “eROC16K184X260”, “eInternationalDL”, “eInternationalC5”,
“eInternationalC6”, “eInternationalC4”, “eInternationalB5”, “eCustom”, “eCustomCard”, “eUSEnvelopeA2”,
“eJapanseEnvLong3”, “eJapanseEnvLong4”, “eJapanseEnv2”, “ePhoto10x15”, “ePhotoCabinet”, “eTabloidExtra”,
“ePhotoLSizeCard”, “eIndexCard5x7”, “ePhotoESizeCard”, “ePhotoKGSizeCard”, “ePhoto2ESizeCard”, “ePhoto2LSizeCard”,
“eUSExecutiveR”, “eUSLetterR”, “eROC16KR”, “eISOandJISA6R”, “eISOandJISA5R”, “eISOandJISA4R”, “eJISBR6R”,
“eJISB5R”, “eStatementR”, “eAnyCustomSize”, “eAnySize”, “eCustomRoll”, “eUnknownMediaSize”, “eStatementWR”,
“eJISB5WR”, “eISOandJISA4WR”, “eISOandJISA5WR”, “eUSLetterWR”, “eJISB4W”, “eJISB5W”, “eISOandJISA3W”,
“eISOandJISA4W”, “eISOandJISA5W”, “eStatementW”, “eLedgerW”, “eUSLetterW”.
2
All pages printed, including copied pages and incoming fax pages.
1

12

Attribute name

Data type Description

total_equivalent_pages

float

The total area equivalent impressions printed.2 For Imperial
page sizes, this is the equivalent to the same area of letter
pages printed. For metric page sizes, this is the equivalent to
the same area of A4 pages printed.

scheduled_collection_time datetime

The time (based on server time) when the data collection was
scheduled to be started for the set of devices that includes this
device. If data is being collected on a large number of
devices, then this time could be substantially different from the
actual time of data collection for this specific device.

attributed_collection_time datetime

The time (based on server time) that this collection’s data was
attributed to. Generally, usage data is attributed to the
previous day since that is when the usage likely occurred.

NOTE

The page count attributes in this table might contain negative page counts. This usually
happens when a device has been reset in such a way that the device’s page count counters
have also been reset.

Job type utilization view (PUBLIC_JOB_TYPE_USE_VW)
Attribute name

Data type

Description

device_guid

varchar(36) A GUID that serves as a unique identifier for the device.

connection_guid

varchar(36) A GUID that serves as a unique identifier for a
communication interface.

copy_count

int

The total number of pages printed during copy operations.

digital_send_count

int

The number of pages scanned for digital send operations.

incoming_fax_count

int

The number of pages printed during incoming fax
operations.

outgoing_fax_count

int

The number of pages in outgoing fax operations.

scan_count

int

The total number of pages scanned regardless of the
operation.

scheduled_collection_time datetime

The time (based on server time) when the data collection
was scheduled to be started for the set of devices that
includes this device. If data is being collected on a large
number of devices, then this time could be substantially
different from the actual time of data collection for this
specific device.

attributed_collection_time datetime

The time (based on server time) that this collection’s data
was attributed to. Generally, usage data is attributed to the
previous day since that is when the usage likely occurred.

NOTE

The page count attributes in this table might contain negative page counts. This usually
happens when a device has been reset in such a way that the device’s page count counters
have also been reset.

13

Consumables utilization view (PUBLIC_CONSUMABLES_USE_VW)
Attribute name

Data type

Description

device_guid

varchar(36)

A GUID that serves as a unique identifier for the device.

connection_guid

varchar(36)

A GUID that serves as a unique identifier for a
communication interface.

consumable_info_id

int

An integer that identifies the entry in the
PUBLIC_CONSUMABLES_INFO_VW view that contains
the information about this consumable for this device.

collection_time

datetime

The time (based on server time) when the consumables
data was collected.

int

The estimated level of the consumable in the same units as
the maximum_capacity attribute of the
PUBLIC_CONSUMABLES_INFO_VW view. This attribute
might also contain negative values that have the following
meanings: level value empty (-1), level value low (-2), level
value unknown (-3), level value out (-4), level value failure
(-5), level value OK (-6).

percent_remaining

int

The estimated percentage of the consumable remaining.
This attribute might also contain negative values that have
the following meanings: level value empty (-1), level value
low (-2), level value unknown (-3), level value out (-4), level
value failure (-5), level value OK (-6).

supply_coverage

decimal(5,2)

The estimated percent average coverage of the
consumable per page.

pages_remaining

int

The estimated number of pages remaining before the
consumable must be replaced.

current_page_count

int

The number of page impressions that have been printed
using this consumable while it has been in this device.

level_value

Consumables information view (PUBLIC_CONSUMABLES_INFO_VW)
Attribute name

Data type

Description

device_guid

varchar(36)

A GUID that serves as a unique identifier for the device.

connection_guid

varchar(36)

A GUID that serves as a unique identifier for a
communication interface.

consumable_info_id

int

A unique integer that identifies a row view that can be
used to identify the consumables information for an entry
in the PUBLIC_CONSUMABLES_USE_VW view.

install_date

datetime

The date that the consumable was installed in the device.

14

removal_date

datetime

The date that the consumable was removed from the
device.

initial_level

int

The initial estimated level, as a percentage, of the
consumable when it was first recognized (when it was first
added to a data collection). This attribute might also
contain negative values that have the following meanings:
level value empty (-1), level value low (-2), level value
unknown (-3), level value out (-4), level value failure (-5),
level value OK (-6).

initial_page_count

int

The initial device page count when the consumable was
first recognized (when it was first added to a data
collection).

supply_status

varchar(10)

The authenticity of the consumable. Displays ”genuinehp“
for a genuine HP consumable, ”refill“ for a refilled
consumable, and ”unknown“ if the authenticity cannot be
determined.

active_state

varchar(15)

Describes whether the data is historical data for a
consumable that is no longer in use or for one that is still
being used in a device. Either ”Active“ or ”Removed“.

maximum_capacity

int

The estimated maximum capacity of this consumable. Units
might vary by consumable, but are usually page
impression counts.

maximum_pages

int

The estimated maximum number of page impressions that
can be printed by this consumable.

part_number

varchar(50)

The part number of the consumable for a 110-volt device
(see second_part_number for a 220-volt device).

serial_number

varchar(50)

The serial number of the consumable.

description

varchar(100) A description of the consumable.

manufacturing_date

datetime

The date that the consumable was manufactured.

oem_name

varchar(50)

The manufacturer of the consumable, when available.
Usually this is either ”HP“ or blank.

second_part_number

varchar(50)

The part number of the consumable for a 220-volt device
(see part_number for a 110-volt device).

type_name

varchar(128) A descriptive name of the type of the consumable.

type_string

varchar(50)

A tokenized string that represents the type of the
consumable. Generally, this is a more generic name than
the value in the type_name attribute.

color

varchar(50)

If the consumable can have a color associated with it (for
example, a toner cartridge), then this attribute contains the
color associated with the consumable.

15

Device attributes view (PUBLIC_DEV_INFO_VW)
Attribute name

Data type

Description

device_guid

string

A GUID that serves as a unique identifier for the device.

asset_number

string

The asset number reported by the device. This can be set
in the UI on the device configuration tab under My
Settings\Asset Number.

contact_person

string

The contact person reported by the device. This can be set
in the UI on the device configuration tab under
Device\Contact Person.

economode

string

The device’s economode setting. Either “ON”, “OFF”, or
“NULL” if unknown.

firmware_rev

string

The firmware revision reported by the device.

device_location

string

The device location reported by the device. This can be set
in the UI on the device configuration tab under My
Settings\Device Location.

device_name

string

The device name reported by the device. This can be set
in the UI on the device configuration tab under
Device\Device Name.

device_status

string

The status of the most recent device utilization data
collection attempt for the device. Either “NULL” (no attempt
was made), “STATUS_SUCCESS”, “STATUS_FAILURE”, or
“STATUS_COMMERROR”.

device_status_severity

string

The severity level of the status of the device. Either
“SEVERITY_GREEN” (ready), “SEVERITY_YELLOW”
(warning), or “SEVERITY_RED” (error).

display_name

string

The name of the device formatted for display.

du_enabled

int

Status of device utilization data collection. “1” if enabled
for the device, otherwise “0”.

du_first_collected

datetime

The date and time of the first device utilization data
collection on the device.

du_last_collected

datetime

The date and time of the most recent device utilization
data collection on the device.

duplex_binding

string

The status of duplexing. “Simplex” indicates that duplexing
is turned off by default. “LongEdge” or “ShortEdge”
indicates that duplexing is turned on by default. “NULL”
indicates that the duplex setting is not known.

has_duplex

int

Indicates whether the device has a duplexer. “1” if
positive, otherwise “0”.

has_powersave

int

Indicates whether the device has Powersave capability.
“1” if positive, otherwise “0”.

16

page_count

int

The lifetime total pages for the printer engine as reported
by the device.

powersave_seconds

int

The number of idle seconds before the printer goes into
Powersave mode. “0” indicates that Powersave is
disabled, “NULL” indicates the setting is unknown.

model_name

string

The model name as reported by the device.

serial_number

string

The serial number of the device.

system_contact

string

The system contact reported by the device. This can be set
in the UI on the device configuration tab under My
Settings\System Contact.

system_location

string

The system location reported by the device. This can be set
in the UI on the device configuration tab under
My Settings\System Location.

Connection attributes view (PUBLIC_CONN_INFO_VW)
Attribute name

Data type

Description

device_guid

string

A GUID that serves as a unique identifier for the device.

connection_guid

string

A GUID that serves as a unique identifier for a
communication interface.

ip_hostname

string

The IP host name of the network interface.

ipv4_address

string

The version 4 IP address of the network interface.

mac_address

string

The MAC address of the network interface.

discovery_time

datetime

The time at which the most recent discovery of the device
occurred.

nic_model_name

string

The model name reported by the network interface.

nic_version

string

The firmware version reported by the network interface.

port_number

int

The port number of the network interface that the device
corresponding to device_guid is attached to.

All attributes view (PUBLIC_DEV_CON_INFO_VW)
This view is a combination of the PUBLIC_DEV_INFO_VW and the PUBLIC_CON_INFO_VW. See the
previous tables for column details.

17

Group membership view (PUBLIC_DEVICE_GROUP_VW)
Attribute name

Data type

Description

group_name

varchar(256) The name of the device group (for example, “Houston” or
“Texas”).

group_full_name

varchar(max) The fully qualified device group name; a slash separated
string that contains the all of the group’s ancestor groups
(”USA“, ”USA/Texas“, ”USA/Texas/Houston“).

group_guid

varchar(36)

A GUID that serves as a unique identifier for the device
group.

device_guid

varchar(36)

A GUID that serves as a unique identifier for the device.

connection_guid

varchar(36)

A GUID that serves as a unique identifier for a
communication interface.

is_direct_member

int

Describes how the device became a member of its group.
“1” if the device referenced by the device_guid and
connection_guid is a direct member of the group_name
group; “0” if the device is a member of the group because
the group_name group is an ancestor of the device’s
parent group.

Media charge view (PUBLIC_MEDIA_CHARGE_VW)
Attribute name

Data type

Description

device_guid

varchar(36)

A GUID that serves as a unique identifier for the device.

connection_guid

varchar(36)

A GUID that serves as a unique identifier for a
communication interface.

media_size

varchar(64)

A string representation of the media size that is associated
with the simplex_charge and duplex_charge values.

simplex_charge

float

The ratio used to calculate the letter or A4 area equivalent
for simplex pages (letter, if the media size is in Imperial
units; A4, if the media size is in metric units).

duplex_charge

float

The ratio used to calculate the letter or A4 area equivalent
for duplex pages (letter, if the media size is in Imperial
units; A4, if the media size is in metric units).

18

APPENDIX C—NAMING SCHEMA

19

20

21

22

23

24

25

26

© Copyright 2017 HP Development Company, L.P. The information contained herein is subject to change without
notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying
such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be
liable for technical or editorial errors or omissions contained herein.
Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States
and/or other countries.

c02079122EN, Rev. 8, April 2017

27



Source Exif Data:
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : Yes
Author                          : HP LaserJet Content Design & Delivery
Company                         : TMS
Content Type Id                 : 0x0101004B37922C9FE54845AE764A3839B62FAB
Create Date                     : 2017:04:12 09:14:03-06:00
Keywords                        : Rev. 8, 4/2017
Modify Date                     : 2017:04:12 09:54:12-06:00
Order                           : 32400.000000
Source Modified                 : D:20170412145950
White Paper Documents           : 
Language                        : EN-US
Tagged PDF                      : Yes
XMP Toolkit                     : Adobe XMP Core 5.4-c006 80.159825, 2016/09/16-03:31:08
Metadata Date                   : 2017:04:12 09:54:12-06:00
Creator Tool                    : Acrobat PDFMaker 11 for Word
Document ID                     : uuid:080349db-bd93-4854-b1f2-2fa0c98dc171
Instance ID                     : uuid:24462b01-6e63-4bf5-bccf-7422464a6f4b
Format                          : application/pdf
Title                           : Database Views in HP Web Jetadmin - ENWW
Creator                         : HP LaserJet Content Design & Delivery
Subject                         : Rev. 8, 4/2017
Producer                        : Adobe PDF Library 11.0
White 0020 Paper 0020 Documents : 
Page Layout                     : OneColumn
Page Count                      : 27
EXIF Metadata provided by EXIF.tools

Navigation menu