FRAMEWORK tables and field names

This document lists and explains most of the tables in the FRAMEWORK database and describes the fields that each table contains. The tables and columns in the database are subject to change from one release to the next.

Printer

The following tables deal with the logical representation of a physical printer.

CONFIG_ITEM

The CONFIG_ITEM table represents the ITIL configuration items (CI) of the printer. It shows the state of the CI and time stamps of its creation, initial management, last discovery, and other actions. The table does not represent any physical portion of a printer; it is simply an abstract representation of the device.

Field Name

Data Type

Description

CI_ID

BIGINT

Primary key.

CI_STATE

VARCHAR(255)

The current state of the CI. The options are NEW, MANAGED, MISSING, FOUND, CHANGED, UNMANAGED, and RETIRED.

CREATION_DATE

TIMESTAMP

The date when the CI first entered the system.

INITIAL_MANAGEMENT_DATE

TIMESTAMP

The date when the CI first entered the MANAGED state or substate.

LAST_AUDIT_DATE

TIMESTAMP

The date of the last audit attempted on the CI (whether or successful or not).

PRINTER_ID

BIGINT

The foreign key to NETWORK_PRINTER.PRINTER_ID.

LAST_DISCOVERY_DATE

TIMESTAMP

The date when the last discovery was attempted on the CI (whether successful or not).

LAST_SUCCESSFUL_AUDIT_DATE

TIMESTAMP

The date of the last successful audit of the CI.

LAST_SUCCESSFUL_DISCOVERY_ DATE

TIMESTAMP

The date of the last successful discovery of the CI.

DEFAULT_CERT_COMMON_NAME

VARCHAR(255)

The name of the default certificate.

DEFAULT_CERT_ISSUER_NAME

VARCHAR(255)

The name of the issuer of the certificate.

DEFAULT_CERT_SIGNING_STATUS

VARCHAR(255)

The certificate signing status of the printer. The options are SIGNED, INVALID_CERT, NO_CA, and UNKNOWN.

DEFAULT_CERT_VALID_FROM

TIMESTAMP

The starting date of the validity of the certificate.

DEFAULT_CERT_VALID_TO

TIMESTAMP

The last date of the validity of the certificate.

DEFAULT_CERTIFICATE

VARCHAR(8190)

The default certificate.

DEFAULT_CERT_SERIAL_NUMBER

VARCHAR(255)

The serial number of the default certificate.


NETWORK_ADAPTER

This table represents the network adapter (also known as the print server) of a physical printer.

Field name

Data type

Description

ADAPTER_TYPE

VARCHAR(31)

Always INA (internal network adapter).

ADAPTER_ID

BIGINT

The primary key.

FIRMWARE_REVISION

VARCHAR(255)

The current network firmware revision.

MANUFACTURER

VARCHAR(255)

N/A.

MODEL_NAME

VARCHAR(255)

N/A.

SERIAL_NUMBER

VARCHAR(50)

N/A.

SYSTEM_NAME

VARCHAR(255)

N/A.

RETRIES

INTEGER

The number of times to retry communicating with a printer.

SNMP_READ_COMMUNITY_NAME

VARCHAR(255)

The SNMP community name for reading.

TIMEOUT

BIGINT

The number of milliseconds to wait for a particular communication attempt with a printer to succeed.

CONTACT_LOCATION

VARCHAR(255)

N/A.

CONTACT_NAME

VARCHAR(255)

N/A.

DOMAIN_NAME_SUFFIX

VARCHAR(191)

The domain name suffix associated with this network adapter (for example, foo.lexmark.com). Combine with HOSTNAME to get the fully qualified domain name (FQDN).

HOSTNAME

VARCHAR(63)

The host name associated with this network adapter. MVE can be configured to retrieve the host name from DNS or from the network adapter itself. Combine with DOMAIN_NAME_SUFFIX to get the fully qualified domain name (FQDN).

IP_ADDRESS

VARCHAR(15)

The integer representation of the IP address of this network adapter. Deprecated.

IP_ADDRESS_INT

INTEGER

The integer representation of the IP address of this network adapter.

IP_ADDRESS_SUBNET

INTEGER

The integer representation of the subnet on which this network adapter resides.

MAC_CANONICAL

VARCHAR(12)

The MAC address of the network adapter, in canonical format.

PORTS

INTEGER

The number of ports that the network adapter supports. Always 1.

RAND_MAC

SMALLINT/ TINYINT*

The flag indicating whether the current value of MAC_CANONICAL was randomly generated.

CREDENTIAL_REQUIRED

SMALLINT/ TINYINT*

The flag indicating whether a credential is necessary to communicate with the associated printer.

CREDENTIAL_PASSWORD

BLOB SUB_TYPE 0

This value is encrypted and not available for use outside MVE.

CREDENTIAL_PIN

BLOB SUB_TYPE 0

This value is encrypted and not available for use outside MVE.

CREDENTIAL_REALM

VARCHAR(64)

The credential realm, if set.

CREDENTIAL_USERNAME

VARCHAR(255)

The credential username, if set.

PORT_CONFIG_LST_TCP_OPEN

SMALLINT/ TINYINT*

The flag indicating whether this port on the associated printer is open.

PORT_CONFIG_LST_UDP_OPEN

SMALLINT/ TINYINT*

The flag indicating whether this port on the associated printer is open.

PORT_CONFIG_MDNS_OPEN

SMALLINT/ TINYINT*

The flag indicating whether this port on the associated printer is open.

PORT_CONFIG_NPA_TCP_OPEN

SMALLINT/ TINYINT*

The flag indicating whether this port on the associated printer is open.

PORT_CONFIG_NPA_UDP_OPEN

SMALLINT/ TINYINT*

The flag indicating whether this port on the associated printer is open.

PORT_CONFIG_RAW_PRINT_OPEN

SMALLINT/ TINYINT*

The flag indicating whether this port on the associated printer is open.

PORT_CONFIG_SNMP_OPEN

SMALLINT/ TINYINT*

The flag indicating whether this port on the associated printer is open.

PORT_CONFIG_XML_TCP_OPEN

SMALLINT/ TINYINT*

The flag indicating whether this port on the associated printer is open.

PORT_CONFIG_XML_UDP_OPEN

SMALLINT/ TINYINT*

The flag indicating whether this port on the associated printer is open.

SECURE_COMMUNICATION_STATE

VARCHAR(255)

The state of the communication. The options are UNSECURED, MISSING_CREDENTIALS, and SECURED.

USER_PASSWORD

Blob sub_type 0

The username portion of the credentials.

SNMP_USERNAME

VARCHAR(32)

The user name used for SNMPv3 communications.

SNMP_PASSWORD

VARCHAR(255)

This value is encrypted and not available for use outside MVE.

SNMP_MIN_AUTHENTICATION_LEVEL

Varchar(50)

The minimum authentication level used for SNMPv3 communications.

SNMP_AUTHENTICATION_HASH

VARCHAR(50)

The hash authentication used for SNMPv3 communications.

SNMP_PRIVACY_ALGORITHM

VARCHAR(50)

The privacy algorithm used for SNMPv3 communications.

LOGIN_METHOD

VARCHAR(256)

The authentication method used to log in to the printer.

LOGIN_METHOD_NAME

VARCHAR(256)

If LOGIN_METHOD is either LDAP or LDAP+GSSAPI, then this field shows the name of the authentication method.

TRACING_SERIAL_NUMBER

VARCHAR(64)

The authentication method used to trace the serial number.


NETWORK_PRINTER

This table represents the actual printer portion of the physical printer.

Field Name

Data Type

Description

PRINTER_ID

BIGINT

The primary key.

MANUFACTURER

VARCHAR(255)

The company that actually made the printer. May differ from DISPLAY_MANUFACTURER.

MODEL_NAME

VARCHAR(255)

The model name of the printer.

SERIAL_NUMBER

VARCHAR(50)

The serial number of this printer.

SYSTEM_NAME

VARCHAR(255)

The name used to identify the device.

COPY

SMALLINT/ TINYINT*

The flag indicating whether the printer supports copying.

DUPLEX

SMALLINT/ TINYINT*

The flag indicating whether the printer supports two-sided printing.

ESF

SMALLINT/ TINYINT*

The flag indicating whether the printer supports eSF applications.

MARKING_TECHNOLOGY

VARCHAR(255)

The type of marking technology used by the printer (for example, electrophotographic).

MEMORY

BIGINT

The amount of memory, in bytes.

PROFILE

SMALLINT/ TINYINT*

The flag indicating whether this printer supports profiles.

RECEIVE_FAX

SMALLINT/ TINYINT*

The flag indicating whether this printer supports receiving faxes.

SCAN_TO_EMAIL

SMALLINT/ TINYINT*

The flag indicating whether this printer supports scanning to email.

SCAN_TO_FAX

SMALLINT/ TINYINT*

The flag indicating whether this printer supports scanning to fax.

SCAN_TO_NETWORK

SMALLINT/ TINYINT*

The flag indicating whether this printer supports scanning to a network.

SPEED

VARCHAR(255)

The number of sheets that the paper can print per minute.

DISPLAY_MANUFACTURER

VARCHAR(255)

The name that appears on the outside of the printer. For example, MANUFACTURER could be LEXMARK, but DISPLAY_MANUFACTURER could be Dell.

FAMILY_ID

INTEGER

The NPA family ID.

INITIAL_DISCOVERY_TIMESTAMP

TIMESTAMP

When the printer was first discovered.

LIFETIME_PAGE_COUNT

BIGINT

The lifetime page count.

MAINTENANCE_COUNTER

BIGINT

The maintenance counter.

ADAPTER_PORT

INTEGER

The port on which this printer is connected to its associated network adapter. For now, the data is always 1.

PROPERTY_TAG

VARCHAR(255)

The asset, brass, or property tag.

ADAPTER_ID

BIGINT

The foreign key to NETWORK_ADAPTER.ADAPTER_ID.

RAND_SN

SMALLINT/ TINYINT*

The flag indicating whether the current value of SERIAL_NUMBER was randomly generated.

DEV_STATUS_REG_COUNTER

INTEGER

The number of device status registrations.

SCANNER_SERIAL_NUMBER

VARCHAR(12)

For modular MFPs, the serial number of the scan head.

DISK_ENCRYPTION

VARCHAR(8)

The frequency at which disk encryption is enabled.

DISK_WIPING

VARCHAR(8)

The frequency at which disk wiping is enabled.

COLOR

SMALLINT/ TINYINT*

The flag indicating whether the printer prints in color.

PRINTER_STATUS_SUMMARY

SMALLINT/ TINYINT*

The indicator of the most severe status message that is present on the printer.

SUPPLY_STATUS_SUMMARY

SMALLINT/ TINYINT*

The indicator of the most severe supply status message that is present on the printer.

TLI

VARCHAR(255)

The Top Level Indicator (TLI) of the printer model.

FAX_STATION_NAME

VARCHAR(255)

The value of the fax name setting on the printer.

FAX_STATION_NUMBER

VARCHAR(255)

The value of the fax number setting on the printer.

SCANNER_SERIAL_NUMBER

VARCHAR(50)

The serial number of the scanner of the printer.

TIME_ZONE

VARCHAR(255)

The ID for different time zones supported by the printer.

MODULAR_SERIAL_NUMBER

VARCHAR(255)

The modular serial number.

TRACING_SERIAL_NUMBER

VARCHAR(64)

The authentication method that is used to trace the serial number.


PRINTER_CURRENT_STATUS

This table represents the printer status when data was collected. There is a row in this table for each status condition on a given printer, all pointing to the same PRINTER_ID.

Field Name

Data Type

Description

STATUS_ID

BIGINT

The primary key.

STATUS_MESSAGE

VARCHAR(255)

The text for this status (for example, Tray 1 Low).

STATUS_SEVERITY

VARCHAR(255)

The severity of this status (for example, Warning).

STATUS_TYPE

VARCHAR(255)

The type of this status (for example, Printer or Supply).

PRINTER_ID

BIGINT

The foreign key to NETWORK_PRINTER.PRINTER_ID.


PRINTER_ESF_APPS

This table represents the installed eSF applications on printers when data was collected. There is a row in this table for each eSF application currently installed on a given printer, all pointing to the same PRINTER_ID.

Field Name

Data Type

Description

APPLICATION_ID

BIGINT

The primary key.

NAME

VARCHAR(255)

The application name.

STATE

VARCHAR(255)

The current state.

VERSION

VARCHAR(255)

The current version.

PRINTER_ID

BIGINT

The foreign key to NETWORK_PRINTER.PRINTER_ID.


PRINTER_INPUT_OPTIONS

This table represents installed input options on printers when data was collected. There is a row in this table for each input option currently installed on a given printer, all pointing to the same PRINTER_ID.

Field Name

Data Type

Description

INPUT_OPTION_ID

BIGINT

The primary key.

NAME

VARCHAR(255)

The name of the input option (for example, Multipurpose Tray).

PRINTER_ID

BIGINT

The foreign key to NETWORK_PRINTER.PRINTER_ID.


PRINTER_INPUT_TRAYS

This table represents input trays associated with an input option. There is a row in this table for each input tray associated with a given input option, all pointing to the same INPUT_OPTION_ID.

Field Name

Data Type

Description

INPUT_OPTION_ID

BIGINT

The foreign key to PRINTER_INPUT_OPTIONS.INPUT_OPTION_ID.

CAPACITY

BIGINT

The maximum number of sheets that the tray can hold.

FEED_TYPE

VARCHAR(255)

Manual or Auto.

FORM_SIZE

VARCHAR(255)

The current paper size (for example, Letter).

FORM_TYPE

VARCHAR(255)

The current paper type (for example, Plain Paper).

TYPE

VARCHAR(255)

The type of input tray (for example, Multipurpose Feeder).


PRINTER_OPTIONS

This table represents installed options on printers when data was collected. There is a row in this table for each option currently installed on a given printer, all pointing to the same PRINTER_ID. Typically, the option is a storage device.

Field Name

Data Type

Description

OPTION_ID

BIGINT

The primary key.

FREESPACE_

BIGINT

The amount of space remaining on the storage device.

NAME

VARCHAR(255)

The name of the printer option (for example, DISK).

SIZE_

BIGINT

The total amount of space.

PRINTER_ID

BIGINT

The foreign key to NETWORK_PRINTER.PRINTER_ID.


PRINTER_OUTPUT_BINS

This table represents output bins associated with an output option. There is a row in this table for each output bin associated with a given output option, all pointing to the same OUTPUT_OPTION_ID.

Field name

Data type

Description

OUTPUT_OPTION_ID

BIGINT

The foreign key to PRINTER_OUTPUT_OPTIONS.OUTPU T_OPTION_ID.

BINDING

SMALLINT/ TINYINT*

The flag indicating whether this bin supports binding.

BURSTING

SMALLINT/ TINYINT*

The flag indicating whether this bin supports bursting.

CAPACITY

BIGINT

The maximum number of sheets that the bin can hold.

COLLATION

SMALLINT/ TINYINT*

The flag indicating whether this bin supports collation.

FACE_DOWN

SMALLINT/ TINYINT*

The flag indicating whether paper is loaded facedown in this bin.

FACE_UP

SMALLINT/ TINYINT*

The flag indicating whether paper is loaded faceup in this bin.

LEVEL_SENSING

SMALLINT/ TINYINT*

The flag indicating whether this bin supports paper-level sensing.

PUNCHING

SMALLINT/ TINYINT*

The flag indicating whether this bin supports hole punching.

SECURITY

SMALLINT/ TINYINT*

The flag indicating whether this bin supports security.

SEPARATION

SMALLINT/ TINYINT*

The flag indicating whether this bin supports separation.

STITICHING

SMALLINT/ TINYINT*

The flag indicating whether this bin supports stitching.

TYPE

VARCHAR(255)

The type of printer output bin (for example, Standard Bin, Bin 5, etc.)


PRINTER_OUTPUT_OPTIONS

This table represents installed output options on printers. There is a row in this table for each output option currently installed on a given printer, all pointing to the same PRINTER_ID.

Field Name

Data Type

Description

OUTPUT_OPTION_ID

BIGINT

The primary key.

NAME

VARCHAR(255)

The name of the option (for example, Integrated Hopper, Mailbox, and Finisher).

PRINTER_ID

BIGINT

The foreign key to NETWORK_PRINTER.PRINTER_ID.


PRINTER_STATISTICS

This table contains information gathered from the meters and counters data of the printer. Each row represents data for an individual printer. Depending on the printer model with which the record is associated, not all columns apply.

Field Name

Data Type

Description

STATISTICS_ID

BIGINT

The primary key.

COVG_LAST_JOB_BLACK

BIGINT

The black toner coverage of the last print job.

COVG_LIFETIME_BLACK

BIGINT

The black toner coverage of lifetime print jobs.

CART_PAGES_PRINT_BLACK

BIGINT

The count of the printed pages that used black toner cartridge.

BLACK_TONER_LEVEL

VARCHAR(255)

The current supply level of the black toner cartridge.

PHOTO_COND_LEVEL_K

VARCHAR(255)

The current supply level of the photoconductor (black).

BLANK_SAFE_SIDE_COPY

BIGINT

The count of the blank safe sides from a copy.

BLANK_SAFE_SIDE_FAX

BIGINT

The count of the blank safe sides from a fax.

BLANK_SAFE_SIDE_PRINT

BIGINT

The count of the blank safe sides from a print.

PAPER_CHANGE

BIGINT

The count of paper change events.

COVER_OPEN

BIGINT

The count of cover open events.

COVG_LAST_JOB_CYAN

BIGINT

The cyan toner coverage of the last print job.

COVG_LIFETIME_CYAN

BIGINT

The cyan toner coverage of lifetime print jobs.

CART_PAGES_PRINT_CYAN

BIGINT

The count of the printed pages that used the cyan toner cartridge.

CYAN_TONER_LEVEL

VARCHAR(255)

The current supply level of the cyan toner cartridge.

CYAN_TONER_STATUS

VARCHAR(255)

The supply status for the cyan cartridge (for example, Intermediate).

YELLOW_TONER_STATUS

VARCHAR(255)

The supply status for the yellow cartridge (for example, Intermediate).

MAGENTA_TONER_STATUS

VARCHAR(255)

The supply status for the magenta cartridge (for example, Intermediate).

BLACK_TONER_STATUS

VARCHAR(255)

The supply status for the black cartridge (for example, Intermediate).

PHOTO_COND_LEVEL_C

VARCHAR(255)

The current supply level of the photoconductor (cyan).

DEVICE_INSTALL_DATE

TIMESTAMP

The time stamp of the first installation of the printer.

FUSER_CURRENT_LEVEL

VARCHAR(255)

The current supply level of the fuser.

IMG_SAFE_SIDE_COPY

BIGINT

The count of imaged printed sides of a copy job.

IMG_SAFE_SIDE_FAX

BIGINT

The count of imaged printed sides of a fax job.

IMG_SAFE_SIDE_PRINT

BIGINT

The count of imaged printed sides of a print job.

LAST_FAX_JOB_DATE

TIMESTAMP

The time stamp of the last fax job.

LAST_PRINTED_JOB_DATE

TIMESTAMP

The time stamp of the last print job.

LAST_SCAN_JOB_DATE

TIMESTAMP

The time stamp of the last scan job.

COVG_LAST_JOB_MAGENTA

BIGINT

The magenta toner coverage of the last job.

COVG_LIFETIME_MAGENTA

BIGINT

The magenta toner coverage of lifetime jobs.

CART_PAGES_PRINT_MAGENTA

BIGINT

The count of the printed pages that used the magenta toner cartridge.

MAGENTA_TONER_LEVEL

VARCHAR(255)

The current supply level of the magenta toner cartridge.

PHOTO_COND_LEVEL_M

VARCHAR(255)

The current supply level of the photoconductor (magenta).

MAINT_KIT_LEVEL

VARCHAR(255)

The current supply level of the maintenance kit.

MEDIA_SIZE_TYPE_MONO_SIDE_ SAFE

BIGINT

The mono printed sides (safe).

MEDIA_SIZE_TYPE_COLOR_SIDE_ SAFE

BIGINT

The color printed sides (safe).

SUPPLY_EVENTS

BIGINT

The count of other supply events.

PAPER_JAMS

BIGINT

The count of paper jam events.

PAPER_LOAD

BIGINT

The count of paper load events.

PRINT_SHEET_USE_PICKED

BIGINT

The printed sheets (picked).

PRINT_SIDE_USE_PICKED

BIGINT

The printed sides (picked).

POR

BIGINT

The count of Power-On Resets.

PRINT_AND_HOLD_JOB

BIGINT

The count of print-and-hold jobs.

SAFE_SHT_COPY

BIGINT

The printed sheets (safe) from copy jobs.

SAFE_SHT_FAX

BIGINT

The printed sheets (safe) from fax jobs.

SAFE_SHT_PRINT

BIGINT

The printed sheets (safe) from print jobs.

SCAN_PAPER_JAMS

BIGINT

The count of scanner jams.

PRINTED_FROM_PRINT_AND_HOLD

BIGINT

The count of printed print-and-hold jobs.

PRINTED_FROM_USB

BIGINT

The count of prints from USB.

TRANS_BELT_LEVEL

VARCHAR(255)

The current supply level of the transfer belt.

USB_DIRECT_JOB

BIGINT

The count of USB insertions.

WASTE_TONER_LEVEL

VARCHAR(255)

The current level of the waste toner bottle.

COVG_LAST_JOB_YELLOW

BIGINT

The yellow toner coverage of the last job.

COVG_LIFETIME_YELLOW

BIGINT

The yellow toner coverage of lifetime jobs.

CART_PAGES_PRINT_YELLOW

BIGINT

The count of the printed pages that used the yellow toner cartridge.

YELLOW_TONER_LEVEL

VARCHAR(255)

The current supply level of the yellow toner cartridge.

PHOTO_COND_LEVEL_Y

VARCHAR(255)

The current level of the photoconductor (yellow).

IMG_SAFE_SIDE_PRINT_MONO

BIGINT

The count of imaged mono printed sides (safe) from print jobs.

IMG_SAFE_SIDE_PRINT_COLOR

BIGINT

The count of imaged color printed sides (safe) from print jobs.

IMG_SAFE_SIDE_COPY_MONO

BIGINT

The count of imaged mono printed sides (safe) from copy jobs.

IMG_SAFE_SIDE_COPY_COLOR

BIGINT

The count of imaged color printed sides (safe) from copy jobs.

IMG_SAFE_SIDE_FAX_MONO

BIGINT

The count of imaged mono printed sides (safe) from fax jobs.

IMG_SAFE_SIDE_FAX_COLOR

BIGINT

The count of imaged color printed sides (safe) from fax jobs.

FAX_JOB_RECV

BIGINT

The count of received fax jobs.

FAX_JOB_SENT

BIGINT

The count of sent fax jobs.

FAX_PAGE_RECV

BIGINT

The count of received fax pages.

FAX_PAGE_SENT

BIGINT

The count of sent fax pages.

SCAN_COPY

BIGINT

The count of scans from copy jobs.

SCAN_FAX

BIGINT

The count of scans from fax.

SCAN_LOCAL

BIGINT

The count of local scans.

SCAN_NET

BIGINT

The count of scans to network.

SCAN_FLAT

BIGINT

The count of scans from the scanner glass flatbed.

SCAN_ADF_SIMPLEX

BIGINT

The count of scans from the ADF (simplex).

SCAN_ADF_DUPLEX

BIGINT

The count of scans from the ADF (duplex).

SCAN_USB_DIRECT

BIGINT

The count of scans directly to USB.

USB_DIRECT_INSERT

BIGINT

The count of USB insertions.

CART_INST_DATE_CYAN

TIMESTAMP

The time stamp of the cyan cartridge installation.

CART_INST_DATE_YELLOW

TIMESTAMP

The time stamp of the yellow cartridge installation.

CART_INST_DATE_MAGENTA

TIMESTAMP

The time stamp of the magenta cartridge installation.

CART_INST_DATE_BLACK

TIMESTAMP

The time stamp of the black cartridge installed.

PRINTER_ID

BIGINT

The foreign key to NETWORK_PRINTER.PRINTER_ID.

MAINT_KIT_STATUS_100K

VARCHAR(255)

The 100K maintenance kit level.

MAINT_KIT_STATUS_160K

VARCHAR(255)

The 160K maintenance kit level.

MAINT_KIT_STATUS_200K

VARCHAR(255)

The 200K maintenance kit level.

MAINT_KIT_STATUS_300K

VARCHAR(255)

The 300K maintenance kit level.

MAINT_KIT_STATUS_320K

VARCHAR(255)

The 320K maintenance kit level.

MAINT_KIT_STATUS_480K

VARCHAR(255)

The 480K maintenance kit level.

MAINT_KIT_STATUS_600K

VARCHAR(255)

The 600K maintenance kit level.


PRINTER_SUPPLIES

This table represents supplies in printers. There is a row in this table for each supply in a given printer, all pointing to the same PRINTER_ID. Depending on the type, not all columns apply.

Field Name

Data Type

Description

SUPPLY_ID

BIGINT

The primary key.

CAPACITY

BIGINT

The maximum sheet capacity of the supply.

COLOR

VARCHAR(255)

The color of the supply (for example, Black, Cyan, or NULL).

NAME

VARCHAR(255)

The name of the supply (for example, Black Toner, Fuser, and Waste Bottle).

SMART_CARTRIDGE_PREBATE

SMALLINT/ TINYINT*

The flag indicating whether this supply is a smart cartridge prebate.

SMART_CARTRIDGE_REFILLED

SMALLINT/ TINYINT*

The flag indicating whether this supply is a smart cartridge refill.

SMART_CARTRIDGE_SERIAL_NUM BER

VARCHAR(255)

The smart cartridge serial number.

TYPE

VARCHAR(255)

The type of supply (for example, Toner, Transfer Belt, Fuser, Container, or Imaging Unit).

PRINTER_ID

BIGINT

The foreign key to NETWORK_PRINTER.PRINTER_ID.

PERCENT_FULL

BIGINT

The calculated remaining percentage of the supply.


CHANGED_SETTINGS

This table contains information about settings that changed between the last two audits.

Field Name

Data Type

Description

ID

BIGINT

The primary key.

CI_ID

BIGINT

Refers to CONFIG_ITEM.ID.

SETTING_NAME

VARCHAR(255)

The name of the setting that changed.

CHANGE_TYPE

VARCHAR(255)

The type of change. The options are ADD, UPDATE, and REMOVE.


PRINTER_PORTS

This table contains information about the status of the printer TCP/UDP ports.

Field name

Data type

Description

PRINTER_PORTS_ID

BIGINT

The primary key.

PRINTER_ID

BIGINT

Refers to PRINTER.ID.

TCP21

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

UDP69

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP79

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP80

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

UDP137

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

UDP161

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

UDP162

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP515

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP631

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP5001

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

UDP5353

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP8000

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP9100

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP9200

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

UDP9200

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

UDP9300

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

UDP9301

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

UDP9302

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP9400

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP9500

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP9501

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP9600

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

UDP9700

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP9000

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP5000

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP443

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP4000

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

UDP6100

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP6100

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP65002

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP65004

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP65004

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP65001

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TCP65003

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.


PRINTER_SECURITY-OPTIONS

This table contains information related to the security details of the printer.

Field Name

Data Type

Description

PRINTER_SECURITY_ID

BIGINT

The primary key.

PRINTER_ID

BIGINT

Refers to PRINTER.ID.

OWASP_CIPHER_CATEGORY

VARCHAR(500)

The list of cipher categories supported by the device.

TLS10

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.

TLS11

VARCHAR(255)

The options are OFF, ON, UNKNOWN, and NONE.


Keywords

The following tables deal with MVE keywords.

ASSIGNED_KEYWORDS

This table represents the keywords assigned to their respective CIs and printers.

Field Name

Data Type

Description

KEYWORD_ID

BIGINT

The composite primary key, and the foreign key to KEYWORD.KEYWORD_ID.

CI_ID

BIGINT

The composite primary key, and the foreign key to CONFIGURATION_ITEM.CI_ID.


KEYWORD

This table represents all the keywords defined in the system.

Field Name

Data Type

Description

KEYWORD_ID

BIGINT

The primary key.

KEYWORD_VALUE

VARCHAR(255)

The keyword name.

CATEGORY_ID

BIGINT

The foreign key to KEYWORD_CATEGORY.CATEGORY_ID.


KEYWORD_CATEGORY

This table lists all the categories defined in the system. It is used for grouping keywords together.

Field Name

Data Type

Description

CATEGORY_ID

BIGINT

The primary key.

CATEGORY_VALUE

VARCHAR(255)

The category name.


Configurations

The following tables deal with MVE’s configurations.

CONFIGURATION

This table represents a printer configuration at the highest level, including the printer name, model, and whether it can be assigned.

Field name

Data type

Description

CONFIGURATION_ID

BIGINT

The primary key.

CONFIGURATION_NAME

VARCHAR(255)

The configuration name.

ASSIGNABLE

SMALLINT/ TINYINT*

The flag indicating whether the configuration is assignable.

DESCRIPTION

VARCHAR(4000)

A user-entered description of the configuration.

LAST_MODIFIED

TIMESTAMP

The time stamp of the last edit of the configuration.

MANAGING_DEV_CERTIFICATE

BOOLEAN

The default Boolean value. This field indicates whether this configuration manages the device certificate automatically.


CONFIGURATION_COMPONENT

This table represents one component of a configuration.

Field name

Data type

Description

CONFIGURATION_COMPONENT_ID

BIGINT

The primary key.

COMPONENT_TYPE

VARCHAR(255)

The component type. The options are DEVICE_SETTINGS, SECURITY_CAESAR1, SECURITY_CAESAR2, ESF, and FIRMWARE.

CREDENTIAL_PASSWORD

BLOB SUB_TYPE 0

The encrypted credential password, if set.

CREDENTIAL_PIN

BLOB SUB_TYPE 0

The encrypted credential PIN, if set.

CREDENTIAL_REALM

VARCHAR(255)

The credential realm, if set.

CREDENTIAL_USERNAME

VARCHAR(255)

The credential user name, if set.

COMPONENT_NAME

VARCHAR(255)

The component name.

LICENSE_TYPE

VARCHAR(255)

The license type of the configuration component. The options are PRODUCTION, TRIAL, and FACTORY.

LOGIN_METHOD

VARCHAR(256)

The authentication method used to log in to the printer.

MERGE_DATA_PATH

VARCHAR(255)

The file location of a variable settings file.

FLASH_FILE_SHA1

VARCHAR(255)

The SHA1 hash of the flash file for a firmware component.

LOGIN_METHOD_NAME

VARCHAR(256)

If the LOGIN_METHOD is either LDAP or LDAP+GSSAPI, then this field shows the name of the particular login method.

DESCRIPTION

VARCHAR(4000)

This field shows the description if it is added in a component.

LAST_MODIFIED

TIMESTAMP

The time stamp of the last modification.

ASSIGNABLE

Boolean

The value is true if the component is assigned to a printer. Otherwise, the value is false.

PRE_POPULATED

Boolean

Added to identify pre-populated Advanced Security Components.


CONFIGURATION_COMPONENTS

This table contains information about different components related to different configurations, if selected.

Field Name

Data Type

Description

CONFIGURATION_ID

BIGINT

The foreign key to CONFIGURATION.CONFIGURATION_ID.

CONFIGURATION_COMPONENT_ID

BIGINT

The foreign key to CONFIGURATION_COMPONENT. CONFIGURATION_COMPONENT_ID.

COMPONENT_TYPE

VARCHAR(255)

Added to discriminate among Device Setting Component and eight other components.


ASSIGNED_CONFIGURATIONS

This table shows which configurations are assigned to which CIs and printers.

Field Name

Data Type

Description

CI_ID

BIGINT

The composite primary key, and the foreign key back to CONFIGURATION_ITEM.CI_ID.

CONFIGURATION_ID

BIGINT

Composite primary key, and the foreign key back to CONFIGURATION.CONFIGURATION_ID.

COMPLIANCE_STATE

VARCHAR(255)

The current conformance state for the configuration.

LAST_COMPLIANCE_CHECK

TIMESTAMP

Time stamp of the last conformance check was run.


FAILED_COMPONENT

This table includes all components that have a setting out of conformance.

Field Name

Data Type

Description

FAILED_COMPONENT_ID

BIGINT

The primary key.

CI_ID

BIGINT

The foreign key back to ASSIGNED_CONFIGURATIONS.CI_ID.

CONFIGURATION_ID

BIGINT (not null)

The foreign key back to ASSIGNED_CONFIGURATIONS.CONFIGURATION_ID.

COMPONENT_TYPE

VARCHAR(255)

The type of the failed component.

COMPONENT_NAME

VARCHAR(255)

The name of the failed component.


FAILED_COMPONENT_SETTINGS

This table includes all settings that are out of conformance and their values.

Field Name

Data Type

Description

TYPE

SMALLINT/ TINYINT*, Default 0

Added to discriminate conformance failure reasons among Discrepancy, Inapplicable, Unsupported, Resource not in Library, and Unable to Merge Token Settings.

FAILED_COMPONENT_ID

BIGINT (not null)

The foreign key back to FAILED_COMPONENT.FAILED_COMPONENT_ID.

SETTING_NAME

VARCHAR(255)

The name of the failed setting.

PRINTER_VALUE

dropNotNullConstraint

Can be a null value.

COMPONENT_VALUE

dropNotNullConstraint

Can be a null value.


FLASHFILE

This table represents information about MVE Firmware library resources.

Field Name

Data Type

Description

ID

BIGINT

The primary key.

FILENAME

VARCHAR(256)

The file name and location within the MVE repository.

SHA1

VARCHAR(255)

The SHA1 hash of the flash file.

DISPLAY_NAME

VARCHAR(255)

A version identifier of the flash file.

DATE_IMPORTED

TIMESTAMP

The date when the flash file was imported.

DESCRIPTION

VARCHAR(255)

The description of the flash file.


FLASH_NET_IDS

This table stores the NETFLASH ID found at the top of each flash file in the Resource Library.

Field Name

Data Type

Description

FLASHNETID

BIGINT

The primary key.

NET_ID

VARCHAR(255)

The NETFLASH ID.


CERTIFICATES

This table represents information about the MVE CA certificate library resources.

Field Name

Data Type

Description

CERTIFICATE_ID

BIGINT

The primary key.

NAME

VARCHAR(255)

The user-friendly name of a CA certificate.

PEM_CERTIFICATE

BLOB

The PEM representation of a CA certificate.

DATE_IMPORTED

TIMESTAMP

The date when the CA certificate was imported to MVE.

PEM_CERTIFICATE_SHA2

VARCHAR (64)

SHA2 hash of this CA certificate.

DESCRIPTION

VARCHAR (255)

Description of the CA certificate.


CERTIFICATE_COMP_CERTIFICATES

This table shows the linking of certificate in the Resource Library to a configuration component, and thus to a configuration.

Field Name

Data Type

Description

CONFIGURATION_COMP ONENT_ID

BIGINT

The foreign key back to CONFIGURATION_COMPONENT.CONFIGURATION_ COMPONENT_ID.

CERTIFICATE_ID

BIGINT

The foreign key back to CERTIFICATES.CERTIFICATE_ID.


COMPONENT_SETTINGS

This table represents settings contained within a given configuration component. There is a row in this table for each setting associated with the configuration component, all pointing to the same CONFIGURATION_COMPONENT.CONFIGURATION_COMPONENT_ID. The values are encrypted and not available outside of MVE.

Field Name

Data Type

Description

SETTING_ID

BIGINT

The primary key.

SETTING_NAME

VARCHAR(255)

The name of the setting.

SETTING_VALUE

VARCHAR(1280)

The encrypted setting value.

CONFIGURATION_COMPONENT_ID

BIGINT

The foreign key to CONFIGURATION_COMPONENT.CONFIG URATION_COMPONENT_ID.

DISCRIMINATOR

VARCHAR(255)

The options are SIMPLE_SETTING and TABULAR_SETTING.

TABULAR_SETTING_VALUE_ID

BIGINT

The foreign key to COMPONENT_TAB_SETTING_VALUE.TA BULAR_SETTING_VALUE_ID.


COMPONENT_TAB_TABLE

This table represents Color Print Permission tables included in configurations.

Field name

Data type

Description

TABLE_ID

BIGINT

The primary key.

TABLE_TYPE

VARCHAR(255)

The options are HOST_TABLE and USER_TABLE.


COMPONENT_TAB_ROW

This table represents a row from the Color Print Permissions tables. Values are encrypted and cannot be used outside MVE.

Field Name

Data Type

Description

TABLE_ID

BIGINT

The foreign key to COMPONENT_TAB_TABLE.TABLE_ID

HOST_NAME

VARCHAR(255)

The value of the Host Name setting in the hosts table.

USER_NAME

VARCHAR(255)

The value of the User Name setting in the users table.

ALLOWED_TO_PRINT_COLOR

SMALLINT/ TINYINT*

The value of the Allow Color Printing setting for both host and user tables.

USER_PERMISSION_OV ERRIDDEN

SMALLINT/ TINYINT*

The value of the Overrides User Permission setting in the host table.


COMPONENT_TAB_SETTING_VALUE

This table shows the correlation of Color Print Permissions tables to components, and thus to configurations.

Field Name

Data Type

Description

TABULAR_SETTING_VALUE_ID

BIGINT

The foreign key to COMPONENT_SETTINGS.TABULAR_SETTING_VALUE_ID.

TABLE_ID

BIGINT

The foreign key to COMPONENT_TAB_TABLE.TABLE_ID.


CC_SUPPORTED_MODEL_BACKUP

Field Name

Data Type

Description

ID

BIGINT

The primary key.

SUPPORTED_MODEL

VARCHAR(255)

Used for creating a backup from CONFIGURATION and CONFIGURATION_COMPONENT for Device Setting Components.


ESF_COMP_PRODUCTS

Field Name

Data Type

Description

CONFIGURATION_COMPONENT_ID

BIGINT

The foreign key references.

Table: CONFIGURATION_COMPONENT

Column: CONFIGURATION_COMPONENT_ID

PART_NUMBER

VARCHAR(255)

The product part number of the solution component.


VCCFILE

Field Name

Data Type

Description

ID

BIGINT

The primary key.

FILENAME

VARCHAR(255)

The uploaded file name.

DISPLAY_NAME

VARCHAR(255)

The VCC file name displayed in MVE.

DATE_IMPORTED

TIMESTAMP

The time stamp of the upload of the file.

SHA1

VARCHAR(255)

The file content hash.

DESCRIPTION

VARCHAR(255)

The description of the VCC file.


UCFFILE

Field Name

Data Type

Description

ID

BIGINT

The primary key.

FILENAME

VARCHAR(255)

The uploaded file name.

DISPLAY_NAME

VARCHAR(255)

The UCF file name displayed in MVE.

DATE_IMPORTED

TIMESTAMP

The time stamp of the upload of the file.

SHA1

VARCHAR(255)

The file content hash.

DESCRIPTION

VARCHAR(255)

The description of the UCF file.


UCF_VCC_RESOURCE_FILES

This table contains information on the status of the printer TCP/UDP ports.

Field Name

DataType

Description

RESOURCE_ID

BIGINT

The primary key.

SHA1

VARCHAR(255)

The file content hash.

RESOURCE_TYPE

VARCHAR(255)

The type of resource file. The options are UCF_FILE, VCC_FILE, and APP_FLS.

CONFIGURATION_COMPONENT_ID

VARCHAR(255)

The foreign key of the ID of the CONFIGURATION_COMPONENT table.


Discovery profiles

The following tables are used to track the discovery profiles of MVE.

DISCOVERY_PROFILE

Field Name

Data Type

Description

ID

BIGINT

The primary key.

NAME

VARCHAR(255)

The user-supplied name for the profile.

RETRIES

INTEGER

The number of times to retry communicating with a printer.

SNMP_READ_COMMUNITY_NAME

VARCHAR(255)

The SNMP community name to use when reading.

TIMEOUT

BIGINT

The number of milliseconds to wait for a particular communication attempt with a printer to succeed.

SNMP_USERNAME

VARCHAR(32)

The user name for SNMP communication.

SNMP_PASSWORD

VARCHAR(32)

The password for SNMP communication.

SNMP_MIN_AUTHENTICATION_LEVEL

VARCHAR(255)

The minimum authentication level for SNMP.

SNMP_AUTHENTICATION_HASH

VARCHAR(50)

The hash used for SNMP authentication.

SNMP_PRIVACY_ALGORITHM

VARCHAR(50)

The algorithm used for SNMP privacy.


DISCOVERY_PROFILE_CI

This table contains the CI-specific pieces of the discovery profile.

Field Name

Data Type

Description

CI_DP_ID

BIGINT

The primary key, and the foreign key to DISCOVERY_PROFILE.ID.

AUTOMANAGE

SMALLINT/ TINYINT*

The flag indicating whether CIs discovered using this profile must be automatically managed.

DESCRIPTION

VARCHAR(4000)

The user-provided description of the discovery profile.

LAST_RUN

TIMESTAMP

Time stamp of the last run of the profile.

CREDENTIAL_USERNAME

VARCHAR(255)

The credential user name, if set.

CREDENTIAL_REALM

VARCHAR(64)

The credential realm, if set.

LOGIN_METHOD

VARCHAR(256)

The authentication method used to log in to the printer.

LOGIN_METHOD_NAME

VARCHAR(256)

The name of the authentication method if LOGIN_METHOD is either LDAP or LDAP+GSSAPI.

CREDENTIAL_PASSWORD

BLOB

This value is encrypted and not available for use outside MVE.

CREDENTIAL_PIN

BLOB

This value is encrypted and not available for use outside MVE.

ASSIGN_KEYWORD_IDS

VARCHAR(512)

The assigned keywords in a discovery profile.


EXCLUDE_PROFILE_ITEM

This table represents the Exclude list for a profile. Each excluded item has a row in this table.

Field Name

Data Type

Description

DISCOVERY_PROFILE_ID

BIGINT

The composite primary key, and the foreign key to DISCOVERY_PROFILE.ID.

VALUE_

VARCHAR(255)

The composite primary key. This field defines what items to exclude.


INCLUDE_PROFILE_ITEM

This table represents the Include list for a profile. Each included item has a row in this table.

Field Name

Data Type

Description

DISCOVERY_PROFILE_ID

BIGINT

The composite primary key, and the foreign key to DISCOVERY_PROFILE.ID.

VALUE_

VARCHAR(255)

The composite primary key. This field defines what items to include.


DISCOVERY_PROFILE_MODEL_CONFIG

This table represents the Assign Configurations portion of a discovery profile.

Field Name

Data Type

Description

ID

BIGINT

The primary key.

MODEL

VARCHAR(255)

The model name of the printers to which the configuration is assigned.

DISCOVERY_PROFILE_ID

BIGINT

The foreign key to DISCOVERY_PROFILE.ID.

CI_CONFIGURATION_ID

BIGINT

The foreign key to CONFIGURATION.CONFIGURATION_ID.


ESF

ESF_APPLICATION

This table contains all the eSF applications in all deployable eSF packages. There may be many eSF applications in each deployable package.

Field name

Data type

Description

ESF_APP_ID

BIGINT

The primary key.

ESF_DP_ID

BIGINT

The foreign key back to ESF_DEPLOYABLE_PACKAGE.ESF_DP_ID.

APP_ID

VARCHAR(255)

The application ID of the eSF applications.

VERSION

VARCHAR(255)

The eSF application version.

DESCRIPTION_URI

VARCHAR(255)

The URI description to the ESF application.

FLS_URI

VARCHAR(255)

The URI to the flash file.


ESF_APPLICATION_LOCALE

This table contains the name and description of each eSF application in all languages supported by MVE.

Field Name

Data Type

Description

ESF_APP_LOCALE_ID

BIGINT

The primary key.

ESF_APP_ID

BIGINT

The foreign key to ESF_APPLICATION.ESF_APP_ID.

LOCALE

VARCHAR(255)

The two-character language code.

NAME

VARCHAR(255)

The name of the eSF application in the language indicated by LOCALE.

DESCRIPTION

VARCHAR(510)

The description of the eSF application in the language indicated by LOCALE.


ESF_COMP_DEPLOYABLE_PACKAGE

This table contains one row for each deployable package in use by an MVE configuration.

Field Name

Data Type

Description

ESF_COMPONENT_ID

BIGINT

The foreign key to CONFIGURATION_COMPONENT.CONFIGURATION_COMPONENT_ID.

ESF_DP_ID

VARCHAR(255)

The foreign key to ESF_DEPLOYABLE_PACKAGE.ESF_DP_ID.


ESF_DEPLOYABLE_PACKAGE

This table represents all the deployable packages uploaded to the MVE library.

Field Name

Data Type

Description

ESF_DP_ID

BIGINT

The primary key.

NAME

VARCHAR(255)

The name of the deployable package.

PART_NUMBER

VARCHAR(255)

The part number of the deployable package.

PART_REVISION

VARCHAR(255)

The part revision of the deployable package.

LICENSE_REQUIRED

SMALLINT/ TINYINT*

The flag indicating whether a license is required for the deployable package.

URI

VARCHAR(255)

The URI of the deployable package.

DATE_IMPORTED

TIMESTAMP

The date when the deployable package was imported.

VERSION

VARCHAR(255)

The version of the deployable package.

DESCRIPTION

VARCHAR(255)

The description of the deployable package.


ESF_DEPLOYABLE_PACKAGE_LOCALE

This table contains the name and description for each deployable package in all languages supported by MVE.

Field Name

Data Type

Description

ESF_DP_LOCALE_ID

BIGINT

The primary key.

ESF_DP_ID

BIGINT

The foreign key to ESF_DEPLOYABLE_PACKAGE.ESF_ DP_ID.

LOCALE

VARCHAR(255)

The two-character language code.

NAME

VARCHAR(255)

The name of the deployable package in the language indicated by LOCALE.

DESCRIPTION

VARCHAR(2048)

The increased description length, from 510 to 2048 characters.


ESF_DP_SUPPORTED MODELS

This table contains one row for each model supported by a deployable package in the MVE library.

Field Name

Data Type

Description

ESF_DP_ID

BIGINT

The foreign key back to ESF_DEPLOYABLE_PACKA GE.ESF_DP_ID.

SUPPORTED_MODEL

VARCHAR(255)

The model name of printer supported by the deployable package.


ESF_LICENSE

This table represents the licenses for eSF applications available in the MVE library.

Field Name

Data Type

Description

ESF_LICENSE_ID

BIGINT

The primary key.

PRINTER_SERIAL

VARCHAR(255)

The serial number of the printer to which the license is tied.

PART_NUMBER

VARCHAR(255)

The part number of the package to which the license is tied.

PART_REVISION

VARCHAR(255)

The part revision of the package to which the license is tied.

LICENSE_TYPE

VARCHAR(255)

The options are TRIAL and PRODUCTION.

FILE_NAME

VARCHAR(255)

The file name of the license binary.

DEPLOYED

SMALLINT/ TINYINT*

The flag indicating whether the license has been deployed.


RAWESFAPPFILE

This table represents the raw eSF application file details available in the MVE library.

Field Name

Data Type

Description

ID

BIGINT

The primary key.

FILENAME

VARCHAR(255)

The name of the package file.

DISPLAY_NAME

VARCHAR(255)

The display name of the package file.

DATE_IMPORTED

TIMESTAMP

The time stamp of the import of the package.

SHA1

VARCHAR(255)

The SHA1 hash of the package.

DESCRIPTION

VARCHAR(255)

The description of the package.

APP_ID

VARCHAR(255)

The application ID of the package.

VERSION

VARCHAR(255)

The version of the package.


APP_FLS_RESOURCE_FILES

This table represents the association of eSF applications file available in the MVE library with configuration.

Field Name

Data Type

Description

RESOURCE_ID

BIGINT

The primary key.

SHA1

VARCHAR(255)

The SHA1 hash of the package.

RESOURCE_TYPE

VARCHAR(255)

The type of the Resource File. The options are UCF_FILE, VCC_FILE, and APP_FLS.

CONFIGURATION_COMPONENT_ID

BIGINT

The foreign key with the ID column of CONFIGURATION_COMPONENT.


Certificate management

The following represents the list of certifications to be verified.

ENROLLMENT_STATUS

The following table lists the issued certificates.

Field Name

Data Type

Description

ENROLLMENT_STATUS_ID

BIGINT

The primary key.

CERTIFICATE_ENROL_STATUS

VARCHAR(255)

The certificate enrollment status. The options are Issued, Pending, and Failed.

CERT_ENROL_TRANSACTION_ID

VARCHAR(2048)

The pending certificate response for EST. Sometimes, this field shows the transaction ID for certificate enrollment.

CERT_SUBJECT_IDENTITY

VARCHAR(255)

The subject identity of the certificate.

CERT_SERIAL_NUMBER

VARCHAR(255)

The serial number of the certificate issued.

PRINTER_ID

BIGINT

The reference printer.

DEFAULT_CERT_REVISION_NO

VARCHAR(255)

The revision number of the certificate that is renewed.

DEFAULT_CERT_RENEWAL_DATE

VARCHAR(255)

The renewal date of the certificate.

CERTIFICATE_FRIENDLY_NAME

VARCHAR(255)

The friendly name of the certificate.

CERTIFICATE_USED_FOR

VARCHAR(255)

The association of the named certificate. The options are DEFAULT, HTTPS, WIRELESS, IPSEC, and UNASSIGNED.


CA_CERT_REVOCATION_COMP_LIST

The following table lists information about the revoked certificates.

Field Name

Data Type

Description

ID

BIGINT

The unique identifier.

SERIAL_NUMBER

VARCHAR(255)

The serial number of the certificate present in the revocation list primary key.

CERTIFICATE_SUBJECT

VARCHAR(255)

The subject of the revoked certificate.

REVOCATION_DATE

TIMESTAMP

The date when the certificate is revoked.

ISSUER

VARCHAR(255)

The issuer of the revoked certificate.

REVOCATION_REASON

VARCHAR(255)

The revocation reason.


NAMED_CERTIFICATE_SETTINGS

The following table lists the name and association of named certificate.

Field Name

Data Type

Description

CERT_SETTING_ID

BIGINT

The unique identifier.

FRIENDLY_NAME

VARCHAR(255)

The friendly name of the named certificate.

CERT_USED_FOR

VARCHAR(255)

The association of the named certificate. The options are DEFAULT, HTTPS, WIRELESS, IPSEC, and UNASSIGNED.

CONFIGURATION_COMPONENT_ID

BIGINT

The foreign key associated with ID of the CONFIGURATION_COMPONENT table.

TEMPLATE_ID

BIGINT

The ID of the associated template.


PRINTER_CERTIFICATE

The following table represents the details of the named certificate.

Field Name

Data Type

Description

CERTIFICATE_ID

BIGINT

The unique identifier.

CERTIFICATE_FRIENDLY_NAME

VARCHAR(255)

The friendly name of the certificate.

CERTIFICATE_COMMON_NAME

VARCHAR(255)

The common name of the certificate.

CERTIFICATE_ISSUER_NAME

VARCHAR(255)

The name of the issuer of the certificate.

CERTIFICATE_SIGNING_STATUS

VARCHAR(255)

The signing status of the certificate. The options are SIGNED, INVALID_CERT, NO_CA, REVOKED, and UNKNOWN.

CERTIFICATE_VALID_FROM

TIMESTAMP

The time when the certificate started to be valid.

CERTIFICATE_VALID_TO

TIMESTAMP

The time when the certificate is no longer valid.

CERTIFICATE_SIGNATURE

VARCHAR(8190)

The signature of the certificate.

CERTIFICATE_SERIAL_NUMBER

VARCHAR(255)

The serial number of the certificate.

TYPE

VARCHAR(255)

The type of the certificate. The options are DEFAULT, HTTPS, WIRELESS, IPSEC, and UNASSIGNED.

PRINTER_ID

BIGINT

The foreign key associated with ID of CONFIGURATION_COMPONENT table.


ENROLLED_CERTIFICATE_TYPE

The following table shows the relationship between certificate and enrollment status.

Field Name

Data Type

Description

TYPE_ID

BIGINT

The unique identifier.

ENROLLMENT_STATUS_ID

BIGINT

The foreign key of the ID column of ENROLLMENT_STATUS table.

TYPE

VARCHAR(255)

The type of the certificate. The options are DEFAULT, HTTPS, WIRELESS, IPSEC, and UNASSIGNED.


CA_TEMPLATE

The following table shows the details of the templates selected when setting up the MSCA server using the MSCEWS protocol.

Field Name

Data Type

Description

TEMPLATE_ID

BIGINT

The unique identifier for templates for MSCA Server with MSCEWS (cannot be null).

TEMPLATE_NAME

VARCHAR(255)

The name of templates in the CEP server.

TEMPLATE_OID

VARCHAR(255)

The corresponding SNMP MIB path.


Authentication and authorization

The following tables are used for the user authentication and authorization mechanism of MVE.

MASTER_ROLE

This table contains all the roles supported by MVE.

Field name

Data type

Description

ID

BIGINT

The primary key.

ROLE_NAME

VARCHAR(255)

The name of the role.


USERS

This table lists all the internal user accounts of MVE.

Field name

Data type

Description

ID

BIGINT

The primary key.

USER_NAME

VARCHAR(15)

The user-supplied user name.

USER_PASS

VARCHAR(1024)

The user-supplied password.

ENABLED

SMALLINT/ TINYINT*

The flag indicating whether this account is enabled.

NAME

VARCHAR(255)

The user’s full name.

LAST_LOGIN

TIMESTAMP

The time stamp of the last login attempt.

LOGIN_ATTEMPT

BIGINT

The current number of attempts made at a successful login.

REFRESH_TOKEN

VARCHAR(1024)

The authentication token when the user logs in.


USER_ROLE

This table describes the association of users to roles.

Field name

Data type

Description

ID

BIGINT

The primary key.

USER_NAME

VARCHAR(15)

The foreign key back to USERS.USER_NAME.

ROLE_NAME

VARCHAR(30)

The foreign key back to MASTER_ROLE.ROLE_NAME.


Security settings

The following tables describe security settings in a configuration. The security configuration information is encrypted for data safety, unavailable outside of MVE, and not useful in the scope of this document. So the details of the following tables are omitted.

CAESAR2_MISC_SETTINGS

Field Name

Data Type

Description

MINIMUM_PASSWORD_LENGTH

SMALLINT/ TINYINT*

Added new miscellaneous setting under Advanced Security Component.

PROTECTED_FEATURES

VARCHAR(255)

PRINT_PERMISSION_PRINT

VARCHAR(255)

PRINT_PERMISSION_BROWSER

VARCHAR(255)

PRINT_PERMISSION_CONTROL_PAN EL

VARCHAR(255)


Views and data export

The following tables describe information on Views in MVE and fields included in each view.

DATA_EXPORT_TEMPLATE

This table contains information on Views in MVE.

Field Name

Data Type

Description

DATA_EXPORT_ID

BIGINT

The primary key.

NAME

VARCHAR(255)

The name of the view.

DEFAULT_TEMPLATE

SMALLINT/ TINYINT*

Whether the template is the default template to be shown when initially logged in, only one view can have this value set to True.

LANGUAGE_CODE

VARCHAR(255)

Deprecated.

INCLUDE_HEADER

SMALLINT/ TINYINT*

Deprecated.

WRAP_FIELDS

SMALLINT/ TINYINT*

Deprecated.

DESCRIPTION

VARCHAR(4000)

The description of the view.

IS_SYSTEM

SMALLINT/ TINYINT*

This field indicates whether the template is in system view, which cannot be edited or deleted.

IDENTIFIER_FIELD

VARCHAR(255)

The identifier field chosen for this view.


DATA_EXPORT_FIELDS

This table contains the fields included in each view.

Field Name

Data Type

Description

FIELD_INDEX

Integer

The primary key.

FIELD

VARCHAR(255)

The name of the field to be included in the view.

DATA_EXPORT_ID

BIGINT

The foreign key to DATA_EXPORT_TEMPLATE.DATA_EXP ORT_ID.


Event manager

The following tables deal with information related to creating and managing events.

ALERT

This table contains all the alerts that MVE supports.

Field name

Data type

Description

ID

BIGINT

The primary key

NAME

VARCHAR(255)

The textual name of the alert. For example, “Supply Alert.”

SEVERITY

VARCHAR(255)

For example, “ERROR.”

CATEGORY

VARCHAR(255)

For example, “SUPPLIES.”


ASSIGNED_EVENTS

This table links events with their assigned Configuration Items.

Field name

Data type

Description

CI_ID

BIGINT

The composite primary key. Refers to CONFIG_ITEM.CI_ID.

EVENT_ID

BIGINT

The composite primary key. Refers to EVENT.EVENT_ID.

EVENT_REGISTRATION_STATE

VARCHAR(255)

The options are REGISTERED and NOT_REGISTERED.


DESTINATION

This table represents an action within the Event Manager module.

Field name

Data type

Description

ID

BIGINT

The primary key.

DESTINATION_TYPE

VARCHAR(31)

The type of destination, currently either email or shell command. Depending on the type, not all columns apply.

NAME

VARCHAR(255)

The user-supplied name of the destination.

EMAIL_BODY

VARCHAR(255)

The email body text.

EMAIL_CC

VARCHAR(255)

The email CC list.

EMAIL_FROM

VARCHAR(255)

The email From text.

EMAIL_SUBJECT

VARCHAR(255)

The email Subject text.

EMAIL_TO

VARCHAR(255)

The email to text.

COMMAND_PATH

VARCHAR(255)

The full path to the command.

COMMAND_PARAMS

VARCHAR(255)

Any parameters to send to the command.

DESCRIPTION

VARCHAR(4000)

An optional user description of the action.

LAST_MODIFIED

Timestamp

The date of the last edit of the action.


EVENT

This table contains user-created events, which consist of a name, a description, and a collection of alerts to include.

Field name

Data type

Description

NAME

VARCHAR(255)

The user-supplied name of the event.

DESCRIPTION

VARCHAR(255)

The user-supplied description of the event.

EVENT_ID

BIGINT

The primary key.

TRIGGER_DESTINATIONS

VARCHAR(255)

The trigger destinations of the event. The options are on_active_only and on_active_and_clear.

GRACE_PERIOD_ENABLED

SMALLINT/ TINYINT*

The flag indicating whether a grace period is enabled.

GRACE_PERIOD_MINUTES

INTEGER

The number of minutes for the grace period.

LAST_MODIFIED

TIMESTAMP

The time of the last edit of the event.


EVENT_ALERTS

This table links an event to the collection of alerts it includes.

Field name

Data type

Description

EVENT_ID

BIGINT

The composite primary key. Refers to EVENT.EVENT_ID.

ALERT_ID

BIGINT

The composite primary key. Refers to ALERT.ALERT_ID.


EVENT_DESTINATIONS

This table links an event to an associated action.

Field name

Data type

Description

EVENT_ID

BIGINT

The composite primary key. Refers to EVENT.EVENT_ID.

DESTINATION_ID

BIGINT

The composite primary key. Refers to DESTINATION.DESTINATION_ID.


PRINTER_EVENT_ACTIVE_CONDITIONS

This table represents the active conditions or alerts for printers with events that trigger that condition or alert. Multiple conditions have their corresponding rows, all pointing to the same PRINTER_ID.

Field name

Data type

Description

ACTIVE_CONDITION_ID

BIGINT

The primary key.

LOCATION

VARCHAR(255)

For example, “Tray 1.”

MESSAGE

VARCHAR(255)

For example, “Tray Missing.”

TYPE

VARCHAR(255)

For example, “Intervention Required.”

CI_ID

BIGINT

Refers to CONFIG_ITEM.ID.

DESTINATION_TASK_ID

VARCHAR(80)

The foreign key back to SYSTEM_LOG.TASK_ID.


Miscellaneous

The following tables provide useful storage but do not fit into any of the previous table categories.

APPLICATION_SETTINGS

This table currently holds all the MVE system settings. The values are encrypted and not available outside of MVE.

Field name

Data type

Description

ID

BIGINT

The primary key.

SETTING_KEY

VARCHAR(255)

The preference name.

SETTING_VALUE

VARCHAR(8190)

The preference value.


BOOKMARK

This table contains all saved searches of MVE. They are currently stored as BLOB, so they cannot be edited outside of MVE.

Field name

Data type

Description

ID

BIGINT

The primary key.

DEFAULT_SEARCH

SMALLINT/ TINYINT*

The flag indicating whether this bookmark is one of the defaults that come with MVE.

NAME

VARCHAR(255)

The user-supplied name of the bookmark.

SEARCH_CRITERIA

BLOB SUB_TYPE 0

The binary representation of the bookmark.

DESERIALIZABLE

SMALLINT/ TINYINT*

Indicates whether the saved search is deserializable.

DESCRIPTION

VARCHAR(4000)

An optional user-entered description of the saved search.


Liquibase and Hibernate Tables

Liquibase and Hibernate are third-party libraries that MVE uses to help maintain the database. The following tables are used by these libraries. These tables do not contain any significant printer data so their contents are not detailed here.

SMTP_CONFIGURATION

This table contains configuration for the Simple Mail Transfer Protocol (SMTP), which allows MVE users to send emails.

Field name

Data type

Description

ID

BIGINT

The primary key.

FROM_ADDRESS

VARCHAR(255)

The email address of the sender.

LOGIN_ID

VARCHAR(255)

The user ID for the SMTP server.

LOGIN_PASSWORD

VARCHAR(255)

The password associated with the user ID for the SMTP server.

LOGIN_REQ

SMALLINT/ TINYINT*

The flag indicating whether the SMTP server requires a login.

SMTP_PORT

BIGINT

The port of the SMTP server.

SMTP_SERVER

VARCHAR(255)

The host name or IP address of the SMTP server.

SMTP_ENABLE

SMALLINT/ TINYINT*

The flag indicating whether SMTP is enabled.

EMAIL_ENCRYPTION

VARCHAR(64)

Refers to the supported encryption types., default is null.


SYSTEM_LOG

This table contains all of the system log messages that are produced as MVE carries out its tasks. This table can get very large.

Field name

Data type

Description

LOG_ID

BIGINT

The primary key.

TIMESTAMP_

TIMESTAMP

The time when the message was logged.

TASKID

BIGINT

The task instance that generated the message.

TASKNAME

VARCHAR(50)

The task that generated the message.

LEVEL_

INTEGER

The options are DEBUG, INFO, etc.

MESSAGE_

VARCHAR(8000)

The actual log message.

USER_NAME

VARCHAR(255)

The username of the user who performed the action.

IP_ADDRESS

VARCHAR(50)

The client IP address.


Quartz DB

QRTZ_FIRED_TRIGGERS

Field name

Data type

Description

SCHED_TIME

BIGINT

A new column added for Scheduled Time.