Leveraging Insight’s Interoperability with OAI, Features to Create Reports, Dynamic Websites, Presentations, or Custom Applications
The Insight Application suite not only contains a dynamic Java Client and BrowserInsight interface, but also provides tools for interoperability between Insight and other applications. These tools include:
HTML & PowerPoint export in the Java Client
Image & XML export in the Java Client
Remote Launch Strings for the Java Client and BrowserInsight
Reporting tools for data on the server
The Insight XML Gateway
Ensuring Interoperability Features are Enabled for the Java Client
For many organizations, there is a balance between enabling the interoperability features in the Java Client and ensuring control and management of content within Insight. For good or ill, enabling these features opens the content within Insight to external applications and uses. This may present copyright or other issues. Please check your institution's policy before enabling these features. Some of Insight's features even enable you to control the extent that users can access a specific feature (i.e. the specific size image a user can export).
Below is a list of features that users can leverage when using content from Insight on the web, in a presentation, or in more advanced situations. Depending on need and technical ability, different options are available:
Export thumbnail or larger images with full XML data from the Java Client.
Create Remote Launch Strings for a search in the Group Workspace from BrowserInsight or the Java Client.
Create Remote Launch Strings for a set of images in the Group Workspace from BrowserInsight or the Java Client.
Create Custom Remote Launch Strings by hand with more advanced features.
Print images and data from the Insight Java Client.
Export HTML web-pages with Remote Launch Strings from the Java Client.
Export Presentations created in the Java Client to HTML, Microsoft's PowerPoint, or Apple's Keynote.
NOTE: PowerPoint Export is only available on Windows; Keynote export is only available on Macintosh.
Create a custom application with the Insight XML Gateway. For more information, see "Getting Started with the Insight XML Gateway."
Many of Insight's interoperability features are controlled in the Collection Manager's profiles. These profiles are linked to User Groups, and then to specific users (in the User Manager).
NOTE:To check a profile or change a specific permission, see Adjusting Profile Settings for a User in a Collection on page for more information.
OAI Static Repository Generator
Insight has a utility to generate a static OAI repository for any or all of your collections.
What is a Static OAI Repository
A static OAI repository is a XML document formatted in accordance with OAI guidelines:
http://www.openarchives.org/OAI/2.0/guidelines-static-repository.htm http://www.openarchives.org/OAI/2.0/guidelines-static-repository.htm
Creating and Implementing a Static OAI repository
Prerequisites:
Java 1.4.2 + installed on the system you will run the utility from
A general understanding of OAI
Access to a static OAI gateway
Insight Studio access to the Collection Manager(s) you wish to generate static repositories from
NOTE: You can run this utility from any computer that you can run any of the Insight client applications from.
Setup and running the Insight static OAI generator
Install
Copy the "static_oai_generator" folder from the Utilities folder on you Insight install CD.
Adjust Insight Standards mappings
Several standards mapping adjustments need to be made in order to properly generate static OAI repositories.
By default, Insight is setup with a crosswalk to various published standards. This crosswalk has been established by The Getty Research Institute and can be referenced at the following URL.
http://www.getty.edu/research/conducting_research/standards/intrometadata/3_crosswalks/index.html
Insight allows you to map your template fields to CDWA (Categories for the Description of Works of Art) fields. In order to generate a proper static OAI repository, you must include data in the Dublin Core metadata standard.
To relate your template metadata fields to Dublin Core, you must map your fields to the center point of this relationship. CDWA represents the center point your template fields and Dublin Cores metadata fields.
Your Fields | CDWA | Dublin Core |
Accession Number | CURRENT LOCATION - REPOSITORY NUMBER (CORE) | Resource Identifier |
Author | CREATION-CREATOR - IDENTITY (CORE) | Creator |
Title | TITLES OR NAMES (CORE) | Title |
Notes | DESCRIPTIVE NOTE | Description |
Subjects | RELATED VISUAL DOCUMENTATION - VIEW-INDEXING TERMS | Subject |
Date | CREATION-DATE (CORE) | Date.Created |
This mapping can be done from within Insight Studio or from the Administrator Tools.
IMPORTANT:
One adjustment needs to be made to the Getty Crosswalk Standards mapping for proper static OAI generation.
According to the Getty Crosswalk, An important field "Resource Identifier" has a double mapping. As seen below. The Insight Static OAI Generator uses "Resource Identifier" to uniquely identify individual records within the repository.
Dublin Core | CDWA |
Resource Identifer or Source | RELATED VISUAL DOCUMENTATION IMAGE SOURCE NUMBER |
Resource Identifier | CURRENT LOCATION - REPOSITORY NUMBER (CORE) |
You must break the mapping between "Resource Identifier" and "RELATED VISUAL DOCUMENTATION IMAGE SOURCE NUMBER". This can only be done from the Administrator Tools
Open the Admin Tools and go to Server settings. Right click (control click on the Mac) and select "Manager field standard relations".
When the mappings panel comes up, Choose "DublinCore" (the one without the space) from the Select field standard 1 panel.
Next locate "Resource Identifier" and double click on it. You should see two CDWA fields showing on the right side of the panel.
In the right panel click on the blue "RELATED VISUAL DOCUMENTATION-IMAGE SOURCE -NUMBER" field.
Click Save. After making this change the Collection Manager must be restarted.
Below is a worksheet for determining your Dublin Core mappings for OAI harvesting.
Your Insight Catalog Template Fields | ||
| Contributor | CREATION-COMMISSION – COMMISSIONER |
| Creator | CREATION-CREATOR - IDENTITY (CORE) |
| Creator string | CREATION-CREATOR - IDENTITY-DATES |
| Date.Created | CREATION-DATE (CORE) |
| Description | INSCRIPTIONS/ MARKS |
| Description | CONSERVATION / TREATMENT HISTORY |
| Description | ORIENTATION / ARRANGEMENT |
| Description | EXHIBITION / LOAN HISTORY |
| Description | DESCRIPTIVE NOTE |
| Description | CONDITION / EXAMINATION HISTORY |
| Description.Abstract | SUBJECT MATTER-DESCRIPTION |
| Format.Extent | OBJECT/WORK-COMPONENTS |
| Format.Extent (Schema) | MEASUREMENTS- SCALE |
| Format.Extent (schema) | MEASUREMENTS – DIMENSIONS |
| Format.Medium | MATERIALS AND TECHNIQUES - MATERIALS (MATERIALS AND TECHNIQUES - MATERIALS -ROLE AND MATERIALS AND TECHNIQUES - MATERIALS-NAME) |
| Format.Medium | PHYSICAL DESCRIPTION |
| Relation | RELATED WORKS |
| Relation | RELATED WORKS-IDENTIFICATION |
| Relation Is Version Of Has Version Is Replaced By Replaces Is Required By Requires Is Part Of Has Part Is Referenced By References Is Format Of Has Format | RELATED WORKS-RELATIONSHIP TYPE |
| Relation.IsFormatOf | RELATED VISUAL DOCUMENTATION - RELATIONSHIP TYPE |
| Relation.IsReferencedBy | RELATED TEXTUAL REFERENCES |
| Relation.IsReferencedBy | CRITICAL RESPONSES |
| Relation.IsReferencedBy | CATALOGING HISTORY |
| Resource Identifer or Source | RELATED VISUAL DOCUMENTATION IMAGE SOURCE NUMBER |
* | Resource Identifier | CURRENT LOCATION - REPOSITORY NUMBER (CORE) |
| Rights | COPYRIGHT / RESTRICTIONS |
| Source | OWNERSHIP / COLLECTING HISTORY-OWNER |
| Source | OWNERSHIP / COLLECTING HISTORY-DESCRIPTION |
| Subject | RELATED VISUAL DOCUMENATION VIEW-SUBJECT |
| Subject | RELATED VISUAL DOCUMENTATION - VIEW-INDEXING TERMS |
| Subject (classification schema) | CLASSIFICATION (CORE) |
| Subject or Coverage.Spatial | CONTEXT- ARCHAEOLOGICAL |
| Subject or Coverage.Spatial | CREATION-PLACE / ORIGINAL LOCATION |
| Subject or Coverage.Spatial | CONTEXT- ARCHITECTURAL |
| Subject or Coverage.Spatial or Coverage.Temporal | SUBJECT MATTER- IDENTIFICATION - INDEX TERMS (CORE) |
| Subject or Coverage.Spatial or Coverage.Temporal | SUBJECT MATTER-DESCRIPTION INDEXING TERMS (CORE) |
| Subject or Coverage.Temporal | STYLES/PERIODS / GROUPS / MOVEMENTS |
| Title | TITLES OR NAMES (CORE) |
| Title.Alternative Description. TableOfContents Description.Abstract | RELATED VISUAL DOCUMENTATION- VIEW |
| Type | OBJECT/WORK-TYPE (CORE) |
indicates a required mapping to a unique identifier contained in your source data.
IMPORTANT:
When making your mappings, you must map one and only one field to:
"CURRENT LOCATION - REPOSITORY NUMBER"
which is mapped to (Resource Identifier in Dublin Core).
The Field you map CURRENT LOCATION - REPOSITORY NUMBER must be populated for every record and should be unique.If you do not perform this mapping, your repository will not be valid.
Configuring the staticoai.conf
Open up the "static_oai_generator" folder and locate the staticoai.conf file in the /conf folder. Open this file in a text editor. Enter in all appropriate information as the comments describe.
#-------------------------------------------------------
Required
#-------------------------------------------------------InsightUserAddress
InsightUserAddress=insightuser.lunaimaging.com
#
InsightUserAddress=DefaultInsightUsername
Default value: empty string ''
#Note: Insight Studio privileges are required.
DefaultInsightUsername=DefaultInsightPassword
Default value: empty string ''
#
DefaultInsightPassword=ServerURL
Static Repository base URL: The base URL that provides access via OAI-PMH to
the contents of the Static Repository through intermediation by a Static
Repository Gateway. This Static Repository base URL is a concatenation of:
#* The Static Repository Gateway URL: All base URLs of Static Repositories
accessible through a given Static Repository Gateway share a common part
of an HTTP address, which is the URL of the Static Repository Gateway
itself. This URL is of the form http://gateway:port/gatewaypath .
* A single forward slash [/] character. If the Static Repository Gateway
URL ends with a forward slash, then an additional one must not be added.
* The persistent Static Repository URL , which must be of the form
http://host:port/path/file, stripped of its prefix URI scheme part
(http://). Hence, the resulting sub-string is of the form host:port/path/file .
#For example, OAI-PMH requests to a Static Repository at http://an.oai.org/ma/mini.xml
using intermediation from a Static Repository Gateway at http://gateway.institution.org/oai
must be issued against the Static Repository base URL:
#
ServerURL=
AdminEmail
OAI administrator
AdminEmail=admininstrator@anywhere.edu
AdminEmail=
#-------------------------------------------------------Optional
#-------------------------------------------------------RequestTriplet
This is a combination of the CollectionID, InstitutionID and the
VCID (Virtual collection ID, usually "NA")
#example: RequestTriplet=1::DALTON::NA
example2: RequestTriplet=1::DALTON::NA,5::LUNA::NA
#If this is left blank, all collections with the proper access privileges
will be processed
RequestTriplet=
Do not modify
ParserClassName=org.apache.xerces.parsers.SAXParser
ResponseSystemID=http://www.lunaimaging.com/support/dtd/insightXMLGateway/v5.6/insightresponse.dtd
Running the Static OAI generator
Now that the conf file has been configured, it is time to generate your repository.
Edit the staticoai.cmd file to point to your staticoai.conf file. This reference must be in the form of a URL. In the example below it is pointing to a file:
-Dstaticoai.conf="file:/C:/Program Files/LunaImaging/6.3/static_oai_generator/Windows/conf/staticoai.conf"
Execute the staticoai.cmd file.
Depending on how large your database is this will take some time (8+ min per 2,000 records). If your collection contains over 2,000 published records you will see a number of documents being generated. The records are being extracted from the system in increments of 2,000. Once all records have been extracted, all documents will be merged into a single repository document.
By processing the information in this way, minimum load is placed on the database and Collection Manager.
Once the processing has completed, you will have only one file per collection processed. The file will be name in the following format CollectionID-InstitutionID-VCID. For example 1-DALTON-NA.xml.
Once the Static OAI repository has been generated, you will need to make it available using a OAI Static Repository Gateway (harvester). There are a number these gateways available freely on the web. We have provided an example of a gateway in the \utilities\examples\oai on the Insight installation disk.
Using the Reporting Tools
In some cases, administrators may require database-level-access to their data, to generate reports and perform database maintenance. Insight 6.3 ships with a series of Views & Stored Procedures which support basic reporting functionality – i.e. transforming the data within the Insight Repository into a useable format for simple or complex queries.
Reports available:
Thumbnail Labels & Image Report: Provides access to the thumbnail labels and first four image sizes for any image within Insight.
Catalog Templates: Provides a list of the catalog data templates used within the Collection Manager, Records, the Field Groups, Fields, and other settings.
Collection Field Data: The collection field data report provides access to all data within any/all collections in a Collection Manager on the field level. Users may query out data on a per-field/per-record basis.
Collection Data Structure: The collection data structure report attempts to represent the entire collection's data structure as a single table, maintaining as much of the relational structure as is possible. The report will add additional rows to appropriately represent authorities or independent records.
NOTE: The Reporting Tools take advantage of Stored Procedures & Views; this functionality is not currently supported in MySQL 4.1.
Installing the Reporting Tools on a Collection Manager's Database
Installation of the Reporting Tools can be accomplished by running a SQL script to add the appropriate stored procedures/views.
NOTE: To install the reporting tools, you must first have DBA/Administrative privileges, or specifically privileges to create Views & Stored Procedures.
Table 6: Locations for the Scripts to Install the Reporting Tools
Database | Location |