Creating a New Data Set

This section provides a detailed, step-by-step guide to creating a Data Set and explaining its related functions.

Data Set Creation using an RDBMS Connector

Use the RDBMS Data Connector to author reusable, database-native queries as Data Sets for Widgets, Dashboards, DS Lab, Data as API, and more.

Steps

1. Navigation path: Data Center → My Connectors → Standard Connectors.

2. Select an RDBMS data connector from the list.

3. Click the Options () icon.

4. Select Create Data Set from the context menu.

• The Data Set page opens.

Configure the Data Set

• Service Name: Enter a user-defined name for the data set.

• Description: Provide a brief description (optional).

• Data Connector Name: Pre-filled based on the selected connector.

• Database Name: Pre-filled from the connector.

• Query: Write a valid query service in the editor. (Use Ctrl+Space for query assistance.)

• Table Information: The right panel lists tables and columns from the database. Double-click a table or column to auto-generate a sample query for quick validation.

Validate, Preview, Protect, Save

1. Click Validate to execute the new Data Set.

   • A notification confirms successful execution.

2. The Preview is displayed at the bottom of the page.

3. Open the Data Protection Rule drawer by using the Ellipsis ()icon next to a column in the preview.

4. Click Save.

   • A notification confirms completion.

   • The new Data Set is added to the Data Sets List.

Note: Once a Data Set is added to the Data Sets list, you can use it to create a Widget, Data Form, Data As API, or Data Preparation. Click the Ellipsis () icon provided next to the Data Set to open the Options context menu.

Applying Dynamic Filter in an RDBMS Data Set

Add dynamic runtime filters directly inside the query.

1. Open the Data Set form for any RDBMS connector.

2. In Query, insert the filter using the @text@ syntax.

   • Example (pattern): ... WHERE country = @country@ AND year >= @fromYear@

3. Click Validate.

   • A Filter List dialog appears, requesting values for each @...@.

4. Enter filter value(s) and click Continue.

   • A notification appears; filtered Preview is shown at the bottom.

5. Click Save to save the Data Set form.

   • A notification confirms creation.

   • The Data Set is saved with the filter configuration in the Data Sets list.

Notes:

• Use Ctrl+Space for query help.

• Click the Help Center icon on the Data Set form to view query formation rules in a pop-up.

• You can customize the Data Sets list by Data Connector Type, Data Connector, and Publish Status from the top of the list page.

Add Data Protection Rules

Prerequisites:

• You have a Data Set open (e.g., Data Center → Data Sets → Edit).

• Your query validates and returns a preview.

You can access the Data Protection Rule drawer by clicking the Ellipsis icon provided next to a column in the Preview.

Steps to Add a Data Protection Rule

1. Open the Data Set

   • Go to Data Center → Data Sets and Edit/View the target Data Set.

   • (Optional) Click Validate to load the Preview grid.

2. Open Data Protection

   • In the Data Set form, open the DATA PROTECTION section and click Add Rule → The Data Protection Rule dialog opens (as shown in the image).

3. Choose the target column

   • Column Name: pick the column to protect (e.g., Commission).

4. Select the rule type

   • Select Rule Type: choose one of the following:

     • Redaction – hide characters fully or partially.

     • Masking – replace characters with a mask character.

     • Hashing – irreversibly hash the value.

     • Date Generalization – reduce date precision (Year/Month/Quarter/Week).

5. Configure rule options (based on type)

   • Redaction

     • Select Redaction Type: Full or Partial.

     • For Partial, set Start and Length (the redacted segment).

   • Masking

     • Set Start and Length; choose the Masking character.

   • Hashing

     • Choose the algorithm: SHA-25, SHA-384, or SHA-512

   • Date Generalization

     • Choose the unit: Year, Month, Quarter, or Week.

6. Save the rule

   • Click Save in the Data Protection Rule dialog.

   • The rule is added to the Data Set’s protection rules list.

Example:

• Column Name: Commission

• Select Rule Type: Redaction

• Select Redaction Type: Partial

• Start: (set start position)

• Length: 2

• Save → values in Commission show partial redaction in Preview.

  

Note:

• Click Validate to preview the protected output.

• Click Save on the Data Set form to persist the configuration.

Restricting Displayed Data for End Users via a Data Set

Control which data dashboard end-users can see using Data Service (Data Set)–driven restriction.

Prerequisite:

Data Restriction through Data Service is interconnected with multiple platform plugins. Users should have a good understanding of the involved BDB Platform modules and the Dashboard Designer plugin.

End-to-end flow

1. Create a Custom Field in the Configurations admin section.

2. Create a Data Set using the ENV with the selected Custom Field Key.

3. Create a Dashboard that uses this Data Set.

4. Publish the Dashboard to the portal.

5. Create a new user (Security module) and pass the Custom Field Value (or update an existing user with the value).

6. Share the Dashboard with the same Platform user using the Share with User option.

7. From the updated user’s account, open the shared dashboard.

• The dashboard displays only the permitted data defined by the admin via the Custom Field value.

Tips:

• Service Name: Use domain-specific names (e.g., Sales_Daily_Fact) to improve reuse.

• Parameters: Prefer @text@ filters over hard-coded literals for reusability.

• Push to VCS: Commit after meaningful query changes to maintain recoverable history.

• Protection: Apply Data Protection for PII or sensitive attributes before sharing/publishing.

Troubleshooting

• Validate fails: Check connection, schema/table names, or syntax; use Table Information to auto-generate a sample and iterate.

• No Preview data: Ensure the query returns rows; remove or adjust filters; confirm filter values entered in Filter List.

• Publish not visible: Look for the Publish icon state; ensure you have the rights to publish.

• Share restrictions not applied: Verify Custom Field Key/Value mapping and that the user account is updated correctly.

Use Assist to Write or Modify a Data Set Query

Assist helps you generate or refine SQL for a Data Set directly from the Query editor.

Prerequisites:

• You are in Data Center → Data Sets → Create / Update.

• A Data Connector and Database Name are already selected.

1. In the Query editor, locate the Assist launcher at the top-right of the editor (highlighted in the image).

   
2. Click the launcher.

   • An inline Assist bar appears above the editor with the placeholder “Generate Query” and two controls:

     • Run () – submit your request.

     • Close () – dismiss Assist.

Generate a new query (natural language → SQL)

The Assist support inside a query builder allows the user to create an SQL query based on their instructions in natural language.

1. In the Assist bar, describe what you want in plain language. Examples:

   1. “Select the top 10 branches by total sales in the last 30 days.”

   2. “List customer_id, day_name, commission where day_name = @dayName@.”

2. Click the Run () icon.

   
3. The Assist drafts an SQL statement and displays it with Accept and Reject options.

   
4. Once accepted, the query will be inserted into the Query editor (it can replace or append, depending on context).

5. Review the SQL; adjust if needed.

6. Click Validate.

   
7. Provide a name and save the data set after successful validation.

   

Modify an existing query

1. With your current SQL in the Query editor, open Assist.

2. In the Assist bar, specify the change you want. Examples:

   • “Add a WHERE filter for day_name = @dayName@.”

   • “Aggregate by branch_id and include SUM(commission) as total_commission.”

   • “Convert to parameterized query with @fromDate@ and @toDate@.”

3. Click Run.

   • Assist will display the updated query with the Accept and Reject options.

   • Accept to bring the updated query to the query builder space.

Validate and save

1. Click Validate to execute and view the Preview.

2. If the results are correct, click Save.

Notes & Tips:

• The editor supports inline hints—press Ctrl+Space for autocomplete and function help.

• You can close the Assist bar at any time with X (your editor contents remain).

• Use BDB parameter syntax in prompts when needed: @paramName@ (e.g., @dayName@).

• Double-click tables/columns in Table Information to auto-insert sample SQL, then refine with Assist.

• Generated SQL uses the dialect of the selected Data Connector (e.g., ClickHouse, Postgres).

• Always validate after Assist changes to confirm syntax and results with your source.

Creating a Data Set using an API Connector

Use this flow to build a Data Set from an API Connector (for example, Google Analytics). The fields presented on the form may vary by API type.

Prerequisites:

• An API Connector is already created and authenticated (e.g., via OpenID Settings) and visible on the Data Source list.

• You have Data Center access and permission to create Data Sets.

Steps

1. Open the Data Set wizard

   • From the Data Center homepage, click the New menu.

   • Select Data Set from the context menu. Result: The Data Source page opens, listing all data connectors.

2. Locate your API Connector

   • Use the Data Source filter or the Search Data Connectors bar to find the connector by name or type.

   • Select the required Data Source tile.

   • Click the Create Data Set icon (+) on that tile.

3. Complete the API-specific form (Example: Google Analytics Dataset form) Fill in the following information:

   • Dataset Name — Enter any user-defined name for the new dataset.

   • Description — Provide a brief description (optional).

   • Data Connector Name — Pre-defined based on the selected connector.

   • Report Selection

     • Select Report Type — Choose a report type from the drop-down.

     • (If applicable) Select Sub-report Type — Appears when the selected report type has sub-types.

     • Columns — Select required columns using the checkmarks next to each field.

4. Preview the data

   • Click Preview data. Result: The Data Preview renders below the form.

5. Save the Data Set

   • Once the preview succeeds, the Save option is enabled.

   • Click Save.

• A success message confirms creation, and the new dataset is added to the Data Sets list.

Notes:

• The fields shown when creating a Data Set using an API Data Connector may differ based on the selected API Connector Type (e.g., Google Analytics vs. Salesforce).

• If the API requires authentication, ensure it is configured in Open ID Settings and mapped in the connector beforehand.

Troubleshooting

• No columns listed / form options missing: Confirm you selected the correct Report Type (and Sub-report Type, if required).

• Preview fails: Re-check connector authentication, API permissions/scopes, and any required parameters (date ranges, account IDs, etc.).

• Save disabled: Run Preview data first; Save is enabled only after a successful preview.

• Connector not found: Use the Search Data Connectors bar and verify the connector exists and is accessible to your role.