Looking for the previous version? View v2024.06 documentation →
FDR using REST API as Source
Overview
This guide walks through the FDR using REST API as Source scenario in Data Trust Scenario Studio. Follow the numbered steps below to configure, execute, and review the results of this scenario type.
Prerequisites
- You are logged in to Data Trust with a Pro-User or Admin Pro-User role.
- The relevant connection profiles have been configured in the Administration module.
Steps
Path: Data Trust › Scenario Studio › Scenario Builder › FDR using REST API as Source
Navigate to the Scenario Studio module and select the FDR using REST API as Source option from the left sidebar or main menu. This opens the scenario builder canvas where you will configure the data source connections, transformation rules, and execution settings.
Drag the Restapi Widget from the widget palette and drop it onto the scenario canvas. Positioning the widget opens its configuration popup where you will set the connection, table, and any additional options.
Navigate to the Scenario Studio module and select the FDR using REST API as Source option from the left sidebar or main menu. This opens the scenario builder canvas where you will configure the data source connections, transformation rules, and execution settings.
This step involves interacting with the SSL Certification OFF within the FDR using REST API as Source workflow. Follow the on-screen prompts to complete this step before proceeding to the next configuration stage.
This step involves interacting with the JSON Data within the FDR using REST API as Source workflow. Follow the on-screen prompts to complete this step before proceeding to the next configuration stage.
Click Get Metadata to automatically retrieve the column structure and data types from the connected data source. Review the retrieved metadata and deselect any columns that are not relevant before proceeding to configure validation rules.
Drag the Qc Widget from the widget palette and drop it onto the scenario canvas. Positioning the widget opens its configuration popup where you will set the connection, table, and any additional options.
The QC widget popup dialog exposes all available configuration options for this step. Review each field carefully and fill in the required values before clicking Save or OK to apply the configuration.
Click Get Metadata to automatically retrieve the column structure and data types from the connected data source. Review the retrieved metadata and deselect any columns that are not relevant before proceeding to configure validation rules.
Click the Save button to persist the current widget or scenario configuration. A confirmation indicator appears on the canvas once the save is successful, and the widget thumbnail updates to reflect the configured state.
Drag the Filter Widget from the widget palette and drop it onto the scenario canvas. Positioning the widget opens its configuration popup where you will set the connection, table, and any additional options.
The Transformations tab lists all available data transformation widgets including Filter, Derive, Aggregate, and Lookup. Add transformation widgets between data source and reconciliation or validation widgets to cleanse or reshape data before comparison.
The Transformations tab lists all available data transformation widgets including Filter, Derive, Aggregate, and Lookup. Add transformation widgets between data source and reconciliation or validation widgets to cleanse or reshape data before comparison.
Drag the Map And Recon Widget from the widget palette and drop it onto the scenario canvas. Positioning the widget opens its configuration popup where you will set the connection, table, and any additional options.
The Reconciliation widget maps source fields to target fields for comparison. Use Smart Mapping to automatically propose column matches, then manually adjust any fields that were incorrectly paired before saving.
The Confirm Action Popup dialog exposes all available configuration options for this step. Review each field carefully and fill in the required values before clicking Save or OK to apply the configuration.
Click the Save button to persist the current widget or scenario configuration. A confirmation indicator appears on the canvas once the save is successful, and the widget thumbnail updates to reflect the configured state.
Drag the Email Widget from the widget palette and drop it onto the scenario canvas. Positioning the widget opens its configuration popup where you will set the connection, table, and any additional options.
The Email widget sends an automated result notification to configured recipients after the scenario finishes executing. Provide the recipient addresses, subject, and choose whether to attach the exception report or include a summary in the email body.
Click the Execute button to trigger the scenario and begin processing data from the configured sources. The scenario transitions to Monitor mode where you can track real-time execution progress and view interim results as each step completes.
Monitor mode displays the live execution status of the scenario with a progress indicator for each processing stage. Wait for all stages to reach a Completed or Passed state before navigating to the result summary to review the full output.
The Scenario Execution Summary Page page presents the full outcome of the scenario execution including record counts, match rates, and any detected exceptions. Drill into exception records to inspect individual mismatches and use the Export to CSV option to share results with stakeholders.
The Email widget sends an automated result notification to configured recipients after the scenario finishes executing. Provide the recipient addresses, subject, and choose whether to attach the exception report or include a summary in the email body.