Working with Delivery Templates

Placeholders

Primo supports the following types of placeholders, which the system fills in when the final URL is calculated:

• Base_urls – Base URLs are defined per institution and stored in the Institution Base URLs mapping table in the Back Office. There are several out-of-the-box types of base URLs that are actually updated via the Institution Wizard, not directly by the table. Most customers do not need to add additional types, but this is an option. Note that it is also possible to enter the base URL as static text in the template. The out-of-the-box base URLs include the following:

  When the URL is calculated, the system takes the base URL of either the institution of the user or the institution of the location.

  • alma_base – the base URL of Alma used by the institution.

  • api_base – the base URL for the OPAC via Primo API used by the institution.

  • digital_rep_base – the base URL of the Digital Repository used by the institution.

  • ils_base – the base URL of the ILS used by the institution.

  • metalib_base – the base URL of the MetaLib used by the institution.

  • rosetta_base – the base URL of Rosetta used by the institution

  • rta_base – the base URL used for RTA. The server name is generally the same as that of the ILS, but the port may be different.

  • sfx_base – the base URL of the SFX (or other link resolver) used by the institution.

• PNX Fields – any field in the PNX can be used as a placeholder. The field is defined as {{section/field}}. The sections and fields of the PNX are explained in the Primo Technical Guide. Use the PNX section and field codes as they display in the Normalization Set Editor, as shown below.

  

  Normalization Set Editor

• FE interface language – The following placeholders may be used for the language:

  • {{language}} – The language is sent using ISO 639-2/T codes, which are three-letter terminological codes that are derived from the name for the language. For example, the three-letter code for French is fra, which is based on the name Francais.

  • {{language_bibliographic}} – The language is sent using ISO 639-2/B codes, which are three-letter bibliographic codes that are derived from the English name for the language. For example, the three-letter code for French is fre, which is based on the English name French.

• Collection ID – {{coll_id}}

• User ID – {{userID}}

• User IP – {{user_ip}}

• Timestamp – {{timestamp}} - The timestamp is the date and time.

• PDS handle – {{pds_handle}}

• Primo server IP – {{primo_server_ip}}

• View – {{view}} – For example, the template may be written as follows:

  ils_base?func=direct&local_base=control/originalsourceid&doc_number=control/sourcerecordid&view={{view}}

Thumbnails

Preference for requests to retrieve thumbnails are given to Syndetics thumbnails, which are free to customers. In case there are several thumbnail links for a record, the following templates are given precedence:

1. syndetics_thumb

2. syndetics_thumb_exl (new template)

3. Google templates

4. Other providers

Modifying and Creating Templates

Primo comes with a set of out-of-the-box templates that many customers find sufficient for their needs, but it is possible to add new templates or modify existing ones.