Components are the building blocks of your data analysis dashboards. There are three types of components you can use to build your dashboard:
- Interactive: Lets users assign custom values to pipeline parameters.
- Data Integration: Allows users to upload data or view data outputs.
- Content: Embed static text and images into your analysis.
Interactive
Interactive components enable users to assign values to pipeline parameters. These values can influence the behavior of each pipeline run and change the output that appears in the analysis.
If the end user leaves an interactive field blank:
- Prophecy first checks for a default value in the component.
- If you did not define a default value for the component, Prophecy uses the default value of the pipeline parameter.
Text Input
The user can enter any text into the field. Only string-type parameters are supported.
| Setting | Description | Required |
|---|
| Configuration field | Name of the pipeline parameter to reference. | True |
| Default value | Value that appears in the field by default. Users can update this value in their config. | False |
| Label | Descriptive label for the text input field. | True |
| Help text | Additional information displayed below the input field to guide the user. | False |
| Tooltip | Tooltip providing extra context when the user hovers over the field. | False |
| Is required | Whether to make the field mandatory. | False |
int, double, long) is determined by the pipeline parameter.
| Setting | Description | Required |
|---|
| Configuration field | Name of the pipeline parameter to reference. | True |
| Default value | Value that appears in the field by default. Users can update this value in their config. | False |
| Label | Descriptive label for the number input field. | True |
| Format | Defines how the number is displayed. Options include Standard, Percent, and Currency. | False |
| Help text | Additional information displayed below the input field to guide the user. | False |
| Tooltip | Tooltip providing extra context when the user hovers over the field. | False |
| Is required | Whether to make the field mandatory. | False |
Text Area
The user can enter any text in the field. Only string-type parameters are supported.
| Setting | Description | Required |
|---|
| Configuration field | Name of the pipeline parameter to reference. | True |
| Default value | Value that appears in the field by default. Users can update this value in their config. | False |
| Label | Descriptive label for the text input field. | True |
| Help text | Additional information displayed below the input field to guide the user. | False |
| Tooltip | Tooltip providing extra context when the user hovers over the field. | False |
| Is required | Whether to make the field mandatory. | False |
The Text Area component has the same settings as the Text Input component. However, it offers a
larger text input area for the user to write in.
Dropdown
The user can select a value from a predefined list. Array-type parameters are not supported.
| Setting | Description | Required |
|---|
| Configuration field | Name of the pipeline parameter to reference. | True |
| Default value | Value selected in the dropdown by default. Users can select a different option in their config. | False |
| Label | Descriptive label for the dropdown field. | True |
| Help text | Additional guidance displayed below the dropdown. | False |
| Tooltip | Tooltip providing extra context when the user hovers over the field. | False |
| Options | Where you define each dropdown option. Each option should have a value to pass to the pipeline and a label. Tooltips are optional. | True |
| Is required | Whether to make the field mandatory. | False |
| Allow selecting multiple options | Whether the user can select multiple options from the dropdown list. | False |
Checkbox
The user can select or unselect a checkbox. Only boolean-type configurations are supported.
| Setting | Description | Required |
|---|
| Configuration field | Name of the pipeline parameter to reference. | True |
| Default value | Either True or False. This determines whether the checkbox is selected by default. Users can select or unselect the checkbox in their config. | False |
| Label | Descriptive label for the checkbox itself. | True |
| Caption | Additional guidance displayed below the checkbox. | False |
| Tooltip | Tooltip providing extra context when the user hovers over the field. | False |
| Is required | Whether to make the field mandatory. | False |
Checkbox Group
The user can select or unselect a list of checkboxes. Only array-type configurations are supported.
| Setting | Description | Required |
|---|
| Configuration field | Name of the pipeline parameter to reference. | True |
| Default value | Whether the checkboxes are selected by default. Provide this using a comma-separated list of True and False values. Users can select or unselect the checkboxes in their config. | False |
| Options | Where you define each checkbox option. | True |
| Is required | Whether to make the field mandatory. | False |
| Setting | Description | Required |
|---|
| Value | Value to pass to the pipeline. | True |
| Label | Descriptive label for the checkbox itself. | True |
| Caption | Additional guidance displayed below the checkbox. | False |
| Tooltip | Tooltip providing extra context when the user hovers over the field. | False |
Radio Group
The user can select a single option from a predefined list. Array-type configurations are not supported.
| Setting | Description | Required |
|---|
| Configuration field | Name of the pipeline parameter to reference. | True |
| Default value | Radio button selected by default. Users can update this value in their config. | False |
| Options | List of available choices. At least one option is required. | True |
| Is required | Whether to make the field mandatory. | False |
| Option Setting | Description | Required |
|---|
| Value | Value that to pass to the pipeline. | True |
| Label | Descriptive label for the radio button itself. | True |
| Caption | Additional guidance displayed below the radio button. | False |
| Tooltip | Tooltip providing extra context when the user hovers over the field. | False |
Toggle
The user can enable or disable a toggle. Only boolean-type configurations are supported.
| Setting | Description | Required |
|---|
| Configuration field | Name of the pipeline parameter to reference. | True |
| Default value | Either True or False. This determines whether to toggle is on or off by default. Users can update this value in their config. | False |
| Label | Descriptive label for the toggle itself. | True |
| Caption | Additional guidance displayed below the toggle. | False |
| Tooltip | Tooltip providing extra context when the user hovers over the field. | False |
| Is required | Whether to make the field mandatory. | False |
Date
The user can enter a date from a date picker. Only date-type configurations are supported.
| Setting | Description | Required |
|---|
| Configuration field | Name of the pipeline parameter to reference. | True |
| Default value | Date that appears in the field by default. Users can update this value in their config. | False |
| Format | Defines how the date is displayed. The default format is MMMM d, yyyy. | True |
| First day | Specifies the first day of the week in the date picker. The default is Sunday. | True |
| Label | Descriptive label for the date input field. | True |
| Help text | Additional guidance below the date picker. | False |
| Tooltip | Tooltip providing extra context when the user hovers over the field. | False |
| Is required | Whether to make the field mandatory. | False |
Data Integration
Data integration components help users interact with the data throughout the pipeline.
File Upload
Let the user upload their own file to replace the data of a Source gem or Table gem in the pipeline.
When a user uploads a file, they have to configure the file and write it to the primary SQL warehouse of the attached fabric. This is the same mechanism that the upload file feature uses.
| Setting | Description | Required |
|---|
| Source | Choose the source table that users will replace with an uploaded file. | True |
| File types | Restrict the type of files that users can upload. If you do not select any checkboxes, the user can upload any type of file that Prophecy supports. | False |
| Tooltip | Add a tooltip to your component to provide help or context. | False |
| Is required | Select the checkbox to make the field mandatory. | False |
Data Preview
Let the user view sample data of from a Table gem or Visualize gem in the pipeline.
| Setting | Description | Required |
|---|
| Data table | Table or Visualize gem that points to the data that Prophecy will display in the analysis dashboard. | True |
| Label | Label to describe the data preview. | True |
Charts
Display a visualization of data from a Table gem or Visualize gem in the pipeline.
| Setting | Description | Required |
|---|
| Data table | Table or Visualize gem that points to the data to visualize in the analysis dashboard. | True |
| Label | Label to describe the chart. | True |
| Chart type | Type of chart you wish to display (for example, bar chart or line chart). | True |
| Chart configuration | Configure how the chart appears. To view information about each chart configuration, visit Charts. | True |
Content
Content components let you embed static text and images into your analyses.
Text
Add context to your analysis. Use the Inspect tab to add formatting to text, such as heading type, bold, italics, links, and more.
| Setting | Description | Required |
|---|
| Content | Text to be displayed in the analysis dashboard. | True |
Image
Embed an image into your analysis.
| Setting | Description | Required |
|---|
| Image source | How Prophecy retrieves the image. | True |
| Source URL | URL of the image. | True |
| Alt text | Option to add alt text to the image. | False |
