Skip to main content
ExLibris
  • Subscribe by RSS
  • ExLibris Dev

    Managing Search Queries and Sets

    Translatable
    The roles required to manage search queries and sets depends on the content type of the set you are managing:
    • For Resource Management content type sets, the following roles are required:
      • Cataloger
      • Catalog Manager
      • Catalog Administrator
      • Electronic/Digital Inventory Operator
      • Repository Manager
      • Requests Operator
    • For Acquisition content type sets, the following roles are required:
      • Purchase Operator/Purchase Manager (PO line set only)
      • Vendor Manager (vendor set only)
      • Acquisitions Administrator
      • General System Administrator
    • For User content type sets, the following roles are required:
      • User Manager
      • User Administrator
    A set is a collection of items, such as users or the results of a repository search. Sets may be used for publishing metadata in bulk, moving a group of records, or to run jobs. For information on running jobs on defined sets, see Running Manual Jobs on Defined Sets. Sets are managed on the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets).
    There are two kinds of sets:
    • Itemized – Individual items, selected or uploaded by the librarian (see Creating Itemized Sets)
    • Logical – A saved search query, which is run every time the set is referenced.
      Items in a logical set are determined dynamically, reflecting information currently in the repository (see Creating Logical Sets).
    Sets can be created from several content types. These content types can be divided into three categories: Acquisition sets, User sets, and Resource Management sets. Your ability to create a set of a certain content type depends on your permissions, as described in the Permissions section at the top of this documentation page:
    • Acquisition Sets
      • PO Lines
      • Vendors
    • User Sets
    • Resource Management Sets
      • All Titles
      • Authorities
      • Collections
      • Digital Files
      • Digital Titles
      • Electronic Collections
      • Electronic Portfolios
      • Electronic Titles
      • Physical Items
      • Physical Titles
    manage_sets.png
    Manage Sets Page
    The tabs on the Manage Sets page are as follows:
    • My Sets – Your saved search queries, both private and public
    • Public Sets – All users' saved queries that are not marked private
    • All Sets – All queries
    • The All Sets tab is available only to a Repository Manager. This role is also required in order to edit public sets.
    • Itemized sets may include references to deleted records. Deleted records do not appear in repository searches or in normalization jobs. Using itemized sets, you can perform operations on deleted records, such as republishing them to Primo.
    • There are no limits on the number of records that can be included in a set.
    The columns are as follows.
    Manage Sets Page Columns
    Column Name Description
    Active Whether the set is active
    Name The set name
    Type Whether the set is logical or itemized
    Created By (Public Sets and All Sets tabs) The name of the user who created the set
    Content Type The type of items in the set
    Created by The user that created the set
    Creation Date The date and time the set was created
    The Actions menu includes the following actions:
    Actions Menu Options - Logical Set
    Action Description
    Edit Modify the set parameters; see Editing Logical Sets.
    Results Run the saved search query and display the results; see Viewing Results of Logical Sets.
    Duplicate Copy a set. The duplicated set is added to the Manage Sets page with the words Copy of added as a prefix to the set name.
    Itemize Convert a logical set to an itemized set. Click Confirm in the Confirmation Message dialog box; see Converting Logical Sets to Itemized Sets.
    Combine Sets Create a new set based on the members of two existing sets; see Combining Sets.
    Delete Delete a set. Click Confirm in the Confirmation Message dialog box.
    You can delete only sets that you created. A Repository Manager can delete any set.
    Actions Menu Options - Itemized Set
    Action Description
    Edit Modify the set parameters; see Editing Itemized Sets.
    Members Display the members (results) of the saved set; see Viewing Members (Itemized Sets Only).
    Duplicate Copy a set. The duplicated set is added to the Manage Sets page with the words Copy of added as a prefix to the set name.
    Combine Sets Create a new set based on the members of two existing sets; see Combining Sets.
    Create Titles Set Create a new set of titles based on an existing itemized set; see Creating Title Sets.
    Delete Delete a set. Click Confirm in the Confirmation Message dialog box.
    You can delete only sets that you created. A Repository Manager can delete any set.
    Additional actions are relevant only for resource management title sets:
    Title Menu Options
    Action Description
    Catalog Set Move the contents of the set to the Metadata Editor for easier cataloging workflow. For more information regarding the Metadata Editor, see Opening the Metadata Editor.
    Filter Set Create a new set from an existing set, based on metadata elements that are not indexed; see Filtering Sets for more information.

    Creating Itemized Sets

    An itemized set is a static collection of individual records in the repository.
    To create an itemized set:
    1. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), click Add Set > Itemized. The Set Details page opens.
      Set Details Page for Itemized Sets
    2. Enter the set details in the respective fields. Set name is a mandatory field and must be unique.
      The set name cannot contain special characters (for example: &, #, $, %).
    3. The options that are available for Set content type depend on your permissions as described at the top of this page.
    4. By default, the set is designated as a Private (Yes) set. This means that the set is only available to you. If you select No, the set becomes a public set and is available to all other users.
    5. By default, the Status is set to Active. Optionally, select Inactive.
    6. Add records to a set using one of the following two methods:
      • Upload a file
        Select a file in the Add Contents from File to Set section that contains the identifiers (MMS ID, ISSN, ISBN, and so forth).
        Do not click Add Members to Set since this has no functionality when adding records to the set by uploading a file.
        The imported file must be a text file (.txt or .csv) or Excel file (.xls or .xlsx) and have the correct header at the top of the column for the data to be read. All other information in the file is disregarded. If the Excel file has more than one column, it utilizes the first column of data that has a valid header type. See the following table for acceptable header types:
        Content Type Header
        All Titles
        MMS ID
        New for May!
        ISSN
        ISBN
        OCLC number
        035 field
        Authorities MMS ID
        Collections PID
        Digital files PID
        Digital titles
        PID
        New for May!
        ISSN
        ISBN
        OCLC number
        035 field
        Electronic collections PID
        Electronic portfolios
        PID
        Portfolio ID
        Electronic titles
        PID
        New for May!
        ISSN
        ISBN
        OCLC number
        035 field
        PO line PO line reference
        Physical items
        Item ID
        Barcode
        PID
        Item PID
        Physical titles
        PID
        New for May!
        ISSN
        ISBN
        OCLC number
        035 field
        User
        Barcode
        User name
        Institution ID
        Facebook
        Google
        Twitter
        Vendor Vendor code
        For more information, see the Create Itemized Sets by Uploading List of Identifiers video (1:53 mins).
        Users:
        When uploading users to an itemized set with an Excel file, the A1 cell must contain either the code of the identifier type used in the file or USERNAME (for the primary ID), and the ensuing cells of the A column must contain the user identifiers. For the procedure for determining the list of identifiers for your institution, see User Identifiers. Similarly, when uploading a .txt file, the first row must contain either the code of the identifier type used in the file or USERNAME, and the ensuing rows must contain the user identifiers (each separated by a carriage return). For example, if you want to upload a set of user names (default primary ID), enter the text USERNAME in the top row of your Excel/.txt file, and enter the actual user names in the ensuing cells/rows.
        For details on viewing the available user identifier types, see User Identifiers.
        Example of an Excel File with User Identifiers
        A validation is performed for the set types Users, PO Lines, and Physical Items. The Add Members to Set job runs and creates a set from the file.
        • If you click Add Members to Set after selecting a file, the file is not loaded. Click Confirm in the confirmation dialog box to search the repository for records to include in the set. The records that are then selected, and not those in the file that was previously selected, are included in the set after you click Done.
        • The import file can be a maximum size of 10 MB.
        • If you perform an import with invalid data, each invalid cell is ignored.
        • If you import a file and then change the content type, you must re-import the file.
      • Select records from the repository
        Click Add Members to Set.
        A search page opens, depending on the content type you selected. The following sections describe the procedure for the different content types..
    7. When you are done, click Save.
      If you used the file input method, the system runs a job to build your set that appears in the list of sets when it is done. The resulting number of records/members in the set may be more or less than the number of entries in the input file. If, for example, an ISBN has multiple matches in the Alma database, all matches found are added as members to the set; and the opposite is true if no matches are found. Similar to other jobs that are run, you can view the job status/history on the Monitor Jobs page (see Viewing Running Jobs and Viewing Completed Jobs).
      When the job is run for the file input method, the process reports on items that matched based on the ID in the file but does not report on items that did not match.

    Resource Management Sets

    For a Resource Management set, the Repository Search page opens. Search for the content you want added to the set using the simple or advanced search. The Repository Search page refreshes to show the results of the search.
    Repository Search Results for Itemized Sets
    Select the items you want included in the set and click Add Selected. The selected records are added to the set.
    For itemized sets, you can continue searching, selecting, and adding records; for logical sets, your current search query defines the set. When you are finished, click Done. The itemized set is saved. The Manage Sets page opens with the new or updated set.

    PO Line Sets

    For a PO Line set, the Search for PO Line page opens. See Creating an Advanced Search for PO Line Sets for more information on the fields on this page.
    Click Go. The search results appear.
    Search for PO Line With Results
    Select the items you want included in the set and click Add Selected. The selected records are added to the set.
    For itemized sets, you can continue searching, selecting, and adding records; for logical sets, your current search query defines the set. When you are finished, click Done. The itemized set is saved. The Manage Sets page opens with the new or updated set.

    Vendor Sets

    For a Vendor set, the Search Vendors page opens.
    vendor_search.png
    Search Vendors
    Select the items you want included in the set and click Add Selected. The selected records are added to the set.
    For itemized sets, you can continue searching, selecting, and adding records; for logical sets, your current search query defines the set. When you are finished, click Done. The itemized set is saved. The Manage Sets page opens with the new or updated set.

    User Sets

    For a User set, the Find and Manage Users page opens.
    find_and_manage_users.png
    Find and Manage Users
    Select the items you want included in the set and click Add Selected. The selected records are added to the set.
    For itemized sets, you can continue searching, selecting, and adding records; for logical sets, your current search query defines the set. When you are finished, click Done. The itemized set is saved. The Manage Sets page opens with the new or updated set.

    Viewing and Removing Members of Itemized Sets

    You can view, add, or remove members (selected items) in an itemized set.
    To view members of an itemized set:
    1. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), find the set and select Actions > Members. A search page opens, depending on the content type. For example, for a Resource Management content type, the Repository Search page opens:
      Repository Search Members
    2. To remove members from the set, select the members you want to remove and click Remove Selected and then click Done. The selected members are removed from the list of members of the set.

    Editing Itemized Sets

    You can edit the set details and add items to the set. To delete items from the set, see Viewing and Removing Members of Itemized Sets.
    To edit an itemized set:
    1. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), find the set and select Actions > Edit. The Set Details page opens.
      Set Details Page Itemized Set to Edit
    2. Modify the set details as required. The Set name is a mandatory field and must be unique. (See Adding Itemized Sets for a description of the fields.)
      The set name cannot contain special characters (for example: &, #, $, %).
    3. If you do not also want to change the items in the set, click Save. The Manage Sets page opens indicating that the set has been successfully saved.
    To add items to an itemized set:
    1. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), scroll to the itemized set to which you want to add items and select Actions > Edit. The Set Details page opens.
    2. Click Add Members to Set. A search page opens, depending on the content type:
    3. Select the items you want included in the set (or click Select All) and click Add Selected. The selected records are added to the set.
      You can continue searching, selecting, and adding records. When you are finished, click Done. The Manage Sets page opens indicating that the set has been successfully saved.

    Creating Logical Sets

    For repository sets, a logical set is the same as a saved query. The items in a logical set are determined each time by running the query. For other kinds of sets, a logical set is created by filtering the results on the search page.
    To create a logical set:
    1. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), click Add Set > Logical. The Set Details page opens.
      Set Details Page for Logical Sets
    2. Enter the set details in the respective fields. Note that the Set name is a mandatory field and must be unique.
      The set name cannot contain special characters (for example: &, #, $, %).
    3. The options available for Set content type depend on your permissions as described at the top of this page.
    4. By default, the set is designated as a Private (Yes) set. This means that the set is only available to you. If you select No, the set becomes a public set and is available to all other users.
    5. By default, the Status is set to Active. Optionally, select Inactive.
    6. Click Next. A search page opens, depending on the content type you selected.
    7. For repository sets, enter the search parameters for the set. For other kinds of sets, filter the list to determine the parameters for the set.
    8. Click Save. The logical set is saved.

    Editing Logical Set Details

    You can edit logical set details. To change the set contents, see Editing Logical Set Queries.
    To edit a logical set:
    1. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), scroll to the logical set you want to edit and select Actions > Edit. The Set Details page opens.
      Set Details Page Logical Set to Edit
    2. Modify the set details as required. The Set name is a mandatory field and must be unique. (See Creating Logical Sets for a description of the fields.)
    3. Click Save. The Manage Sets page opens indicating that the set has been successfully saved.

    Viewing the Results of Logical Sets

    You can view the results of a logical set (in other words, the records returned when running a search using the logical set). The population of a logical set is determined dynamically, reflecting the records currently in the repository.
    To view results of a logical set, on the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), scroll to the logical set whose results you want to view and select Actions > Results. A search page opens, depending on the content type:

    Editing Logical Set Queries

    You can edit logical set queries.
    To edit resource management logical set queries:
    1. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), scroll to the logical set whose query you want to edit and select Actions > Results. The Repository Search page opens.
    2. Click Change Query to modify the search criteria according to the way the initial set was created. The following is an example of the Advanced Search page after clicking Change Query.
      Change Advanced Search Page
    3. Modify the search criteria and click Go. The Repository Search page opens.
    4. To save the set as a new query, click Save Query. The Set Details page opens.
      Set Details Page for Logical Set
      1. Enter the set details in the respective fields. The Set Name is a mandatory field and must be unique.
        The Set content type takes on the same value as the original set.
      2. By default, the set is designated as a Private (Yes) set. This means that the set is only available to you. If you select No, the set becomes a public set and is available to all other users.
      3. By default, the Status is set to Active. Optionally, select Inactive.
      4. Click Save. The Manage Sets page opens indicating that the set has been successfully saved.
    To edit other kinds of logical set queries:
    1. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), scroll to the logical set whose results you want to edit and select Actions > Results. A search page opens, depending on the content type:
    2. Change the filter parameters of the search page.
    3. Click Save.
    The new logical search query is saved.

    Converting Logical Sets to Itemized Sets

    You can convert a logical set to an itemized set. This creates a fixed itemized set based of the criteria of an existing logical set.
    To convert a logical set to an itemized set:
    1. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), scroll to the logical set that you want to convert to an itemized set and select Actions > Itemize. The Set Details page opens with the set name filled in:
      Set Details Page Convert Logical Set to Itemized Set
    2. Modify the set details as required. See Creating Itemized Sets for a description of the fields.
    3. Click Submit. A confirmation message opens.
    4. Click Confirm. The Manage Sets page opens indicating that the set has been successfully saved.

    Combining Sets

    You can create a new set based on the members of two existing sets. The combined set is an itemized set.
    For more information on Combining Sets, see the Combine Two Sets of Items video (3:42 mins).
    1. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), scroll to the set whose members you want to combine with another set and select Actions > Combine Sets. The Set Details page opens with the Combine Sets section:
      Set Details
    2. Select an Operation from the Operation drop-down list:
      • And – Include only the members in common between the two sets in the new combined set.
      • Not – Include only the members that are in the first set and not in the second set in the new combined set.
      • Or – Include all of the members in both of the sets in the new combined set.
    3. Click from the With field to display the Set Details page.
    4. Select the set that you want to combine with the first set you selected.
    5. Click Submit. A confirmation message indicates the number of members in each set you selected to combine, the operation you selected, and the number of members in the combined set:
      Confirmation Message
      The confirmation message contains a range of members, since some members between the two sets may be identical and are therefore only included once in the combined set.
    6. Click Confirm.
      A job is run to combine the sets. The following message appears.
      After the job finishes, the new set is added to the list of sets (you must refresh the list to see the new set).

    Combining Sets Example

    The following is an example of combing sets to create a set such as
    (X and Y) or Z
    To create this set:
    1. Create set X, set Y, and set Z.
    2. For set X, select Actions > Combine sets.
    3. Combine set X with set Y:
      Combine Set X and Set Y
    4. For the new X and Y set, select Actions > Combine sets.
    5. Create set (X and Y) or Z:
      Create (X and Y) or Z
      Set (X and Y) or Z is now available:
      Set (X and Y) or Z

    Creating a Titles Set from an Items, Portfolios, or Files Set

    A titles set is a set of bibliographic records, as opposed to a set of inventory records, such as physical items, electronic portfolios, or digital files. You can create a title set from an itemized set of physical items, electronic portfolios, or digital files. The new set contains the titles of the items in the original set.
    • Title sets can be created only from Resource Management content types.
    • To create a title set from a logical set, you must first convert the set to an itemized set.
    To create title sets:
    1. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), select Actions > Create title set for an itemized set of physical items, electronic portfolios, or digital files. The Set Details page opens with information concerning the new title set - such as the date and time that the set was created - added to the set name.
      Set Details Page
    2. Fill in the Description and Note fields (optional) and click Submit. A confirmation message such as the following appears.
      Confirmation Message
    3. Click Confirm. The job runs and creates the title set.

    Filtering Sets

    This section is relevant only for Resource Management content types.
    You can filter existing sets to create new sets. This feature is helpful when you need a set that is based on metadata elements that are not indexed. You can refine any set to include just the records that match the bibliographic record content regardless of whether the attributes are indexed or not.
    This feature is implemented using indication rules. Similar to normalization rules, indication rules use the flexible Drools logic to filter existing sets, both public and private sets. With the Drools logic, you can filter a set to create a new set based on different characteristics, as shown in the following examples that may include non-indexed fields:
    • Excluding government documents (where the 008 field byte 28 equals #, blank, or u)
    • Bibliographic records that do not contain a MARC 074 or 086 field
    • Limiting bibliographic records to print journals (where leader 06 record type = a or leader 07 bibliographic level = s)
    In addition, you can check for brief bibliographic records or missing fields by using the Drools logic.
    For information about filtering sets, see the Filtering Sets Using Drools Logic video (3:24 mins).
    To filter existing sets using indication rules:
    1. Create the required indications rule. See Creating Indication Rules.
    2. On the Manage Sets page (Administration > Manage Jobs and Sets > Manage Sets), locate the logical or itemized set that you want to refine, and select Actions > Filter. The Set Details page appears.
    3. Enter a new set name or use the one that is automatically generated by appending the word filtered and the date and timestamp to the original name of the set.
    4. Select the indication rule.
    5. Complete the remaining options to match your requirements.
    6. Click Submit. A confirmation message appears indicating how many records in your original set will be processed as part of your filtering request.
      Submit Set for Filtering Confirmation Message
    7. Click Confirm to proceed. The Filter set by indication job runs to process your filtering request and creates a new itemized set. The filtering process goes over all records in the defined set and applies the specified indication rules. Those records that meet the indication rules condition will be filtered out of the set. When the job is complete, the system sends an email to the user that initiated the request.
    8. You can view progress or the job results for the Filter Set by Indication job on the Monitor Jobs page (see Viewing Running Jobs and Viewing Completed Jobs). Select Actions > Report to view the results. The report shows the number of records that were processed and the number of records that were created in the new, filtered set.
    9. Filter Set by Indication Job Report
      The new set appears on the Manage Sets page along with the original set from which it was created.

    Working with Indication Rules

    To work with indication rules, you must have one of the following roles (the same roles as required for using the MD Editor):
    • Cataloger
    • Catalog Manager
    • Catalog Administrator
    Indication rules are used to filter sets. The result of the filtering process is a new set that is created that is a subset of the original/filtered set. See Filtering Sets for more information.
    The following sections describe how to create and test indication rules and provide examples that you can incorporate into your workflow:
    Indication rules are relevant only for Resource Management content types.

    Creating Indication Rules

    You create and maintain indication rules through the MD Editor.
    To create indication rules:
    1. Open the MD Editor (Resource Management > Cataloging > Open Metadata Editor).
    2. Click File > New > Indication rules. The properties dialog box appears.
      Properties Dialog Box
    3. Complete the parameters in the properties dialog box and click Save. The MD Editor editing pane appears.
      Indication Rule Editing Pane
    4. Enter the Drools logic for your indication rule. Refer to the section Normalization Rules – Syntax and Examples for the syntax to use when creating indication rules. The following indication rules are provided in Alma:
      • MultiTitleIndication.dslr
        Indication Rule Provided (Multiple Titles)
      • BriefIndication.dslr
        Indication Rule Provided (Brief Subjects)
      See the Indication Rules Syntax Examples section for more examples.
    5. Click Save.

    Testing Indication Rules

    Prior to running a job to filter a set using an indication rule, you may want to test the rule. Within the MD Editor, options are available for you to test an indication rule.
    To test indication rules that you have created:
    1. Open a bibliographic record in the MD Editor.
    2. Click Edit > Split Editor.
    3. Select the Rules tab in the left pane and expand the Indication rules folder.
    4. Locate the rule that you want to test in the Private or Shared folder.
    5. Click the rule name. The following options are available:
      • Edit
      • Delete
      • Duplicate
      • Properties
      Indication Rule Processing Options
    6. Click Edit. The indication rule opens in the split screen next to the bibliographic record.
      Indication Rule Open in the Split Screen
    7. Click Try it. Depending on the results, a pop-up appears with either a true or false response indicating that the bibliographic record either met or did not meet the Drool logic in the indication rule.
      Indication Rule Try It Response

    Indication Rules Syntax Examples

    The following are additional examples of indication rules syntax:
    Example 1
    Identify records in a set containing $a in the 949 field.
    rule "Contains 949 with subfield a"
    when
    exists "949.a.*"
    then
    set indication."true"
    end
    Example 2
    Identify records in a set containing a 1XX or 6XX or 7XX in $0 (subfield zero).
    rule "Contains a 1XX or 6XX or 7XX subfield 0"
    when
    ((exists "1**.0.*") OR (exists "6**.0.*") OR (exists "7**.0.*"))
    then
    set indication."true"
    end
    Example 3
    Identify records in a set containing $0 (subfield zero) in a field that starts with 65 such as 650 or 659.
    rule "Contains a 65X subfield 0"
    when
    exists "65*.0.*"
    then
    set indication."true"
    end
    One asterisk is used for each numerical digit in a field tag when used as a wildcard when creating indication rules.
    Example 4
    Identify records in a set containing $0 (subfield zero) in a field that starts with 6 such as 600, 630, 650, or 659.
    rule "Contains a 6XX subfield 0"
    when
    exists "6**.0.*"
    then
    set indication."true"
    end
    Example 5
    Retrieve all records which have multiple 300 fields each having a subfield a
    rule "Retrieve all records which contain two subfield a occurrences in 300"
    when
    existsMoreThanOnce "300.a"
    then
    set indication."true"
    end