Skip to main content
ExLibris

 

  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Publishing to Central Discovery Index

    Translatable

    Alma publishes the full text activation status of electronic holdings (all unsuppressed holdings), together with the Central Discovery Index search activations (in case of FullyFlexible customers only) to CDI in a set of institutional holdings files, which Central Discovery Index then uses to determine:

    • The full text availability of electronic holdings for each institution.
    • The collections to search in the Expand search (for FullyFlexible customers only).

     To publish electronic holdings to Central Discovery Index, you must configure and run a publishing profile in Alma.

    Central Discovery Index will harvest the files and create full text and searchable rights information using the Central Discovery Index holdings file created as part of the Alma publishing. Currently, it takes up to 72 hours from publishing in Alma until the actual rights are visible in the Primo Discovery search.

    When working with a Network Zone, Alma publishes electronic holdings from the Network Zone and each member institution at the same time and creates the following, respectively:

    • One institutional holdings file for each "Available for" group that has been defined in the Network Zone. Each "Available for" group corresponds to each of the member institutions.
    • One institutional holdings file from each member institution.

    "Available for" is only necessary to be set for Electronic Collections/Databases in the Network Zone for CDI when only "certain" institutions have access to that resources and "not all".

    If an Electronic Collection/Database is in the Network Zone and the customer wants to make them available for every Institution in the Network, the "Available for" group should be left blank, as this makes it 'Available for' all.

    Each day, the system merges the above institutional holdings files into a single institutional holdings file so that it can be harvested by Central Discovery Index.

    Configuring the Publishing Profile

    To configure publishing to Central Discovery Index, you must have one of the following roles:
    • Catalog Administrator
    • Repository Administrator
    • General System Administrator
    The publishing profile allows you to configure the settings used to generate the electronic holdings file that Central Discovery Index uses to update the status indicators. This process should be run daily to make sure that the holdings information is accurate.
    The Electronic Profiles section in the Publish electronic records to CDI job allows you to define profiles for groups of libraries and campuses that are defined as inventory management groups in a multicampus configuration. This allows the publishing job to create additional holdings files at the campus/library level so that Central Discovery Index can determine the full-text availability per Alma campus/library (each of which can be defined separately as a Primo institution, or all together as one Primo institution).
    To configure the publishing profile for CDI publishing:
    1. On the Publishing Profiles Details page (Resources > Publishing > Publishing Profiles), select Edit in the row actions list for the Publish electronic records to CDI profile. The Publishing Profile Details page opens.
      Publishing Profile Details Page (Standard Configuration)
    2. In the Publishing Parameters section, select Active or Inactive and select a scheduling option.
      If your institution works with a Network Zone, this export process must be run at the Network Zone before it is run at each member institution. This allows updates to the Network Zone inventory to be included in the holdings file for each member institution.
    3. Select Email Notifications to specify which users and email addresses will receive email notifications when the publishing profile is complete.
    4. If each group of campuses/libraries in a multicampus configuration is defined as a Primo institution, define a profile for each group of campuses and libraries. Otherwise, continue to the next step:
      1. Select Add Profile.
      2. Enter a name for campus or library in Profile name with no spaces. Optionally add a description.
      3. Select Add and Close.
      4. Select Edit in the row actions list to edit the new profile. The Publishing Profile Details page appears.
        PC_Pub_Profile_Edit_MC_Profile.png
        Publishing Profile Details Page (Electronic Profile Members)
      5. In the Electronic profile members section, select Add another member to add members to the profile group (select either campuses or libraries, or both).
        • Campus – Select a campus and select Add Campus.
        • Library – Select a library and select Add Library.
      6. Select Save to save the changes to the member profile.
    5. Select Save to save the changes to the export publishing profile.
    Data that meets the defined criteria is exported to the institutional holdings file when the profile is run according to the selected schedule.
    For information on monitoring a publishing export job, see Viewing Running Jobs. For information on the job report, see Viewing Completed Jobs.

    The Output of the Publishing Process

    The publishing job writes the holdings information to the following file for standard configurations:
    https://<Alma domain>/rep/getFile?institution_code=<Alma_Institution_Code>&file=cdi_institutional_holding
    For multicampus configurations, the publishing job writes the holdings information to the following file for each group of campuses/libraries:
    https://<Alma domain>/rep/getFile?institution_code=<Alma_Institution_Code>&file=cdi_institutional_holding&member_code=<profile_name>

    The CDI holdings file is a tar.gz file, <Alma_Institution_Code>_cdi_institutional_holding.tar.gz. In the file is a directory, <Alma_Institution_Code>_cdi_institutional_holding, with the following three files:

    • <Alma_Institution_Code>_holding.xml - This file contains the CDI title level full text availability. This file includes all books/journals/documents with at least one active portfolio in Alma (this includes both local and CZ portfolios). If a collection is set to Do not show as Full text in CDI even if active in Alma, the portfolios for this collection will not be included in the file.
      For each book/journal/document, the file contains title, identifier, coverage (for each portfolio) and CDI-related information if applicable, including Provider package code(s) DB id and the Selective settings (We subscribe to only some titles in the collection field).
      To match against the CDI records, CDI uses the following resource identifiers in the MARC fields of the CZ bibliographic record:
      ISSN
      ISBN
      022 $$a,l
      776 $x
      020 $a
      776 $z

      Below is an example of a journal included in the holdings file:

        <item type="electronic">
          <title>Access, IEEE</title>
          <title>IEEE access : practical innovations, open solutions.</title>
             <eissn>2169-3536</eissn>
          <object_type>JOURNAL</object_type>
          <sfx_id>992560000000093664</sfx_id>
          <mms_id>9919293011702321</mms_id>
          <coverage>
            <portfolio_id>5390276730002321</portfolio_id>
            <from>
              <year>2013</year>
            </from>
          </coverage>
          <collection>
            <portfolio_id>5390276730002321</portfolio_id>
            <db_id>DOA</db_id>
            <omitProxy>true</omitProxy>
            <selective>false</selective>
          </collection>
        </item>
        

      The Provider package code (DB id) is found in the CDI tab of the Electronic Collection editor, in the summary information section.
    • <Alma_Institution_Code>_db_ids.xml - This file contains the CDI database level full text availability. It includes the Provider package code (DB id) for each database type of collection activated in Alma (with unsuppressed bib and title level URL), for each collection that is Active for full text in CDI only, and for each aggregator/selective collection in Alma that is active (active service and at least one active OP) that does not have the Do not show as active in CDI even if active in Alma and has selective=false. Below is an example of a CDI database level full text availability file:

      <institutional_dbids xmlns="http://www.exlibris.com/repository/publish/primo/xmlbeans/">
        <db_ids>
          <dbidData>
            <dbid>BHHNA</dbid>
           <omitProxy>true</omitProxy>
          </dbidData>
          <dbidData>
            <dbid>AJIOW</dbid>
            <omitProxy>true</omitProxy>
          </dbidData>
          <dbidData>
            <dbid>AVCIM</dbid>
            <omitProxy>true</omitProxy>
          </dbidData>
          <dbidData>
            <dbid>AXISE</dbid>
            <omitProxy>true</omitProxy>
          </dbidData>
       </db_ids>
      </institutional_dbids>

    • <Alma_Institution_Code>_searchable_dbids.xml - This file contains the CDI Search activation (FullyFlexible customers only). It includes the Provider package code (DB id) for each collection activated for search in Alma.
      Below is an example of a CDI search activation file:

      <institutional_dbids xmlns="http://www.exlibris.com/repository/publish/primo/xmlbeans/">
        <db_ids>
      <dbidData>
            <dbid>JBS</dbid>
          </dbidData>
          <dbidData>
            <dbid>.2K,.2O,AABPG,AATZT,AAVOP,ABGWC,ABMRY,ADFCF,B8W,SFC</dbid>
          </dbidData>
          <dbidData>
            <dbid>KLI</dbid>
          </dbidData>
          <dbidData>
            <dbid>STJ</dbid>
          </dbidData>
       <dbidData>
            <dbid>AEAUQ</dbid>
          </dbidData>
        </db_ids>
       <dbidData>
            <dbid>AOOXX</dbid>
          </dbidData>
          <dbidData>
            <dbid>RAC</dbid>
          </dbidData>
      </institutional_dbids>

    Publishing to Central Discovery Index in a Multicampus or Available For Environment

    For Primo VE configuration information, see Multicampus Setup in Primo VE.
    If inventory management groups are set up to offer different electronic services to different libraries and/or campuses, Primo must take this into account, too. Primo must account for:
    • The Central Discovery Index profile (per each group)
    • The Alma OpenURL definition (per each group)
    When you publish to Central Discovery Index in a multicampus / available for environment, add a separate publishing profile for each campus that corresponds to an inventory management group. Creating a profile for each inventory management group allows each group to retrieve its own resources from the Central Discovery Index.
    Each group should have its own central index profile, because:
    • Each group subscribes to different electronic materials, so each group should see a different set of resources activated from the Central Discovery Index.
    • The indication of availability on the results (full-text availability) is different for each group.
    • Each profile must take its relevant holdings file according to the Publishing to Central Discovery Index Profile that was set up.
    You must add an Alma OpenURL definition for each group. Since each Primo institution is set to work with one of the groups, ensure that the electronic services that are provided are for the correct campus. This is done as described above in Adding Access to Resources by Adding a Campus to an OpenURL. In addition, see Alma Multicampus Setup in Primo regarding Primo integration details.

    Configuring Central Discovery Index to Use the Institutional Holdings File

    In order for the Central Discovery Index to update the status indicators for the institutional holdings, it must know where the published holdings file is stored. Although the holdings file should be updated daily, this configuration needs to be set only once, which may occur while registering your institution with the Central Discovery Index service. For more information, see Central Discovery Index.
    • You can assign only one institutional holdings file per Client UID (or PC Key). If you are already a Central Discovery Index customer and you want to use the PC for Alma, you must register a new client, get a new PC Key, and link the PC Key to the Primo institution that is integrated with Alma. This will also allow you to create an independent environment to test the integration of Alma and Central Discovery Index.
    • When using Primo in a multicampus environment, you must define a Primo institution for each PC publishing profile to register separate holdings files per inventory management group. For more information, see Alma Multicampus Setup in Primo.
    • When using Primo VE in a multicampus environment, you must define a PCI profile for each campus/library and assign each to a view to register separate holdings files per inventory management group. For more information, see Multicampus Setup in Primo VE.
    To set the URL of the holdings file:
    1. Access the back office for the PCI service:
      • For Primo: In the Primo Back Office, select Profile next to the PC Key field in the Institution Wizard (Primo Home > Ongoing Configuration Wizards > Institution Wizard). This button does not appear until you have registered your Primo institution to use Central Discovery Index.
      • For Primo VE: In Alma, select View my Profile on the Central Index and Proxy Setup page (Configuration Menu > Discovery > Other > Central Index and proxy set-up). This button does not appear until you have registered your Primo institution to use Central Discovery Index.
      The main menu on the My Profile page opens to allow you update your Central Discovery Index settings.
    2. Select My Client Applications to display the list of clients associated with your institution.
    3. Select the client application that was used to register the Central Discovery Index service in Primo.
    4. Select Edit Client Attributes.
    5. In the Institutional holdings file URL field, use the following format to enter the URL for the holdings file:
      • For standard configuration:
        https://<Alma domain>/rep/getFile?institution_code=<Alma_Institution_Code>&file=institutional_holding
      • For multicampus configuration(member_code should be set to the name of the PC publishing profile):
        https://<Alma domain>/rep/getFile?institution_code=<Alma_Institution_Code>&file=institutional_holding&member_code=<profile_name>
    • Was this article helpful?