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

    Configuring Import Profiles for Primo VE

    Return to menu

    Adding a Discovery Import Profile

    An Import profile allows you to define an external data source, apply normalization rules, configure delivery links, and schedule the execution of the import profile job.

    To define an import profile for discovery:
    1. Open the Import Profiles page (Configuration Menu > Discovery > Loading External Data Sources > Discovery Import Profiles), which lists all of the Discovery import profiles.

    2. Click Add New Profile to open the Import Profile Details page.

      DiscoveryImportProfile_Add_NewUI.png

      Import Profile - Choose Discovery Type (Step 1)
    3. Make sure that the Discovery option has been selected and then click Next.

      PVE_ImportProfileDetails.png

      Import Profile Details Page (Step 2 - Profile Details Tab)
    4. Specify the following fields and then click Next.

      Discovery Import Profile - Profile Details
      Field Description
      Profile Details

      Profile name (required)

      The profile's name. This name appears in the list of import profiles and also appears at the top of the page.

      Profile description

      A free text description of the profile that shows on the list of import profiles.

      Data Source Code (required)

      The unique code for the data source in Primo VE.

      Data Source Label

      This is the source name that appears in the View It section on the record's full display page.

      File name patterns

      A file name pattern (such as *.xml) filters out records that do not conform to the pattern you specify. Use this when the FTP directory contains additional files that should not be imported.

      Alma looks for this pattern as a sub-string in the file name, exactly like a regular expression, except for two changes:

      • A period . matches only a period (as if you had entered \\.).

      • An asterisk * matches zero or more characters of any type (as if you had entered .*).

      Otherwise, use regular expressions.

      Ensure that the regular expression you use exactly matches only the files that you want to import. For example:

      • The following retrieves all files ending in ".xml" (without the quotes): .xml$

      • The following retrieves all files containing the string “yLk” (without the quotes): yLk

      • The following retrieves all files beginning with “YLK” (without the quotes): ^YLK

      • The following retrieves all files beginning with “YLK” (without the quotes) followed by a space: ^YLK\s

      • The following retrieves any file that contains at least one of the following words (without the quotes): “harry” or “potter” or “rowling”: \b(harry|potter|rowling)\b

      • The following retrieves any file that contains all of the following words (without the quotes): “harry” and “potter” and “rowling”: (?=*?\bharry\b)(?=*?\bpotter\b)(?=*?\browling\b)

      Originating system (required)

      The type of system from which the records originated.

      When using the MARC21 Bibliographic source format, set this field to Other.

      Import protocol

      The protocol used to retrieve the file containing the records. The options are:

      • FTP – Retrieve by FTP. You must enter fields under Import Processing and FTP Information (see below).

      • Upload File/s – Upload the file from a local or network drive.

      • OAI (Repository and Authority profiles only) – Retrieve using OAI. You must define additional fields associated with the OAI server (see below).

      Physical source format

      The file format of the import file. The available options are:

      • XML

      • Binary – Used with MARC21 Bibliographic source format only.

      Source format

      The format of the records in the file:

      • Dublin Core – Dublin Core records wrapped in oai-dc format.

      • Generic XML – Generic XML records.

      • MARC21 Bibliographic – MARC21 records in XML or binary format. With this format, your source records must include an 035 field, which is used as the Source control number to identify the record.

      Target format

      The format in which to save the records in Primo VE. The available options are:

      • Dublin Core – Select this option if Source format is Dublin Core or XML.

      • MARC21 Bibliographic – Select this option if Source format is MARC21 Bibliographic.

      Status

      The default is Active. Select Inactive if you do not want the import profile to be available for use at this time.

      Share with Network

      For consortia environments only, this parameter indicates whether the external resource is included in the 'Entire network' search scope and shared with other member institution's catalogs.

      • This configuration option is not visible by default. If you are interested in this functionality, please contact Ex Libris Support.

      • Enabling/disabling this feature requires you to republish the external data source.

      File Splitter Parameters (Generic XML only)

      Root element tag

      The XPath to the first tag in the file.

      Record elements tag

      The XPath to the beginning of a record. A file may contain one or more records.

      XPath to the identifier tag

      The XPath to the identifier tag of the record. This should be the tag that contains the unique identifier for the record.

      XPath to the location of the deleted status

      The XPath to the location of the deleted status of the record. Default value for a record is: deleted = false.

      Delete record regular expression

      This regular expression is applied to the value found under the XPath to the location of the deleted status field. If the regular expression matches the value found, the record is marked as deleted.

      Scheduling

      Appears if you selected FTP or OAI. When the profile is scheduled, a Metadata Import job appears in the list of scheduled jobs in Alma. For more information on this job, see Viewing Scheduled Jobs and Viewing Running Jobs.

      Files to import

      Select All for all files found in the FTP location. Select New to select only those files that have not yet been imported.

      Scheduler status

      Whether the scheduling is active or inactive.

      Scheduler

      Select one of the scheduling options from the drop-down list. Times depend on your time zone and the server you are using.

      Email Notifications

      Which users and email addresses receive email notifications when the publishing profile completes. Opens the Email Notifications for Scheduled Jobs page. You can choose whether to send the notifications for successful jobs and/or jobs that contain errors.

      FTP Information

      Appears only if you selected FTP as the Import Protocol.

      Description

      A description of the FTP submission format that is defined in this section.

      Server/Port

      The IP address and port of the FTP server sending or receiving the files.

      User name/Password

      The username and password for logging on to the server that is sending or receiving the files.

      Input directory

      The path of the submission format’s input directory.

      Max. number of files

      Not in use. Accept the default value.

      Max file size/Size type

      Not in use. Accept the default value.

      FTP server secured

      Whether to use a secure FTP transfer (SFTP)

      FTP passive mode

      Whether to use FTP passive mode, or not. This depends on the setting in your FTP server.

      Test Connection

      Click to run a test of the FTP connection

      OAI Details

      Appears only if you selected OAI as the Import Protocol.

      OAI Base URL

      The OAI provider’s URL, which OAI harvesters can use to load metadata. After you have entered a valid URL, click Connect and Edit to display the associated fields. If you configured a default OAI Base URL, it appears here.

      Authentication

      Whether the OAI server requires you to enter a user name and password.

      Username

      The user name if authentication is required to access the server.

      Password

      The password if authentication is required to access the server.

      Connect and Edit

      Click to refresh the page with the associated OAI fields after entering the base URL of the server and authentication information if necessary.

      The following fields appear after you click Connect and Edit.

      Repository Name

      From the OAI provider, populated by Alma.

      Granularity

      Indicates the granularity of the repositories date stamp.

      Earliest Date Stamp

      The earliest that data exists in the OAI provider records, populated by Alma.

      Admin's E-Mail

      OAI provider admin's email, populated by Alma.

      Metadata Prefix

      The metadata prefix from the OAI provider. Currently, Primo VE supports oai_dc and qdc formats.

      Set

      OAI repository available sets, populated by Alma.

      Identifier Prefix

      The Identifier Prefix is the shared prefix that appears before the actual unique record identifier when harvesting by the identifier.

      Harvest Start Date

      When submitting a new import job and after the job completes successfully, the Harvest Start Date is updated automatically with the job’s ending time.

      Encode Date

      Whether the repository supports encoding dates.

      Encode data

      Whether the repository encodes the data.

      Open Test Page

      Click to test the OAI connection and flow. See Testing OAI Import Protocol Flow.

    5. In the Normalization tab, select a normalization rules process if this data source requires additional normalization. For more information, see Configuring Normalization Rules for Primo VE.

      PVE_ImportProfileDetails-Normalization.png

      Import Profile Details Page (Step 3 - Normalization Tab)
    6. Click Next.

    7. In the Delivery tab, configure the delivery links for resources and thumbnails in their respective sections: Link to Resource and Link to Thumbnail.

      PVE_ImportProfileDetails-Delivery.png

      Import Profile Details Page (Step 4 - Delivery Tab)
      1. For each type of link (resource and thumbnail), specify the following information:

        • Select the method used to create the delivery links:

          • Template – Select this option if it is necessary to generate the delivery links using a combination of static text and linking parameters, which include normalized data taken from the source record. In addition to the source record's ID ($$SourceRecordID), the linking parameters ($$LinkingParameter1 - $$LinkingParameter5) are defined in the Linking Parameters section.

          • Static URL from source – This method allows you to use the source record's static URL for delivery, which may be stored in a Dublin Core tag (such as dc:uri) or a MARC21 field.

        • For the Template method only, specify the relevant linking parameters and static text to build the delivery link in the Template field. For example:

          http://hdl.handle.net/$$LinkingParameter1
        • For the Static URL method only, enter the following fields:

          • Dublin core tag – (DC targets only) Specify the Dublin Core tag from which to retrieve the record's static URL.

          • Field, Ind1, Ind2, and Sub field – (MARC targets only) Specify the MARC field, matching indicators, and the MARC subfield from which to retrieve the record's static URL.

        • Link Label – For resource links only, specify the label that displays for all resource links in Primo VE.

      2. In the Linking Parameters section, edit each linking parameter that was assigned to a template above. The Edit Linking Parameter dialog box opens:

        EditLinkingParameterDialogBoxFilled.png

        Edit Linking Parameter Dialog Box
      3. Specify the following fields and then click Save.

        • Source Tag (DC only) - Search for and select the DC source tag from which to get the delivery URL.

        • Field, Ind1, Ind2, and Sub field (MARC only) - Search for and select the MARC field, matching indicators, and the MARC subfield from which to get the delivery URL.

        • Use source tag - Select one of the following options to indicate whether the tag must contain a specific value:

          • Always - No matching string is necessary. The value is always used.

          • Matching string - The value of the tag must match the string specified in the Matching String field.

          • Matching string using a regular expression - The value of the tag must match the result of the regular expression specified in the Matching string field.

        • Matching String - If matching is necessary, specify the string that you want to match.

        • Normalization source tag - Select one of the following options to indicate whether normalization is necessary before loading the value into Primo VE.

          • No normalization - No normalization is needed. The value of the tag is taken as is.

          • Normalization using a regular expression - A regular expression is used to modify the value before saving to Primo VE.

        • Normalization pattern - If normalization is necessary, specify the regular expression needed to modify the value of the source tag.

        For example, the following configuration includes dc:identifier fields with values that begin only with http or https:

        Field Value

        Source Tag

        dc:identifier

        Use source tag

        Matching string using a regular expression

        Matching String

        ^(?:http(s)?:\/\/).*

        Normalization source tag

        No normalization

    8. Click Save to save the import profile.

    • Was this article helpful?