Submitting Requests via OpenURL

Print Friendly and PDF Follow

OpenURL is an industry-standard way of encoding resource metadata into a URL. Aeon supports all configurations of OpenURL and is highly customizable for different OpenURL sources. Aeon OpenURL is installed and functional as a part of the standard Aeon server installation. As a general rule, if your Aeon web pages are functional, so is Aeon OpenURL. No further installation on the Aeon side of things is required.

Configuring Aeon Requesting From Your Electronic Resources

While the Aeon side of OpenURL is functional immediately, OpenURL will not be functional until an OpenURL-compatible system is set up to submit requests via your Aeon server. Aeon allows you to submit Unicode data in OpenURL requests. When a request is submitted, the Unicode data appears correctly on the Aeon request form. The user web interface and Aeon Client will accept and display CJK, Hebrew, Arabic, and other non-Western character sets as well as Extended Latin. If your site implements an OpenURL link to Aeon but can only offer one outbound link, you can edit your request forms to allow users requesting items to order copies without having to first submit a loan request and then request a clone to copy order.

Installing Aeon OpenURL

Aeon is capable of linking with any database system that supports OpenURL. This allows the researcher to request items found in various library databases directly through Aeon, without having to re-key any of the request information. Aeon OpenURL uses the built-in Aeon web pages, so you don't have to customize separate request pages specifically for OpenURL. The OpenURL link places them directly inside the standard Aeon web front-end.

Once requested using Aeon OpenURL, the transaction will appear in the Aeon Client at the status of Awaiting Request Processing. Aeon OpenURL is an integral part of the Aeon Web DLL and uses the same technology and web pages as the rest of the Aeon web system. The Aeon DLL supports OpenURL Version 1.0 in addition to the previous version of OpenURL, Version 0.1. To learn how web session data is maintained when placing requests through external systems such as OpenURL, see Submitting Requests.

Setting Up and Testing OpenURL with Aeon

To configure the base URL and test the setup with your catalog, create an OpenURL target of http://your.server.name/aeon/aeon.dll/logon?Action=10&Form=30 and add your test parameters:

  • http://your.server.name/aeon/aeon.dll/logon?Action=10&Form=30&title=Test&author=Smith

The OpenURLMapping Table

The OpenURLMapping table is pre-seeded with a setup that should work with most default OpenURL systems. If you need to change the behavior of how OpenURL interprets certain fields or genres, this is where you can make the changes. The OpenURLMapping table appears in the Customization Manager under Web Interface | OpenURL | OpenURLMapping.

OpenURLMapping Table

The OpenURLMapping Table Fields

For information on configuring this table for use with the ArchivesSpace Request Fulfillment via Aeon plugin, please see ArchivesSpace Request Fulfillment via Aeon

The OpenURLMapping table consists of the following fields:

Field Name

Information

URL_Ver

This field has a default value of Default and rarely needs to be changed. Additional entries can be configured in the OpenURLMapping table with modified URL_Ver values targeting a specific OpenURL version if you would like to have separate mappings available based on the version of OpenURL used to place the request. An example of the value for OpenURL version 1.0 would be "Z39.88-2004". 

rfr_id

This field has a default value of Default and rarely needs to be changed. Additional entries can be configured in the OpenURLMapping table with modified rfr_id values if you would like to have separate mappings available based on the source of the OpenURL link used to place the request.

For example, to have all requests of a specified OpenURL genre considered a Monograph when submitted from FirstSearch, but to have those same requests considered a Manuscript when submitted from Alma, you could configure separate OpenURLMapping table entries for each of these behaviors with the rfr_id setting on the entries specifying which mappings to use for FirstSearch and which mappings to use for Alma. 

Aeon Action

Three actions requiring separate OpenURLMapping table entries are used to convert an OpenURL request to an Aeon request:

As these three actions work in conjunction with each other, please ensure that you create separate entries for each Aeon Action below when adding new entries to the OpenURLMapping table targeting a specific rfr_id or URL_Ver value.
  • Substitute:genre: This action is used to set the RequestType (Loan or Copy) and DocumentType (Monograph, Serial, Manuscript, etc.) for the generated request in Aeon and to specify the Aeon web request form that should be used to place the request based on the genre for the item passed via OpenURL. When configuring this action:
    • The Aeon Field Name field for the entry must be set to RequestType
    • The Open URL Field Values field for the entry should be set to the genre returned by OpenURL (e.g., manuscript, monograph, serial, etc.) or to a value of default, which will match any genre not specifically listed in another entry.
    • The Aeon Value for the entry should be configured to specify the Aeon RequestType and DocumentType that should be set for incoming requests of that genre and the HTML request form that should be used to place those requests on the Aeon web interface. This value must be configured in the format: RequestType:DocumentType:HTMLRequestPageToUse (e.g., Loan:Monograph:GenericRequestMonograph.html).

  • Substitute:rft.genre: This action functions and is configured the same way as the Substitute:genre action, but is used specifically with OpenURL version 1.0.

    When adding new genre mappings to the OpenURLMapping table, you should create one entry for that genre using the Substitute:genre action and a separate identical entry for that genre using the Substitute:rft.genre action to ensure all potential OpenURL versions are handled by Aeon.
  • Replace: This action sets the Aeon field that will be used to store the OpenURL information that is sent via the OpenURL link. A separate Replace entry should be created for each individual Aeon field used to hold the data sent via OpenURL. When configuring this action:
    • The Aeon Field Name field for the entry should be set to the name of the Aeon field that will be used to store the data passed from the OpenURL link.
    • The Open URL Field Values field for the entry should be set to the OpenURL field that will be used to pass the desired information from the OpenURL link into that Aeon field.

      This value must be formatted as <#OpenURLTagName>. See the Open URL Field Values documentation below for more information on additional formatting options for this value.
    • The Aeon Value field for the entry does not need a value and can be left blank.
    • For example, if the Aeon Field Name is set to ItemEdition and the Open URL Field Values value is set to <#rft.edition>, the value in the ItemEdition field on the Aeon request record will be replaced with the data passed through the OpenURL link via the rft.edition field. 

Aeon Field Name

  • For entries with an Aeon Action value of Replace, this should be set to the name of the Aeon field that will be populated by the OpenURL field configured in the Open URL Field Values column. 
  • For entries with Aeon Action values of Substitute:genre or Substitute:rft.genre, this must be set to RequestType.
See the Aeon Action documentation above for more detailed guidance on configuring the Aeon Field Name for each action.

OpenURL Field Values

  • For entries with an Aeon Action value of Replace, this should be set to the name of the OpenURL field that will populate the value in the Aeon field configured in the Aeon Field Name column.

    The OpenURL field must be formatted as <#OpenURLTagName> (e.g., <#rft.edition>). Other text is also allowed. For example, in the case of an author's name, you can separate the last name and first name with a comma and a space, i.e., <#rft.aulast>, <#rft.aufirst>
  • For entries with Aeon Action values of Substitute:genre or Substitute:rft.genre, this should be set to the OpenURL genre (e.g., manuscript, monograph, serial, etc.) that should map to the Aeon RequestType and DocumentType indicated in the Aeon Value column for the entry. 
See the Aeon Action documentation above for more detailed guidance on configuring the Open URL Field Values for each action.

Assigning Multiple OpenURL Values to the Same Aeon Field 

Entries in the OpenURLMapping table configured to use the Aeon Action 'Replace' can have separate OpenURL values assigned to the same Aeon field in a single OpenURLMapping table entry. This is useful for handling different OpenURL mappings that end up going to the same Aeon fields.

You can separate these values with a pipe character (|). When Aeon sees the pipe, it interprets everything up to that point in the expression. If it has no values for the OpenURL fields up to that point in the expression, then it continues and uses the next expression. If it already has a value, then it ignores everything after the pipe. You can have as many pipe/field value combinations as you need.

Example:

This example uses the default Open URL Field Values configuration in the OpenURLMapping table entry for the ItemAuthor field:

<#author>|<#rft.au>|<#rft.aulast>, <#rft.aufirst> <#rft.auinitm>|<#aulast>, <#aufirst> <#auinitm>

  1. If the first part, <#author>, has a value, then that is what is sent back to Aeon.
  2. If not, then Aeon looks at the second part: <#rtf.au>. If that has a value, then that is what is sent back to Aeon.
  3. If not, then Aeon looks at the third part: <#rft.aulast>, <#rft.aufirst> <#rft.auinitm>. If any part of that has a value, then it is used.
  4. If not, then Aeon uses the last expression: <#aulast>, <#aufirst> <#auinitm>.
  5. If none of the OpenURL values are returned, then Aeon puts no value into the field.

Aeon Value

The Aeon Value field must be configured only for entries using an Aeon Action type of Substitute:genre or Substitute:rft.genre. See the Aeon Action documentation above for more detailed guidance on configuring the appropriate Aeon Value for these actions.

Entries with action types of Replace do not need a value configured in this field. 

 

 

Questions?

If this article didn’t resolve your issue, please contact Atlas Support for assistance:

Contact Support