Skip to main content
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Managing Remote Digital Repositories

    To configure remote digital repositories, you must have one of the following roles:
    • Repository Administrator
    • General System Administrator
    Institutions can integrate their local Digital Asset Management System (such as Rosetta or DSpace) in Alma. The remote digital system must provide a bibliographic metadata record (full or partial) with the digital-specific record ID and any additional digital-oriented inventory information embedded as bibliographic field information. This feed ensures that the digital inventory from the remote system is reflected in Alma for new, updated, and deleted digital inventory–ensuring that inventories of all types (physical, electronic, and digital) can be cataloged in one place and managed by one staff.
    • Synchronization is one-way only: metadata is sent from the local Digital Asset Management (DAM) System to Alma.
    • Alma currently supports imports in OAI formats only (either directly online through the http OAI-PMH protocol or using downloaded files in the following OAI formats): oai_dc (simple or qualified, see sample) , oai_marc21 (see sample), or DSpace's simple archive format. If you are working with a different format (such as non-OAI Dublin Core, non-OAI MARC 21, or delimited text), convert it to one of the supported OAI formats before attempting to import.
    • For more information on remote digital repositories, see Integrating Remote Digital Asset Management System in the developer's network.
    You can configure the remote digital repositories that are used when creating import profiles on the Remote Digital Repositories page (Configuration Menu > Resources > Record Import > Remote Digital Repositories).
    Remote Digital Repositories Page
    The repositories are available in the Remote digital repository instance drop-down field when creating a new digital import profile (see Creating/Editing an Import Profile: General Profile Information).
    Out of the box, Alma provides a set of remote digital repositories for D-Space, Rosetta, Digitool, Fedora, Equella, Omeka, and Bepress/DigitalCommons with selected OAI formats. If your format differs, you may choose one of the other system's formats, while ensuring your local format adheres to one of the supported OAI-PMH standards. If none of the supported standard OAI formats can be supplied, new repository types and formats may be considered for enhancement and added by Ex Libris in the future.
    From this page, you can add a new remote repository or you can edit some values of the existing Alma-supplied repository types/formats.
    To add a new remote digital repository:
    1. Click Add Remote Repository Instance. The first page of a wizard appears.
    2. Enter general information in the three pages of the wizard:
    3. When you are done, click Save.

    General Information Tab (Wizard Step 1)

    The General Information Tab opens first when you edit or view an existing remote repository configuration. The tab contains the same fields as Step 1 of the wizard, when you are adding a repository instance.
    General Information Tab for Remote Digital Repository
    The remote repository is defined by the following parameters on this page:
    • Remote Repository Code – A unique code that is set when the repository or repository instance is first created. If you are adding a repository instance, the field is blank and you can create a code that indicates the remote system type and format (such as ROSETTA_OAI_QDC for a remote system using Rosetta from a source with the format of OAI QDC).
    • Remote Repository Name – The name of the remote digital repository. This name displays as one option in the import profile drop-down list for remote repositories.
    • Remote System Type – The external digital system (such as Rosetta or Fedora).
    • Format – The format of the records to be imported. Alma supports OAI-DC, Simple-DC, oai_marc21, and DSpace simple archive. More formats will be added based on your needs.
    • Status – Indicates if the remote repository is active or inactive.
    • OAI Base URL – The default OAI base URL. This is the OAI base URL displayed when you add a single remote digital representation or create an import profile that uses the OAI import protocol. (For more information, see Adding a Representation and Managing Import Profiles). Click Connect and Edit to display the Metadata Prefix drop-down list.
    • Metadata Prefix – The default metadata prefix. This is the metadata prefix displayed when you add a single remote digital representation or create an import profile that uses the OAI import protocol. (For more information, see Adding a Representation and Managing Import Profiles).

    Transformer Rules (Wizard Step 2)

    The remote digital repository definitions include a set of rules that determine how the metadata and bibliographic records of digital remote representation resources should be created based on the imported bibliographic records.
    Transformer Rules Tab for Remote Digital Repositories
    Transformer rules are logically split into two types:
    • General rules — The record identifier, which is used internally in Alma to import the digital resource, does not have a target section and cannot be deleted.
    • Representation rules — Rules that define a mapping between the import record values and the remote representation. These rules may be edited, deleted, and added.
    The remote digital system integration enables you to build base URL templates to the remote system for digital delivery. Ex Libris recommends that the remote system metadata feed pass only the record ID of the remote digital record rather than a full URL to its delivery. This allows greater flexibility should the digital system base URL change in the future.
    Representation rules define how information is mapped from the source record to the representation’s definition in Alma. In addition, you can create multiple representations in Alma for a single import record when your remote digital system maintains more than one version of a digital inventory record (for instance, high resolution master versus a low resolution copy).
    You can configure representation rules per representation instance by selecting Actions > Edit in the row of the rule you want to edit or by clicking Add Rule in the Transformer Rules tab.
    Representation Rules
    Representation rules contain the following settings:
    Representation Rule Settings
    Field Description
    Representation section:
    Representation number The representation instance to which this rule applies. This allows you to specify rules for multiple representations. If you do not want to create multiple representations for an import record, specify 1 for all rules.
    Because general rules apply to all representations for the import record, they are not assigned a representation number.
    Source Field: This section is required only if you need information from the source record to create a representation.
    Field name The name of the field from which to extract its value in the harvested record. A source field value can be retrieved by using one of the following methods: field order or regular expression.
    Extract value by order Enables you to select which occurrence of the field to use.
    This method requires you to specify the Field order field.
    Field order If using the field order method, specify the occurrence of the field.
    For example, specify 1 in the Field order field to select the first occurrence of the field in the import record.
    Extract value by regular expression Allows you to match the first value of the field that matches a given regular expression. This method requires you to specify the Regular expression value extraction field.
    Regular expression value extraction If using the regular expression method, specify a regular expression to find the field in the import record.
    Source Field Normalization and Validation: This section is required only if you want to change or validate information retrieved from the import record.
    Add source field normalization Select this field if you want to normalize information retrieved from the import record.
    See the following fields for more information.
    Normalization type Select one of the normalization methods:
    • Code table – Uses the Digital Normalizer Value code table to retrieve the corresponding code value for the source field value.
    • Constant – Replaces the value retrieved from the source record with the constant value specified in the Normalization Pattern field.
    • Regular expression – Specify a regular expression that groups information in the source field’s value so that you can extract information for a particular group. For more information, refer to the Normalization pattern and Normalization group fields.
    Normalization Pattern For the regular expression method, specify a regular expression that separates the source field’s value into groups of information so that you can extract information from a particular group, which is specified in the Normalization group field.
    For the constant normalization method, specify a value that will replace the source field’s value in the representation.
    Normalization group For the regular expression method only, specify which group of information (as determined by the Normalization pattern field) to extract from the source field’s value.
    Add source field validation Select this field if the source field’s value is required to create the representation. Otherwise, no validation is performed on the source field’s value.
    Refer to the Validation type field, for more information.
    Validation type Set this field to Mandatory if a value is needed to create the representation. Otherwise, the representation will created even if the field’s value does not exist in the import record.
    Target Field:
    Target field Specify one of the following fields, which will be populated on the Digital Representation Resource Editor page for the representation:
    • Entity Type – Can be used for storing values such as Web site, E-book, Digitized photo and more.
    • Linking Parameter 1 - 5 – A value that is needed to create View It and Thumbnail links. This can be the ID of the object in the remote system that should be used as part of the delivery URL (for example,{Linking Parameter})
    • Representation Type – Can be used to tell if a representation is an Access Copy or a Master

    Transformer Example

    This example shows how the linking ID, which is stored in the <identifier> element of an OAI-DC import record, is normalized, stored in the LinkingParameter1 target field, and used to build the URL that allows users to view the item in the remote digital repository.
    Example OAI-DC Import Record - Linking ID
    1. On the Remote Digital Repositories page (Resources > Record Import > Remote Digital Repositories), select Actions > Edit for your remote digital repository and select the Transformer Rules tab to display the list of defined transformation rules.
      Transformer Rules Tab
    2. Select Actions > Edit for the LinkingParameter1 target field.
      The transformation details for the linking parameter opens in the editor page.
      Transformer Rules Editor
      If additional information from the input record was needed to build the URL, you would have to create additional rules to pass that information to additional linking parameter fields (LinkingParameter2 - LinkingParameter5), as needed.
    3. Specify the following fields:
      Representation Rule Settings
      Field Description
      Representation number Because you are only creating one representation per import record, specify 1.
      Source Field:
      Field name Specify header:identifier, which is the field that contains the object’s ID in the import record.
      For this example, the following value is extracted from the import record:
      Extract value by order Select this method to extract the value.
      Field order Specify 1 to extract the entire value from the first and only header:identifier field for this record.
      Source Field Normalization and Validation:
      Add source field normalization Select this field because information is needed from the import record.
      Normalization type Select Regular Expression.
      Normalization Pattern Specify the following regular expression to separate the value of the identifier into three groups, where each group is separated by a colon in the value: (.*):(.*):(.*)
      Normalization group Specify group 3, which holds the ID number for the object.
      For this example, the following value is extracted: 343143
      Add source field validation Select this field to make sure that an ID exists for the object.
      Validation type Set this field to Mandatory.
      Target Field:
      Target field Select the LinkingParameter1 field.
      For this example, the following value is stored in the LinkingParameter1 field: 343143
    4. Select the Delivery tab to configure the template that Alma uses to build the URL that displays the object in the remote digital repository.
      Delivery Tab
      In the Object template field, add the LinkingParameter1 field to the URL. In this example, the object template was set to the following URL, which was dependent upon the Digital Asset Management system that was used:$$LinkingParameter1&amp;custom_att_2=simple-viewer
      This link appears as follows in the Primo View It tab:
      Delivery Link in Primo View It Tab

    Delivery (Wizard Step 3)

    The remote digital repository includes a set of configurations that support the viewing of loaded remote digital resources.
    To edit conditions for a remote digital repository, or to create a new configuration based on one of the existing, out-of-the-box configurations, access the Wizard Step 3 through the Add... process, or select the Delivery tab of the Remote Digital Repository Details page.
    Delivery Tab for Remote Digital Repository
    The following configuration is available:
    • Repository Name – The repository name to be displayed both in the View It and Search Results screens.
    • Object Template – The URL template to view remote digital resources.
      This URL contains general attribute parameters such as linkingParameter1, linkingParameter2 …, linkingParameter5, as well as OriginatingSystemId (note that these parameters are extracted using the representation rules configuration).
      Enter the information in the syntax as follows:
      For DigiTool:
      <DigiTool base URL>/webclient/DeliveryManager?pid=$$LinkingParameter1&amp;custom_att_2=simple_viewer
      For Rosetta:
      <Rosetta base URL> delivery/DeliveryManagerServlet?dps_pid=<$$LinkingParameter1>
      For Dspace:
      <DSpace base URL>/xmlui/<$$LinkingParameter1>
    • Thumbnail Template – URL template for generating an object’s thumbnail resource link (to be used only when the remote repository supports thumbnail generation).
    • Check Access Rights – check the access rights policies in the remote repository and enforce them when a user searches for the digital resource in Alma.