oclc online computer library center contentdm developers meeting ala midwinter meeting seattle, wa...

OCLC Online Computer Library Center

CONTENTdm Developers Meeting

ALA Midwinter MeetingSeattle, WAJanuary 19th, 2007

Claire Cocco, Product Manager

Joe Tavares, Consulting Software Engineer

Craig Yamashita, Director of Product Technology

OCLC Online Computer Library Center

Agenda

1. Multiple Compound Object Wizard

2. CONTENTdm API

3. Collection Customization

4. Discussion and Questions

OCLC Online Computer Library Center

Meeting Goals

Share Knowledge

Share Ideas

OCLC Online Computer Library Center

Using the Multiple Compound Object Wizard – Tips & Tricks

How to choose a wizard

Metadata entry

OCR

Joe TavaresConsulting Software Engineertavaresj@oclc.org

Joe TavaresConsulting Software Engineertavaresj@oclc.org

OCLC Online Computer Library Center

Importing into the MCOW

Four different wizards to import data

Single Compound Object

Directory Structure

Object List

Job List

OCLC Online Computer Library Center

Which Wizard Do I Use?

Compound Object

A small number of Compound Objects

A large number of Compound Objects

Unique item level metadata

Single CompoundObject

Directory Structure

No unique item Level metadata

Objects in single list

Object List

Other

Directory Structure

Object List

OCLC Online Computer Library Center

Formatting Data

The last field in the tab-delimited file should contain the filename

The directory structure supports just compound object level metadata and page level metadata. The filename of the tab-delimited file must be the same as the folder name

OCLC Online Computer Library Center

Adding Administrative Data using the Template Creator

Add administrative metadata using the Template Creator

Applied only to page not to compound object

Options include Default Text

Username

Checksum

Image Properties

Batch Number

OCLC Online Computer Library Center

Common Errors in Tab-Delimited Files

File does not exist

Most common error we see in support

Filenames not paths

Extra tabs or carriage returns

Incorrect date formats

Carriage returns in metadata and last field is not filename field

Unicode is not supported in tab-delimited files, yet! Use windows code pages for diacritics

OCLC Online Computer Library Center

Tips for Mapping Fields

If the fields in the tab-delimited file are in the same order as the collection fields the fields will be mapped correctly by default.

Add blank fields to tab-delimited file to make sure fields line up.

All tab-delimited files used in a single batch must have same fields.

OCLC Online Computer Library Center

OCR

OCR is most time consuming process

Methods to improve throughput

Fast Mode

De-skewed images

Quality source material

Use shared drive or manual upload method in order to maximize Acquisition Station time spent on OCR

OCLC Online Computer Library Center

Multiple Compound Object Wizard

Questions

Current Projects

OCLC Online Computer Library Center

CONTENTdm API

What is it?

How can it be used?

Craig Yamashita

Director of Product Technology

Craig Yamashita

Director of Product Technology

OCLC Online Computer Library Center

PHP API

PHP A widely used general purpose scripting

language suited for Web development

CONTENTdm supports PHP versions 4.3.x, 5.0.x, 5.1.x

Current version of PHP is 5.2.0 (Nov 2006) CONTENTdm libraries for PHP 5.2.x are now in

testing

Available soon

Download from the User Support Center

OCLC Online Computer Library Center

PHP API

Web Interface API CONTENTdm 4 implements a well-defined API

(Application Programming Interface) of callable PHP functions

Facilitates the building of custom interfaces

Default CONTENTdm Web interface is built on top of this API

OCLC Online Computer Library Center

PHP API

API Calls List of collections

Collection settings

Collection field properties

Query

Image properties

Item metadata

Favorites

OCLC Online Computer Library Center

PHP API

PHP API Examples dmGetCollectionList() – returns PHP array of

collections available on the Server

dmGetCollectionFieldInfo() – returns array of collection field properties

dmGetItemInfo() – returns XML containing the metadata for the specified item

dmQuery() – returns array of search results for the specified query

OCLC Online Computer Library Center

PHP API

PHP Scripting Example Print out names of all collections on the Server

<?php include("DMSystem.php"); $list = &dmGetCollectionList();

print("Collections:<br>\n"); for ($i = 0; $i < count($list); $i++) { print("{$list[$i]["name"]}<br>\n"); } ?>

OCLC Online Computer Library Center

PHP API

Sample Interface Session Call is made to dmGetCollectionList() to return

the names and properties of the collections on the Server.

Single collection is selected for search by fields. Call is made to dmGetCollectionFieldInfo() to retrieve the field names and properties. Search page is displayed.

Text query is performed by calling dmQuery() and results are shown.

OCLC Online Computer Library Center

PHP API

Sample Interface Session (continued) Item selected from results. Call is made to

dmGetItemInfo() to retrieve the metadata associated with the item.

Item viewer page is presented.

OCLC Online Computer Library Center

PHP API

Potential Applications Non-traditional search/navigation interface

Viewers for exotic file types

Audio

Video

Interface extensions

OCLC Online Computer Library Center

PHP API

API Changes for CONTENTdm Version 4.2 Support for new default parameters for new

compound object viewer “menu off” mode

Support for alternate language Dublin Core field names

OCLC Online Computer Library Center

CONTENTdm PHP API

Questions

Current Projects

OCLC Online Computer Library Center

Collection Customization

New options in Version 4.2

Scripted method

Duplication method

Claire Cocco

Product Manager

Claire Cocco

Product Manager

OCLC Online Computer Library Center

Collection Customization

Two methods for customizing interfaces for individual collections

Scripted method is now in default templates

Duplication method

OCLC Online Computer Library Center

Collection Customization

Scripted method Now included in default templates

Pass CISOROOT variable in URL

Looks for custom files with matching alias Copy file and rename:

STY_global_style.php to STY_alias_style.php

global_header.php to alias_header.php

Apply custom changes

Style, header, menu, index and footer files

OCLC Online Computer Library Center

Collection Customization

Duplication method Copy the cdm4 directory and rename

/cdm-alias

Remove the admin, cqr, and msoffice folders

Customize files in new folder

Style, localization, header, footer, menu files

Changes do not affect files in /cdm4 or other directories

OCLC Online Computer Library Center

Collection Customization

Configure search and browse for customized collections

STY_global_style.php

Edit variable to change functionality

All – searches all collections, collection list displayed

None – searches current collection, collection list suppressed

Alias list – searches specified collections, collection list suppressed

OCLC Online Computer Library Center

Collection Customization

Search and browse differences Duplication method

Browse - will remain in current custom collection interface when browse other collections

Search - will remain in current custom collection interface when search all collections or a different collection

Scripted method

Browse - will switch to custom interface for selected collection (if exists) when browse other collections

Search - will return to default interface if multiple collections are searched; will switch to custom interface for selected collection (if exists) when search a single collection

OCLC Online Computer Library Center

Collection Customization

Demo site http://custom.contentdmdemo.com

Finalizing demo and documentation

Available on USC when completed

OCLC Online Computer Library Center

Collection Customization

Which method should you use? Two options provide choice

Use what works best for you

Recommend selecting one of the other for implementation

Duplication method is more contained

Good choice for consortia projects – each organization can have own directory

Requires duplication of files – maintenance and upgrade considerations

OCLC Online Computer Library Center

Collection Customization

Questions

Current Projects

OCLC Online Computer Library Center

Discussion

If you were a CONTENTdm developer for a day…

What would you change?

What would you add?

OCLC Online Computer Library Center

Additional Questions

Specific questions

Craig

Joe

Claire

Make appointments

OCLC Online Computer Library Center

Developers Meeting

Thank you!

Please fill out a survey before you leave.