Loading

QueryResource

QueryResource

This message specifies which resources are queried.

Syntax

XPath: /JMF/Command[@Type=”QueryResource”]/ResourceQuParams

Description

The current implementation supports Media and UsageCounters resources. If no ResourceQuParams are specified or if ./ResourceQuParams/@Classes contains ‘Consumable’, the media catalogue and the supported UsageCounters are returned in the response to QueryResource.

The supported UsageCounters depend on the Accounting License and on the number of ink/toner colours.

If ./ResourceQuParams/@ResourceName = ‘Media’, then only the media catalogue is returned. If ./ResourceQuParams/ @ResourceName = ‘UsageCounter’, then only the supported usage counters are returned.

If @Scope=’Present’, then the returned media catalogue only contains media that are assigned to a tray. If @Scope=’Allowed’ or not defined, then all media in the catalogue are returned.

Example 1

<JMF>

<Query Type="Resource" xsi:type="QueryResource">

<ResourceQuParams Classes="Consumable Handling"/>

</JMF>

Example 2

<JMF>

<Query Type="Resource" xsi:type="QueryResource">

<ResourceQuParams ResourceName="Media"/>

</Query>

</JMF>

Default response to "QueryResource"

For each media in the media catalogue, a unique Media node is added to the "ResourceInfo" node. The attributes in this section are set if the QueryResource message is send by a default JDF Manager.

Syntax

XPath: /Response/ResourceInfo/

Supported value

@Scope

Syntax

XPath: /Response/ResourceInfo/Media/

Supported range

@Class

@DescriptiveName

@Dimension

@ImagableSide

@MediaColorName

@MediaColorNameDetails

@MediaType

@MediaTypeDetails

@oce:CustomMediaType

@HoleType

@HoleCount

@MediaSetCount

@Status

@Scope

@Thickness

@Weight

@ID

Syntax

XPath: /Response/ResourceInfo/GeneralID

Supported value

IDUsage="DeviceProductID"/@IDValue

Syntax

XPath: /Response/ResourceInfo/UsageCounter/

Supported range

@Class

@CounterTypes

@Scope

@Status

@ID

Example

<JMF>

<Response Type="Resource" ReturnCode="0">

<ResourceInfo>

<Media Class="Consumable" DescriptiveName="Example" Dimension="612 792" Status="Available" Scope="Allowed" Weight="123" MediaColorNameDetails="RGB(253,237,184)" HoleType="R3-generic" MediaSetCount="4" MediaType="Paper" MediaTypeDetails="PreCutTabs" oce:CustomMediaType="Custom Type" ImagableSide="Neither" ID="Media_151117093659.127_0">

<GeneralID IDUsage="DeviceProductID" IDValue=".."/>

</Media>

</ResourceInfo>

<ResourceInfo>

<UsageCounter Class="Consumable" ID="Counter_NormalBlack_170705080509.695_1" Status="Available" Scope="Job" CounterTypes="Impressions Black Blank Insert OneSided TwoSided NormalSize">

</UsageCounter>

</ResourceInfo>

</Response>

</JMF>

Media scope

Syntax

XPath: /Response/ResourceInfo/@Scope

Type

Enumeration

Supported values

Present

Allowed

Remark

Scope = ‘Present’ if media is assigned to a tray, otherwise it is ‘Allowed’.

Media class

Syntax

XPath: /Response/ResourceInfo/Media/@Class

Type

Enumeration

Supported value

Consumable

Remark

Supported by all products.

Media descriptive name

Syntax

XPath: /Response/ResourceInfo/Media/@DescriptiveName

Type

String

Supported range

[0 .. 255] characters

Description

The name is equal to the name of the media in the catalogue.

Remark

The name can be empty.

Media dimension

Syntax

XPath: /Response/ResourceInfo/Media/@Dimension

Type

XYPair

Supported range

Points (1 point=1/72 inch)

Description

@Dimension syntax is “X Y” where X and Y are the respectively the width (horizontal edge) and height (vertical edge) of the media.

Media status

Syntax

XPath: /Response/ResourceInfo/Media/@Status

Type

Enumeration

Supported value

Available

Media thickness

Syntax

XPath: /Response/ResourceInfo/Media/@Thickness

Type

Integer

Supported range

μm

Remark

Thickness is only set if the internal thickness accuracy is larger than 50.

Media weight

Syntax

XPath: /Response/ResourceInfo/Media/@Weight

Type

Integer

Supported range

g/m2

Media type

Syntax

XPath: /Response/ResourceInfo/Media/@MediaType

Type

Enumeration

Supported range

Paper

Transparency

Film

Other

Syntax

XPath: /Response/ResourceInfo/Media/@MediaTypeDetails

Type

NMTOKEN

Supported range

Stationary

PreCutTabs

Plain

Envelope

Aluminium

CardBoard

CD

ContinuousLong

ContinuousShort

CtPVisiblePhotoPolymer

CtPVisibleSilver

CtPThermal

DoubleWall

DVD

DryFilm

Envelope

EnvelopePlain

EnvelopeWindow

FlexoBase

FlexoPhotoPolymer

Flute

FullCutTabs

ImageSetterPaper

Labels

Letterhead

MultiLayer

MultiPartForm

Photographic

PlateUV

Polyester

SingleFace

SingleWall

TabStock

Tractor

TripleWall

WetFilm

Syntax

XPath: /Response/ResourceInfo/Media/@oce:CustomMediaType

Type

String

Supported range

Free string

Description

The Media Type is specified using @MediaType, @MediaTypeDetails or @oce:CustomMediaType in this order of priority.

If media setting Custom type is in the supported range of @MediaType, the attribute @MediaType = Custom type.

If media setting Custom type contains spaces, the attribute @oce:CustomMediaType = Custom type.

Otherwise, the attribute @MediaTypeDetails = Custom type and @MediaType= ‘Paper’.

Except if media setting Tab is set, then the attribute @oce:CustomMediaType = @MediaTypeDetails or @MediaType and the attribute @MediaType = ‘Paper’ + the attribute @MediaTypeDetails = ‘PreCutTabs’.

Example - the “Transparency” media type

<Media ID="media_1" Class="Consumable" Status="Available" MediaType="Transparency" Dimension="648.0 792.0"/>

Example - the “Plain” media type

<Media ID="media_2" Class="Consumable" Status="Available" MediaType="Paper" MediaTypeDetails="Plain" Dimension="648.0 792.0"/>

Example - the “Yellowish Tabbed Plain paper with 4 holes” media type

<Media ID="media_3" Class="Consumable" Status="Available" HoleType="R4-generic" MediaColorNameDetails="Yellowish" MediaSetCount="4" MediaType="Paper" MediaTypeDetails="PreCutTabs" oce:CustomMediaType="Plain paper" Dimension="648.0 792.0"/>

Media color

Syntax

XPath: /Response/ResourceInfo/Media/@MediaColorName

Type

NamedColor

Supported range

Black

Blue

Brown

Buff

Cyan

Gold

Goldenrod

Gray

Green

Ivory

Magenta

MultiColor

Mustard

NoColor

Orange

Pink

Red

Silver

Turquoise

Violet

White

Yellow

Syntax

XPath: /Response/ResourceInfo/Media/@MediaColorNameDetails

Type

String

Description

Preferably, the attribute @MediaColorName is used. When none of the predefined colours of @MediaColorName are applicable, then @MediaColorNameDetails is used (and @MediaColorName is not specified).

Media holes

Syntax

XPath: /JDF/ResourcePool/Media/@HoleType

Type

Enumeration

Supported range

@HoleType

Description

None

Not prepunched

R2-generic

Prepunched with 2 holes

R3-generic

Prepunched with 3 holes

R4-generic

Prepunched with 4 holes

R5-generic

Prepunched with 5 holes

Explicit

Prepunched

Syntax

XPath: /JDF/ResourcePool/Media/@HoleCount

Type

Integer

Description

The punch pattern for pre-punched media is determined by @HoleType. When @HoleType is “Explicit” the number of pre punched holes is determined by @HoleCount.

The deprecated attribute @HoleCount, is used only when a free integer is required which is not covered by @HoleType.

Media set count

Syntax

XPath: /JDF/ResourcePool/Media/@MediaSetCount

Type

Integer

Description

This attribute determines the number of different sheets in a set of cyclic media (such as tab sheet, pre-printed colour sheets…)

Media imagableSide

Syntax

XPath: /JDF/ResourcePool/Media[@ImagableSide=”Neither”]

Description

@ImagableSide = ”Neither” in case of insert media, otherwise it is not specified.

Resource ID

Syntax

XPath: /Response/ResourceInfo/Media/@ID

Type

String

Supported range

[0 .. 255] characters

Description

Unique ID; generated every time a response is created.

Media ID

Syntax

XPath: GeneralID[IDUsage="DeviceProductID"]/@IDValue

Type

String

Supported range

[0 .. 63] characters

Description

An ID of the media as defined in the Device namespace. The ID remains the same after a restart or adding/removing media from the catalogue. The ID changes if media attributes are edited.

Usage Counter Class

Syntax

XPath: /Response/ResourceInfo/UsageCounter/@Class

Type

Enumeration

Supported value

Consumable

Remark

Supported by all products.

Usage Counter Status

Syntax

XPath: /Response/ResourceInfo/UsageCounter/@Status

Type

Enumeration

Supported value

Available

Usage Counter Scope

Syntax

XPath: /Response/ResourceInfo/UsageCounter/@Scope

Type

Enumeration

Supported value

Job

Usage Counter ID

Syntax

XPath: /Response/ResourceInfo/UsageCounter/@ID

Type

String

Supported range

[0 .. 63] characters

Description

An ID of the usage counter as defined in the Device namespace. See the table below for the available counter IDs.

CounterTypes

Counter ID

Units

Colorant

Sides

Size

Account log

NormalBlack

Impressions

Black

Blank

Insert

OneSided

TwoSided

NormalSize

nofprinteda4bw

NormalColor

Impressions

Color

OneSided

TwoSided

NormalSize

nofprinteda4c +

nofprinteda4micr

LargeBlack

Impressions

Black

Blank

Insert

OneSided

TwoSided

LargeSize

nofprinteda3bw +

nofprintedxlbw

LargeColor

Impressions

Color

OneSided

TwoSided

LargeSize

nofprinteda3c +

nofprintedxlc +

nofprinteda3micr +

nofprintedxlmicr

OneSided

Impressions

Black

Blank

Color

OneSided

sum of nofsimplex<mediaid>

TwoSided

Impressions

Black

Blank

Color

TwoSided

sum of nofduplex<mediaid>

Remark

The ID changes every time, but it includes the following fixed part: ‘Counter_<counter ID>_<timestamp>’

Usage Counter Types

Syntax

XPath: /Response/ResourceInfo/UsageCounter/@CounterTypes

Type

NMTOKENS

Supported range

See the table below for the available counter types.

CounterTypes

Counter ID

Units

Colorant

Sides

Size

Account log

NormalBlack

Impressions

Black

Blank

Insert

OneSided

TwoSided

NormalSize

nofprinteda4bw

NormalColor

Impressions

Color

OneSided

TwoSided

NormalSize

nofprinteda4c +

nofprinteda4micr

LargeBlack

Impressions

Black

Blank

Insert

OneSided

TwoSided

LargeSize

nofprinteda3bw +

nofprintedxlbw

LargeColor

Impressions

Color

OneSided

TwoSided

LargeSize

nofprinteda3c +

nofprintedxlc +

nofprinteda3micr +

nofprintedxlmicr

OneSided

Impressions

Black

Blank

Color

OneSided

sum of nofsimplex<mediaid>

TwoSided

Impressions

Black

Blank

Color

TwoSided

sum of nofduplex<mediaid>