DigiTool 3.1 Service Pack 18 Release Notes December 2007 · DigiTool v 3.1 Service Pack 18 –...

DigiTool 3.1 Service Pack 18 Release Notes

December 2007

CONFIDENTIAL INFORMATION

The information herein is the property of Ex Libris Ltd. or its affiliates and any misuse or abuse will result in economic loss. DO NOT COPY UNLESS YOU HAVE BEEN GIVEN SPECIFIC WRITTEN AUTHORIZATION FROM EX LIBRIS LTD.

This document is provided for limited and restricted purposes in accordance with a binding contract with Ex Libris Ltd. or an affiliate. The information herein includes trade secrets and is confidential.

DISCLAIMER

The information in this document will be subject to periodic change and updating. Please confirm that you have the most current documentation. There are no warranties of any kind, express or implied, provided in this documentation, other than those expressly agreed upon in the applicable Ex Libris contract.

Any references in this document to non-Ex Libris Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this Ex Libris product and Ex Libris has no liability for materials on those Web sites.

Copyright Ex Libris Limited, 2007. All rights reserved.

Documentation created: December 9, 2007.

Document version 1.1

Web address: http://www.exlibrisgroup.com

1

http://www.exlibrisgroup.com/

Table of Contents

1. Introduction ............................................................................................................................3

1.1 Purpose and Scope.............................................................................................................3

1.2 Service Pack Information ..................................................................................................4

1.2.1 Service Pack Name & Number.....................................................................................4

1.2.2 Service Pack Highlights................................................................................................4

1.3 New Terms and Definitions...............................................................................................5

2. Service Pack Content Summary.............................................................................................6

2.1 Changes with Implementation Actions .............................................................................6

2.2 Code Changes (No Implementation Actions)....................................................................7

3. Changes with Implementation Actions (Detailed) ...............................................................10

3.1 Change 1 - Ingest – Image Uploader Active-X upgraded and License Replacement. ....10

3.2 Change 2 - METS viewer ALTO content and article extraction.....................................11

3.3 Change 3 - Control Attribute Assignment Task - Enhanced logic..................................14

3.4 Change 4 – Repository Synchronization - Metadata update performance enhancement16

3.5 Change 5 – Repository Synchronization – Normalizing VIEW_MAIN for ALEPH .....17

3.6 Change 6 – Deposit fields – Hidden to depositor and exposed to Approver ..................19

3.7 Change 7 – Xepicur URL definition enhancement .........................................................19

3.8 Change 8 – Repository Synchronization – Allow retention of Leader field ...................20

2

1. Introduction Service pack 18 represents the third service pack in DigiTool release version 3.1. The primary focus of service pack 18 is additional improvements to the new DigiTool METS/COMPLEX viewer as well as focus on targeted SI fixes.

1.1 Purpose and Scope The purpose of this document is to describe the functional and technical changes related to fixed defects (SIs) and new enhancements included in this Service pack

Ex Libris has improved the SP implementation process since SP 16 so that wherever possible, implementation actions will be performed automatically by the SP mechanism – particularly for mandatory and recommended setup changes involving server-side setup and configuration implementation steps. The user receives an e-mail with the list of changes applied, as well as a “To Do” list of any remaining manual changes that may still be required, if any. This document will be attached to the e-mail described.

Whenever relevant, the additional manual steps that remain to be taken to activate any new functionality or change is described and organized by topic, level and target audience. Generally, the non-automatic changes are non-mandatory, but there may be infrequent exceptions which will be denoted accordingly.

Ideally, and in most cases, the SP can be installed and no further changes will be needed in order to continue work with the system.

Note: It is required to run set_globals.sh after installing and implementing any relevant manual changes related to this SP - and before bringing up the application again with dtl_startup_all.

>>j_bin

>>./set_globals.sh

>>dtle

>>dtl_startup_all

3

Note: Always run Meditor’s version update after each SP installation to ensure you have the most recent and working functionality of the Meditor PC client. This should be performed from the Meditor’s top toolbar:

DigiTool > Utilities > Version Check

1.2 Service Pack Information

1.2.1 Service Pack Name & Number DigiTool v 3.1 Service Pack 18 – December 9, 2007

1.2.2 Service Pack Highlights Note: items are categorized by the following:

• Implementation actions – Changes that involve some setup/configuration change to activate. Two main classes of implementation actions exist:

o Changes that involve change to configuration/setup in order to allow using the new change/function/feature. These changes are noted in the SP automated email report and in the “Changes with Implementation Actions” table. Usually these changes will be automated.

o Changes that may also involve instructions on how to use the new change/function/feature. These changes are included in the “Changes with Implementation Actions” table. These changes are usually optional and contain instructions on how to use a new function/feature.

May be automatic (done by SP) or manual (may require additional actions to activate)

Level

• Mandatory – it is mandatory to activate this feature (auto or manual)

• Recommended – it is not mandatory, but it is the recommendation of EXL that the change be initiated.

• Optional – it is possible to choose whether or not to activate the new feature

Target Audience

• ALL

4

• Module/Orientation specific

• No Implementation actions – changes that do not involve any setup/configuration change, but are generally code-based changes. Always automatic. They can be viewed in the “Change with No Implementation Actions” table.

1.3 New Terms and Definitions This section will explain the new terms and definitions introduced in this SP

• METS Article level zoom and text reader – This refers to an enhancement added which when ALTO data is provided to the METS viewer, the ability to cut out certain articles/sections and read them in a separate zoomed window is now available. See below

• entity_group – A new digital entity control field you will see in the Meditor (after running required Meditor version update) with Service Pack 18. This is a field which is reserved for future use.

5

2. Service Pack Content Summary Below is a list of corrections and enhancements included in this service pack. More detailed descriptions – when relevant – are provided in subsequent chapters.

The first table represents those changes that involve configuration change(s) performed automatically or to be performed manually in order to activate. The Auto enable column indicates whether the change was intended to be automatically performed by the SP or not. However, ensure you check the SP-generated email after SP is installed to see the status of any unperformed actions intended automatic or otherwise.

The second table represents a list of defect fixes (code change only) which are automatically fixed by the SP mechanism patch.

Items that have additional information or implementation actions will be linkable from the Change ID # column.

2.1 Changes with Implementation Actions

Change ID #

Target Audience

Brief Description Level Type Module/ Topic

RPC # Auto Enable

1 ALL New Active-X version and license added.

Mandatory Enhancement Ingest 1065 Y

2 Sites using METS ALTO

Enhancement – METS Viewer METS viewer ALTO content and article extraction

Mandatory Enhancement Delivery 1080 Y

3 Sites using Attribute Assignment

Ingest – Control Attribute Assignment Task – Enhanced logic

Mandatory Enhancement Ingest 1077 Y

4 Sites using Repository Sync

Repository Synchronization – Metadata update performance enhancement. The metadata update job run is now done outside of JBOSS.

Mandatory Enhancement Repository Sync

1081 Y


DigiTool to ALEPH synchronization – normalizing VIEW_MAIN to VIEW for ALEPH by adjusting de2aleph.xsl

Recommended Bug Repository Sync

1070 N

6

Change ID #

Target Audience

Brief Description Level Type Module/ Topic

RPC # Auto Enable

6 Sites using Deposit

Deposit/Approver – Add ability to hide field/s in the depositor forms and expose them in the approver forms.

Optional Enhancement Deposit 1076 Y*

7 German Market

GERMAN MARKET ONLY – Repository Replication – Xepicur transformer url definition.

Optional Enhancement Repository Replication

1068 Y*


ALEPH-DigiTool synchronization (Metadata Update) –Allow retention of DTL-defined Marc leader field.

Optional Enhancement Repository Sync

1075 Y

2.2 Code Changes (No Implementation Actions)

Change ID #

Target Audience

Description Type Module/ Topic

RPC #

1 ALL Support for UTF-8 search terms passed to delivery 1. RD search term passed to METS viewer and PDF viewer now in UTF-8 2. Search term passed in METS viewer now in UTF-8.

Defect Delivery and RD

1064

2

ALL Enhancement to Re-load repository configuration job. In addition to the previous system configurations handled by the Reload Repository Configuration job, the following will also now be handled by the job and therefore prevent needing re-start to JBOSS when updating them: 1. repository_replication.xml 2. repository_synchronisation.xml 3. repository_stream_handler.xml 4. pi_profiles_rules.xml 5. messages*.properties

Enhancement MNG jobs 1072

3 ALL New digital entity control field added – entity_group – which is reserved for future use.

Enhancement General 1078

7

Change ID #

Target Audience

Description Type Module/ RPC # Topic

4 ALL Ingest - Tiff to Jp2 in combination with METS loads - When running ingest with Tiff2jp2 task for METS loads, the last jp2 failed to create in certain cases - Resolved.

Defect Ingest 1067

5 ALL Add Metadata Task - Reinstating ALL metadata names/types to the add metadata task. A previous change limited the job to only the more common types (descriptive and access rights).

Defect Digital Entity Services

1069

6 ALL Meditor - Adding local md for non-descriptive metadata types did not always adhere to the "allow_multiple" setting in repository_configuration.xml. This has been fixed.

Defect Meditor 1083

7 ALL Object Cache - The system would attempt to use object cache (hdeobjectcache) if data was available, even if this functionality was deactivated, but had data from previously being activated. Resolved.

Defect General 1084

8 Sites using COMPLEX objects

Replace the title of COMPLEX objects which don't have a control/label to "Table Of Contents". This will happen in two places: 1. In the METS/COMPLEX viewer for display in the View options dropdown menu for cases where there is not control/label. 2. In Ingest when no label is provided in the workflow, Table of Contents will be the default control/label provided to the digital entity of the parent object. In cases where a "real" control/label is present or provided, that will be used in preference over "Table of Contents".

Enhancement Delivery 1062

9 Sites using METS/ COMPLEX

METS Viewer Fixes 1. When changing from split (parallel) mode to single mode and vice versa, the application didn't maintain the correct view after page switch. Corrected. 2. Right To Left display of numbering search results and thumbnails has been corrected.

Defect MNG Reindexing Job

1066

8

Change ID #

Target Audience

Description Type Module/ RPC # Topic

10 Sites using Resource Discovery

Prevention of restart of background daemons (ue_01) as long as p_harvest_02 is running. PLEASE NOTE that if the Harvest fails for some reason (e.g. reboot server in middle of process) the stop file needs to be deleted manually in order to continue running the ue_01 background process again. $user_dev/gen01/scratch/util_e_stop

Defect Harvesting 1082

11 Sites using OAI provider

OAI Data Provider - The responseDate which is sent as part of OAI data provider was in some cases not fully appropriate. The time was taken at the moment the request was finally operated and the response message was sent. This has been changed and DTL OAI provider now sends the time which is taken when the request is internally operated which may be slightly earlier than the sending of the message.

Defect OAI 1012

12 Sites using LDAP and deposit

Deposit - LDAP handled only authentication, but did not pass user details (bor_info) to the deposit module (such as name, email, etc.) - Fixed.

Defect Deposit

1063

9

3. Changes with Implementation Actions (Detailed)

3.1 Change 1 - Ingest – Image Uploader Active-X upgraded and License Replacement.

Level - Mandatory Target Audience – ALL Type - Defect Module – Ingest Automatic enabled - Y Description: Ingest - ImageUploader ActiveX with IE7 was not entirely compliant. The solution: The ActiveX component was upgraded from version 3.5 to 4.1. Support for IE 6 and IE 7 now in place. As part of the SP installation, your Active-X license will be automatically updated to v 4.1. Your license number should be updated by the SP automatically - however, if the file uploader Active-X does not work after you install SP 18 – please contact EXL support immediately. Action to do to activate

In $jdtlh/profile/global.properties (and global.properties.tml)

Add new Active-X license to the following parameter.

activex_upload_lic=YOURLICENSE#

Your Active-X license number should be updated by the SP automatically.

10

Click here to return to table above.

3.2 Change 2 - METS viewer ALTO content and article extraction

Level – Mandatory change. Optional Use. Target Audience - Sites using METS ALTO Type - Enhancement Module – Delivery Automatic enabled - Y Description: Enhancement - METS Viewer ALTO content and article extraction. A. The METS content window now handles articles that contain ALTO coordinate and OCR full text in a more suitable way. An article is now highlighted across the page and a sequence of pages is created when the article spreads across more than one page. In addition, when clicking on the highlighted article a new window is opened with the following: 1) Image manifestation: cutting the article from the original page and putting the cuts in order and aligned to center. When a search term exists, it is highlighted within the article. 2) Text manifestation: the OCR of the article is placed with the ability to search for a term. Also print and save buttons are available for the above options. Here is a sample scenario for using this function:

1. By default, when the METS viewer is opened, it will be opened on the relevant branch of the logical tree. The whole page of the newspaper will be displayed and only the relevant article will be highlighted (default yellow).

2. Additionally the search term will be highlighted on the page (default red), both in and outside the article (if it exists outside the article on that page). Navigating within the search term should be done using the next/previous arrow icons on the left side of the window. The focus of the page should be changed according to the search term (meaning that that if we have more than one search term on the page, the page's focus should be changed on each click of the "Next" icon to be focused on the next search term). Note

11

that if one search term is inside one article and the next search term is in another article, when using the "Next" icon the second article will be highlighted instead of the first one.

3. If the article spreads over more the one page, a separate sequence will be created for each page the article is shown in. Moving from one sequence to the other sequence will be done with the existing designated button.

4. The highlighted article (the combination of all the sub-divs) will be a hyper link that will open a new window with the article alone.

B. Enabled ability to sort the structMap Views dropdown list according to a pre-defined order as set in the mets_view_profile configuration file. See instructions below for details.

12

Action to do to activate

In $jdtlh/system/conf/i18n/messages*.properties

Add the following lines:

nmets.article.view_options=View Options

nmets.article.search=Search

nmets.article.search_term=Search Term

nmets.article.clear_selection=Clear Selection

nmets.article.image_manifestation=Image Manifestation

nmets.article.text_manifestation=Text Manifestation

2. Optional : Add ability to sort the structMap Views dropdown list according to a pre-defined order attribute as set in the $jdtlh/system/conf/mets_view_profile configuration file.

Example - setting Logical map to show up before Physical Map.

13

<structures>

<structure order="1">

<struct_type>LOGICAL</struct_type>

<i18n_label_key>v.mets.newspaper.logical

</i18n_label_key>

<include>true</include>

</structure>

<structure order="2">

<struct_type>PHYSICAL</struct_type>

<i18n_label_key>v.mets.newspaper.physical</i18n_label_key>

<include>true</include>

</structure>

</structures>


3.3 Change 3 - Control Attribute Assignment Task - Enhanced logic

Level - Mandatory Target Audience – Sites using Control Attribute Assignment Task Type - Enhancement Module – Ingest Task Automatic enabled - Y Description: Ingest - Control Attribute Assignment Task - Enhanced logic From now on, when running a Control Attribute Assignment Task, the following logic is in place: 1. A new "Parent Only" checkbox was added to allow setting an assignment only to parent objects. A parent object will be considered any/all of the following:

14

a. entity type = METS or b. entity type = COMPLEX or c. entity type defined in $jdtlh/system/conf/mets_configuration.xml <mets_compliant_entity_type> or d. entity type defined in $jdtlh/system/conf/mets_configuration.xml <complex_compliant_entity_type> Please note: A new complex_compliant_entity_type has been added to mets_configuration.xml. in order to define those entity types used in your system (other than COMPLEX) which may need to be treated like COMPLEX objects. complex_compliant_entity_type cannot be the same as mets_compliant_entity_type. 2. With a file extension filter defined (multiple extensions may be defined by comma separation - i.e. jpg,gif,tif) - the matching digital entities with such file extension(s) will attain the assignment.

Action to do to activate 1. In file $jdtlh/system/i18n/dynamic_messages*.properties

Add the following line:

i.task.AttributeAssignment.apply_to_parent_only=Apply parent only

2. In $jdtlh/system/conf/repository_stream_handler.xml

1. In $jdtlh/system/conf/repository_stream_handler.xml

Within <preingest_handler name="Control section Attribute Assignment" task_name="AttributeAssignment">”

Add the following line:

<default_param name="Apply to parent only" param_name="apply_to_parent_only" type="combo" default_values="false,true" value="false" />

3. In file $jdtlh/system/conf/mets_configuration.xml

After "</mets_transformer>"

Add the following lines:

15

<complex_configuration> <complex_compliant_entity_type>complex_type</complex_compliant_entity_type>

</complex_configuration>


3.4 Change 4 – Repository Synchronization - Metadata update performance enhancement

Level - Mandatory Target Audience – Sites using Repository Synchronization Type – Enhancement Module – Repository Synchronization Automatic enabled - Y Description: Repository Synchronization - Metadata update performance enhancement

The metadata update job run is now done outside of Jboss.

The default configuration (repository_jobs_configuration.xml and repository_synchronisation.xml) has been adjusted in order to run the metadata update as a separate non-Jboss job.

Actions to do to activate

1. In $jdtlh/system/conf/repository_jobs_configuration.xml

Add the new hidden field "isSA" to the MetadataUpdateReportForm (at line 8991):

<x_field>

<input_name>isSA</input_name>

<md_target_name></md_target_name>

<md_custom_target></md_custom_target>

<ui_description></ui_description>

<ui_explanation_text></ui_explanation_text>

16

<ui_tool_tip></ui_tool_tip>

<single>true</single>

<default_value>true</default_value>

<pos_x>20</pos_x>

<pos_y>20</pos_y>

<mandatory>false</mandatory>

<logic_type>8</logic_type>

<x_ui_type>HiddenField</x_ui_type>

</x_field>

2. In $jdtlh/profile/synchronisations/conf/repository_synchronisation.xml

Add the following line at line 31 - after line "<paramname="mergeRules">md_merge_rules.xml</param>"

<param name="isSA">true</param>


3.5 Change 5 – Repository Synchronization – Normalizing VIEW_MAIN for ALEPH

Level - Recommended Target Audience – Sites using Repository Synchronization Type – Bug Module – Repository Synchronization Automatic enabled - N

Description: DigiTool to ALEPH synchronization - Digital entities of usage type VIEW_MAIN cause problems as part of the synchronization process from DigiTool to ALEPH.

The ALEPH environment does not handle usage type VIEW_MAIN nor does it have meaning in terms of the link updates made there. Therefore de2aleph.xsl has been corrected so that usage type VIEW_MAIN will be automatically changed to VIEW as part of the repository replication for DigiTool's publish to ALEPH.

Other usage types remain unchanged.

17

Actions to do to activate

1. In $jdtlh/system/xsl/de2aleph.xsl

Change the following:

From:

<usage_type>

<xsl:value-of select="//control/usage_type"/>

</usage_type>

To:

<xsl:choose>

<xsl:when test="//control/usage_type='VIEW_MAIN'">

<usage_type>VIEW</usage_type>

</xsl:when>

<xsl:otherwise>

<usage_type>

<xsl:value-of select="//control/usage_type"/>

</usage_type>

</xsl:otherwise>

</xsl:choose>


18

3.6 Change 6 – Deposit fields – Hidden to depositor and exposed to Approver

Level - Optional Target Audience – Sites using Deposit Type - Enhancement Module – Deposit/Approver Automatic enabled – Y* Description: Enhancement - Deposit/Approver - Add ability to hide field/s in the depositor forms and expose them in the approver forms. A new field-level check box definition option has been added at the deposit form field management level. The option for definition will appear similar to the current checkbox definition option of "mandatory" - but will have the following effect on the field using that definition for depositor and approver: - Will not appear in the depositor metadata form - Will appear in the Approver metadata form - Should act like a Hidden field that does not appear in the deposit form but should appear for the Approver. The difference is that a label can be created and it will appear only in the Approver form. - Will not appear in the Preview/summary stage for Depositor or Approver

Action to do to activate


3.7 Change 7 – Xepicur URL definition enhancement

Level - Optional Target Audience – German Market Type - Enhancement Module – Repository Replication Automatic enabled – Y*

19

Description: GERMAN MARKET ONLY - Repository Replication - Xepicur transformer: New parameter added for the XEpicur replication. This parameter is named "primaryRole" and allows explicitly defining which URL should become the primary URL in the replicated XEpicur record. If the parameter does not exist the viewer_url is taken as primary per default and if the viewer_url parameter is set to false the stream_url becomes primary URL. These parameters are defined within in the format_convertor section of the XEpicur replica. Parameter Sample: <params> <param name="viewer_url">true</param> <param name="stream_url">true</param> <param name="primaryRole">viewerUrl</param> </params> In addition the XEpicur replication was enhanced to support the update of URLs. If the URL was changed in $jdtlh/system/conf/digital_entity_urls_template.xml this new URL will be replicated with "<update_status type="url_update" />" for records which already existed in oai_pub. To update all existing records the replication must be re-run from scratch.


3.8 Change 8 – Repository Synchronization – Allow retention of Leader field

Level - Optional Target Audience – Sites using Repository Synchronization Type - Enhancement Module – Repository Synchronization Automatic enabled – Y* Description: ALEPH-DigiTool synchronization (Metadata Update) - Until now, it was not possible to preserve the Marc leader field in the DTL Marc record via definition in $jdtlh/profile/conf/templates/metadata/md_merge_rules.xml. The mechanism has been enhanced and the leader field can now be retained as shown in the example below. (Please note that deletion of the leader (action=delete) is not supported for the leader field.)

20

<mr:md_merge_rules xmlns:mr="http://com/exlibris/digitool/common/formatting/xmlbeans"> <fields> <field action="insert" force="false"> <location type="md" md_name="descriptive" md_type="marc" path="leader"/> </field> </fields> </mr:md_merge_rules>


21

DigiTool 3.1 Service Pack 18 Release Notes December 2007 · DigiTool v 3.1 Service Pack 18 –...

Documents

Transcript of DigiTool 3.1 Service Pack 18 Release Notes December 2007 · DigiTool v 3.1 Service Pack 18 –...