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:
# - http://gateway.institution.org/oai/an.oai.org/ma/mini.xml
- ServerURL=http://gateway.institution.org/oai/an.oai.org/ma/
-
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 |
MSSQL |
/utilities/reports/50_Reports_Collection_MSSQL.sql |
Oracle |
/utilities/reports/50_Reports_Collection_Oracle.sql |
MySQL |
NOTE: MySQL 4.1 does not support views or stored procedures, hence it cannot run aNOTE: MySQL 4.1 does not support Views or Stored Procedures and therefore cannot support the Reporting Tools at this time. |
To Install the Reporting Tools
-
- Locate the Insight 6.3 or later Installation/Upgrade CD.
-
- On the CD, open the utilities/reports Directory (see "Table 6: Locations for the Scripts to Install the Reporting Tools" above).
-
- Open a database script editor and connect to the Collection Manager or Personal Insight Manager database to which you wish to add the reporting tools.
Microsoft SQL
- SQL Query Analyzer or isql
Oracle - SQLPlus or SQLPlus Worksheet
NOTE:To run the installation script you must have the Oracle "Resource" permission. This permission will only be required during the installation process and can be removed after the script has been run. This script creates both "Stored Procedures" and "Views" within the database.
- Open the appropriate script for your database version.
-
- Run the script.
- Please report any errors to Luna Technical Support.
NOTE:If you are running more than one Collection Manager/Personal Insight Manager, you will have to add the reporting tools to each instance.
Configuring the Reporting Tools for a Collection
Some of the reporting tools, including the Collection Data Structure Report, require further configuration in order to be setup for a collection. As some of the reports represent the collection's data structure, if the structure changes, the report must be updated. To assist in the generation and re-generation of these reports, Luna has provided stored procedures to re-create the report's views.
IMPORTANT:You will need to re-generate the views any time you modify a collection's data structure or create a new collection. Due to the nature of the database's views however, they will automatically update as data within the collection is added, modified, or deleted.
Generating and Re-generating the Collection Data Structure Views
There are two steps to using the Reporting Tools for a specific collection, first, you must create the views for the collection; second, use a tool like Microsoft Excel or Crystal Reports, to extract the data.
To generate or re-generate the views
- Open a database script editor and connect to the Collection Manager or Personal Insight Manager database to which you wish to add the reporting tools.
Microsoft SQL
- SQL Query Analyzer or isql
Oracle - SQLPlus or SQLPlus Worksheet
NOTE:To run the script you must have the Oracle "Resource" permission. This permission will only be required during the process and can be removed after the script has been run.
- Run the following command:
EXEC GENERATE_REPORT_VIEWS
NOTE:This command will work with both Microsoft SQL Server and Oracle.
- The database views should now be created/re-created.
Accessing the Views created by the Reporting Tools
The views created by the reporting tools can be accessed via ODBC, JDBC, or other standard data access methods. Within queries, the views can be accessed as if they were tables.
Accessing the views from Microsoft SQL Server Enterprise Console
To open the views in MSSQL Server's Enterprise Console, simply browse to the collection's database in the Enterprise console and select the "Views" tab from the tree.
Accessing the views from Oracle's Enterprise Manager
To open the views in Oracle's Enterprise Manager, simply browse to the collection's schema and open the "Views" tab.
Figure 31: Microsoft SQL Server Reporting Views
Accessing the Thumbnail Label & Image Report
The Thumbnail Label & Image Reports view presents all of thumbnail information for each of the collections as well as image URLs and display information.
To access the view simply run the following query
SELECT * FROM RPT_DATA_THUMBNAIL_LABELS ORDER BY
UniquecollectionID,
ObjectID
Limiting the query to a given collection
SELECT * FROM RPT_DATA_THUMBNAIL_LABELS WHERE
CollectionName= '<collection_name>'
Simply replace <collection_name> with the name of your collection.
Accessing the Collection Template Report
The Collection Template Report lists field and data structure information for all of the collections in the database. This includes display preferences, data groupings, data standard, and other useful information.
To access the view simply run the following query
SELECT * FROM RPT_TEMPLATE
ORDER BY
StandardID,
EntityTypeDisplayOrder,
FieldDisplayOrder,
FieldID
Accessing the Field Data Report
The fielded data report allows users to query out specific fields from a collection and limit them.
To access the view simply run the following query
SELECT * FROM RPT_DATA_SOURCE ORDER BY
UniqueCollectionID,
EntityID,
EntityTypeDisplayOrder,
RelEntityTypeID,
Grouping,
FieldDisplayOrder,
FieldID,
ValueDisplayOrder
Where:
<ORDER BY …>: orders and groups the results to maintain the inherent relationships in the data.
Some examples, limiting results to a given field, or record
Limiting the results from the report to a given field
SELECT * FROM RPT_DATA_SOURCE WHERE EntityId IN
(
SELECT EntityId FROM RPT_DATA_SOURCE WHERE
FieldDisplayName='<field_name>'
) AND CollectionName='<collection_name>' AND ParentEntityTypeID=0
ORDER BY
UniqueCollectionID,
EntityID,
EntityTypeDisplayOrder,
RelEntityTypeID,
Grouping,
FieldDisplayOrder,
FieldID,
ValueDisplayOrder
Where:
<field_name>: is the name of the field you wish to limit the results to.
<collection_name>: is the name of the collection you wish to limit the results to. parententitytypeid=0: specifies that the report should only include Object data. <ORDER BY …>: orders and groups the results to maintain the inherent relationships in the data.
SELECT * FROM RPT_DATA_SOURCE WHERE EntityId IN
(
SELECT EntityId FROM RPT_DATA_SOURCE WHERE
FieldDisplayName='<field_name>' AND
(
ValueText='<value1>' OR ValueText='<value2>'
)
) AND CollectionName='<collection_name>'
AND ParentEntityTypeId=0
ORDER BY
UniqueCollectionID,
EntityID,
EntityTypeDisplayOrder,
RelEntityTypeID,
Grouping,
FieldDisplayOrder,
FieldID,
ValueDisplayOrder
Where:
<field_name>: is the name of the field you wish to limit the results to.
<collection_name>: is the name of the collection you wish to limit the results to. <value1>: is a value you wish the result to match.
<value2>: is another value you wish the result to match. parententitytypeid=0: specifies that the report should only include Object data. <ORDER BY …>: orders and groups the results to maintain the inherent relationships in the data.
A more complex example
The example below uses the VRA Model and is intended to extract label text. The first section of the query selects the field and value information. The sub-select limits the results to that of one object in Insight. The "and" limits the results further to a specific set of fields, and finally the "order by" groups the results to maintain data integrity.
SELECT EntityTypeID as Insight_Record_ID, FieldDisplayName,
ValueText, ValueNumber FROM RPT_DATA_SOURCE WHERE EntityId IN (
SELECT EntityId FROM RPT_DATA_SOURCE WHERE FieldDisplayName = 'Work Record ID' AND ValueText = '110820' ) AND
(
FieldDisplayName = 'Creator Name' OR FieldDisplayName = 'Title' OR FieldDisplayName = 'Display Date'OR FieldDisplayName = 'Work Record ID' )
AND ParentEntityTypeID=0 ORDER BY
UniqueCollectionID,
EntityID,
EntityTypeDisplayOrder,
RelEntityTypeID,
Grouping,
FieldDisplayOrder,
FieldID,
ValueDisplayOrder
Accessing the Collection Data Structure Report
Unlike many of the other reports, the Collection Data Structure Report models the view created to the data structure of the collection. Because of this dependency, if the data structure changes, the stored procedure will need to be created.
Also, each of the collections has its own view. The views are named as follows:
RPT_DATA_ + <UNIQUE_COLLECTION_ID> + _ + <COLLECTION_NAME>
Where:
<UNIQUE_COLLECTION_ID> is the unique ID # for the collection in the database.
<COLLECTION_NAME> is the name of the collection.
To access the view simply run the following query
SELECT * FROM RPT_DATA_<UNIQUE_COLLECTION_ID>_<COLLECTION_NAME> ORDER BY
EntityTypeID,
EntityID
Where:
<UNIQUE_COLLECTION_ID> is the unique ID # for the collection in the database.
<COLLECTION_NAME> is the name of the collection.
NOTE: If there are repeating field grouping, for example a creator record with a creator birth/death date and other information, repeating information would be displayed in a second row of data.
Taking Advantage of the Insight XML Gateway
The Insight XML Gateway provides a platform for the creation of custom applications, plug-ins and other tools which take advantage of content within Insight. The Gateway is a Web-Services interface for Insight.
For more information on the Insight XML Gateway, please see the XML Gateway Documentation.
Using Remote Launch Strings
Remote Launch Strings are URLs which link to Insight. These URLs can perform various tasks, including opening a collection in BrowserInsight or the Java Client, performing a search, and opening an image or set of images in the Image Workspace. The simplest way to create Remote Launch Strings is through the Java or Browser Clients.
In the following section, we will provide several examples of Remote Launch Strings and break them down to identify the individual components. These strings can be static or dynamically generated, depending on your needs.
Enabling Remote Launch String creation in BrowserInsight
Remote Launch Strings are a combination of servlet URL and parameters to the servlet. BrowserInsight dynamically builds Remote Launch Strings by interpreting the current environment into servlet parameters and appending them to the URL. Insight Studio should pre-configure the Remote Launch Base URL for you using the configuration value in the InsightServer.dat. The following section is provided as a reference, if you need to adjust the configuration specifically for one collection. Should you want to change the default for future collections, edit the InsightServer.dat for your Collection or Personal Insight Manager.
The URL (explained below in Constructing a Base URL) must be configured into the collection by using the Administrator Tools:
-
- Open the Administrator Tools.
-
- Connect to the collection:
- Expand the Collections node in the tree on the left.
- Right-click the desired collection, which will cause a context-menu to pop up.
- Select Connect from the context-menu, and enter the administrator username and password.
- Connect to the collection:
The collection node should now expand.
-
- Open the collection's configuration:
- Select Collection Configuration from the expanded collection tree on the left. The right pane should reveal a table of collection configurations (for most collections, there is only one entry).
- Select the desired collection configuration and either double-click it, or:
- Right-click the desired collection configuration, which will cause a context-menu to pop up.
- Select Edit from the context-menu.
- Open the collection's configuration:
The Collection Configuration Window should then pop up.
-
- Press the Edit Browser Attributes button at the bottom of the Screen.
-
- Set Remote Launch String to the Base URL as defined below in Constructing a Base URL. Be aware that EITHER Java or Browser version of the Base URL can be placed here.
-
- Press the Save button.
Enabling Remote Launch String creation in the Java Client
For collections created in Insight 6.3, the base URL of a Remote Launch String should be automatically setup for you. The following instructions are for customizing this value. Insight Studio should pre-configure the Remote Launch Base URL for you using the configuration value in the InsightServer.dat. The following section is provided as a reference, if you need to adjust the configuration specifically for one collection. Should you want to change the default for future collections, edit the InsightServer.dat for your Collection or Personal Insight Manager. The URL (explained below in Constructing a Base URL) must be configured into the collection by using the Administrator Tools.
- Open Administrator Tools.
- Connect to the collection:
-
- Expand the Collections node in the tree on the left.
- Right-click the desired Collection, which will cause a context-menu to pop up.
- Select Connect from the context-menu, and enter the administrator username and password.
-
The collection node should now expand.
- Open the collection's configuration:
-
- Select Collection Configuration from the expanded collection tree on the left. The right pane should reveal a table of collection configurations (for most collections, there is only one entry).
- Select the desired collection configuration and either double-click it, or:
- Right-click the desired collection configuration, which will cause a context-menu to pop up.
- Select Edit from the context-menu.
-
The Collection Configuration Window should then pop up.
- Set Web Initiated Insight JVA URL to the Base URL as defined below in Constructing a Base URL. Though the prompt explicitly asks for the Insight Java Client URL, in fact either the Insight Java Client or Browser version of the Base URL can be placed here.
- Press the Save button.
Creating a Custom Remote Launch String
Creating custom Remote Launch Strings may enable you to dynamically create links to Insight from other applications.
Remote Launch Strings contain the following components:
- A base URL (which points to BrowserInsight or DeployDirector).
- A collection to open.
- Which components to open (Group Workspace, Image Workspace, or Both).
- A search to perform in the Group Workspace (if it is opened).
- A specific page of images to return (i.e. if you want to open the 5th page in a search result set).
- A specific image or set of images to open.
Constructing a Base URL
The base URL for a Remote Launch String is the URL for BrowserInsight or DeployDirector:
An example of a base URL for BrowserInsight:
http://library.Dalton.edu:8080/BrowserInsight/BrowserInsight?cmd=start
An example of a base URL for the Insight Java Client (using Deploy Director):
http://library.Dalton.edu:8080/servlet/deploy/insight/launch?cmd=start
Required Parameters for all Remote Launch Strings
When Insight generates a Remote Launch String for you, it begins with the Base Request URL, and appends the following parameters:
- Cid (Collection Unique ID)
This is the combination of the Collection ID, Institution ID, and Virtual Collection ID for your collection. To confirm these values, check the User Manager.
NOTE: in pre-5.x versions of Insight, the CID referenced the BrowserUniqueCID as specified in the User Manager and the BrowserInsight.conf. The BrowserUniqueCID is still supported in 6.3, but Insight will always create 6.3 Remote Launch Strings which use the CID as described above.
- iia (insight initial activity)
Any of the following:
0 |
Open Group Window |
1 |
Open Image Workspace |
2 |
Open Both Group Window and Image Workspace |
Making a Request Based on a Search
Beginning with the Base Request URL and the required parameters, requests for a Remote Launch that dynamically retrieves all qualifying entries based on search criteria may look like this:
http://library.Dalton.edu:8080/BrowserInsight/BrowserInsight/?cmd=start&cid=LUNA-123-NA&iia=0&iia=0&ig=The%20Dalton%20Library&isl=0&gwisp=0|Period|Period|1|Ming|1&gwia=3&gc=0
where:
- cid=LUNA-123-NA&iia=0 – In this example, the collection referred to by the LUNA-123-NA cid (Collection unique ID, made up of Collection ID of LUNA, Institution ID of 123 and no Virtual Collection ID (NA)) will be opened in the Group Workspace (iia=0).
- ig=The%20Dalton%20Library – Referring to "image group," ig indicates which media group in the collection to open. Since quotes aren't used, "%20" is used in place of " " (%20 is the hex value for a space character). If ig is omitted, the default group contained in the collection configuration will be used.
- gwisp=0|Period|Period|1|Neolithic|1 – gwisp defines the search parameters. Simple requests will contain one set of search criteria composed of six parameters (described below), complex searches can contain several sets of criteria back to back, delimited by "|". Every set of criteria will consist of the following six positional parameters. Unlike keyword parameters, positional parameters are not identified by keyword, and must appear in a specific order:
Bool|Fieldname|FieldDisplayName|FieldType|FieldValue|Relation
-
- Bool – Referring to "Boolean operator," Bool indicates how this set of criteria is to be combined with the preceding set (ignored in the first set, set to 0):
0
OR – include results if EITHER this set of criteria or its predecessor are true
1
AND – include results if BOTH this set of criteria and its predecessor are true
- FieldName – The database column name to be searched.
- Bool – Referring to "Boolean operator," Bool indicates how this set of criteria is to be combined with the preceding set (ignored in the first set, set to 0):
-
- FieldDisplayName – The name to be displayed in the data window.
-
- FieldType – Specifies the data type of the FieldValue that follows. Though fields in a database have a specific data type, database queries can be made using either numeric or string operands, which is determined by the use of quotes. Since quotes are not allowed in Remote Launch Strings, FieldType tells the server how to format FieldValue into the query, and must be one of:
1
Text
2
Number
- FieldValue – This is the value you are searching for. Remember that since quotes are not allowed, "%20" is used in place of " " (%20 is the hex value for a space character).
- FieldType – Specifies the data type of the FieldValue that follows. Though fields in a database have a specific data type, database queries can be made using either numeric or string operands, which is determined by the use of quotes. Since quotes are not allowed in Remote Launch Strings, FieldType tells the server how to format FieldValue into the query, and must be one of:
-
- Relation – Relation defines how the FieldValue is to be evaluated.
1
EQUALS
2
CONTAINS
3
BEGINS
4
ENDS
5
GREATER
6
LESS
9
DOES NOT CONTAIN
To perform a complex Boolean search, concatenate multiple sets of the above criteria into one string, separated by "|".
The example below contains two sets of criteria, searching for a "SubjectType" = "Painting" AND an "EarlyDate" (numeric) > 1900.
gwisp=0|SubjectType|Category|1|Painting|1|1|EarlyDate|Early%20Date|2|1900|5
- Relation – Relation defines how the FieldValue is to be evaluated.
- gwia=3 – gwia or "Group Window Initial Activity" has three options:
Since this is a search request, set gwia=3.
0
Do nothing (merely open the group workspace)
1
Show search menu
3
Custom search
- gc=0 – gc controls paging. BrowserInsight displays 20 objects per page, the Insight Java Client displays 50. Starting at 0, gc=# will display the page holding the #th object. For example, gc=73 would cause BrowserInsight to display the 4th page, the Java Client to show the 2nd page.
Making a Request for a Set of Specific Images in the Group Workspace:
The two requests detailed below are based on ImageID and ObjectID. These are internal numbers that identify a specific Image and the relating descriptive information for that image. Together they form a unique call for a referenced record.
NOTE:The first portion of these strings is consistent with what has been described previously, so we will just focus on the portions that are different.
http://library.Dalton.edu:8080/BrowserInsight/BrowserInsight?cmd=start&cid=5&iia=0&ig=The%20Dalton%20Library&isl=0&gwisp=0|ImageID|ImageID|2|101854:3013|1|0|ImageID|ImageID|2|101842:301|1|0|ImageID|ImageID|2|101843:302|1&gwia=3&gc=-1
The main difference in this string has to do with the gwisp parameter. Notice that there is a special keyword ImageID used for the Fieldname and FieldDisplayName sections. It is also identified as a numeric field. The FieldValue section there is 101854:3013, which is the ObjectID:ImageID reference for the record.
Opening an Image in the Image Workspace
To open an image or set of images in the Image Workspace, you must specify an initial activity of opening the Image Workspace, and provide pairs of ObjectID's and ImageID's to open in Insight. (Remember that a specific item in Insight is identified by an ObjectID, which references the data record and an ImageID, which references the specific media file). Optionally, you may specify an initial resolution size.
http://library.Dalton.edu:8080/BrowserInsight/BrowserInsight?cmd=start&cid=5&iia=1&ig=The%20Dalton%20Library&isl=0&ir=3013+301+302&id=101854+101842+101843&iwas=2
When requesting images to open in the Image Workspace, some of the parameters are different:
- ir=3013+301+302 – Meaning "Image Reference," ir is a list of ImageIDs, separated by a plus sign.
- id=101854+101842+101843 – ObjectIDs are the heart of Insight. id is a list of ObjectIDs, separated by a plus sign. id and ir must be in sync in order to get the correct result. The first ImageID must correlate to the first Object ID, and so on.
- iwas=2 – Referring to "Image Workspace Aspect Size," iwas is the requested image size. For a list of image sizes, please see Table 14: Image Sizes in Insight on page 241.Size"WorkspaceID must correlate to the first Object ID, and so on.) - but the #th object lue is to be evaluated g operands. ver
Creating a Remote Launch String with Auto-Login
The following two optional parameters are available to auto-login – providing a default username and password. When provided (and validated by the User Manager), the remotely launched Insight application will automatically log in and bring the user straight to the images/objects of interest.
These parameters are generally provided as a pair or omitted:
- un=MyUsername – Referring to "User Name," un is an Insight user name for auto-login.
- pw=MyPassword – Referring to "Password," pw is an Insight password corresponding to the username provided above (parameter un), used for auto-login.
Special Remote Launch Parameters for the Insight Java Client
Since the Insight Java Client does not use cid (Collection Unique ID – defined for BrowserInsight) and since it performs its own authentication against a User Manager, Deploy Director Remote Launch Strings need to identify Collections and User Manager differently:
- u=insightusermanager.dalton.org – Referring to "User Manager" (not to be confused with un for auto-login User Name), u specifies the address of the User Manager that will authenticate access and map the request to a Collection Manager.
Special Remote Launch Parameters for BrowserInsight
Currently, there is only one special parameter for BrowserInsight, which allows you to control whether users can create Remote Launch Strings or not:
- isl indicates whether or not the user of the Remote Launch has the right to create Remote Launch Strings in BrowserInsight.
0 |
NO |
1 |
YES |