Research Data Keys

Data keys allow for the storing of information from a source. These keys act as destinations that may be leveraged by either a single source (when configured as a private key) or from multiple sources. 

For example, the data key "Engagement Score" may be supplied by multiple sources. By contrast, a score or rating from a specific enrollment management solution should only ever apply to that particular source (such as a Capture score). 

By leveraging shared keys where the underlying data is ultimately the same, users can look across multiple sources when querying and reporting in order to evaluate the information in the aggregate. Or, users may choose to specify a particular key from a particular source.

Create a shared data key

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

  1. Navigate to the Research Configurations section of the Database.
  2. Click Data Keys in the right-hand navigation.
  3. Click Add Data Key.
  4. In the pop-up, enter the following:
    • Name: enter a name for the data key, such as Engagement.
    • Key: provide a computer friendly key, using no spaces or special characters, such as engagement.
    • Memo: add any necessary 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 while viewing the research data on the record.
    • Category: select a category from the dropdown, or select Other to create a new category. Categories ultimately become a tab when viewing the individual research item on a record.
    • Status: select 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. 
    • Prompt Key: if selecting the data type Prompt Value, choose the appropriate prompt list by selecting the prompt key from the list. 
    • Add to Research Sources: this will display existing research sources. Select the source or sources for which the data key should be associated.
  5. Click Save.

New_Research_Data_Shared_Key.png

   

  Tip

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

Create a Private Key

Private keys allow the storing of data that is associated with a single research source. Often, these keys are items unique to the business processes of external research sources. For example, some services provide proprietary ratings that only make sense in context of their own source of data. 

Create a private key

  1. Navigate to the research source that will be associated with the private key.
  2. Click Add Data Key on the right side of the page.

    Add_Private_Data_Key.png

    In the popup, select Add New Key from the select list.

  3. Click Next.
  4. Enter the following details:
    1. Name: Enter the name of the data key, such as Technolutions' Rating
    2. Key: provide a computer friendly key, using no spaces or special characters, such as technolution_rating.
    3. Memo: add any necessary 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 while viewing the research data on the record.
    4. Category: select a category from the dropdown, or select Other to create a new category. Categories ultimately become a tab when viewing the individual research item on a record.
    5. Status: select Active.
    6. 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.
    7. Prompt Key: if selecting the data type Prompt Value, choose the appropriate prompt list by selecting the prompt key from the list. 
    8. Private Key Indicator: selected by default, this indicates the key is private and intended just for this particular research source.
  5. Click Save.

New_Research_Private_Key.png

Was this article helpful?
0 out of 0 found this helpful