Skip to main content

ExecutionDetails Embeddable

The ExecutionDetails embeddable offers an easy-to-implement, UI-based workflow for managing pipeline executions. It allows you to view successful runs and provides tools for fixing and updating failed ones. With this component you can also allow your customers to manage their own pipelines by reviewing execution details and resolving issues.

When a pipeline execution fails, you can fix errors in two ways: by manually editing individual cells or by updating the pipeline configuration (e.g., adjusting mappings, transformations and/or header row). After making changes, you can retry the execution, choosing whether to apply the updated configuration to just this execution or save it for future runs.

Upon opening the component, you'll always see the transformed dataset, giving you an immediate view of the imported data and its final result. Additionally, the pipeline configuration view displays key details such as the header row used, mappings, and transformations applied to the data.

Preview Mode for Large Datasets

The ExecutionDetails component can automatically activate preview mode to optimize performance and provide a faster configuration experience when fixing failed executions with large datasets. Preview mode allows users to configure transformations on a sample of the data before applying them to the entire dataset.

How Preview Mode Works​

Preview mode is automatically activated when the number of input rows exceeds the sampleSize setting (default: 10.000 rows). Set sampleSize to null to disable preview mode entirely. When active:

  1. Initial Data Transformation: Only the initial data transformation step uses a sample of the data (limited to the number of rows specified by sampleSize).

  2. Info Banner: An info banner is displayed at the top of the data transformation step, indicating that you're working with a sample of the data.

  3. Configuring Transformations: Users can adjust mappings and transformations using the sample data, ensuring a responsive and efficient workflow.

  4. Applying to All Rows: After configuring transformations, users can apply the changes to the entire dataset. The transformations are then processed across all input rows.

  5. Continuing the Flow: Once transformations are applied to all rows, the flow continues normally with the complete dataset, and preview mode is no longer active for subsequent steps.

info

Preview mode is designed to improve performance when working with large files while maintaining the same level of control over data transformation and mapping.

Configure the component based on your specific use case

Add the code snippet below and insert the component on the page where you want it to appear:

Fields

accessToken

Add here your access token

executionId

Add here the ID of the execution you want to display

settings

i18nOverrides

Allows you to override each text element in the interface

language

Defines the language of the embeddable (so far we only support English ("en"))

modal

Defines whether the component is shown inline (false) or within a modal view (true)

sampleSize

Defines the maximum number of rows to use during the data transformation preview phase when fixing failed executions with large datasets. Default: 10000 (integer or null). When the number of input rows exceeds this value, preview mode is automatically activated, allowing users to configure transformations on a sample before applying them to the entire dataset. Set to null to disable preview mode entirely.

onExecutionRun

Runs after the user has triggered the rerun of the execution

onClose

Runs when the user trys to exit the "Execution Details" flow by clicking "Cancel" or closing the modal using the "X" button

React
Angular
Vue
VanillaJS
<ExecutionDetails
  accessToken="ACCESS_TOKEN"
  executionId="EXECUTION_ID"
  settings={{
    i18nOverrides: {},
    language: "en",
    modal: boolean (default: true),
    sampleSize: number (default: 10000)
  }}
  onExecutionRun={({data}) => {
    // runs after the user has triggered the rerun of the execution
    // data: execution object of the rerun
    }}
  onClose={() => {
    // runs when the creation workflow is closed via the "Cancel" button or the "X" button
  }}
/>