Skip to content

Click in-app to access the full platform documentation for your version of DataRobot.

ClicktoPrep links

As a data preparation tool, Data Prep is frequently used in conjunction with business intelligence (BI) and data visualization tools, for example Tableau®, Power BI®, Qlik® and MicroStrategy®. For tools that support hyperlinks or URLs, you can generate a Data Prep ClicktoPrep link that takes you from your tools directly to any of the following:

  • The last step in your Data Prep project
  • A Data Prep project Filtergram
  • A specific Data Prep project step that generated or modified the data

You can then open the link from your BI or visualization tool, make modifications to the Data Prep data, republish, and refresh the visualization or report to reflect your updated data.

To begin, you need the base URL for your project, which takes you to the last step in your Data Prep project. Copy your project's base URL from the project's General page.

Use this base URL to point from your visualization tool to the last step in your project. Or, continue to append the parameters described in the following sections to point to specific Filtergrams or steps in your Data Prep project.

This type of link opens a Data Prep project Filtergram for the dataset on the column and value you specify. For example, the following ClicktoPrep link navigates to the Customers project and opens a Filtergram on the column City filtered to Pasadena.

To create this type of link, see Configure links to project Filtergrams.

This type of link opens a Data Prep project in edit mode, set to one of the following:

  • The last step that edits or modifies a column.

  • The last [StepType] that edits or modifies a column, for example a “Find and Replace” step on the column.

The following [StepTypes] are supported by ClicktoPrep.

Note

If you have more than one of these [StepTypes] in your project, the URL points to the last one that occurs in your Steps pane.

Example 1

The following ClicktoPrep link navigates to the last step in your Customer project that affected or modified data in the Division column.

Example 2

The following ClicktoPrep link navigates to the Customer project where the last "Find + Replace" [BulkEditStep] step was made on the Company column.

To create this type of link, see Configure links to project steps.

Requirements and considerations

Before creating Data Prep ClicktoPrep links, keep the following requirements and considerations in mind:

  • Your visualization tool must support URLs.
  • You must have the required Data Prep Resource-Level permissions to open any URL that directs you into a Data Prep project.

The format and configuration parameters for ClicktoPrep project Filtergram links are described in this section. (For Tableau users, see Create links to project Filtergrams in Tableau.)

The format is as follows.

https://[server]/#/view/[projectname]?filtercolumn=[column]&filtervalue=[value]

Tip

The characters before the question mark form the base URL. Copy the base URL from the ClicktoPrep URL field on the General page.

The following are requirements for project Filtergram links:

  • Everything after the # in the URL is case sensitive.
  • In order to create a link for a Data Prep project Filtergram, your visualization tool must support dynamic URLs.
  • If your project name or a column name includes one or more spaces and you haven't copied it from the General page, replace (resolve) each space in the URL with %20 (the HTML encoding value for a space.) For example: https://<server>/#/edit/Web%20Campaigns%20demo/Phone%20Number

Note

Some visualization tools provide an option to automatically encode the spaces for you. Refer to HTML URL Encoding Reference for other special characters that require encoding.

The format and configuration parameters for ClicktoPrep project step links are described in this section. (For Tableau users, see Create links to Data Prep project steps in Tableau.

For the last step that edits or modifies a column, the format is as follows:

https://[server]/#/edit/[projectname]/[columnname]

For the last [StepType] that edits or modifies a column, for example a “Find and Replace” step on the column, the format is as follows.

https://[server]/#/edit/[projectname]/[columnname]?filter=[StepType]

Tip

The characters before the question mark form the base URL. Copy the base URL from the ClicktoPrep URL field on the General page.

These [StepTypes] are supported:

  • AnchorTableStep
  • AppendStep
  • BulkEditStep
  • ClusterEditStep
  • DuplicateColumnStep
  • EditColumnsStep
  • ExpressionStep
  • PivotStep
  • TransformStep

See ClicktoPrep links to project steps for an explanation of the [StepTypes].

Following are requirements for project step links:

  • Everything after the # in the URL is case sensitive.
  • If your project name or a column name includes one or more spaces and you haven't copied it from the General page as described above, you must replace (resolve) each space in the URL with %20 (the HTML encoding value for a space.) For example: https://<server>/#/edit/Web%20Campaigns%20demo/Phone%20Number

Note

Some visualization tools provide an option to automatically encode the spaces for you. Refer to HTML URL Encoding Reference for other special characters that require encoding.

For tools that support dynamic hyperlinks or URLs, you can link directly to your Data Prep project with a filter applied based on your selection tool. This section explains how to do this in Tableau.

  1. Open your visualization in Tableau and go to: Worksheet > Actions...

  2. Select Add URL Action and provide the following configuration information:

    1. Name for the link displayed in Tableau.
    2. The URL is in this format: https://[server]/#/view/[projectname]?filtercolumn=[column]&filtervalue=[value] The characters before the question mark form the base URL. Copy the base URL from the ClicktoPrep URL field on the General page. Everything after the # in the URL is case sensitive.
    3. Click to select the Tableau column that will dynamically receive data from your URL.
    4. Ensure URL Encode Data Values is checked.
  3. Click Test Link to verify the link works.

  4. Click OK to save.

For tools that support dynamic hyperlinks or URLs, you can link directly to your Data Prep project with a filter applied based on your selection tool. This section explains how to do this in Tableau.

  1. Open your visualization in Tableau and go to: Worksheet > Actions...

  2. Select Add URL Action and provide the following configuration information:

    1. Enter the name for the link displayed in Tableau.
    2. Specify the URL using one of these formats:

      • For the last step that edits or modifies a column: https://[server]/#/edit/[projectname]/[columnname]
      • For the last [StepType] that edits or modifies a column: https://[server]/#/edit/[projectname]/[columnname]?filter=[StepType]

      The characters before the question mark form the base URL. Copy the base URL from the ClicktoPrep URL field on the General page. Everything after the # in the URL is case sensitive.

      See ClicktoPrep links to project steps for an explanation of the [StepTypes].

    3. Click to select Tableau column that will dynamically receive data from your URL.

    4. Ensure URL Encode Data Values is checked.
  3. Click Test Link to verify the link works.

  4. Click OK to save.

Updated October 28, 2021
Back to top