Fields: Add/Edit Discovery Search Sources

When you set up your search configuration, you specify the Discovery search sources and sites that Portfolio will connect to in order to extract and index data. A Discovery search source specifies the search fields to be used by the search source, any match fields that you want to match and merge data on from multiple Discovery source sites, and the frequency with which you want to index data from this search source.

If you add or edit the settings for a Discovery search source, or if you add or edit any Discovery source sites associated with a Discovery search source, you must refresh the Discovery search cache afterwards. Your changes are not reflected in Searching or the Admin console until you refresh the search cache. For more information about refreshing the Discovery search cache, see Refreshing the search cache.

Search Configuration > Discovery Search Sources > Add Discovery Search Source

Search Configuration > Discovery Search Sources > Edit

Discovery Source Name

Displays the name of the Discovery search source that you are editing. If you are adding a Discovery search source, this information does not appear.

Code

Specifies a unique code for the Discovery search source (up to 30 characters). This code is used to identify the search source on the Discovery Search Sources page and on any other pages that display the search source code.

Codes are displayed in all upper case letters. If you enter lower case alphanumeric characters for the code, the software automatically converts them to upper case when the code is displayed. The Code cannot include spaces. If you enter a space, Portfolio will display an error message when you save the settings.

Note: This value must be unique. If you enter a code that is already being used elsewhere on the system and try to save the profile, the software displays an error message indicating that the value must be unique, and informing you that the value you entered is already being used for another profile.

Name

Specifies the system name of the Discovery search sources (up to 80 characters) for the specified language. This name is used to identify the search source on the Discovery Search Sources page and on any other pages in the Admin console that display the search source name.

For this field, you can also specify an alternate name for a specific language. Choose the language from the drop-down list of supported languages in the Admin console, then enter the localized name in the field.

Note: If your web browser is configured to use a display language that is not supported by Portfolio and you have chosen to display the Admin console in a language other than the default language (en_US), the language that displays in the drop-down list of supported languages defaults to US English.

If a localized name already exists for a specific language, the software displays that language name differently in the drop-down list. When you enter a localized name for a specific language, the language name appears with a “++” suffix. If you clear the localized name for a specific language, the software displays the language name without the different formatting.

Description

Specifies a text description of this Discovery search source (up to 255 characters).

Note: This field is optional.

Index Type

Specifies which type of indexing you want for the Discovery search source. Select CJK (Chinese Japanese Korean) if your catalog includes records that are predominantly Chinese, Japanese, and Korean titles. Otherwise, leave the Default setting.

Note: You must run a full index against the search source for this setting to take effect.

Include in ‘Did You Mean?’ suggestions

Specifies whether or not to include a Discovery search source’s dictionary in “Did you mean?” search suggestions. For details about “Did you mean?”, see Fields: Add/Edit/Copy Profile.

Because the dictionaries used for “Did you mean?” are search source specific, you can choose which search source dictionaries Portfolio searches for “Did you mean?” suggestions. This can be helpful when a dictionary is limited due to the small data set of the search source.

Suppose, for example, that you have a search source that contains only 100 small PDF documents. Because the search source has such a small data set, its dictionary is going to have relatively few terms it can use for “Did you mean?” suggestions. A user might search “computers” but if that term is not found in the search source dictionary, the suggestions offered by “Did you mean?” may not be helpful.

All delivered default Discovery search sources will automatically be selected to be included in “Did you mean?” suggestions. If you are upgrading from an existing version of Portfolio, the “Did you mean?” feature will be automatically selected for all existing Discovery search sources. You can then edit any search sources you wish to exclude from “Did you mean?” suggestions. When you add a new Discovery search source, by default “Include in ‘Did You Mean?’ suggestions” will be clear.

Note: Excluding a Discovery search source for “Did you mean?” suggestions does not disable searching. Portfolio will still search and display the search source data, regardless of whether or not “Did you mean?” is enabled.

All search source dictionaries are updated automatically when the library system’s data sources are indexed, even if “Did you mean?” is disabled. No re-indexing is required when you select or clear “Include in ‘Did You Mean?’ suggestions”.

Important: You must enable “Did you mean?” for each profile, regardless of whether or not you have selected to include specific Discovery search sources in “Did you mean?” suggestions. For more information, see Fields: Add/Edit/Copy Profile.

Search Fields

Specifies the search fields that are associated with the Discovery search source. Associating a search field with a Discovery search source makes that search field available to a Discovery search target. Search fields associated with a Discovery search target can then be displayed on profiles, rooms, and displays.

Available

Displays a list of all the available search fields on the system.

You can select or multiselect one or more fields and then click Select, or you can double-click individual fields to move them to the Available list.

Note: The "Item Available" field can be used for sources that can be checked out. This allows patrons to use the "Only Show Available" button to filter searches. If none of the search sources included in a profile include an "Item Available" field, the "Only Show Available" button will not appear in the Searching interface.

Note: If you subscribe to Extra Content, you will see Syndetics ICE search fields in the list of available search fields associated with an ICE enabled Discovery Search Source. The names of these search fields normally start with “Syndetics ICE...” However, if you have subscribed to Fiction Profiles, five of the Syndetics ICE search fields are available for you to assign as facets in a profile search results display. Because search field names serve as facet labels, these five particular search fields have been named so that library users do not see “Syndetics ICE...” as a facet label in Searching.

Search field Name

Syndetics ICE Fiction Profile Genre

Genre

Syndetics ICE Fiction Profile Timeframe

Timeframe

Syndetics ICE Fiction Profile Location

Geographic Location

Syndetics ICE Fiction Profile Topic

Topic

Syndetics ICE Fiction Profile Non-Geographic Setting

Setting

Selected

Displays the list of search fields that are associated with this Discovery search source.

You can select or multiselect one or more search fields and then click Remove, or you can double-click individual fields to move them to the Available list.

Important: You can only select 10 search fields for a single search source.

To add or remove search fields in the list, choose the search field, and then use these buttons:

Option Description

Select

Moves the selected search field from the Available list to the Selected list.

Remove

Removes the selected search field from the Selected list and returns it to the Available list.

Note: These buttons are context-sensitive based on which search field(s) you choose. (For example, if you select a search field from the Available list, the Remove option is disabled because that command is not enabled for available search fields. If you select a search field from the Selected list, the Remove option is enabled because that command is available for selected search fields.

Match Fields

Specifies the search fields on which you want to match and merge data from multiple Discovery sources of the same type. For example, if you have multiple Discovery sources that convey ILS data, you may want to merge certain search fields together so that they are handled the same way in Portfolio.

When you select match fields for a Discovery search source, you must first select them as a search field. If you edit a Discovery search source and choose a match field that has not been selected as a search field, the software displays an error message indicating that you cannot use the field as a match field because it must be in the list of selected search fields.

Portfolio displays a list of all the search fields on the system, but any match fields that you select for a Discovery search source must have a hierarchy type of “parent”. If you select a match field that is not a parent field, the software displays an error message indicating that you cannot use the field as a match field because it is a child field. You designate the hierarchy type for a specific search field when you create or modify it. For more information, see Adding or editing a search field.

Due to a known issue with Portfolio's match fields function, choosing to merge fields may make item details unavailable in the Checkout tab of My Account. Item details are still available in all other areas of Portfolio, however.

Available

Displays a list of all the available search fields in the system on which you can match and merge data.

You can select or multiselect one or more fields and then click Select, or you can double-click individual fields to move them to the Available list.

Selected

Displays the list of the match fields that are associated with this Discovery search source. Any match fields that you select must have previously been selected as search fields for this Discovery search source.

You can select or multiselect one or more match fields and then click Remove, or you can double-click individual fields to move them to the Available list.

Important: You can only select match fields that have a hierarchy type of “parent.”

Important: You can only select 10 match fields for a single search source.

To add or remove match fields in the list, choose the match field, and then use these buttons:

Option Description

Select

Moves the selected match field from the Available list to the Selected list.

Remove

Removes the selected match field from the Selected list and returns it to the Available list.

Move Up

Moves the selected match field up one position in the Selected list.

Move Down

Moves the selected match field down one position in the Selected list.

Note: These buttons are context-sensitive based on which match field(s) you choose. (For example, if you select a match field from the Available list, the Remove option is disabled because that command is not enabled for available match fields. If you select a match field from the Selected list, the Remove option is enabled because that command is available for selected match fields.

Full Indexing Schedule

Specifies the interval when the harvest, import, and index tasks will run for this search source. When you create a Discovery search source, Portfolio creates the tasks used to collect the search data and index it for searching. These tasks can be scheduled to run on a regular interval or can be configured to be run only when triggered manually. For more information, see Scheduled Tasks.

Two tasks are created for Discovery search sources: import and index. When the schedule is triggered, the import task runs first. When it has finished, it triggers the index task, which completes the process.

When you schedule a task, you need to be aware of the location of the server in relation to your location. Scheduled times are local to the server hosting Enterprise. For example, if the server is located in the US Mountain time zone and you are located in the US Eastern time zone, a task scheduled for 11:00 pm on the 6th will run at 1:00 am on the 7th your local time.

Index Exists

Indicates whether Portfolio has created an index for the search source. If the search source has not been indexed, the items included in the source will not be available for searching.

  • True: An index has been created for the search source. The index may not be recent, but one exists.
  • False: No index has been created for the search source. You should go to Scheduled Tasks and run the tasks necessary to create the index. This may include a harvest or import in addition to the index task. For more information, see Scheduled Tasks.

Note: When the status of the search source index is "false," a link to Search Source Tasks displays. The link opens the Search Source Tasks page so you can locate the tasks that need to be run to create the index.

Frequency

Specifies the period of time between the triggers that launch the indexing tasks. The Full Indexing Schedule fields change according to the Frequency option you select.

The table describes the fields that appear for each Frequency option.

Option Description

None

Specifies that the search tasks are not scheduled to run. You can run the tasks only by triggering the execution in Scheduled Tasks. For more information, see Triggering a task manually.

No fields appear for the None option.

Once

Specifies that the task will run on a specific date and time (local to the server). If you need the task to run before or after that date, you must trigger the task manually.

Note: If you enter a date in an invalid format, a parsing error occurs. Clear the invalid entry and re-enter the date in the correct format (mm/dd/yyyy) or choose a date from the calendar.

Interval

Triggers the task every time the specified number of minutes elapses. The interval continues from the time that the task was last triggered.

Hourly

Triggers the task once every hour at a specified number of minutes past the hour.

Daily

Triggers the task once every day at the specified hour and minute.

Weekly

Triggers the task once each week on the specified day, hour, and minute.

Monthly by Date

Triggers the task once each month on the specified date, hour, and minute.

Monthly by Day of Week

Triggers the task once each month on the specified week (first, second, third, or fourth), day, hour, and minute.

Custom Setup (Advanced)

Custom Setup lets you define a more precise frequency than is possible with the other frequency options, such as triggering tasks beginning and ending during specific hours and running only on specific workdays.

Note: With the exception of None and Once, the interval will continue until you change the Full Search Schedule settings or suspend the schedule. For more information, see Suspending and resuming a task’s schedule.

Frequency fields

The fields that appear below the Frequency drop-down list when you select an option specify the times when the task will run at the selected frequency. The fields that are available depend on the Frequency you selected. The following table describes the frequency fields.

Field Description Frequency Option

Date

Specifies the single day (local to the server) when you want the task to run. You can enter the date in the field (mm/dd/yyyy format) or choose the calendar ( inserts the date you select into the Date field).

Note: If you enter a date in an invalid format, a parsing error occurs. Clear the invalid entry and re-enter the date in the correct format (mm/dd/yyyy) or choose a date from the calendar.

  • Once

Week of Month

Specifies which week of the month (first, second, third, or fourth) to run the report. With the Day field, it allows you to run the task on a schedule such as "the first Monday of the month."

  • Monthly by Day of Week

Day

In the Weekly Monthly by Day of Week options, Day specifies the day of the week, Sunday through Saturday.

In the Monthly option, Day specifies the day of the month, 1 through 28 (to allow for February).

  • Weekly
  • Monthly by Date
  • Monthly by Day of Week

Hour

Specifies the hour (local to the server) when you want to trigger the task.

Note: Enter the hour as an integer from 0 to 23, where 0 is midnight and 23 is 11:00 pm.

  • Once
  • Daily
  • Weekly
  • Monthly by Date
  • Monthly by Day of Week

Minutes

Specifies the number of minutes past the hour when you want to trigger the task.

Note: In the Interval option, enter the number of minutes you want in the interval, up to 1440 (the number of minutes in a day). For all other options, enter the minutes as an integer from 0 to 59.

  • Once
  • Interval
  • Hourly
  • Daily
  • Weekly
  • Monthly by Date
  • Monthly by Day of Week

Starting at this hour

Specifies the hour of the day (local to the server) to run the first instance of the report. This is typically the first of a number of recurring triggers during the day.

Note: Enter the hour as an integer from 0 to 23, where 0 is midnight and 23 is 11:00 pm.

  • Custom Setup (Advanced)

Run

Specifies the interval throughout the day to trigger the report. You have these intervals available:

  • 1 through 6 hours
  • 30 minutes

20 minutes

  • Custom Setup (Advanced)

Repeat through hour

Specifies the hour of the day (local to the server) in which you want to trigger the last occurrence of the task.

Note:  Enter the hour as an integer from 0 to 23, where 0 is midnight and 23 is 11:00 pm.

Important: Tasks are triggered through the end of the hour.

For example, if you specify Run Every 20 Minutes and Repeat through hour 20, the task will run at 20:00, 20:20, and 20:40 (as well as other times throughout the day).

If you specify Run Every 1 Hours and Repeat through hour 20, the final triggering of the task will be at 20:00 (as well as other times throughout the day).

  • Custom Setup (Advanced)

Only run task on these weekdays

Specifies which days of the week to run the report. You can select more than one day. To remove a day, click the x next to the day.

  • Custom Setup (Advanced)

Delta Indexing Schedule

Specifies when the delta harvest task, and subsequent import and index tasks, runs for an ILS search source. The schedule settings are identical to those described in the Full Indexing Schedule (above).

When you schedule a task, you need to be aware of the location of the server in relation to your location. Scheduled times are local to the server hosting Enterprise. For example, if the server is located in the US Mountain time zone and you are located in the US Eastern time zone, a task scheduled for 11:00 pm on the 6th will run at 1:00 am on the 7th your local time.

Delta indicates that this scheduled task includes only the changes made in the ILS since the last full or delta index was created. It harvests only the new, deleted, or edited ILS records. Because it harvests only the changes, the delta index is much quicker than the full index. When you create the schedule for the full and delta index schedules, you should consider the size of your ILS database and the number of changes made on a daily or weekly basis. For example, for a large database with many changes, you might consider scheduling the delta index to run daily to update the Portfolio for the following day, and the full index to run each weekend. A smaller library might need to run the delta index weekly with a full index occurring once a month.

Related topics