7.4.3.7. Element Set Names

The Profile defines the following three element set names for the Abstract Record Structure (ARS) for the Retrieval Record:

Element set names are literal strings.

For each element set name, servers are strongly encouraged to return all elements listed, if they are available, even though specific elements may be listed as optional in the ARS in Section 7.4.3.5.

Servers may exercise some judgment in the choice of elements to be returned. For example, retrieval records may include tagSet-M and tagSet-G elements not specifically mentioned in these element set names.

7.4.3.7.1. Element Set Name b

The element set name b (i.e., brief) retrieves a form of the database record comprised of tagSet-M and tagSet-G elements at the top of the Abstract Record Structure for the Retrieval Record. The elements comprising this view of the record corresponds to a generic level of resource discovery and retrieval utilizing the Dublin Core Metadata Elements. See Section 7.6. Conformance. Other tagSet-G and tagSet-M elements can be included by the CIMI-server in the retrieval record. All elements listed should appear in the retrieval record according to guidance in Section 7.4.3.9. Guidance for the Retrieval Record. The following elements comprise element set name b:

TagPath Element
(1,14) localControlNumber
(2,1) title
(2,2) creator
(2,32) contributor
(2,8) date
(2,17) description
(2,28) identifier
(2,22) type
(2,20) language
(2,21) subject
(2,31) publisher
(2,27) format
(2,33) source
(2,30) relation
(2,34) coverage
(2,29) rights

7.4.3.7.2. Element Set Name mb

The element set name mb is intended to retrieve a brief form of the database record according to common practice in museum systems (i.e., a museum brief record). The purpose of this brief form is to provide CIMI-clients with sufficient elements to construct a tombstone record. All elements listed should appear in the retrieval record according to guidance in Section 7.4.3.9. Guidance for the Retrieval Record.

In the case of several elements, there is additional guidance:

Servers will send details of all available images and image renditions in element set name mb.

TagPath Element
(1,14) localControlNumber
(1,1) schemaIdentifier
(4,1) typeOfDescriptiveRecord
(4,4) objectInfo
(4,4)(4,12) typeOfObject
(4,4)(4,13) categoryOfObject
(4,4)(4,14) digitalObject
(4,4)(4,14)(4,29) actualDO
(4,4)(4,14)(4,29)(1,1) schemaIdentifier
(4,4)(4,14)(4,29)(5,31) objectName
(4,4)(4,14)(4,29)(5,32) objectTitle
(4,4)(4,14)(4,29)(5,33) bibliographicTitle
(4,4)(4,14)(4,29)(5,36) creatorInfo
(4,4)(4,14)(4,29)(5,60) fieldCollector
(4,4)(4,14)(4,29)(5,61) dateCollected
(4,4)(4,14)(4,29)(5,62) agePeriod
(4,4)(4,14)(4,29)(5,63) typeSpecimen
(4,4)(4,14)(4,29)(5,38) owner
(4,4)(4,14)(4,29)(5,3) objectID
(4,4)(4,14)(4,29)(5,5) materialMedium
(4,4)(4,14)(4,29)(5,13) dimensions
(4,4)(4,14)(4,29)(5,11) placeOfOrigin
(4,4)(4,14)(4,29)(5,14) stylePeriod
(4,4)(4,14)(4,29)(5,28) mrObject

 

7.4.3.7.3. Element Set Name f

The element set name f (i.e., full) includes all available database record elements. All elements listed should appear in the retrieval record according to guidance in Section 7.4.3.9. Guidance for the Retrieval Record. Those database record elements that can be tagged using the available tags from tagSet–G, tagSet–M, Collections Tag Set, and CIMI Tag Set should be so tagged. Additional elements returned by the CIMI-server should be identified with string tags (using TagType 3 for locally defined elements) and/or be packaged into the element displayObject. The client does not process the data in displayObject or identified by string tags but simply displays the information to the user.

7.4.3.8. Unique Identifiers

All retrieval records returned by a CIMI-server must include the tagSet-M element localControlNumber (value = 14) element at the top level. This is a string, not intended for display and not necessarily numeric. It must uniquely identify the record within a database. With this element, subsequent location of the record is performed by a search consisting of a single search term (the value of the localControlNumber element), and a Use Attribute doc-id (value = 1032) and a Structure Attribute urx (value = 104). This is the search specified by the Z39.50 URL per RFC 2056, Uniform Resource Locators for Z39.50 [7]:

z39.50r://host : port / dbname ? localControlNumber

(Either the Bib-1 or CIMI-1 Attribute Set OID can be used with these attributes since CIMI-1 imports a selected set of Bib-1 attributes including doc-id.) CIMI-servers are required to support this search.

7.4.3.9. Guidance for the Retrieval Record

The following is implementation guidance for a CIMI-server's behavior when no field exists in a database for an element requested by a client.

The following are the two possible cases:

For the first case, the CIMI-server returns the GRS element and for ElementData returns elementEmpty. This explicitly tells the CIMI-client that there is no data in the field.

In the second case, CIMI-clients must be prepared for CIMI-servers to respond in two ways:

The CIMI-client will interpret these two responses in the same way, namely, that there is no database field in the record associated with the GRS element.

7.4.3.10. Record Syntaxes

The Profile requires the support of the following record syntax defined by Z39.50-1995:

GRS-1, Generic Record Syntax (OID = 1.2.840.10003.5.105)

For interchange, GRS-1 records are to be treated as the complete and canonical representation.

For purposes of interoperability, servers may support other record syntaxes including:

Recommendations on supporting the USMARC record syntax can be found in Section 7.6. Conformance.

When a server is unable to return an object in the requested record syntax, the server should return a diagnostic (e.g., Bib-1 Diagnostic #238 - Record not available in requested syntax; Bib-1 Diagnostic #239 - Record syntax not supported).

7.4.3.11. Use of GRS-1

Usage of record syntax GRS-1 is defined as follows. In the GRS-1 main structure, the following parameters must be supported:

The GRS-1 element appliedVariant may be used in retrieval record elements and should be used for the following elements:

The tables below define how appliedVariant is used with each of these elements.

Variant information for displayObject
CIMI-servers should use appliedVariant with displayObject. If no variant information is supplied, the content of the element is assumed to be text.

Name Value Description
variantSetId 1.2.840.10003.12.1 variant-1
class 2 BodyPartType
type 1 or 2 ianaType or Z39.50Type
value InternationalString or OctetString  

or

Name Value Description
variantSetId 1.2.840.10003.12.1 variant-1
class 9 miscellaneous
type 5 content is a pointer in the form of a URL
value Null  

 

Variant information for resource
CIMI-servers should provide variant information to indicate the type and size of the "image." Type is conveyed through a MIME-type value. Size is conveyed through the use of a string value or actual size in intUnit.

CIMI-servers must use the following appliedVariant when the content of the element resource is a pointer to the image:

Name Value Description
variantSetId 1.2.840.10003.12.1 variant-1
class 9 miscellaneous
type 5 content is a pointer in the form of a URL
value Null  

 

To provide information about the MIME-type of the image, CIMI-servers should use the following appliedVariant:

Name Value Description
variantSetId 1.2.840.10003.12.1 variant-1
class 2 BodyPartType
type 1 ianaType
value InternationalString  

 

To describe the size of an image using an enumerated set of string values, CIMI-servers should use the following appliedVariant. Allowable string values for the description of the size of the image are:

Name Value Description
variantSetId 1.2.840.10003.12.1 variant-1
class 7 meta-data returned
type 6 variant description
value InternationalString  

 

To give the byte size of the image, CIMI-servers should use the following appliedVariant. Unit is defined as (see Unit Definitions for Z39.50 [20])

Name Value Description
variantSetId 1.2.840.10003.12.1 variant-1
class 7 meta-data returned
type 2 size
value IntUnit consists of Integer and Unit

 

To give the cost of the image, CIMI-servers should use the following appliedVariant. Unit is defined as (see Unit Definitions for Z39.50 [20])

Name Value Description
variantSetId 1.2.840.10003.12.1 variant-1
class 7 meta-data returned
type 1 cost
value IntUnit consists of Integer and Unit

 

7.4.3.12. Encoding Documents in A GRS-1 Record

CIMI-servers are encouraged to return fielded data according to the CIMI Schema and Abstract Record Structure (ARS) for the Retrieval Record. In the case, however, when the server wishes to transfer to the client a single, complete representation of a record (e.g., a document marked up in Standard Generalized Markup Language) rather than using the entire GRS per the ARS, the following encoding can be used. Such a representation should be sent as a GRS-1 record with a single element having tag type 2 (tagSet-G) and tag value 19 (DocumentContent). The element's content should contain the text of the document in the octet or string branch of the ElementData CHOICE.

The type of the data must be specified by an appliedVariant using the standard variant-set variant-w, have class 2 (BodyPartType), type 1 (ianaType), and value appropriate to the data. For example, to type the data as SGML, use appliedVariant:

Name Value Description
variantSetId 1.2.840.10003.12.1 variant-1
class 2 BodyPartType
type 1 iana
value text/sgml  

The Profile does not address the transfer of document type definitions (DTD), stylesheets, etc., need by the client for processing the content of the GRS-1 record. The mechanism provided for in this section results in a record that is not compatible with the Digital Collections Profile structure.

7.4.3.13. Retrieval of Images

The CIMI Profile assumes that CIMI-servers will provide CIMI-clients with information about available images and available renditions of those images. The repeatable element rendition contains a subelement resource that will contain a HTTP URL or the actual bit stream of data for a specific rendition of an image.

CIMI-servers may be guided by the following regarding the sizes of images that they may provide to CIMI-clients:

Renditions are to be ordered in the GRS record with the smallest size/lowest resolution listed in the first occurrence of rendition. A CIMI-client, however, should look at the appliedVariant information for resource to determine if the rendition is an appropriate size for its use.

7.4.4. Close

The Profile requires clients and servers to recognize the Close protocol data unit (PDU), but the actual use of the Close Service is optional.

7.5. Diagnostic Messages

The Profile requires support for Diagnostic Set Bib-1 (OID = 1.2.840.10003.4.1).

7.6. Conformance

The Profile defines five Conformance Levels: Levels 0,1,2,3,4. These are associated with search and retrieval functionality supported by Z39.50 clients and servers. For each Conformance Level, clients and servers must support selected Use Attribute values and element set names. In addition to specifying a group of Use Attribute values and one or more element set names to support, each Conformance Level identifies the Z39.50 Objects (see Section 7.2) required. Conformance Levels are cascading in that Conformance Level N+1 inherits the functionality for Conformance Level N.

This approach to conformance addresses two key concerns. First, Conformance Levels 0 and 1 provide a foundation for interoperable cross-domain resource discovery. This level results in relatively "coarse grain" search and retrieval.

Second, the resources accessible by CIMI-clients and CIMI-servers are diverse in database richness, structure, the extent to which fields in the database are populated with data, and the extent of access points supported in specific databases. Specifying multiple Conformance Levels reflects the Profile's sensitivity to this heterogeneous situation.

Support for attributes in this context means that the server will recognize the Use attributes, and a search using the Use attributes listed for a Conformance Level will always result in a valid result set (which could contain 0 hits). This implies that all implementations conformant with this Profile must have search capabilities for the listed Use attributes for a specific conformance level.

7.6.1. Interoperability with Other Z39.50 Implementations: Bib-1 and USMARC

Implementation at Conformance Levels 0 and 1 puts the least burden on the installed base of Z39.50 implementations to interact with CIMI-clients and CIMI-servers that support this Profile. Level 0 can be considered the easiest Conformance Level to support and implement; it provides support for simple searching and returns a simple, brief record comprised of tagSet-G and tagSet-M elements.

To ensure basic search interoperability with installed Z39.50 implementations that use the Bib-1 Attribute Set, CIMI-clients and CIMI-servers should be prepared to use/receive the Bib-1 OID in a query and to support a small selection of Bib-1 Use Attributes. These Bib-1 Use Attributes are listed in the appropriate Conformance Levels below.

To improve broad interoperability with installed Z39.50 implementations that process USMARC records, the Profile recommends that CIMI-clients and CIMI-servers consider support for the USMARC record syntax. Appendix D provides a mapping between element set name b elements and USMARC fields. CIMI-clients and CIMI-servers should also be prepared for interactions with implementations that understand the Simple Unstructured Text Record Syntax (SUTRS). Support for USMARC and SUTRS record syntaxes is optional at all Conformance Levels.

7.6.2. Conformance Level 0

Conformance Level 0 offers a mode of interaction between CIMI-clients and CIMI-servers for basic and generic search and retrieval. Use attributes Who, What, When, and Where support simple searching for cultural heritage information on CIMI-servers. This Conformance Level allows Z39.50 bibliographic clients to conduct basic Author, Title, and Subject searching of CIMI-servers through use of selected Bib-1 attributes. CIMI-clients can also search Z39.50 bibliographic servers for similar search and retrieval.

The selection of Bib-1 Use attributes in CIMI-1 is based on emerging consensus within the Conference of European National Libraries (CENL) as documented in the Z39.50 Bib-1 Attribute Set Profile for CENL [3], which in turn is closely related to the U.S. ATS-1 Profile [9]. Both profiles address semantic interoperability between bibliographic Z39.50 clients and servers. Adopting these Bib-1 Use Attributes in increases the likelihood of semantic interoperability between those Z39.50 clients and servers, and CIMI-clients and CIMI-servers.

Conformance Level 0 requires support of a minimum set of attributes, one element set name, and several Z39.50 objects.

Use Attributes:

Bib-1 Use Attribute Value Name
4 title
7 ISBN
8 ISSN
21 subject heading
31 date of publication
1003 author
1004 personal author
1016 any

 

CIMI-1 Use Attribute Value Name
4 title
7 ISBN
8 ISSN
21 subject heading
31 date of publication
1003 author
1004 personal author
1016 any
2046 who
2047 what
2048 when
2049 where

Element Set Name:

Level 0 requires that CIMI-servers and CIMI-clients support element set name b (see Section 7.4.3.7.1.).

Z39.50 Objects:

Object OID Client Server
Bib-1 attribute set 1.2.840.10003.3.1 X* X
CIMI-1 attribute set 1.2.840.10003.3.8 X X
Bib-1 diagnostic set 1.2.840.10003.4.1 X X
GRS-1 record syntax 1.2.840.10003.5.105 X X
SUTRS record syntax 1.2.840.10003.5.101 optional optional
USMARC record syntax 1.2.840.10003.5.10 optional optional
TagSet-M 1.2.840.10003.14.1 X X
TagSet-G 1.2.840.10003.14.2 X X

* For interoperability with Z39.50 bibliographic servers, CIMI-clients are encouraged to support the Bib-1 Attribute Set.

7.6.3. Conformance Level 1

Conformance Level 1 provides "coarse grain" or generic-level search and retrieval for purposes of resource discovery. Network-accessible resources are viewed through the lens of the Dublin Core Metadata Elements. Conformance Level 1 allows CIMI-clients and CIMI-servers to use Dublin Core Metadata as concepts upon which to search (i.e., access points) and as elements in which to package database information into a retrieval record.

Conformance Level 1 requires support of all Use attributes listed in Conformance Level 0 and the following specific to Conformance Level 1 searching:

Use Attributes:

Bib-1 Use Attribute Value Name
54 codeLanguage
62 abstract
1018 publisher
1031 materialType
1032 doc-id

 

CIMI-1 Use Attribute Value Name
1032 doc-id
2051 DC-title
2052 DC-creator
2053 DC-subject
2054 DC-description
2055 DC-publisher
2056 DC-contributor
2057 DC-date
2058 DC-type
2059 DC-format
2060 DC-identifier
2061 DC-source
2062 DC-language
2063 DC-relation
2064 DC-coverage
2065 DC-rights

Element Set Name:

Level 1 requires that CIMI-servers and CIMI-clients support element set name b (see Section 7.4.3.7.1.).

Z39.50 Objects:

Object OID Client Server
Bib-1 attribute set 1.2.840.10003.3.1 X* X
CIMI-1 attribute set 1.2.840.10003.3.8 X X
Bib-1 diagnostic set 1.2.840.10003.4.1 X X
GRS-1 record syntax 1.2.840.10003.5.105 X X
SUTRS record syntax 1.2.840.10003.5.101 optional optional
USMARC record syntax 1.2.840.10003.5.10 optional optional
TagSet-M 1.2.840.10003.14.1 X X
TagSet-G 1.2.840.10003.14.2 X X

* For interoperability with Z39.50 bibliographic servers, CIMI-clients are encouraged to support the Bib-1 Attribute Set.

7.6.4. Conformance Level 2

Conformance Level 2 is unspecified in this release of the Profile. When specified, Conformance Level 2 will address more extensive use of the Digital Collections Profile. Conformance Level 2 corresponds to the Digital Collections level of semantic interoperability discussed in Section 7.4.3.1.

7.6.5. Conformance Level 3

Conformance Level 3 provides for more sophisticated, cultural heritage information-related search and retrieval. CIMI-clients and CIMI-servers conformant at this level must be both Digital Collection-Schema and CIMI-Schema aware. Conformance Level 3 retrieval allows CIMI-clients to receive sufficient database elements to build typical brief record views of museum data (e.g., tombstone). Conformance Level 3 corresponds to the CIMI level of semantic interoperability discussed in Section 7.4.3.1.

Conformance Level 3 requires support of all Use attributes listed in Conformance Levels 0 and 1, and the following specific to Conformance Level 3 searching:

Use Attributes:

Value Name
2035 creatorName
2036 creatorDateOfBirth
2037 creatorDateOfDeath
2009 creatorNationalityCultureRace
2070 fieldCollector
2071 dateCollected
2072 agePeriod
2073 typeSpecimen
2008 materialMedium
2024 objectID
2032 objectName
2033 objectTitle
2026 owner
2023 placeOfOrigin
2017 stylePeriod

Element Set Name:

Level 3 requires that CIMI-servers and CIMI-clients support element set name mb (see Section 7.4.3.7.2.).

Z39.50 Objects:

Object OID Client Server
Bib-1 attribute set 1.2.840.10003.3.1 X* X
CIMI-1 attribute set 1.2.840.10003.3.8 X X
Bib-1 diagnostic set 1.2.840.10003.4.1 X X
GRS-1 record syntax 1.2.840.10003.5.105 X X
SUTRS record syntax 1.2.840.10003.5.101 optional optional
USMARC record syntax 1.2.840.10003.5.10 optional optional
Digital Collections Schema 1.2.840.10003.13 3 X X
CIMI Schema 1.2.840.10003.13.5 X X
TagSet-M 1.2.840.10003.14.1 X X
TagSet-G 1.2.840.10003.14.2 X X
Collections Tag Set 1.2.840.10003.14.5 X X
CIMI Tag Set 1.2.840.10003.14.6 X X

* For interoperability with Z39.50 bibliographic servers, CIMI-clients are encouraged to support the Bib-1 Attribute Set.

7.6.6. Conformance Level 4

Conformance Level 4 requires CIMI-clients and CIMI-servers to support the CIMI-1 Attribute Set and the entire Abstract Record Structure. Conformance at Level 4 provides the richest search and retrieval of cultural heritage information resources. Conformance Level 4 corresponds to full CIMI-level semantic interoperability discussed in Section 7.4.3.1.


To Table of Contents

Next Section of Profile