DigiTool Configuration Guide - McGill Library · ʺEx Libris,ʺ the Ex Libris bridge , Primo,...

632
Configuration Guide Version 3.4

Transcript of DigiTool Configuration Guide - McGill Library · ʺEx Libris,ʺ the Ex Libris bridge , Primo,...

  • Configuration GuideVersion 3.4

  • CopyrightExLibrisLimited,2012.Allrightsreserved.Documentreleased:August2012

    Webaddress:http://www.exlibrisgroup.com

    CONFIDENTIAL INFORMATIONTheinformationhereinisthepropertyofExLibrisLtd.oritsaffiliatesandanymisuseorabusewillresultineconomicloss.DONOTCOPYUNLESSYOUHAVEBEENGIVENSPECIFICWRITTENAUTHORIZATIONFROMEXLIBRISLTD.ThisdocumentisprovidedforlimitedandrestrictedpurposesinaccordancewithabindingcontractwithExLibrisLtd.oranaffiliate.Theinformationhereinincludestradesecretsandisconfidential.

    DISCLAIMER

    Theinformationinthisdocumentwillbesubjecttoperiodicchangeandupdating.Pleaseconfirmthatyouhavethemostcurrentdocumentation.Therearenowarrantiesofanykind,expressorimplied,providedinthisdocumentation,otherthanthoseexpresslyagreeduponintheapplicableExLibriscontract.ThisinformationisprovidedASIS.Unlessotherwiseagreed,ExLibrisshallnotbeliableforanydamagesforuseofthisdocument,including,withoutlimitation,consequential,punitive,indirectordirectdamages.Anyreferencesinthisdocumenttothirdpartymaterial(includingthirdpartyWebsites)areprovidedforconvenienceonlyanddonotinanymannerserveasanendorsementofthatthirdpartymaterialorthoseWebsites.ThethirdpartymaterialsarenotpartofthematerialsforthisExLibrisproductandExLibrishasnoliabilityforsuchmaterials.

    TRADEMARKS

    ExLibris,theExLibrisbridge,Primo,Aleph,Alephino,Voyager,SFX,MetaLib,Verde,DigiTool,Preservation,URM,Voyager,ENCompass,EndeavoreZConnect,WebVoyage,CitationServer,LinkFinderandLinkFinderPlus,andothermarksaretrademarksorregisteredtrademarksofExLibrisLtd.oritsaffiliates.TheabsenceofanameorlogointhislistdoesnotconstituteawaiverofanyandallintellectualpropertyrightsthatExLibrisLtd.oritsaffiliateshaveestablishedinanyofitsproducts,features,orservicenamesorlogos.Trademarksofvariousthirdpartyproducts,whichmayincludethefollowing,arereferencedinthisdocumentation.ExLibrisdoesnotclaimanyrightsinthesetrademarks.UseofthesemarksdoesnotimplyendorsementbyExLibrisofthesethirdpartyproducts,orendorsementbythesethirdpartiesofExLibrisproducts.OracleisaregisteredtrademarkofOracleCorporation.UNIXisaregisteredtrademarkintheUnitedStatesandothercountries,licensedexclusivelythroughX/OpenCompanyLtd.Microsoft,theMicrosoftlogo,MS,MSDOS,MicrosoftPowerPoint,VisualBasic,VisualC++,Win32,MicrosoftWindows,theWindowslogo,MicrosoftNotepad,MicrosoftWindowsExplorer,MicrosoftInternetExplorer,andWindowsNTareregisteredtrademarksandActiveXisatrademarkoftheMicrosoftCorporationintheUnitedStatesand/orothercountries.UnicodeandtheUnicodelogoareregisteredtrademarksofUnicode,Inc.GoogleisaregisteredtrademarkofGoogle,Inc.

    http://www.exlibrisgroup.com

  • Table of Contents

    3

    UpdatestoThisGuide .......................................................................................................25

    Part I Introduction to This GuideChapter1 IntroductiontotheConfigurationGuide ...........................................29

    DocumentationConventions .................................................................. 29

    ContentandScope.................................................................................... 29

    PartsofThisGuide.................................................................................29

    CommonInterfaceFeaturesAcrossWebClients ................................ 30

    RightHeaderControls ...........................................................................30LeftHeaderNavigation ..........................................................................31

    Part II Configuration File ManagementChapter2 ManagingConfigurationFiles ..............................................................35

    Introduction...............................................................................................35

    AccessingYourConfigurationFiles ...................................................... 36

    FilteringtheFilesList............................................................................... 38

    ChoosingFiles ........................................................................................... 38

    ModifyingConfigurationFiles ............................................................... 39

    ActivatingConfigurationChanges ........................................................ 39

    Part III User ManagementChapter3 UserManagement ....................................................................................45

    StaffUsers ..................................................................................................45

    StaffUserDefinitionsforManagingotherStaffUsers .........................46ManagingStaffUsers ............................................................................47

    StaffPrivileges/AccessRights ................................................................. 50

    UsersAccessRights ..............................................................................50ManagingStaffAccessRights ...............................................................52StaffAdministratorsSystemAdministratorFunctions .....................52

    Patrons........................................................................................................53

    Patronregistration .................................................................................54ManagementofPatrons .........................................................................55

  • Configuration Guide

    4

    WebProfiles .............................................................................................. 60

    PatronProfileInformationform ............................................................ 61ResourceDiscoveryPreferences............................................................ 64

    DepositorsandDepositProfiles............................................................. 65

    DepositRegistration .............................................................................. 65SetupforPDSDepositorAuthentication .............................................. 66ManualAssigningofProfiles ................................................................ 69

    ApproversandApproverProfiles ......................................................... 73

    Approvers .............................................................................................. 73Staff(Approver)ProfileRecord ............................................................. 75

    StaffPrivilegeList..................................................................................... 75

    ForSystemAdministratorsOnly .......................................................... 75FullListofStaffPrivileges..................................................................... 76

    Part IV Deposit ConfigurationChapter4 DepositWorkflows ................................................................................ 83

    ContentandScope.................................................................................... 83

    Workflows............................................................................................... 83DepositLifecycle..................................................................................... 84LoggingontotheManagementInterface .............................................. 84

    FastTrackDepositConfiguration.......................................................... 85

    AnonymousFastTrack .......................................................................... 85AuthorizedLoginFastTrack ................................................................. 86LDAPSetup ........................................................................................... 86FastTrackParameters/repository_configuration.xml........................... 87SystemGeneratedURL ......................................................................... 87

    MaterialTypeWorkflows ....................................................................... 88

    AddingaWorkflow/MaterialType ........................................................ 88

    DescriptiveMetadataForms................................................................... 89

    CreatingMetadataForms ...................................................................... 90ConfiguringMetadataForms ................................................................ 92ChoosingaDescriptiveMetadataFormforaWorkflow ....................... 93

    CopyrightandAccessRights.................................................................. 94

    CreatingCopyrightFiles........................................................................ 94CreatingAccessRightsRoutines........................................................... 94ChoosingCopyrightandAccessRightsforaWorkflow ........................ 96

  • 5

    SubmissionFormats ................................................................................. 97

    DefiningSubmissionFormats ...............................................................98ChoosingaSubmissionFormatforaWorkflow...................................100PostApproval.......................................................................................101

    UpdatingandDeletingWorkflows...................................................... 101

    Chapter5 UserManagement,Groups,andProfiles ..........................................103

    DepositGroups ....................................................................................... 103

    StaffProfiles............................................................................................. 105

    Add,Edit,orDeleteaStaffApproverProfile ......................................106DepositorProfiles .................................................................................106Add,Edit,orDeleteaDepositorProfile ..............................................107DepositUserManagement ..................................................................107ViewDepositorDetails.........................................................................107Assign,Edit,orDeleteaProfile...........................................................108

    Chapter6 DepositorEmailsandReports ...........................................................109

    Email........................................................................................................ 109

    AlteringtheEmailNotificationText..............................................110ExampleofAlteredEmailNotification ...............................................111

    Reports ..................................................................................................... 112

    TrackingReportsServerSide............................................................. 113

    Part V Handle Persistent IdentifiersChapter7 HandleNetIntegration.........................................................................119

    HandlesandtheHandleSystem.......................................................... 119

    HandlesinDigiTool ............................................................................... 119

    GeneralConfiguration ........................................................................... 120

    pi_profiles_rules.xml ...........................................................................120pi_publisher_rules.xml.........................................................................123handleConfig.properties .......................................................................127hdltool.ini .............................................................................................128repository_replication.xml ...................................................................129

    Chapter8 UsingHandlePersistentIdentifiers...................................................131

    GeneratingaHandlePIwithinDigiTool ............................................ 131

    GlobalHandleCreationManagementModule..................................131CreateURNMeditorModule ...........................................................132

  • Configuration Guide

    6

    PublishingaHandlePIWithinDigiTool ............................................ 133

    PublishPersistentIdentifierManagementModule .......................... 134

    Workflow:SettingUpHandlewithDigiTool .................................... 136

    ResolvingHandlesLocally.................................................................... 137

    ConfigurationforUseinaConsortialFramework............................ 137

    pi_profiles_rules.xml............................................................................ 138pi_publisher_rules.xml......................................................................... 139

    Part VI Ingest ConfigurationChapter9 IngestGettingStarted........................................................................ 143

    IngestinDigiTool ................................................................................... 143

    ContentandScope.................................................................................. 144

    LoggingOn.............................................................................................. 144

    Chapter10 IngestActivity ........................................................................................ 147

    PreTransformers(ForDepositOnly).................................................. 147

    GeneralPreTransformer ..................................................................... 148METSPreTransformer ....................................................................... 148

    Acquiring ................................................................................................. 148

    RecurringIngests................................................................................. 148ServerAcquire(NetworkFileSystem) ................................................ 148EMailAcquire.................................................................................... 149

    Transformers ........................................................................................... 151

    FileStream(s)thatWillbeLoadedwithNoRelationships .................. 151CommaSeparatedValue(.csv)File...................................................... 151FileStream(s)thatWillBecomePartofOneParentRecord............... 152MARCXMLFileandAssociatedFileStream(s) ............................... 152DublinCoreXMLFileandAssociatedFileStream(s) ........................ 152MODSXMLFileandAssociatedFileStream(s)................................ 153METSXMLFileandAssociatedFileStream(s) ................................. 153FileStreamsLoadedwithManifestationRelationships....................... 153ExportedDigiToolRepositoryElementsforIngest/ReIngest ............ 153FileStreamsUtilizingtheDigiToolFileNameConvention ............... 154

    AutoRollback.......................................................................................... 154

  • 7

    Tasks ......................................................................................................... 155

    TechnicalMetadataExtraction ............................................................155AddMetadata.......................................................................................157ControlSectionAttributeAssignment ................................................157FullTextExtraction .............................................................................157AddHistoryEvent ...............................................................................157TifftoJPEG2000Converter .................................................................158RemoteStreamDownload....................................................................158ThumbnailCreation .............................................................................158PremisMetadataCreationwithPI ......................................................158

    Chapter11 IngestConfiguration .............................................................................159

    DigitalEntityTemplates ....................................................................... 159

    General ................................................................................................159MARC ..................................................................................................161DublinCore ..........................................................................................163MODS..................................................................................................164

    ProcessingInstructions .......................................................................... 165

    ....................................................................165 ...........................................................................................165MARCConvertingRules .................................................................166DublinCoreConvertingRules .........................................................168MODSConvertingRules .................................................................169

    ChangestoTasks ................................................................................... 171

    PluggingInNewTasks.......................................................................... 173

    Folders ...................................................................................................... 174

    Foldersview..........................................................................................174Folderscleanup.....................................................................................175

    PostDepositIngest................................................................................. 176

    Part VII Delivery ConfigurationChapter12 DeliveryComponents,Workflow,andInterface ............................181

    DeliveryModuleInterfaces................................................................... 181

    EndUserInterface................................................................................181ManagementInterface..........................................................................182

    Workflow ................................................................................................. 182

  • Configuration Guide

    8

    EndUserInterfaceURLsandCustomization .................................... 183

    DeliverySystemURLSyntax.............................................................. 183ConfigurationfortheEndUserInterface ............................................ 185

    Chapter13 DeliveryManagementInterface ......................................................... 189

    LoggingOntotheManagementModule............................................ 189

    DeliveryRules......................................................................................... 190

    DeliveryRuleAttributes........................................................................ 191

    GeneralAttributes ............................................................................... 192RequestAttributes ............................................................................... 192DigitalEntity(Object)Attributes ....................................................... 193

    ViewerPreprocessors............................................................................. 194

    SimpleViewerPreprocessor ................................................................ 194J2KViewerPreprocessor ..................................................................... 194JpegViewerPreprocessor .................................................................... 194NMETSViewerPreprocessor ............................................................. 195ALTOViewerPreprocessor ................................................................. 195SidViewerPreprocessor...................................................................... 195DefaultViewerPreprocessor ............................................................... 195TextCGIViewerPreprocessor .............................................................. 195XSLViewerPreprocessor.................................................................... 195MessageViewerPreprocessor .............................................................. 195WebarchiveViewerPreprocessor ......................................................... 196ResourceDiscoveryViewerPreprocessor ............................................ 196DirectStreamViewerPreprocessor ...................................................... 196PDFCGIViewerPreprocessor ............................................................ 196

    Viewers..................................................................................................... 196

    SimpleViewer ..................................................................................... 197J2KViewer........................................................................................... 199JpegNavViewer................................................................................... 201METSViewer....................................................................................... 203SidViewer ............................................................................................ 207TextCGIViewer ................................................................................... 207XSLViewer ......................................................................................... 209MessageViewer.................................................................................... 210WebarchiveViewer.............................................................................. 211PDFCGIViewer .................................................................................. 212AdditionalDefaultViewer .................................................................. 213

  • 9

    Chapter14 AccessRightsandCopyrights .............................................................215

    AccessRightsRules ................................................................................ 215

    AccessRightsMetadataSyntax...........................................................216AccessRightsKeys...............................................................................222

    CreatingRightsforDepositedMaterial .............................................. 224

    CreatingCopyrightandAccessRightsDefinitions.............................224

    AssigningRightsfromWebIngest ...................................................... 226

    AssigningRightsfromtheMeditor ..................................................... 228

    CreatingNewAccessRightsMetadata ...............................................228OpeninganExistingTemplate ............................................................229InsertingMetadataFromYourLocalDrive ........................................229

    EditingAccessRightsMetadata ........................................................... 230

    AccessRightsForm ..............................................................................230AccessRightsxmlgridEditor .............................................................232

    AccessRightsCheckfortheDigitalEntity ......................................... 234

    DefaultSystemBehavior......................................................................234AccessRightsChecker..........................................................................235CustomAccessRightsChecker ............................................................237CheckResult .........................................................................................238

    CopyrightCheckfortheDigitalEntity ............................................... 239

    CopyrightsText....................................................................................241SettingtheCopyrightsOptions ...........................................................241

    Chapter15 UsingMETSFormat ..............................................................................243

    Overview.................................................................................................. 243

    DigiToolMETSProfile ........................................................................... 244

    METSschemaversion..........................................................................245MetadataSupport.................................................................................245ValidvaluesfortheUseattribute.........................................................247FileGroups ...........................................................................................248Linkingtoexternalfiles........................................................................249LinkingaFiletoMetadata ..................................................................250CreatingthestructMap........................................................................250

    METSTransformation/Decomposition................................................ 251

    TheTransformationProcess.................................................................252

  • Configuration Guide

    10

    METSDelivery........................................................................................ 253

    MetsViewerPreProcessor ..................................................................... 253METSViewer....................................................................................... 253

    ComplexEntityvs.METSEntity.......................................................... 257

    ComplexCache ..................................................................................... 257

    CreatingMETSDocumentsfromNonMETSInput ......................... 257

    ParentRecordTransformer.................................................................. 258FileNameConventionTransformer .................................................... 258

    Chapter16 METSProfileandExamples ................................................................ 259

    ExLibrisMETSProfile.......................................................................... 259

    AMETSExampleConformingtotheExLibrisMETSProfile......... 259

    Part VIII Repository Replication and OAIChapter17 RepositoryReplication ......................................................................... 267

    AboutRepositoryReplication .............................................................. 267

    DefiningRepositoryReplications ........................................................ 267

    Replication............................................................................................ 268Set......................................................................................................... 268Targets.................................................................................................. 273Scheduling............................................................................................ 281ReplicationMaintenanceJob ............................................................... 283

    ReplicationManagementFiles ............................................................. 283

    Logs ...................................................................................................... 283Timestamps .......................................................................................... 284Recovery ............................................................................................... 284

    Chapter18 OpenArchivesInitiative(OAI) .......................................................... 285

    AboutOAI ............................................................................................... 285

    OAIPMH ............................................................................................ 285

    OAIDataProvider ................................................................................. 286

    OAIDataProviderConfiguration ....................................................... 286

    oaipubconf.xml ..................................................................................... 286Sampleoaipubconf.xmlFile ................................................................. 288

  • 11

    ProtocolRequestsandResponses ........................................................ 288

    GetRecord .............................................................................................289Identify .................................................................................................290ListIdentifiers .......................................................................................291ListMetadataFormats ...........................................................................294ListSets .................................................................................................295

    HowtoRuntheOAIDataProvider .................................................... 296

    OAIHarvester ......................................................................................... 296

    RunningOAIHarvester ......................................................................297PostOAIHarvest.................................................................................298

    Chapter19 CombiningRepositoryReplicationandOAI...................................299

    BackgroundandPreparation................................................................ 301

    CreatingaSet........................................................................................... 301

    ConfiguringTargets ............................................................................... 302

    SchedulingtheReplicationJob ............................................................. 303

    Chapter20 PublishingDigitalEntitiesviaGoogleScholar...............................307

    Overview.................................................................................................. 307

    RequirementstoEnablePublishingviaGoogleScholar................... 307

    ProperCataloging................................................................................... 308

    MetaTags................................................................................................. 309

    MetadataMetaTags ............................................................................309FullTextMetaTags.............................................................................310

    GoogleScholarReplicationParameters .............................................. 310

    HandlingtheCrawlers...........................................................................311

    DeliveryRuleForDirectLinkFullText .............................................. 312

    Part IX Meditor ConfigurationChapter21 IntroductiontoMeditor ........................................................................315

    ContentandScope.................................................................................. 315

    IntendedAudience ................................................................................. 315

    GettingStarted ........................................................................................ 316

    MeditorInstallation................................................................................ 316

    UsefulSetupfiles..................................................................................317FixingInstallationErrors ....................................................................318

  • Configuration Guide

    12

    UserInterface .......................................................................................... 318

    Chapter22 ClientSetupFiles................................................................................... 319

    MeditoriniFiles...................................................................................... 319

    Common.iniSettings ........................................................................... 320[SearchFind] ......................................................................................... 327[PrintDaemon] ..................................................................................... 328[External] ............................................................................................. 328[Package] .............................................................................................. 330[PrintExecute] ...................................................................................... 331[ATabControl] ...................................................................................... 331[PlainTextPrintout] ............................................................................. 331[ListBoxPrintout]................................................................................. 332Meditor.iniSettings ............................................................................. 332Font.iniSettings.................................................................................. 338Library.iniSettings .............................................................................. 340Print.iniSettings ................................................................................ 340

    LanguageSetup ...................................................................................... 343

    SettinguptheShortcutkeys ................................................................. 343

    SettinguptheformprintmethodTagin.trnfiles ............................ 344

    ImportingUpdatedTables ................................................................... 345

    FloatingKeyboard .................................................................................. 346

    Keyboard.ini ......................................................................................... 346Keyboard.txt ......................................................................................... 348Font.ini ................................................................................................. 350

    Chapter23 GeneralServerSideSettings .............................................................. 351

    DateFormat ............................................................................................ 351

    WithSeparator ..................................................................................... 352WithoutSeparator................................................................................ 352DateRange .......................................................................................... 353

    TimeFormat ........................................................................................... 353

    LogsandReports .................................................................................... 354

    TransactionsLog ................................................................................. 354FormInformationDisplay ................................................................... 354StatisticAnalysisofServerUse........................................................... 354ProductivityReports ............................................................................ 355

    BatchQueue ........................................................................................... 355

  • 13

    MeditorServices ..................................................................................... 355

    SystemErrorsandMessages................................................................. 356

    StaffPrivileges......................................................................................... 356

    Passwords .............................................................................................356DefaultPassword .................................................................................356EnteringPasswords .............................................................................357Timeouts ...............................................................................................357LockPeriods.........................................................................................357FunctionsandSubfunctions ................................................................357DropdownMenus ...............................................................................358

    ColumnHeadings................................................................................... 359

    pc_tab_col.lng.......................................................................................359pc_tab_col.lngandtab_col.dat .............................................................359

    CombiningDiacritics ............................................................................ 360

    ObjectServices ........................................................................................ 361

    Chapter24 MetadataServerSideSettings ...........................................................363

    MetadataDefinitionsLocations ......................................................... 363

    ConfigurationFiles ................................................................................. 364

    md_conf.xml .........................................................................................364md_util_conf.xml .................................................................................365editor_conf.xmlfile ...............................................................................366new_md.xml .........................................................................................368

    MetadataTemplateFiles........................................................................ 368

    CreatingLocalTemplates .....................................................................368CreatingUnitdependentTemplates....................................................369

    MetadataSnippetFiles........................................................................... 372

    UpdatingtheTablesPackage................................................................ 372

    TagInformationFiles ............................................................................. 374

    CheckRoutines ...................................................................................... 375

    ForbiddenErrorsandTriggers ............................................................ 377

    AllowedandDeniedTags..................................................................... 378

    LockingMetadataRecords.................................................................... 379

    LockingPeriodforLockedMetadataRecords ......................................379LockStatusMessage ............................................................................379

  • Configuration Guide

    14

    Chapter25 AddingaNewXMLMetadataSchema ............................................. 381

    NewMetadataScript ............................................................................. 381

    RunningtheScript .............................................................................. 381ViewingtheLogFile ............................................................................ 382

    RootDirectoryforMetadata($unit/md)............................................. 382

    MetadataConfigurationFilemd_conf.xml....................................... 382MetadataUtilityConfigurationFilemd_util_conf.xml................... 383

    MetadataSpecificDirectory............................................................. 383

    EditorConfigurationFileeditor_conf.xml ....................................... 384NewMetadatanew_md.xml.............................................................. 385

    TagsInformationDirectory................................................................... 385

    Java/RepositoryConfiguration............................................................. 385

    RepositoryConfigurationFile............................................................. 386RepositoryIndexingSchema ............................................................... 386

    SiloConfiguration .................................................................................. 388

    SiloHarvestingSchema ....................................................................... 388

    Chapter26 AddANewDublinCoreField ........................................................... 389

    Introduction............................................................................................. 389

    Purpose ................................................................................................... 389

    ProductwideImpact ............................................................................. 390

    AddingaNewDublinCoreField........................................................ 390

    EditingorDeletinganExistingDublinCoreField............................ 396

    Chapter27 SettingupMARCConfigurationFiles.............................................. 399

    MetadataFormats................................................................................... 399

    ValidFields.............................................................................................. 400

    CodesTableSample.............................................................................. 401KeytoCodesTable ............................................................................... 401

    Forms....................................................................................................... 402

    SampleForm#1.................................................................................... 403SampleForm#2.................................................................................... 403KeytoForm .......................................................................................... 404VisualTextDefinitions(UpperandLowerSections).......................... 405InputFieldsDefinitions(UpperSection) ............................................ 406UpperSectionAdditionalInformation .............................................. 408AdditionalValuesSection .................................................................... 409

  • 15

    RecordandFieldDefaults ..................................................................... 410

    RecordLengthLimits ..........................................................................410NewMARCMetadataRecords ..........................................................410ValuesforFixedFields .........................................................................411DefiningSubfields ................................................................................411

    TagInformation ...................................................................................... 412

    BrowseHeadingsofExternalDatabase .............................................. 415

    KeytoTable ..........................................................................................415

    CheckField .............................................................................................. 416

    ALSection ............................................................................................416KeytotheALSection ..........................................................................416Dsection..............................................................................................418

    FixRecord ................................................................................................ 419

    tab_fix ...................................................................................................419Keytothetab_fixTable: .......................................................................420fix_doc.lng ............................................................................................421Keytothefix_doc.lngtable: .................................................................421

    ValidationofaFieldsContents ........................................................... 422

    FieldOccurrencesandDependencies.................................................. 423

    CheckingRoutines.................................................................................. 425

    CheckRecord .......................................................................................425FixedlengthFields ...............................................................................427

    ValidationMessages............................................................................... 431

    Tabledependent....................................................................................431Systemdriven ......................................................................................431

  • Configuration Guide

    16

    Chapter28 AvailableFixProgramsforMeditorConfiguration ....................... 433

    fix_doc_001 .......................................................................................... 433fix_doc_001_prefix_sysno .................................................................... 433fix_doc_001_sysno ............................................................................... 434fix_doc_001_sysno_inv ........................................................................ 434fix_doc_005 .......................................................................................... 434fix_doc_char_conv_z ............................................................................ 434fix_doc_create_035 ............................................................................... 435fix_doc_create_035_1 ........................................................................... 435fix_doc_create_066 ............................................................................... 435fix_doc_create_fmt ............................................................................... 435fix_doc_delete_empty ........................................................................... 435fix_doc_field_lower/fix_doc_field_upper ........................................... 436fix_doc_do_file_08................................................................................ 436fix_doc_fixed_fields .............................................................................. 436fix_doc_ldr_05_d.................................................................................. 437fix_doc_ldr_sta_delete.......................................................................... 437fix_doc_marc21_spaces ........................................................................ 437fix_doc_non_filing_ind ........................................................................ 437fix_doc_punctuation_usm.................................................................... 437fix_doc_sort .......................................................................................... 438fix_doc_space_char............................................................................... 438fix_doc_tab04_(0199) ......................................................................... 439fix_doc_tag_008 ................................................................................... 439fix_doc_tag_008_open_date ................................................................. 439fix_doc_usm_001 ................................................................................. 439fix_doc_usm_222 ................................................................................. 439fix_doc_zero_ldr_00_04 ....................................................................... 439expand_doc_fix_abbreviation............................................................... 440expand_doc_type .................................................................................. 440tab_fix.xml ........................................................................................... 440

    Part X Resource DiscoveryChapter29 ResourceDiscoveryConceptsandDesign ....................................... 443

    InterfaceDesign ...................................................................................... 443

    Design .................................................................................................. 443MainComponents................................................................................ 444

  • 17

    OrientingtheUser .................................................................................. 444

    Toolbar..................................................................................................444EnteringResourceDiscovery...............................................................445

    SearchinginDigiTool............................................................................. 447

    SimpleSearch .......................................................................................447AdvancedSearch ..................................................................................447SearchResults ......................................................................................456RefineaSearch .....................................................................................459PreviousSearches .................................................................................459

    ObjectViewingandDelivery................................................................ 460

    StandardDigiToolViewers ..................................................................460ViewingObjects ...................................................................................460ObjectDownload..................................................................................461

    MySpace .................................................................................................. 463

    eShelf ...................................................................................................463MySearchHistory ...............................................................................464Preferences............................................................................................464

    OracleRankAlgorithm:DigiToolResultsRelevance ....................... 464

    Chapter30 GlobalConfiguration............................................................................465

    SettingUptheSystem ........................................................................... 465

    SearchBases............................................................................................ 469

    Definition .............................................................................................469ConfigurationSiloBases ...................................................................471ConfigurationVirtualBases .............................................................471

    MediaTypes ............................................................................................ 472

    Definition .............................................................................................472Configuration .......................................................................................472

    eShelf ...................................................................................................... 473

    Definition .............................................................................................473GeneralConfiguration .........................................................................474PersonalCollection..............................................................................476

  • Configuration Guide

    18

    Chapter31 SiloConfiguration ................................................................................. 477

    Harvesting ............................................................................................... 477

    Configuration ....................................................................................... 478HarvestingSchemaDataNormalization .......................................... 481SuppressionofChildObjectsfromHarvest/Search............................. 483ChildObjectExceptions....................................................................... 483name = status value= UNSUPPRESSED ............484Runningp_harvest_02service ............................................................ 484

    Indexing ................................................................................................... 485

    DefiningWordBreakingRoutinestab_word_breaking ................... 485SettingUpSiloIndexes........................................................................ 485IndexingServices ................................................................................. 487Runningp_manage_91........................................................................ 487FullTextIndexingFormattedDocument........................................... 488

    GeneralSiloConfiguration ................................................................... 489

    SearchSelectCollection .................................................................... 489Sort ....................................................................................................... 491SearchResultViews ............................................................................. 493RemovingTagRepetition..................................................................... 496

    CombiningFieldsintoOneParagraph................................................ 497

    Enabling/DisablingRank..................................................................... 497DisplayingIdentifierLinks .................................................................. 498URLLinkinMetadata ......................................................................... 499RelevantResourceDiscoveryTables.................................................... 501

    MultipleSilos .......................................................................................... 503

    CreatinganAdditionalSilo ................................................................. 504Harvesting............................................................................................ 505DeletingofObsoleteSilo ...................................................................... 506

    Part XI UI CustomizationChapter32 HTMLConfiguration............................................................................ 511

    TheDigiToolWebApplication............................................................ 511

    BrowserSupportinDigiTool3............................................................ 511SupportedCustomization .................................................................... 512

    DigiToolHTMLPageStructure ........................................................... 512

    ContentsofTemplateFiles.................................................................... 513

  • 19

    ElementsinaDigiToolHTMLPage .................................................... 514

    MetaTags............................................................................................514StyleClasses:rd.css..............................................................................515SharedCode:IncludeFiles ...................................................................515JavaScriptCode ....................................................................................516PlaceholdersandEnvironmentVariables ............................................516

    RulesforHTMLWritingandCustomization..................................... 516

    GeneralRules .......................................................................................516

    RemovingaModule ............................................................................... 517

    UsingtheCascadingStyleSheets(CSS)File....................................... 518

    TheCSSFileComponents....................................................................518TheCSSFileSyntax ............................................................................518WorkingwiththeCSSFile ..................................................................519

    GeneralGuidelinesforEditingHTML................................................ 520

    UsingTables.........................................................................................520CreatingLinkstoPagesExternaltoDigiTool .....................................520UsingImages........................................................................................521UsingForms.........................................................................................521

    CustomizingHTMLPerAdministrativeUnit.................................... 522

    DateFormat ............................................................................................. 522

    Forms........................................................................................................ 522

    StructureoftheForms .........................................................................523

    SFXSetupinDigiTool ............................................................................ 524

    LinktoSFXServerandInstance .........................................................524SFXmapping .......................................................................................524SFXButtons.........................................................................................525

    CharacterSetforSaved/SentRecords.................................................. 525

    Chapter33 InternationalizationTranslatingtheDigiToolInterfaces ...........527

    DigiToolTranslationBasics................................................................... 527

    ListofLanguageCustomizableInterfaces............................................528

    AddNewLanguageScript.................................................................... 528

  • Configuration Guide

    20

    TranslatableTextStrings ....................................................................... 529

    StaticTextStrings ............................................................................... 529DynamicTextStrings......................................................................... 529ErrorMessages.................................................................................... 529Images.................................................................................................. 530UserDataEntry.................................................................................. 530Date ..................................................................................................... 530

    DetectingtheUserLocale...................................................................... 531

    AutomaticLanguageHTTPHeaderDetection .................................. 531InteractiveSelectedbytheUser......................................................... 531UserProfile ......................................................................................... 531

    ResourceDiscoveryLanguageCustomization .................................. 531

    NewLanguageFilesandTables........................................................... 532TranslatingGeneralResourceDiscoveryDisplay.............................. 532TranslateIndexNames:tab00.lng ....................................................... 533ImageFiles............................................................................................ 535Forms.................................................................................................... 535DigiToolUserMessages ...................................................................... 535DeterminingtheUserInterfaceLanguage .......................................... 535LanguageofResourceDiscoveryRecords............................................ 536PDSErrorMessageTranslation........................................................ 538

    Deposit,Approver,Ingest,andCollectionTranslation .................... 539

    JavaTextualStringTranslationResourceBundles .......................... 539MessageKeySyntaxandRules ........................................................... 541UTF8ResourceBundlesandConversiontoASCII .......................... 541DefiningSupportedModuleLanguagesByModule ........................... 542ActivatingtheJavaTranslations ......................................................... 543

    MeditorTranslation ............................................................................... 543

    ClientSideTranslation ...................................................................... 543ServerSideMeditorFileTranslations................................................. 544

    DeleteLanguageScript.......................................................................... 545

    Chapter34 ADMSpecificJavaBasedWebModules ......................................... 547

    Basics ........................................................................................................ 547

    FirstPrinciples ..................................................................................... 547

    ModificationofStyleSheetsandBanner ............................................ 548

    TheOverwritesDirectory .................................................................... 548ActivatingtheOverwriteMechanism ................................................. 549

  • 21

    Part XII Configuring Remote Search Tools and DatabasesChapter35 UniversalGateway ................................................................................553

    Workflows ............................................................................................... 553

    DigiToolMeditorSearchWorkflow .....................................................553DigiToolMeditorBrowseHeadingsWorkflow....................................553UniversalGatewayWorkflow ..............................................................554

    UniversalGatewayCollections ............................................................ 554

    UniversalGatewayConfiguration ....................................................... 554

    GeneralSettings ...................................................................................555Transformations ...................................................................................558

    ExampleofaTargetConfiguration...................................................... 561

    TestCollectionConfiguration............................................................... 561

  • Configuration Guide

    22

    TermTransformationRoutines ............................................................ 563

    Transformationnumber:1 ................................................................... 563Transformationnumber:2 ................................................................... 564Transformationnumber:3 ................................................................... 564Transformationnumber:4 ................................................................... 564Transformationnumber:5 ................................................................... 564Transformationnumber:6 ................................................................... 564Transformationnumber:7 ................................................................... 565Transformationnumber:8 ................................................................... 565Transformationnumber:9 ................................................................... 565Transformationnumber:10 ................................................................. 565Transformationnumber:11 ................................................................. 565Transformationnumber:12 ................................................................. 566Transformationnumber:13 ................................................................. 566Transformationnumber:14 ................................................................. 566Transformationnumber:15 ................................................................. 566Transformationnumber:16 ................................................................. 567Transformationnumber:17 ................................................................. 567Transformationnumber:18 ................................................................. 567Transformationnumber:19 ................................................................. 567Transformationnumber:20 ................................................................. 567Transformationnumber:21 ................................................................. 568Transformationnumber:22 ................................................................. 568Transformationnumber:23 ................................................................. 568Transformationnumber:24 ................................................................. 568Transformationnumber:25 ................................................................. 569Transformationnumber:26 ................................................................. 569Transformationnumber:27 ................................................................. 569

    Chapter36 z39_server .............................................................................................. 571

    OverviewofServices.............................................................................. 571

    InitService ........................................................................................... 571SearchService....................................................................................... 572SortService .......................................................................................... 572PresentService ..................................................................................... 572

    Z39.50ServerServices............................................................................ 572

    SearchService...................................................................................... 572PresentService ..................................................................................... 574

  • 23

    Z39ServerConfiguration ...................................................................... 575

    z39server.conf......................................................................................576z39server_.conf .........................................................................576z39server_elements .............................................................................579

    UserAuthentication ............................................................................... 579

    Runningz39Server ................................................................................ 580

    DefiningaNewBaseforz39Server..................................................... 581

    CheckingNewBases .............................................................................. 581

    Chapter37 z39_gate ..................................................................................................583

    OverviewofServices.............................................................................. 583

    InitService ...........................................................................................584SearchService.......................................................................................584SortService...........................................................................................584PresentService .....................................................................................584ScanService..........................................................................................585

    z39_gateConfiguration.......................................................................... 585

    z39_gate.confContents ........................................................................585z39_gate_.confContents.........................................................586

    Runningz39_gate ................................................................................... 590

    DefiningaNewTargetforz39_gate .................................................... 591

    CheckingNewTargets........................................................................... 591

    Part XIII AppendicesAppendixA HTMLFileList .......................................................................................595

    AppendixB digital_entity.xsd....................................................................................603

    Part XIV Glossary and IndexGlossary ....................................................................................................................615

    Index ....................................................................................................................625

  • Configuration Guide

    24

  • 25August 2012

    Updates to This GuideThisguidecontainsthefollowingupdatessincetheDigiToolversion3.4release:

    UpdatestotheDigiToolConfigurationGuide

    Feature Change Type Chapter LinkPublishingDigitalEntitiesviaGoogleScholar

    NewFeature PublishingDigitalEntitiesviaGoogleScholaronpage 307

    PublishingDigitalEntitiesviaGoogleScholaronpage 307

  • Configuration Guide

    August 201226

  • Part IIntroduction to This Guide

    PartIcontainsthefollowing:

    Section1:IntroductiontotheConfigurationGuideonpage 29

  • Configuration Guide

    28

  • 1

    29August 2012

    Introduction to the Configuration GuideThisintroductiondescribesthecontentsandconventionsoftheDigiToolConfigurationGuide.

    Documentation ConventionsThisguidefollowsstandardtechnicaldocumentationpracticesasoutlinedinExLibrissourcesaswellasexternalmanualsofstyle.

    Inadditiontotypographicalandnamingconventions,thisguideusesaliaspathsratherthanfullpathswheneverpossibletoenablequickerandmoreaccurateexecutionofserverapplicationsandcommands.

    Content and ScopeThisguideprovidesinformationonhowtoconfigurevariouscomponentsoftheDigiToolsystem.ItdiscussesoptionsforfrontendHTMLpagesandJavabasedviewingtoolsaswellaswaysofsettingupaccessrightsforusersandforobjects.Globalandlocalconfigurationsareaddressed,aswellassettingsforSystemAdministratorsandsettingsforpatronendusers.

    Parts of This GuideThisguideconsistsofthirteenparts,asfollows:

    IntroductiontoThisGuideonpage 27

    Thissectionincludes:

    DocumentationConventionsonpage 29

    ContentandScopeonpage 29

    CommonInterfaceFeaturesAcrossWebClientsonpage 30

  • Configuration Guide, Part I: Introduction

    August 201230

    ConfigurationFileManagementonpage 33

    UserManagementonpage 43

    DepositConfigurationonpage 81

    HandlePersistentIdentifiersonpage 117

    IngestConfigurationonpage 141

    DeliveryConfigurationonpage 179

    RepositoryReplicationandOAIonpage 265

    MeditorConfigurationonpage 313

    ResourceDiscoveryonpage 441

    UICustomizationonpage 509

    ConfiguringRemoteSearchToolsandDatabasesonpage 551

    Contentsforeachpartarelistedonthepartscoverpage(usetheabovelinks)aswellasintheguidestableofcontents.

    Common Interface Features Across Web ClientsTheDigiToolmodulessharecommoninterfaceelementsthatwillbediscussedhereandreviewedonlyifneededatotherplacesintheguide.

    Right Header ControlsAllWebbasedclientscontainthecontextsensitivehelpandexitimages.Somealsocontainthelanguage/globebutton.

    Figure 1: Right Header with Standard Controls

    Logging OffOnceauserhasfinishedworkingintheWebclient,theycanlogofffromthemodulebyclickingthedooricon.Aconfirmationboxopenstoconfirmthattheuserwantstologoff.

  • Chapter 1: Introduction to the Configuration Guide

    31August 2012

    Changing the LanguageIfaninterfacehasbeensoconfiguredandsetup,userscanchangethelanguagebyclickingtheglobeChangeLanguagebutton.Availablelanguagealternativesdependonwhatyourinstitutionhassetup.Forinstructions,seeInternationalizationTranslatingtheDigiToolInterfacesonpage 527.

    Context-Sensitive HelpInordertoaidthestaffuserinroutineworkflowsandscenarios,eachwindowcontainsacontextsensitivehelpfilethatcanbeaccessedbyclickingthequestionmarkbuttonlocatedontherighttoolbar.

    Left Header NavigationTheleftheaderofallDigiToolWebclientsdisplaystextlinkstovariousareasandactivitiesofthemodule(seeFigure 2).

    Figure 2: Left Header

    Mostmodulesdisplaytworowsoftextlinks.Thetoprowisthemainlevelandthebottomrowisthesubleveloftheselectedmainlevellink.InFigure 2,forexample,MaintenanceisthemainactivitysetandthesubcategoriesareSubmitanewjob(selected)andJobList.

    Abovethelinks,themoduleisidentifiedtotherightoftheExLibrisDigiToollogo.

  • Configuration Guide, Part I: Introduction

    August 201232

  • Part IIConfiguration File Management

    PartIIcontainsthefollowing:

    Section2:ManagingConfigurationFilesonpage 35

  • Configuration Guide

    34

  • 2

    35August 2012

    Managing Configuration Files

    Introduction

    NOTE:ThisdocumentisintendedforstaffuserswhohaveadministrativeprivilegesforoneormoreadminunitsandwhoarefamiliarwithXML.

    ConfigurationfilesestablishtheinitialsettingsforDigiTool.Thesefilesareusedforserverprocessesandoperatingsystemsettings.TheyarewrittenineitherXMLformat,whichhastheadvantageofawelldefinedsyntaxthatcanbeeasilyvalidatedandverified,orinASCII,lineorientedformat.YoucanviewandeditconfigurationfilesthroughtheDigiToolManagementinterface.

    Thissectionincludes:

    Introductiononpage 35

    AccessingYourConfigurationFilesonpage 36

    FilteringtheFilesListonpage 38

    ChoosingFilesonpage 38

    ModifyingConfigurationFilesonpage 39

    ActivatingConfigurationChangesonpage 39

  • Configuration Guide, Part II: Configuration File Management

    August 201236

    Accessing Your Configuration FilesSteps

    1 InyourWebbrowsersaddressfield,entertheURLsetbyyourinstitution.Bydefault,thisURLishttp://:/mng

    Forexample:http://www.university.com:1801/mng.

    Or

    EnterthegeneralDigiToolURLsetbyyourinstitutionandthenchoosetheManagementinterface.Bydefault,thisURLis:http://:/main

    Forexample:http://www.university.com:8881/main.

    Alogonformopens.

    2 Typeastaffusernameandpassword.

    3 ClickOK.

    Ifyournameandpasswordareauthorized,DigiToolopensthedefaultviewofarepositorysearch.

    4 YoucanalsoenterthemanagementinterfacefromtheDigiToolMeditor:FromtheLaunchbar,clicktheManagementbutton.

  • Chapter 2: Managing Configuration Files

    37August 2012

    5 ClicktheCommontextlinkinthetopheader,thentheEditConfigurationFileslinkbelowit(ifisnotselectedbydefault).

    TheEditConfigurationFilespageopens.

    Figure 3: Configuration Files

    TheEditConfigurationFilespagecontainsaFilesListontheleftandacontenteditorontheright.Whenyoudrilldowntoaclickableentrysuchasatemplateintheleftcolumn,thefileopensintherightpaneeditorwithadditionalbuttons

  • Configuration Guide, Part II: Configuration File Management

    August 201238

    availableforediting.ClickingtheEditbuttononthispanereloadsthefileaseditabletext(seefigurebelowandfollowingdiscussion).

    Figure 4: Configuration File Editor

    Filtering the Files ListTheFilesListintheleftcolumncontainsgroupsofelementswhichcanbeexpandedtoshowallfilesanddirectoriesthatbelongtoaspecificgroup.YoucanfiltertheseelementsbyselectingvaluesinthedropdownfieldabovetheFilesList.Youcaneitherchooseagroupofelements(forexample,DepositrelatedConfiguration)orthewordAll.Ifyouchooseaspecificgroupofelements,onlyelements(files/directories)thatbelongtothatgroupwillbedisplayed.Otherwise,allelementsinconfigurationfilesappear.

    Thegroupsshowninthefilterdependonyourstaffuserprofile.Ifyouareanadministrativeuser(ADMIN),youwillseeinthegrouplistallgroupsofthetypecommon.IfyouarenotanADMIN,youwillseealistofallgroupswithtypeunit.Directoriesandfilesresideundertheadministrativeunittowhichtheyareassigned.

    Choosing FilesIftheentryinthelistisafile,clickingitopensthefilename,contents,andanEditbuttonintherightpane.Youcanscrolltoviewallpartsofthefile.

  • Chapter 2: Managing Configuration Files

    39August 2012

    Iftheentryinthelistisadirectory(containingconfigurationfiles),clicktheplussignbuttonbesideittoopenthelistofallfilesinthatdirectorybelowthedirectoryname.Tocollapsethelist,clicktheminussignbutton.(SeeFigure 4onpage 38foranopendirectorylist:DepositAccessRightsMDTemplates.)

    Whenthelistoffilesinadirectoryisdisplayed,youcanclickanyfilenametodisplayitscontentasdescribedabove.

    Adirectorycanonlyholdfilenames;itcannotcontainsubdirectories.

    Modifying Configuration FilesIfyouselectanXMLfilefromtheleftcolumn,itopensbydefaultwithallthenodesexpandedintherightpane.Youcanclosethenodesbyclickingtheminussign(s)intheXMLrows.

    Click the Editbuttontodisplayaneditableversionofanyfileyouselect.

    Threebuttonsaredisplayedabovethetextarea:

    Save:savesthecurrenttexttothefile.Validationisperformedusingthevalidatorclass.Thefileisreloadedontotheapplicationserverifauto_reload_after_saveistrueforthisfile.Inthecaseofavalidationerror,anerrormessageopensintherightpaneandabackbuttonenablesyoutogobacktoeditthefile.

    Reload:restoresthefiletothelastsavedversiononthedisk.(Cancelsanyunsavedchanges.)

    Cancel:exitstheeditingsessionwithoutchanges.

    Ifyouchooseadirectory,andthenafile,theEdit,DeleteandDuplicatebuttonswillbedisplayed.

    Toplaceyourcursorinthetextareacontainingthefilescontent,clickEdit.

    Toopenadialogboxaskingforanewfilename,clickDuplicate.Edittheexistingfilenametomakeanewname,andclickSave.

    Toremovethisconfigurationfilefromthisdirectory,clickDelete.

    Activating Configuration ChangesInorderforconfigurationchangestotakeeffectinthesystem,runthefollowingjobsforthecorrespondingfileschanged.

  • Configuration Guide, Part II: Configuration File Management

    August 201240

    NOTE:Atypicalinstallationplacestherelevantscriptsinthejbindirectoryatthefollowingpath: /exlibris/dtl/j3_1/digitool/home/system/binoralias:$jdtlh/system/bin.

    Table 1. Jobs to Run for Configuration File Changes

    For Changes To Run the Followingrepository_stream_handler.xml reloadrepositoryconfiguration

    mimetypes_configuration.xml reloadrepositoryconfiguration

    repository_indexing_schema.xml reloadrepositoryconfiguration

    repository_jobs_configuration.xml reloadrepositoryconfiguration

    mets_configuration.xml reloadrepositoryconfiguration

    pi_profiles_rules.xml reloadrepositoryconfiguration

    pi_publishing_rules.xml reloadrepositoryconfiguration

    repository_replication.xml reloadrepositoryconfiguration

    mets_view_profile.xml reloadrepositoryconfiguration

    globalpropertiesdefinitions jbossshutdown,set_globals.sh,jbossstartup

    mime.typesdefinitions none

    templateofrepository_configuration.xml reloadrepositoryconfiguration

    shutdownjboss

    runset_globals.sh

    startupjboss

    digital_entity_urls_template.xml reloadrepositoryconfiguration

    Silodefinitions RefertoResourceDiscoveryandMeditorconfigurationsections

    LocalSystemSettings restartDigiTool

    GeneralwwwServerSettings(www_server.conf)

    start_w

    unit_configuration.xml reloadrepositoryconfiguration

    Peradminunitconfigurationfiles(exceptunit_configuration.xml)

    allJavaside(deposit/ingestsettings,de/mdtemplates,processinginstructions)requirereloadrepositoryconfiguration.

    PeradminunitnonJavasideconfigurationfiles(suchascatalogingconfiguration)

    RefertoResourceDiscoveryandMeditorconfigurationsections

  • Chapter 2: Managing Configuration Files

    41August 2012

  • Configuration Guide, Part II: Configuration File Management

    August 201242

  • Part IIIUser Management

    PartIIIcontainsthefollowing:

    Section3:UserManagementonpage 45

  • Configuration Guide

    44

  • 3

    45August 2012

    User Management

    ThefollowingsectionoutlinesthedifferentusersandprivilegesavailableinDigiTool.Thedocumentalsoprovidessomebasicworkflowsinvolvinggeneralmanagement(creation,update,deletion)ofusersandtheirprofiles.

    Staff UsersThissectionconsistsofthesetopics:

    StaffUserDefinitionsforManagingotherStaffUsersonpage 46

    ManagingStaffUsersonpage 47

    StaffusersofDigiToolhaveauthorizedaccesstothesystemthatenablesthemtoperformvariousfunctions,dependingontheirlevelofaccess.

    Astaffusersdetailsaremanagedlocallyonly(fromtheMeditorclient)byotherauthorizedstaffusers.ADMINstaffuserswithappropriateprivilegescanmanageallstaffusersinthesystem,whilenonADMINstaffuserscanonlymanageotherstaffuserswithintheirAdministrativeunit.

    Thissectionincludes:

    StaffUsersonpage 45

    StaffPrivileges/AccessRightsonpage 50

    Patronsonpage 53

    WebProfilesonpage 60

    DepositorsandDepositProfilesonpage 65

    ApproversandApproverProfilesonpage 73

    StaffPrivilegeListonpage 75

  • Configuration Guide, Part III: User Management

    August 201246

    NOTE:ThedefaultADMINuserwithprivilegestomanageotherusersisnamedDIGITOOLandshouldnotbeeraseduntilanotherADMINuserexists.

    Staff User Definitions for Managing other Staff UsersTheprivilegesforstaffuserstomanageotherusersaredefinedintheDAT01systemunitandrelatetothefunctionsinFigure 5:

    Figure 5: Staff Definitions for Managing Other Staff

    StaffUsersRelatestospecificprivilegesinvolvedwithmanagingotherStaffusers.

    WebProfilesRelatestomanagementofWebprofilesofpatrons.

    PatronUsersRelatestomanagementofpatrons.

    NOTES:AllowingastaffusertheprivilegetothegloballysetprivilegesforAllFUNCTIONS(nonuser)doesnotprovidecoverageforthethreeuser

  • Chapter 3: User Management

    47August 2012

    managementrelatedfunctionsnotedabove.OnlywithinthesespecificprivilegeswillAllsubfunctionsapply.

    UnitsotherthanDAT01containthelistrelatedtousermanagementfunctions.However,thefunctionsrelatedtousermanagementinotherunitshavenoimpact.ThegivenprivilegesforusermanagementrelatetoDAT01only.

    Managing Staff UsersToaccesstheStaffUsersListandPrivileges,youmustbeloggedontotheMeditorasastaffuserwiththeappropriateprivilegeformanagingotherstaffusers.Thenfollowthemenu:DigiTool>Administration>StaffPrivileges.Thefollowinglistboxopens.

    Figure 6: Staff Privileges List Box

    NOTE:Staffusersandtheirassociatedprivilegesaremanagedtogether.

  • Configuration Guide, Part III: User Management

    August 201248

    Staff Users ListThisbox(Figure 6onpage 47)liststheStaffusersinthesystem.Toselectauser,scrollthroughthelist.Alternatively,enterpartoftheusernameinthespaceprovidedandpressENTER.Thelistwillautomaticallyscrolltothefirstmatchingusername.

    NOTE:InordertodisplayonlyuserswiththesameUserUnitastheconnecteduser,selectthecheckboxatthetopofthelistbox.Ifthecheckboxisnotselected,usersforallunitswillbedisplayed.

    ThebuttonsontherightsideofthewindowwillbeactivatedonlywhenthehighlighteduserinthelistisassignedtothesameUnitastheconnecteduser.StaffuserswithADMINastheirUserUnitwillseeallStaffusers.

    Table 2. Staff Privileges List - Actions

    To Do ThisAddanewstaffuser Fromthestaffuserlist,clickNewUser.An

    emptyUserPasswordInformationformappears.

    Modifyastaffuser Fromthestaffuserlist,selectauserandclickModifyUser.TheappropriateUserPasswordInformationformappears.Youcanmodifyanyfield.

    Duplicateastaffuser Fromthestaffuserlist,selectausertoduplicateandclickDuplicateUser.TheappropriateUserPasswordInformationformappears.Youcanmodifyanyfield.

    Deleteastaffuser Fromthestaffuserlist,selectausertodeleteandclickDeleteUser.

    WARNING!DonotdeletethedefaultDIGITOOLStaffuserbeforeyouhavecreatedanotherADMINuser.

    Modifyastaffusersaccessrights Fromthestaffuserlist,selectauserandclickAccessRights.SeeStaffPrivileges/AccessRightsonpage 50formoredetailsonthespecificdefinitionsavailableforstaffprivileges.

    Viewasummaryofastaffusersdefinedprivileges

    Fromthestaffuserlist,selectauserandclickSummary.TheoutputsummarydenotesallowedanddeniedprivilegesforeachfunctionbyAdministrativeunit.

  • Chapter 3: User Management

    49August 2012

    User Password Information FormTheUserPasswordInformationformopenswhen,fromtheStaffPrivilegeslist,youelecttocreateanewuserortomodifyorduplicateanexistingstaffuser.

    Figure 7: User Password Information Form

    Table 3describesthefieldsontheUserPasswordInformationform.Table 3. User Password Form - Fields

    Field DescriptionUserName Theusernameistheuniquestringbywhichthesystem

    identifiestheuser.Theusernamemaybeupto10alphanumericcharacters.

    UserUnit TheAdministrativeunittowhichthestaffuserwillbeassociated,forexample,DTL01,DTL02,ADM01,andsoon.Additionally,astaffusermaybeanAdministrator,wherebythedefinedUserLibrary(unit)wouldbeADMIN.

    Password EnterapasswordfortheStaffuserupto10alphanumericcharacters.Thepasswordyouenterwillnotbedisplayed.

    EditorLevel ThisinformationisusedinrelationtoMetadatarecords.WhenanMDrecordiseditedandsavedontheserver,thelevelofthecatalogerisassignedtotherecord.Inorderforsomeoneelsetoupdatetherecord,thatusermusthavealevelequaltoorhigherthanthelevelassignedtotherecord.Notethatthehigherthelevel,thegreatertheaccess.(Forexample,level99canseeeveryrecord.)

  • Configuration Guide, Part III: User Management

    August 201250

    NOTE:Allnewlyaddedusersneedtohavetheirprivilegesaddedmanually.

    Staff Privileges/Access RightsEachstaffuserhasaprofileorasetofprivilegesthatdefinestheirauthorizationstatusfordifferentstafffunctionsperadministrativeunit.Everyprivilegerepresentsasetoffunctionsgroupedbytopicthatcanbeeitherallowedordenied.

    ADMINstaffuserswithappropriateprivilegescanmanageallstaffusersinthesystem,whilenonADMINstaffusersmayonlygainprivilegetomanageotherstaffuserswithintheirAdministrativeunit.

    Thissectionconsistsofthefollowingtopics:

    UsersAccessRightsonpage 50

    ManagingStaffAccessRightsonpage 52

    StaffAdministratorsSystemAdministratorFunctionsonpage 52

    User's Access RightsWhenyouclicktheAccessRightsbutton,thefollowinglistboxopens.

    Coll.Mng.Group Thisisanoptionalsubsettingforastaffusertoapplyfurtherownershipoveracollectionfromthecollectionmanagementmodulebeyondadminunitfordefiningspecificsubcollectionsthatmayonlybeeditedbyotherstaffmemberswithnotonlythesameunit,butalsothesameCollectionManagementgroupassociation.ADMINuserswithrightsintheadminunitcanupdateanyownedcollection.Additionally,anyuserwithRootPermissionsforCollectionManagementwillbeabletoeditanycollectionwithintheiradministrativeunit.

    Cat.OWNID NOTINUSE

    Cat.OWNPermission

    NOTINUSE

    Table 3. User Password Form - Fields

    Field Description

  • Chapter 3: User Management

    51August 2012

    Figure 8: Access Rights from Staff Privileges Dialog Box

    Thisboxliststheunitstowhichtheselectedstaffusercanbeassignedrights.ThelistisdeterminedbytheentryintheUserUnitfieldontheUserPasswordInformationform.IftheUserUnitfieldonthatformcontainsaunittypethatissharedamongotherunits,thenallunitsofthattypeappearonthislist..

    Forexample,inFigure 8,staffuserDTL02withinUserUnitDTL02hasDTL02,GEN01,andDAT01aspotentialunitstobeassignedaccess.

    ThePASlineinthe./dtle/tab/library_relationconfigurationtabledefineswhichunitsareincludedinthesphereoftheUnit.Forexample:

    PASDTL02GEN01DAT01

    NOTE:StaffuserswithADMINastheiruserunitwillhaveallunitsavailableforprivilegestobeassignedtothem.

  • Configuration Guide, Part III: User Management

    August 201252

    Managing Staff Access Rights

    To assign access rights to a user

    1 HighlightthenameontheStaffUserslistandclickAccessRights.AccessRightsareassignedforeachAdministrativeUnitseparately.

    2 SelecttheUnitforwhichyouwouldliketodefineaccessrightsandclickOK.

    ThefollowingPrivilegelistopens:

    Figure 9: Access Rights Details

    Allowedprivilegesaredenotedbyaredcheck.

    Deniedprivilegesaredenotedbyaredex.

    3 EditthestaffusersprivilegesbyselectingfunctionsandclickingAllowedorDeniedasappropriate.TodeletepreviouslydefinedAllowedorDeniedprivileges,selectthedesiredfunctionandclickDelete.

    Staff Administrators System Administrator FunctionsStaffuserswiththeiruserunitsetasADMIN(superuser)canbedefinedtomanageSystemAdministratorrelatedfunctionsoftheDigiToolrepository.Functionssuchasrepositorystoragerules,delivery/viewerrules,common

  • Chapter 3: User Management

    53August 2012

    tables,andsoon,willbeavailablefromtheWebmanagementmoduleforADMINuserswithappropriateprivilegeintheREP00(repository)systemunit.

    AsystemadministratorthedefaultsystemAdministratorisMNGROOTmayhavethefollowingprivilegesintheREP00unit.

    Figure 10: MNGROOT Access Rights

    Eachunithasitsownlis