Custom Dataset Legacy Compatibility
  • 27 Mar 2025
  • 3 minute read
  • Dark
    Light
  • PDF

Custom Dataset Legacy Compatibility

  • Dark
    Light
  • PDF

Article summary

If your institution still uses local/Slate Template Library features, additional steps are required to use your custom dataset with those features. This article will walk you through the steps to ensure your dataset is compatible with any legacy tools that may depend upon legacy querying functionality (local/Slate Template Library queries).

These steps are optional, and are not recommended unless needed for a specific purpose. Completing these steps will require using database tools that are shown in gray text and marked as “(legacy tool)”.

Best Practice

Local and Slate Template Library queries/query bases are no longer in development and are not supported by Technolutions. Unless absolutely necessary, we advise against following the steps in this article and instead recommend making the transition to using only Configurable Joins queries and database tools.

Step 1. Preparation

This article assumes you have already completed all steps noted in the Creating a Custom Dataset article.

Step 2. Refresh the Slate Template Library

  1. From the main navigation, select Database.

  2. Under Configurations, select Slate Template Library (legacy tool).

  3. Click the link to manually refresh the Slate Template Library.

    Refresh Slate Template Library

Step 3: Add the custom dataset query base

Before Configurable Joins, it was necessary to add query bases manually before they could be used. Creating a custom query base allows you to use a new dataset in the areas of Slate that do not yet support Configurable Joins, or where Local or Slate Template Library filters are still in use. If your institution is still using the legacy Lookup tool, this step is required to add your new dataset to that tool.

To add the query base for the custom dataset:

  1. From the main navigation, select Database.

  2. Under Configurations, select Slate Template Library (legacy tool).

  3. In the Search Library bar, enter the name of the new dataset.

  4. Under Query Bases, click Add. A popup appears.

    Add_Query_Base_to_Slate_Template_Library.png

  1. Set Status to Active.

    Insert_Record_in_Query_Bases_-_Set_Status_and_Read_Permission.png

  1. In the Order field, enter a number. This number determines the position of the new dataset in the Lookup tool relative to other record types.

  2. Select a Read Permission for the dataset query base. Leave all other settings unchanged.

  3. Click Save.

    New_Query_Base_-_Lookup_Order.png

Step 4: Creating the Lookup

Creating a Lookup for a custom dataset displays it in the Record Lookup tool. The Lookup also determines the columns that display for the Dataset Records in the Record Lookup tool.

To create the Lookup:

  1. From the main navigation, select Database.

  2. Under Configurations, select Slate Template Library (legacy tool).

  3. Click the refresh the Slate Template Library link at the top of the page. A system dialog appears.

  4. Click OK.

  5. In the Search Library bar, enter the name of the new dataset.

  6. Under Query Custom Exports, select one of the results from the list (it doesn't matter which) and click Add. A popup appears.

  7. Configure the following settings:

    • Base: Select your new custom dataset.

    • Name: Enter Lookup

    • Default: Yes

  8. Click Save.

    Create_Custom_Dataset_Lookup_Record.png

With the Lookup record created, we'll create the partial match.

Step 5: Creating the partial match

Partial Match creates a “search box” that can be used in the Record Lookup tool to find specific Dataset Records.

To create a partial match:

  1. From the main navigation, select Database.

  2. Under Queries, select Query Exports/Filters.

  3. Click Insert. A popup appears.

  4. Configure the following settings:

    • Base: Select your new custom dataset

    • Name: Enter Partial Match

    • Where Clause: Enter (contains(d. [index], ))

    • #1 Operators: Enter CONTAINS

  5. Click Save.

    Create_Custom_Dataset_Partial_Match_Record.png

Step 6: Assign the New Record form to the Query Base

Locate the New Record form for your custom dataset. This will be needed for the following steps.

  1. On the New Record form, right-click the New Registration link on the registration page, and then select Copy link address.

  2. Select Database on the top navigation.

  3. Select Query Bases (legacy tool).

  4. Select the Query Base of the new dataset.

  5. In the Create Record URL settings, paste the New Registration link that was previously copied.

  6. Select Save.

    2021-10-29_15-39-59.png

When manually adding a record to the custom dataset, if an error appears that reads "Resource not available," this indicates that the query base has not been properly configured. Go to the Query Base with the Database tool and complete the Create Record URL setting.


Was this article helpful?