Research Data Keys

Updated 18 Apr 2024
8 minute read

Print
Share
Dark
Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

Data keys enable storing of information from a source. These keys act as destinations that can be used from multiple sources (when configured as a shared key) or from a single source (when configured as a private key). By using shared keys where the underlying data is ultimately the same, users can look across multiple sources when querying and reporting to evaluate the information in the aggregate. Or, users might choose to specify a particular key from a particular source.

Tip
Prompt lists for research data keys should be created just like all other prompts - using the Prompts tool. If a newly created prompt list doesn't immediately appear when attempting to associate the list with a data key, force-refresh the prompt cache to make the option available.

Admissions Example

Creating a Shared Data Key

To create a data key (destination) that can be contributed to from multiple research sources:

Click Database on the Slate navigation bar. The Database page appears.
In the Configurations area, click Research Configurations. The Research Configurations summary page appears.
Click Data Keys on the right of the page. The Research Data Keys page appears.
Click Add Data Key. An Edit Data Key popup appears.
Enter the following configurations:
Name: Enter a name for the data key, such as “Engagement.”
Key: Provide a computer friendly key (lower case, with no spaces or special characters), such as “engagement.”
Memo: Add any desired descriptive text to provide additional information about the values stored in this key. The memo will appear as a pop-up when clicking the "i" icon when viewing the research data on the record.
Category: Select a category from the list, or select Other to create a new category. Categories appear as a tab when viewing the individual research item on a record.
Status: Set to Active.
Data Type: Select the type of data to be stored in this key. The options include: Real Number, Money, Integer, String (Paragraph), String, Link, Prompt Value, Date, Date/Time. If selecting Prompt Value, a Prompt Key select list appears.
Prompt Key: If the Prompt Value data type was selected, choose the appropriate prompt key from the list.
Add to Research Sources: Existing research sources appear here. Select the source or sources that will be associated with this data key.
Click Save. The new data key appears in the list on the Research Data Keys summary page.

Creating a Private Key

To create a private data key specific to a research source:

Click Database on the Slate navigation bar. The Database page appears.
In the Configurations area, click Research Configurations. The Research Configurations summary page appears with a list of existing research sources.
Select an existing research source from the list. The research configuration editor appears.
Tip
For information on creating a new research source configuration, refer to the Research Sources article in the Knowledge Base.
Select the Manage Private Keys tab. A list of existing private keys (if any) appears on the page.
Click Add Data Key. An Add Data Key popup appears.
Select Add New Key and click Next. An Edit Data Key popup appears.
Enter the following configurations:
Name: Enter a name for the data key, such as “Technolutions Rating.”
Key: Provide a computer-friendly key (lower case, with no spaces or special characters), such as “technolutions_rating.”
Memo: Add any desired descriptive text to provide additional information about the values stored in this key. The memo will appear as a pop-up when clicking the "i" icon when viewing the research data on the record.
Category: Select a category from the list, or select Other to create a new category. Categories appear as tabs when viewing the individual research item on a record.
Status: Set to Active.
Data Type: Select the type of data to be stored in this key. The options include: Real Number, Money, Integer, String (Paragraph), String, Link, Prompt Value, Date, Date/Time. If selecting Prompt Value, a Prompt Key select list appears.
Prompt Key: If the Prompt Value data type was selected, choose the appropriate prompt key from the list.
Private key indicator: This is selected by default, indicating that the key is private and intended only for this research source.
Click Save. The private data key appears on the research source summary page.

Advancement Example

Creating a Shared Data Key

To create a data key (destination) that can be contributed to from multiple research sources:

Click Database on the Slate navigation bar. The Database page appears.
In the Configurations area, click Research Configurations. The Research Configurations summary page appears.
Click Data Keys on the right of the page. The Research Data Keys page appears.
Click Add Data Key. An Edit Data Key popup appears.
Enter the following configurations:
Name: Enter a name for the data key, such as “Estimated Capacity.”
Key: Provide a computer friendly key (lower case, with no spaces or special characters), such as “estimated_giving_capacity.”
Memo: Add any desired descriptive text to provide additional information about the values stored in this key. The memo will appear as a pop-up when clicking the "i" icon when viewing the research data on the record.
Category: Select a category from the list, or select Other to create a new category. Categories appear as a tab when viewing the individual research item on a record.
Status: Set to Active.
Data Type: Select the type of data to be stored in this key. The options include: Real Number, Money, Integer, String (Paragraph), String, Link, Prompt Value, Date, Date/Time. If selecting Prompt Value, a Prompt Key select list appears.
Prompt Key: If the Prompt Value data type was selected, choose the appropriate prompt key from the list.
Add to Research Sources: Existing research sources appear here. Select the source or sources that will be associated with this data key.
Click Save. The new data key appears in the list on the Research Data Keys summary page.

Creating a Private Key

To create a private data key specific to a research source:

Click Database on the Slate navigation bar. The Database page appears.
In the Configurations area, click Research Configurations. The Research Configurations summary page appears with a list of existing research sources.
Select an existing research source from the list. The research configuration editor appears.
Tip
For information on creating a new research source configuration, refer to the Research Sources article in the Knowledge Base.
Select the Manage Private Keys tab. A list of existing private keys (if any) appears on the page.
Click Add Data Key. An Add Data Key popup appears.
Select Add New Key and click Next. An Edit Data Key popup appears.
Enter the following configurations:
Name: Enter a name for the data key, such as “Technolutions Rating.”
Key: Provide a computer-friendly key (lower case, with no spaces or special characters), such as “technolutions_rating.”
Memo: Add any desired descriptive text to provide additional information about the values stored in this key. The memo will appear as a pop-up when clicking the "i" icon when viewing the research data on the record.
Category: Select a category from the list, or select Other to create a new category. Categories appear as tabs when viewing the individual research item on a record.
Status: Set to Active.
Data Type: Select the type of data to be stored in this key. The options include: Real Number, Money, Integer, String (Paragraph), String, Link, Prompt Value, Date, Date/Time. If selecting Prompt Value, a Prompt Key select list appears.
Prompt Key: If the Prompt Value data type was selected, choose the appropriate prompt key from the list.
Private key indicator: This is selected by default, indicating that the key is private and intended only for this research source.
Click Save. The private data key appears on the research source summary page.

Student Success Example

Creating a Shared Data Key

To create a data key (destination) that can be contributed to from multiple research sources:

Click Database on the Slate navigation bar. The Database page appears.
In the Configurations area, click Research Configurations. The Research Configurations summary page appears.
Click Data Keys on the right of the page. The Research Data Keys page appears.
Click Add Data Key. An Edit Data Key popup appears.
Enter the following configurations:
Name: Enter a name for the data key, such as “Risk Score.”
Key: Provide a computer friendly key (lower case, with no spaces or special characters), such as “risk_score.”
Memo: Add any desired descriptive text to provide additional information about the values stored in this key. The memo will appear as a pop-up when clicking the "i" icon when viewing the research data on the record.
Category: Select a category from the list, or select Other to create a new category. Categories appear as a tab when viewing the individual research item on a record.
Status: Set to Active.
Data Type: Select the type of data to be stored in this key. The options include: Real Number, Money, Integer, String (Paragraph), String, Link, Prompt Value, Date, Date/Time. If selecting Prompt Value, a Prompt Key select list appears.
Prompt Key: If the Prompt Value data type was selected, choose the appropriate prompt key from the list.
Add to Research Sources: Existing research sources appear here. Select the source or sources that will be associated with this data key.
Click Save. The new data key appears in the list on the Research Data Keys summary page.

Creating a Private Key

To create a private data key specific to a research source:

Click Database on the Slate navigation bar. The Database page appears.
In the Configurations area, click Research Configurations. The Research Configurations summary page appears with a list of existing research sources.
Select an existing research source from the list. The research configuration editor appears.
Tip
For information on creating a new research source configuration, refer to the Research Sources article in the Knowledge Base.
Select the Manage Private Keys tab. A list of existing private keys (if any) appears on the page.
Click Add Data Key. An Add Data Key popup appears.
Select Add New Key and click Next. An Edit Data Key popup appears.
Enter the following configurations:
Name: Enter a name for the data key, such as “Risk Details.”
Key: Provide a computer-friendly key (lower case, with no spaces or special characters), such as “risk_details.”
Memo: Add any desired descriptive text to provide additional information about the values stored in this key. The memo will appear as a pop-up when clicking the "i" icon when viewing the research data on the record.
Category: Select a category from the list, or select Other to create a new category. Categories appear as tabs when viewing the individual research item on a record.
Status: Set to Active.
Data Type: Select the type of data to be stored in this key. The options include: Real Number, Money, Integer, String (Paragraph), String, Link, Prompt Value, Date, Date/Time. If selecting Prompt Value, a Prompt Key select list appears.
Prompt Key: If the Prompt Value data type was selected, choose the appropriate prompt key from the list.
Private key indicator: This is selected by default, indicating that the key is private and intended only for this research source.
Click Save. The private data key appears on the research source summary page.

Was this article helpful?

What's Next

Research Sources

Table of contents