You are viewing documentation for an older version.

Click here to view the latest documentation.

Profiles UI

While creating a Profiles project, you can choose either of the below:

• Profile Builder (PB) CLI which gives you the flexibility to create, develop, and debug your Profiles project using various commands in fine detail. You can explore and implement the exhaustive list of features and functionalities offered by Profiles.
• Profiles UI which provides a step-by-step intuitive workflow in the RudderStack dashboard. You can configure your project, schedule its run, explore the outputs and the user profiles.

This guide lists the detailed steps to create a Profiles project in the RudderStack dashboard.

Create Profiles project

1. Log in to the RudderStack dashboard and go to Unify > Profiles option in the left sidebar.
2. Click Create project.

3. Select Basic Entity Setup on the next screen.

You can also import an existing project from your Git repository. See Import Profiles from Git for more information.

4. Enter a unique name and description for your Profiles project.
5. Select a data warehouse from the dropdown and the source(s) connected to the warehouse.

RudderStack currently supports the Snowflake, Redshift, Databricks, and BigQuery warehouses for creating a Profiles project.

You must connect an event stream source to one of the above warehouses and sync data at least once so that they populate in the dropdown.

For example, in the below image, the Node event stream source (es src) is connected to the Snowflake warehouse destination (cohort sample ) containing the schema SAMPLE_SHOPIFY_DATA.

6. Click Add mapping and provide values to map the existing ID types from the above-selected event stream source:

You can see some predefined mappings for the identifiers which comes from the Profiles library project.

Here, Event column represents the tables present in the warehouse, Property column represents the column name in that table, and ID type represents the type of identifier.

7. Define features either by adding a custom feature or selecting a pre-defined feature as shown:

• To add a custom feature, click Add a custom feature and enter the relevant feature details:

• To use a pre-defined feature, select the required feature from the Template features library.

8. Select the schedule type.
9. Enter the warehouse details where you want to store this Profiles project.
10. Finally, review all the provided details and click Create Profiles project.

Convert to a Git project

Once you set up a Profiles project in the dashboard, you can convert it to a configuration-based Git repository by uploading it either to GitHub, GitLab, or Bitbucket:

You cannot revert to your UI-based project after Git conversion. Once converted, all the project edits and updates can only be done via Git repository.

1. Navigate to the Unify > Profiles option in the left sidebar to view all your Profiles projects.
2. Click Convert to Git button next to the project you want to convert.
3. Create a new Git repository.
4. Enter the SSH URL of your Git repository to be used for your Profiles project and click Continue.
5. Copy the SSH public key and click Add deploy key which will take you to your git repository’s Deploy keys section. See deploy keys section in the GitHub, GitLab, or Bitbucket documentation for more information.

Make sure your Git repository has at least one commit for successful validation.

7. Click Add deploy key, add a Title, paste your SSH public key, and click Add key.
8. Click Continue to let RudderStack verify read access.
9. Click Download project to download the Profiles project you set up in the dashboard.
10. Commit the downloaded project to your Git repository.
11. Once the project is committed successfully, return to the dashboard and click Convert Profiles project.

Start/Stop project run

Once created, you can:

• Run your Profiles project using either of the following ways:
  • Clicking Run in the History tab of the project.
  • Programmatically using the Profiles API.
    
    
• Stop a running project by clicking the red button in the Status column:

It might take up to a few seconds to stop a running project.

Download project

To download the Profiles project, click the arrow icon corresponding to your Profiles project and click Download this project:

Once downloaded, you can view the project folder structure, modify the files, or run various commands to execute the desired use-cases.

Project details

To view the Profile project details, click the arrow icon corresponding to your Profiles project:

Profile details

You can also view the details of a specific profile in your Profiles project:

1. In your Profiles project’s Entities tab, click View button across the entity for which you want to see the profile:

   

2. Click Profile Lookup tab to search a profile record.

3. Type an available unique identifier like email, phone number, user id, anonymous id etc. and click Search user profile.

   

Note that:

• It can take a few minutes for the data preview to show up in your profile’s History tab.
• If you keep getting a blank screen, it may be because you do not have sufficient access. Make sure you have a Connections Admin resource role with access to PII. In case the problem persists, contact RudderStack support.

FAQ

When trying to fetch data for a lib project, then data/columns are shown as blank. What should I do?

You’ll need to sync data from a source to a destination. If data is synced from the source you are using and not from some pre-existing tables in the destination, the missing column/data issues should not occur.

I am not able to see Unify tab on the web app though I have admin privileges. What should I do?

Disable any adblockers on your web browser.

Questions? Contact us by email or on Slack