Primo Deep Links Rael Elstein Primo Tier 2 Support Analyst
Copyright Statement All of the information and material inclusive of text, images, logos, product names is either the property of, or used with permission by Ex Libris Ltd. The information may not be distributed, modified, displayed, reproduced in whole or in part without the prior written permission of Ex Libris Ltd. TRADEMARKS Ex Libris, the Ex Libris logo, Aleph, Alma, SFX, SFXIT, MetaLib, DigiTool, Verde, Primo, Voyager, MetaSearch, MetaIndex and other Ex Libris products and services referenced herein are trademarks of Ex Libris, and may be registered in certain jurisdictions. All other product names, company names, marks and logos referenced may be trademarks of their respective owners. DISCLAIMER The information contained in this document is compiled from various sources and provided on an "AS IS" basis for general information purposes only without any representations, conditions or warranties whether express or implied, including any implied warranties of satisfactory quality, completeness, accuracy or fitness for a particular purpose. Ex Libris, its subsidiaries and related corporations ("Ex Libris Group") disclaim any and all liability for all use of this information, including losses, damages, claims or expenses any person may incur as a result of the use of this information, even if advised of the possibility of such loss or damage. Ex Libris Ltd., 2013 Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary What Is a Deep Link? A deep link is an external URL link to Primo search. Results are returned in a Primo front end. The link is intended to perform only the configured functions of the specified view. Deep links are documented in the Ex Libris Developer Network: https://developers.exlibrisgroup.com/primo/apis/deeplinks A deep link is not to be confused with deep search. Not to be confused with Deep Search API searches (X-service, web-service) the searches are not primo based and not related to the Primo application results retrieved with XML (or XML wrapped with Soap) Deep Link Types Brief Search dlSearch.do Full View dlDisplay.do
Get eShelf dlBasketGet.do Find Databases Special parameters for dlSearch.do Add to my Account login.do & myAccountMenu.do Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary Type of Deep Link: Brief Search
Most common deep link Is used to create search boxes Similar to a standard front-end search Also called dlSearch.do search Can be used for searches and for applying facets in a single link - Behavior and features may change with Service Packs before 4.6 permalink was not available; Permalink using dlDispaly.do (created automatically) - Building a Brief Search Deep Link
Always compare to the same search performed in the front end Parameters should be separated with & Required parameters: institution vid query search_scope* tab* onCampus* * Mandatory since Primo 4.5 After 4.5 Search_scope is mandatory (replaces the loc) Search_scope name should be taken from the BO Building a Brief Search Deep Link - Examples
Brief search with record ID: Brief search with Facet: hau_aleph Building a Brief Search Deep Link - Examples
Brief search with record ID: hau_aleph Building a Brief Search Deep Link - Examples
Brief search with Facet: hau_aleph Building a Brief Search: Query
query parameter: Required parameter Combines three arguments Arguments should be separated by a comma &query=,, Multiple query parameters can be used to invoke AND search argument: Field names used by search engine section in PNX Possible values: any &query=any,contains,motion+picture Regular fields, from Basic Index Fields code table &query=rid,exact,PRIMO1234 Facet fields, from Facets Code Fields code table &query=facet_creator,exact,roger+ebert Regular fields from Basic Index Fields code table &query=rid,exact,PRIMO1234 Facet fields from Facets Code Fields code table &query=facet_creator,exact,roger+ebert Building a Brief Search: Query (continued)
argument: exact: Must be used for facet fields contains: When search term is a phrase, result contains at least one of the given terms. begins_with: Applies only to sort title field (swstitletitle in section of PNX) Other fields are overwritten if specified argument: Search term Replace space with + sign Other special characters may be encoded EL Commons > CodeShare >Primo Open Interfaces > Guidelines > Special Characters Encoding Begin with &query=swstitle , begins_with ,motion+picture Building a Brief Search: Query (continued)
Searching with facets exact is required as precision argument Multiple query parameters are used One query for each facet One query for search term Query for search term should be last (fixed in SP 4.6) &query=facet_creator,exact,jane+austen &query=facet_pfilter,exact,book &query=any,contains,pride+and+prejudice Helpful tips Perform same search in Primo front end (FE) and examine the FE URL. Examine PNX of expected results for list of facets in use and their values. Helpful tips Perform same search in Primo FE and examine the FE URL. This may reveal the correct field to use Examine PNX of expected results for list of facets in use and their values. You may be searching for facet value video when the correct facet value really is media Building a Brief Search: Scopes
search_scope parameter: Was introduced in SP 3.1.3 Replaces loc parameter Easier to use Search scope code defined in Views Wizard (uses Name field) Search scope code must be attached to a View tab Each scope represented in the FE dropdown requires a separate search tab parameter required &search_scope=RE_MATHS&tab=default_tab Do not use loc with loc we also had to add the PC scope even if it was included in the scope Building a Brief Search: Scopes (continued)
Do not use loc with loc we also had to add the PC scope even if it was included in the scope Building a Brief Search: Scopes (continued)
loc parameter: Deprecated (SP and earlier) Complicated Uses two arguments, separated by comma &loc=, Three values for Local, for local searches Adaptor, for deep searches (Primo Central) Remote, for remote searches (MetaLib) Each type has different rules for : local, &loc=local,scope:(VOLCANO) Be aware of scope values that contain quotation marks &loc=local,scope:(NORTH) Perform similar search in FE, examine result URL for &scp.scps parameter local, &loc=local,scope:(VOLCANO) Scope values can be found in Ongoing Configuration Wizards > Pipe Configuration Wizard > Scope Values Configuration Building a Brief Search: Scopes (continued)
adaptor, Used for Primo Central searches &loc=adaptor,primo_central_multiple_fe remote, Used for MetaLib searches &loc=remote, (quick set ID) Quick set ID from MetaLib Perform similar search in FE, examine result URL for &scp.scps parameter Use browser Inspect Element on Quick Set label on front end or back end Building a Brief Search Deep Link - Examples
Brief search Sort by Date: Brief search Highlight: Building a Brief Search Deep Link - Examples
Brief search Sort by Date: Building a Brief Search Deep Link - Examples
Brief search Highlight: Building a Brief Search: Sorting
sortField parameter: Specifies the type of sort to perform in the retrieved results Default value is relevance The following types are supported, as defined in the Index Field of the Sort Fields Config mapping table: Stitle: sorts by title Scdate: sorts by date Screator: sorts by author Popularity: sorts by popularity srt parameter: Changes the displayed sort value in the front end interface Values are title, date, author, popularity, rank &sortField=scdate&srt=date sortField parameter for the search itself srt parameter is also required for Deep Links srt parameter for the display Need to use both Building a Brief Search: Highlight
highlight parameter: Highlights the search term in the retrieved results Requires use of highlight AND one or moredisplayField parameters displayField parameter: Required when highlight=true is used Defines which field from the section of PNX contains the search term to be highlighted Multiple displayField parameters may be used &highlight=true&displayField=title&displayField=creator Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary Type of Deep Link: Full View
Links to a page of full results for a specific record Similar to the Details tab of an FE search result Is also called dlDisplay.do search Requires institution, vid, and docId Dedup merged records are problematic Displays Primo Central results only if they are still in cache Cannot be used for remote records Is also used in saved-search alertmessages Building a Full View Deep Link - Examples
Full view example: Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary Type of Deep Link: Get eShelf
Uses dlBasketGet.do function Link goes to a specified users eShelf Specified userId is the internal patron id User must already be signed in Institution and userId are required Building a Get eShelf deep link - Example
User/pass: / Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary New in Primo 4 Personalize Your Results (PYR)also known as ScholarRank &pyrCategories=chemistry;business Categories based on codes in Personalize Your Results Disciplines code table &pyrDegree=undergraduate Degrees based on codes in Personalize Your Results Degrees code table Multiple facets: a query can include or exclude &query_inc=facet_topic,exact,women,science &query_exc=facet_topic,exact,women,science Behavior of default search_scope changed in SP 4.5 Search_scope and tab now required Find Databases Provides functionality of the Find Databases light box Find Databases Collection of special parameters used with Brief Search
To find a database, specify searchType AZ (AtoZ) or Find &openFdb=true&prefLang=en_US&searchType=Find&searchMethod=contains&searchTerm=medical&includeRestricted=1 You can also search other fields as defined in the MetaLib IRD &publisher= &keywords= &irdType= &category=/ &subCategory= Permalink New in SP 4.6 Enables end users to create and copy simplified deep links to individual records Available from search results and eShelf SendTo > Permalink, now called Actions > Permalink Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary Dont Try This at Home Dont Use search.do to create a search box
Use search.do to create a link to Advanced Search Use display.do or search.do outside of Primo Create ad-hoc scope lists for Brief Search Why Not? These actions can cause: Strange behavior Error on Details tab Inconsistent or changing number of results Performance problems System downtime Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary Deep Link Search Box - Example
Search box examples: User/pass: / Deep Link Search Box - Example
User/pass: / Deep Link Search Box - Example
Search box examples: User/pass: / Deep Link Search Box - Example
User/pass: / Deep Link Search Box A basic sample template is available in Knowledge-Centered Support (KCS) article #2017, Make a Search Box using Primo Deep Links (dlSearch.do). Values from the back office are required: Institution code View code (vid) Search_scope code (Scope Name attached to View tab) Tab code An alternative technique using iframe is described in the Primo Technical Guide, in chapter 11, Embedding the Primo Search into a Local Site. Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary Resources EL Commons: Ex Libris Developer Network: Search box example:
Ex Libris Developer Network: https://developers.exlibrisgroup.com/primo/apis/deeplinks Search box example: KCS Article # : Make a Search Box using Primo Deep Links (dlSearch.do) Permalink (SP 4.5 and earlier): KCS Article # : How to Create Persistent Link to Data Source in Primo Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary Known Issues Deep Link Truncates Queries with Commas Fixed in 4.8.2
Facet search results do not reflect in the UI Currently it can be achieved by adding the parameters:&ct=facet&fctN=facet_rtype&fctV=books Issues with Deduped records Unable to switch language in Front End when using the parameter prefLang Agenda 1 What Is a Deep Link? 3 New in Version 4 2 Deep Link Types 4
Dont Try This at Home Brief Search 5 Deep Link Search Box Full View 6 Resources Get eShelf 7 Known Issues 8 Summary Summary What is a deep link?
An external URL link to Primo, with the results returned in a Primo front end Types of deep links:Brief Search, Full View, and Get eShelf New in version 4: - Personalize Your Results (PYR) - Multiple facets query can include or exclude - Search_scope and tab now required - Find Databases light box - Permalink Dont Try This at Home: Do not use search.do to create a search box Deep link search box: Basic template in KCS article #2017 Q & A THANK YOU!