The Data Prep (Paxata) documentation is now available on the DataRobot public documentation site. See the Data Prep section for user documentation and connector information. After the 2021.2 SP1 release, the content on this site will be removed and replaced with a link to the DataRobot public documentation site.
ClicktoPrep
As a data preparation product, Paxata is frequently used in conjunction with BI and data visualization tools, for example Tableau®, Power BI®, Qlik® and MicroStrategy ®. For tools that support hyperlinks or URLs, you can generate a Paxata ClicktoPrep link that takes you from your tools directly into:
- the last Step in your Paxata Project.
- a Paxata Project Filtergram.
- a specific Paxata Project Step that generated or modified the data.
You can then open the link from your BI or visualization tool, make modifications to the Paxata data, re-publish, 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 Paxata Project. You can easily copy your Project's base URL from the Project's general information page:
You can use this base URL to point from your visualization tool to the last Step in your Project. Or, you can continue to append the parameters described below to point to specific filtergrams or Steps in your Paxata Project.
ClicktoPrep for Paxata Project Filtergram
This type of link opens a Paxata 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:
See section Configure ClicktoPrep link for Paxata Project Filtergram below to create this type of link.
ClicktoPrep for Paxata Project Step
This type of link opens a Paxata Project, in edit mode, to:
- the last Step that edits or modifies a column.
or - the last [StepType] that edits or modifies a column, for example a “Find and Replace” Step on the column.
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:
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 panel.
See the section Configure a ClicktoPrep link for a Paxata Project Step to create this type of link.
Requirements and Considerations
Before creating Paxata ClicktoPrep links, keep the following requirements and considerations in mind:
- Your visualization tool must support URLs.
- You must have the required Paxata Resource-Level permissions to open any URL that directs you into a Paxata project.
Configure a ClicktoPrep link for Paxata Project Filtergram
The format and configuration parameters are described in this section. (For Tableau users, please see this section: Tableau Steps to Create a ClicktoPrep link for Paxata Project Filtergram.)
The format is as follows. Note the portion in bold is the base URL that was copied from the General page in Paxata as described in the beginning of this article.https://[server]/#/view/[projectname]?filtercolumn=[column]&filtervalue=[value]
Important:
- Everything after the # in the URL is case sensitive.
- In order to create a link for a Paxata Project Filtergram, your visualization tool must support dynamic URLs.
- If your Project’s name or a column’s name includes one or more spaces and you haven't copied it from the General information page as described above, then 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.
Configure a ClicktoPrep link for a Paxata Project Step
The format and configuration parameters are described in this section. (For Tableau users, please see this section: Tableau Steps to Create a ClicktoPrep link for Paxata Project Step.)
For the last Step that edits or modifies a column the format is as follows. Note the portion in bold is the base URL that was copied from the General page in Paxata as described in the beginning of this article.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. Note the portion in bold is the base URL that was copied from the General page in Paxata as described in the beginning of this article.https://[server]/#/edit/[projectname]/[columnname]?filter=[StepType]
These [StepTypes] are supported:
AnchorTableStep
AppendStep
BulkEditStep
ClusterEditStep
DuplicateColumnStep
EditColumnsStep
ExpressionStep
PivotStep
TransformStep
See the earlier section ClicktoPrep for Paxata Project Step for an explanation of each [Step Type].
Important:
- Everything after the # in the URL is case sensitive.
- If your Project’s name or a column’s name includes one or more spaces and you haven't copied it from the General information 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.
Tableau Steps to Create ClicktoPrep link for a Paxata Project Filtergram
Note: for tools that support dynamic hyperlinks or URLs, you can link directly to your Paxata Project with a filter applied based on your selection tool. This section explains how to specifically do this in Tableau.
1. Open your visualization in Tableau and go to: Worksheet ->Actions...
2. Select Add URL Action. Provide the following configuration information:
a). name for the link. This is the name for the link that is displayed in Tableau.
b.) the URL in this format, and note the portion in bold is the base URL that was copied from the General page in Paxata as described in the beginning of this article.
https://[server]/#/view/[projectname]?filtercolumn=[column]&filtervalue=[value]
Important: everything after the # in the URL is case sensitive.
c.) click to select Tableau column that will dynamically receive data from your URL
d.) ensure URL Encode Data Values is checked.
3. Click Test Link to verify the link works. Click OK to save.
Tableau Steps to Create ClicktoPrep link for a for Paxata Project Step
Note: for tools that support dynamic hyperlinks or URLs, you can link directly to your Paxata Project with a filter applied based on your selection tool. This section explains how to specifically do this in Tableau.
1. Open your visualization in Tableau and go to: Worksheet ->Actions...
2. Select Add URL Action. Provide the following configuration information:
a). name for the link. This is the name for the link that is displayed in Tableau.
b.) the URL in format
- for the last Step that edits or modifies a column, and note the portion in bold is the base URL that was copied from the General page in Paxata as described in the beginning of this article.
https://[server]/#/edit/[projectname]/[columnname] - for the last [StepType] that edits or modifies a column, and note the portion in bold is the base URL that was copied from the General page in Paxata as described in the beginning of this article.
https://[server]/#/edit/[projectname]/[columnname]?filter=[StepType]
See earlier section ClicktoPrep for Paxata Project Step for an explanation of each [StepType]
Important: everything after the # in the URL is case sensitive.
c.) ensure URL Encode Data Values is checked.
3. Click Test Link to verify the link works. Click OK to save.
#FORM FOLLOW