Skip to main content

App components

Components are the building blocks of your Prophecy Apps. You can add, configure, and preview components in the App Builder. There are three types of components that you can add:

  • 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 Prophecy Apps.

Interactive

Interactive components make pipelines dynamic by letting users assign values to pipeline parameters. These values can influence the behavior of each run and change the pipeline output.

If the end user leaves an interactive field blank:

  • The app first checks for a default value in the component.
  • If you did not define a default value in the component, the app uses the default value from the pipeline parameter.

Text Input

The user can enter any text into the field. Only string-type parameters are supported.

SettingDescriptionRequired
Configuration fieldName of the pipeline parameter to reference.True
Default valueValue that appears in the field by default. Users can update this value in their app config.False
LabelDescriptive label for the text input field.True
Help textAdditional information displayed below the input field to guide the user.False
TooltipTooltip providing extra context when the user hovers over the field.False
Is requiredWhether to make the field mandatory.False

Number Input

The user can enter any number into the field. The number type (e.g., int, double, long) is determined by the pipeline parameter.

SettingDescriptionRequired
Configuration fieldName of the pipeline parameter to reference.True
Default valueValue that appears in the field by default. Users can update this value in their app config.False
LabelDescriptive label for the number input field.True
FormatDefines how the number is displayed. Options include Standard, Percent, and Currency.False
Help textAdditional information displayed below the input field to guide the user.False
TooltipTooltip providing extra context when the user hovers over the field.False
Is requiredWhether to make the field mandatory.False

Text Area

The user can enter any text in the field. Only string-type parameters are supported.

SettingDescriptionRequired
Configuration fieldName of the pipeline parameter to reference.True
Default valueValue that appears in the field by default. Users can update this value in their app config.False
LabelDescriptive label for the text input field.True
Help textAdditional information displayed below the input field to guide the user.False
TooltipTooltip providing extra context when the user hovers over the field.False
Is requiredWhether to make the field mandatory.False
note

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.

The user can select a value from a predefined list. Array-type parameters are not supported.

SettingDescriptionRequired
Configuration fieldName of the pipeline parameter to reference.True
Default valueValue selected in the dropdown by default. Users can select a different option in their app config.False
LabelDescriptive label for the dropdown field.True
Help textAdditional guidance displayed below the dropdown.False
TooltipTooltip providing extra context when the user hovers over the field.False
OptionsWhere you define each dropdown option. Each option should have a value to pass to the pipeline and a label. Tooltips are optional.True
Is requiredWhether to make the field mandatory.False
Allow selecting multiple optionsWhether 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.

SettingDescriptionRequired
Configuration fieldName of the pipeline parameter to reference.True
Default valueEither True or False. This determines whether the checkbox is selected by default. Users can select or unselect the checkbox in their app config.False
LabelDescriptive label for the checkbox itself.True
CaptionAdditional guidance displayed below the checkbox.False
TooltipTooltip providing extra context when the user hovers over the field.False
Is requiredWhether to make the field mandatory.False

Checkbox Group

The user can select or unselect a list of checkboxes. Only array-type configurations are supported.

SettingDescriptionRequired
Configuration fieldName of the pipeline parameter to reference.True
Default valueWhether 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 app config.False
OptionsWhere you define each checkbox option.True
Is requiredWhether to make the field mandatory.False

For each option that you add to the checkbox group, you can define the:

SettingDescriptionRequired
ValueValue to pass to the pipeline.True
LabelDescriptive label for the checkbox itself.True
CaptionAdditional guidance displayed below the checkbox.False
TooltipTooltip 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.

SettingDescriptionRequired
Configuration fieldName of the pipeline parameter to reference.True
Default valueRadio button selected by default. Users can update this value in their app config.False
OptionsList of available choices. At least one option is required.True
Is requiredWhether to make the field mandatory.False

For each option that you add to the checkbox group, you can define the:

Option SettingDescriptionRequired
ValueValue that to pass to the pipeline.True
LabelDescriptive label for the radio button itself.True
CaptionAdditional guidance displayed below the radio button.False
TooltipTooltip 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.

SettingDescriptionRequired
Configuration fieldName of the pipeline parameter to reference.True
Default valueEither True or False. This determines whether to toggle is on or off by default. Users can update this value in their app config.False
LabelDescriptive label for the toggle itself.True
CaptionAdditional guidance displayed below the toggle.False
TooltipTooltip providing extra context when the user hovers over the field.False
Is requiredWhether to make the field mandatory.False

Date

The user can enter a date from a date picker. Only date-type configurations are supported.

SettingDescriptionRequired
Configuration fieldName of the pipeline parameter to reference.True
Default valueDate that appears in the field by default. Users can update this value in their app config.False
FormatDefines how the date is displayed. The default format is MMMM d, yyyy.True
First daySpecifies the first day of the week in the date picker. The default is Sunday.True
LabelDescriptive label for the date input field.True
Help textAdditional guidance displayed below the date picker.False
TooltipTooltip providing extra context when the user hovers over the field.False
Is requiredWhether to make the field mandatory.False

Data Integration

Data integration components help users interact with the data that flows into and out of the app.

File Upload

Let the user upload their own file to replace the data of a Source gem in the pipeline. When a user uploads a file to the Prophecy App, they will 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.

SettingDescriptionRequired
Source componentChoose the source table that users will replace with an uploaded file.True
File typesRestrict 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
TooltipAdd a tooltip to your component to provide help or context.False
Is requiredSelect the checkbox to make the field mandatory.False

Data Preview

Let the user view sample data of a table in the pipeline.

SettingDescriptionRequired
Data tableTable that will appear in the app.True
LabelLabel to describe the data preview.True

Charts

Display a visualization of a table from the pipeline. Prophecy provides multiple chart types that you can integrate in your app.

SettingDescriptionRequired
Data tableTable that contains data to visualize.True
LabelLabel to describe the chart.True
Chart typeType of chart you wish to display (for example, bar chart or line chart).True
Chart configurationConfigure 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 Prophecy Apps.

Text

Add context to your Prophecy App. Use the Inspect tab to add formatting to text, such as heading type, bold, italics, links, and more.

SettingDescriptionRequired
ContentText to be displayed in the appTrue

Image

Embed an image into your Prophecy App.

SettingDescriptionRequired
Image sourceHow Prophecy retrieves the image.True
Source URLURL of the image.True
Alt textOption to add alt text to the image.False