Customer Guide To Primo Documentation

Customer Guide to Primo
Documentation
Version 4.x
Ex Libris Confidential
CONFIDENTIAL INFORMATION
TheinformationhereinisthepropertyofExLibrisLtd.oritsaffiliatesandanymisuseorabuse
willresultineconomicloss.DONOTCOPYUNLESSYOUHAVEBEENGIVENSPECIFIC
WRITTENAUTHORIZATIONFROMEXLIBRISLTD.
Thisdocumentisprovidedforlimitedandrestrictedpurposesinaccordancewithabinding
contractwithExLibrisLtd.oranaffiliate.Theinformationhereinincludestradesecretsandis
confidential.
DISCLAIMER
Theinformationinthisdocumentwillbesubjecttoperiodicchangeandupdating.Pleaseconfirm
thatyouhavethemostcurrentdocumentation.Therearenowarrantiesofanykind,expressor
implied,providedinthisdocumentation,otherthanthoseexpresslyagreeduponinthe
applicableExLibriscontract.ThisinformationisprovidedASIS.Unlessotherwiseagreed,Ex
Librisshallnotbeliableforanydamagesforuseofthisdocument,including,withoutlimitation,
consequential,punitive,indirectordirectdamages.
Anyreferencesinthisdocumenttothirdpartymaterial(includingthirdpartyWebsites)are
providedforconvenienceonlyanddonotinanymannerserveasanendorsementofthatthird
partymaterialorthoseWebsites.ThethirdpartymaterialsarenotpartofthematerialsforthisEx
LibrisproductandExLibrishasnoliabilityforsuchmaterials.
TRADEMARKS
ExLibris,theExLibrisbridge,Primo,Aleph,Alephino,Voyager,SFX,MetaLib,Verde,
DigiTool,Preservation,Rosetta,URM,ENCompass,EndeavoreZConnect,WebVoyge,Citation
Server,LinkFinderandLinkFinderPlus,andothermarksaretrademarksorregistered
trademarksofExLibrisLtd.oritsaffiliates.
Theabsenceofanameorlogointhislistdoesnotconstituteawaiverofanyandallintellectual
propertyrightsthatExLibrisLtd.oritsaffiliateshaveestablishedinanyofitsproducts,features,
orservicenamesorlogos.
Trademarksofvariousthirdpartyproducts,whichmayincludethefollowing,arereferencedin
thisdocumentation.ExLibrisdoesnotclaimanyrightsinthesetrademarks.Useofthesemarks
doesnotimplyendorsementbyExLibrisofthesethirdpartyproducts,orendorsementbythese
thirdpartiesofExLibrisproducts.
OracleisaregisteredtrademarkofOracleCorporation.
UNIXisaregisteredtrademarkintheUnitedStatesandothercountries,licensedexclusively
throughX/OpenCompanyLtd.
Microsoft,theMicrosoftlogo,MS,MSDOS,MicrosoftPowerPoint,VisualBasic,VisualC++,
Win32,
MicrosoftWindows,theWindowslogo,MicrosoftNotepad,MicrosoftWindowsExplorer,
MicrosoftInternetExplorer,andWindowsNTareregisteredtrademarksandActiveXisa
trademarkoftheMicrosoftCorporationintheUnitedStatesand/orothercountries.
UnicodeandtheUnicodelogoareregisteredtrademarksofUnicode,Inc.
GoogleisaregisteredtrademarkofGoogleInc.
iPhoneisaregisteredtrademarkofAppleInc.
CopyrightExLibrisLimited,2013.Allrightsreserved.
Documentreleased:December15,2013
Webaddress:http://www.exlibrisgroup.com
Table of Contents
Chapter1
PrimoDocumentation ...............................................................................5
PDFDocuments ..........................................................................................5
GeneralInformation .................................................................................5
ImplementationandInstallationInformation .........................................6
StaffUserInformation .............................................................................6
SystemAdministratorInformation..........................................................7
OnlineDocumentation...............................................................................7
FrontEndOnlineHelp ............................................................................7
BackOfficeOnlineHelp...........................................................................8
APIDocumentation....................................................................................9
DocumentationFeedback ........................................................................10
Glossary
.....................................................................................................................11
December 15, 2013
3
Customer Guide to Primo Documentation

Table of Contents
December 15, 2013

1
Primo Documentation
ThisguidedescribesthedocumentationthatisavailablewithPrimo3.0and
explainsthemainpurposeofeachdocumentationcomponent.
Thissectionincludes:
PDFDocumentsonpage5
OnlineDocumentationonpage7
APIDocumentationonpage9
DocumentationFeedbackonpage10
PDF Documents
AllofthePrimodocumentsareavailableinPDFformatviatheExLibris
DocumentationCenter.
ThePrimodocumentationsetisorganizedintothefollowingcategories:
GeneralInformation,ImplementationandInstallationInformation,StaffUser
Information,SystemAdministrationInformation.
General Information
Thiscategorycontainsthefollowingdocuments:
PrimoVersionHighlightsThisdocumentdescribesthechangesand
enhancementsmadetoPrimoforthecurrentrelease.Thisguideshouldbe
readpriortoupgradingtothisversionofPrimo.
CustomerGuidetoPrimoDocumentation(thisdocument)Thisdocument
describesthedocumentationthatisavailableforPrimo,howitcanbe
accessed,andhowitshouldbeused.
December 15, 2013
5

Chapter 1: Primo Documentation
Implementation and Installation Information

RequirementsforPrimoInstallationThisguidedescribestherequirements
forthePrimoinstallation.Theguideshouldbereadbeforepurchasingand
installingPrimotoensurethatyoursystemcomplieswiththeappropriate
softwareandhardwarerequirements.
PrimoInstallationRequestFormInthisform,thecustomerspecifiesthe
followingdetailsthatExLibrisrequirespriortotheinstallation:Primo
serverlogininformation,serverspecifications,existingdatabase
information,firewallsettings,authorizations,andinstallationcontacts.
PrimoSizingRequestFormInthisform,thecustomerspecifiesthesizing
informationthatExLibrisrequirespriortoaninstallationoranupgradeof
Primo.
RequirementsforUpgradingPrimoThisguidedescribestherequirementsfor
upgradingtothisversionofPrimo.Theguideshouldbereadbefore
upgradingPrimotoensurethatyoursystemhastheappropriatesoftware
andhardware.
PrimoVersionUpgradePackagePreparationsandHighlightsThisguide
describestheupgradetothecurrentversionofPrimoprocessandcontains
thenecessarycheckstomakesurethatyourPrimoinstallationisreadyfor
theupgrade.
PrimoUpgradeRequestFormInthisform,thecustomerspecifiesthe
followingdetailspriortotheupgrade:Primoserverlogininformation,
serverspecifications,existingdatabaseinformation,firewallsettings,
authorizations,andinstallationcontacts.
PrimoServicePackInstallationGuideThisguidedescribestheSPUtilityand
theprocessusedtoincludedefectfixesandenhancementsforPrimoduring
thecurrentrelease.
Staff User Information

PrimoOnlineEndUserHelpThisguidedescribeshowtousethemain
functionsintheFrontEnduserinterface.
PrimoBackOfficeGuideThisguidecontainsinstructionsonhowtousethe
BackOfficeforconfiguringPrimosFrontEnd,monitoringPrimosstatus,
andconfiguringthePublishingPlatformpipeflow.Thisguideisused
duringtheinitialandongoingconfigurationofthesystem.Itisalsousedfor
implementingadvancedconfigurationelements.
PrimoTechnicalGuideThisguideprovidesmoreadvancedinformation
aboutthePrimosystem,includingthePNXrecord,theduplication
December 15, 2013


detectionprocess,FRBRization,customizingPrimosuserinterface,
linguisticfeatures,andmappingtothenormalizationrecord.
PrimoInteroperabilityGuideThisguideprovidesthecustomerwithspecific
configurationinformationforthePrimosystemwhenusingPrimoin
conjunctionwithotherExLibrisproducts.Theguidecontainsconfiguration
informationsuchasuserauthentication,harvestingdata,harvesting
availabilityforILSsystems,linkingtodeliverysystems,andremotesearch
forMetaLib.
System Administrator Information

Thiscategorycontainsthefollowingdocument:
PrimoSystemAdministrationGuideThisguideprovidesadetailedtechnical
overviewofthePrimosystemanditscomponents.Inaddition,theguide
containsinstructionsonhowtoperformsystemadministrativetasks,
including:startingandstoppingthesystem,performingsystemcleanup,
accessingreportsandlogfiles,andmanagingthePrimodatabase.
Online Documentation
Primocontainstwoonlinehelpsystems:onefortheFrontEnd(FE)andonefor
theBackOffice(BO).
Front End Online Help

TheFrontEnd(FE)onlinehelpdescribeshowtosearchforlocalandremote
records,manageinformationthatyouwanttosaveinyoureShelfbasket,and
useotherfeaturesavailableintheFE.
ToaccesstheFEonlinehelp,selectHelpinPrimosFE.
December 15, 2013
7

Figure 1: Primo Front End Online Help
Back Office Online Help

TheBackOffice(BO)onlinehelpcontainsthesameinformationthatisprovided
inthePrimoBackOfficeGuideinacontextsensisitiveformat,fromtheBOtools
andwizards.Italsoallowsyoutosearchandviewthefollowingguides:
PrimoInteroperabilityGuide
PrimoTechnicalGuide
PrimoSystemAdministrationGuide
PrimoHighlights
PrimoServicePackInstallationGuide
ToaccesstheBOonlinehelp,selectHelpinPrimosBO.
December 15, 2013


Figure 2: Primo Back Office Online Help
Tofindtopicsintheonlinedocumentation,youcanusethefollowingmethods:
ContentstabClickatopicfromthelist.
IndextabClickNumericsoraspecificlettertodisplaytheindexitemsthat
beginwithanumberoraspecificletter.
SearchtabEnterasearchtermandthenclickGOtodisplaythesearch
results.
API Documentation
ThePrimoopeninterfacepagesinELCommonsdescribetheapplicationsand
commandsthatyoucanusetoenhanceormodifyPrimosfunctionalityinthe
BackOfficeandtheFrontEnd.
ToaccessthisdocumentationinELCommons,enterthefollowingURLina
browser:
http://www.exlibrisgroup.org/display/PrimoOI/Home
Logonwiththeusername/passwordthathavebeenprovidedtoyoubyEx
Libris.
December 15, 2013
9

Documentation Feedback
ExLibrisisinterestedinimprovingitsdocumentationandwelcomesyour
commentsandsuggestions.Tosubmitcommentsbyemail,pleasesendyour
messageto:
doc_requests@exlibrisgroup.com
10
December 15, 2013

Glossary
ThissectioncontainsaglossaryoftermsusedintheExLibrisPrimosystem.
Alerts
Youcansaveasearchquery,andhavethesearchsettobe
performedautomatically.Analertnotifiesyouifthereare
anynewsearchresults.
Availability pipe
Theavailabilitypipechecksforavailableupdatesseveral
timesthroughouttheday.
Availability text
ThistextisdeterminedbyPrimo.Itappearsnexttotheitem
nameandindicatestotheusertheavailabilityofthe
resource.
Back Office
TheuserinterfaceandprogramsthatmanagethePublishing
Platform.
Basic Search
AconfigurabletileintheViewswizard.Theuserusesthis
tiletosearchforaspecificitem.
Brief Results
AconfigurabletileintheViewswizard.Aftertheuser
searchesforaspecificitem,theresultsappearinthistile.
Bulks
Thepublishingpipeprocessrecordsingroupsofrecords
thatarecalledbulks.Bydefault,thebulksizeis1000records.
Data source
ThedatasourcefromwhichthePublishingPlatform
harvestsrecords.Asinglesourcesystemmaycontainseveral
datasources.Forexample,intermsofSFX,Primoharvestsa
singleSFXinstance.AsingleSFXinstallationmayinclude
severalinstances(thatis,datasources).InAlephand
Voyager,everybibliographicdatabaseisaseparatedata
source.AsingleinstallationofAlephorVoyagermay
includeseveralbibliographicdatabasesthatareharvestedby
Primo.
December 15, 2013
11

Glossary
Delivery restricted
scopes
Restricteddeliveryscopesindicateaccessrestrictionsfor
onlineresources.
Double metaphone
Thedoublemetaphonesearchalgorithmisaphonetic
algorithmandisthesecondgenerationofthemetaphone
algorithm.Itiscalleddoublebecauseitcanreturnbotha
primaryandasecondarycodeforastring.Forexample,
encodingthenameSmithyieldsaprimarycodeofSM0
andasecondarycodeofXMT,whilethenameSchmidt
yieldsaprimarycodeofXMTandasecondarycodeofSMT.
BothhaveXMTincommon.
E-shelf
EshelfletsyousavesearchresultsinyourBasket.
Facets
AconfigurabletileintheViewswizard.Thetileopens
relevantlinksthatmightinteresttheuser,determinedfrom
thesearchthatwasmade.
Institution
TheinstitutionisacentraladministrativeconceptinPrimo.
Usersandresourcesbelongtoinstitutions.
Main pipe
ThemainILSpipeisgenerallyrunduringthenightand
includesallupdatestobibliographicrecordsandrelated
holdingsandauthorities.
Metaphone
Metaphoneisaphoneticalgorithmforindexingwordsby
theirsound,whenpronouncedinEnglish.Thealgorithm
produceskeysasitsoutput.Similarsoundingwordsshare
thesamekeysandareofvariablelengthinthemetadata
form.
n-gram
Anngramisasubsequenceofnitemsfromagiven
sequence.ngramsareusedinvariousareasofstatistical
naturallanguageprocessingandgeneticsequenceanalysis.
Theitemsinquestioncanbeletters,words,orbasepairs,
accordingtotheapplication.
Normalization
mapping set
Thesetofnormalizationrulesthatconvertsourcerecordsto
thePNX.
12
December 15, 2013


Glossary
Normalization rule
sets
Normalizationrulesareappliedtothesourcedata.These
rulesareusedtotranslatethedatasourceintoaPNXformat.
PDS
ThePatronDirectoryServiceisusedwithallExLibris
productsasauserauthenticationsystem.
Persistence layer
AnOracledatabasethatispartofthepublishingplatformin
whichPNXrecordsarestoredbeforetheyareretrievedby
thesearchengine.
Pipe run
Everyexecutionofapublishingpipeiscalledapiperun
Pipes
Thepipeisthesetofstepsthatthesourceinformationgoes
throughbeforebeingturnedintothePNXrecord.
PNX
ThePrimonormalizedXMLformat.Thisisthecommon
formattowhichallsourcerecordsareconverted.
PNX record
PrimonormalizedXMLrecord.Thesourcerecordis
translatedtothisformatandloadedintothePrimodatabase.
Publishing pipe
WithinthePublishingPlatform,PNXrecordsarecreatedby
publishingpipes.Inprinciple,everydatasourcehasitsown
pipewithitsownnormalizationmappingset.
Restricted search
scopes
Bydefiningrestrictedsearchscopes,youcanrestrict
discoveryofgroupsofrecordstospecificusers.
Scopes (Views)
Scopeisageneralconceptthatisusedtocreategroupsof
resources.Primohasthreetypesofscopes:
Searchscopes
Restrictedsearchscopes
Restricteddeliveryscopes
Thetermscopeisalsooftenusedtorefertosearchscopes,
whicharedefinedperview.
December 15, 2013
13

Glossary
Search scopes
Searchscopesaredefinedperviewanddefineagroupof
recordthatcanbesearchedtogether.Therearetwotypesof
searchscopes:
AlocalscopeisasubsetwithinthePrimorepository.The
defaultistheentirelocalrepository.
Aremotescopeisalistofrecordsinaremotelocation
outsidethePrimorepository.
Similar items
Youcancreateasearchforsimilaritems.Similaritems
createsasearchbasedontheauthoroftheitemfromthe
previoussearch.
Slice
ThePrimoSearchEnginesupportsmultipleslicestoreduce
retrievaltimeforverylargedatasets.
Source record
Theindividualrecordfromthedatasourcethatisconverted
tothePrimonormalizedrecord(thePNX).
Source system
ThesystemfromwhichthePublishingPlatformharvests
recordsforexample,Aleph,Voyager,andSFX.
Tagging
Userscanaddreviewsandkeywordstoanyitem.
View
TheViewisthePrimouserinterface.Youcandefineoneor
moreview.Everyviewcanhaveadifferentlookandfeel
andlistofsearchscopes.
14
December 15, 2013


Customer Guide To Primo Documentation

Transféré par

Informations du document

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Customer Guide To Primo Documentation

Transféré par

Droits d'auteur :

Formats disponibles

Customer Guide to Primo

December 15, 2013