Skip to main content

Import Functionality Documentation

Page/Section: Module-Import-Intro

This documentation describes the Import Wizard, a multi-step module designed to help users migrate multiple project components from a source project to a target project. The process ensures safe configuration, renaming, credential validation, and final confirmation of migrated items.

Page/Section: Module-Import-Overview

The Import Module allows users to migrate multiple components — Integrations, Mappers, Scripts, Connections, Reports, and Workflows — from a source project to a target project using a guided multi-step wizard.


Module: Import Wizard Flow

Step 1 — Select Project

Page/Section: Module-Import-Step1

In this initial screen, the user selects:

  • Source Project (project from which components will be migrated)
  • Target Project (project where components will be imported)
  • One or more Component Types, such as:
    • Integrations
    • Mappers
    • Connections
    • Scripts
    • Reports
    • Workflows

A dropdown allows multi-select of component categories. Once selections are completed, click Next to proceed. Page/Section: Module-Import-Step1

In this screen, the user selects:

  • Source Project
  • Target Project
  • One or more Component Types to import (e.g., Integrations, Mappers, Connections, etc.)

After selections, the user clicks Next to proceed.


Step 2 — Select Components

Page/Section: Module-Import-Step2

Based on selections in Step 1, this page displays one tab per component type. Each tab contains:

  • An Available List (items fetched from the source project)
  • A Selected List (items the user chooses for import)
  • Controls for moving items between lists (>, >>, <, <<)
  • Search inputs for filtering items within each list

Users must select at least one component per chosen type. When ready, click Next. Page/Section: Module-Import-Step2

Based on the selected component types in Step 1, this screen displays separate tabs such as:

  • Integrations
  • Mappers
  • Scripts
  • Connections
  • Workflows
  • Reports

Within each tab, users can:

  • View available items in the source project
  • Select one or more items to migrate using simple list selectors

Once all required items are selected, click Next.


Step 3 — Rename Entities

Page/Section: Module-Import-Step3

On this screen, the system displays all selected components along with editable fields for renaming them.

Columns include:

  • Type (Integration, Mapper, Workflow, etc.)
  • Source Entity Name (existing name from source project)
  • Imported Entity Name (user-editable field)

Renaming is optional but recommended to:

  • Prevent conflicts in the target project
  • Follow naming conventions
  • Organize components consistently

Click Next to proceed. Page/Section: Module-Import-Step3

This screen displays a list of all components selected in Step 2.

Features:

  • Source Entity Name → name of the component in the source project
  • Imported Entity Name → editable field for renaming before import

Users may rename any item to avoid conflicts or follow naming conventions.

Click Next to continue.


Step 4 — Validate Credentials

Page/Section: Module-Import-Step4

This step appears only if Connections were selected.

The screen shows a table with:

  • Connection Name
  • Status (initially Pending)
  • Action column with an Edit button

When editing a connection, users must enter all required credentials such as:

  • Hostname
  • Username
  • Password
  • Tokens / Keys (depending on connection type)

Once valid credentials are saved, the status updates to Configured. After all connections are configured, click Finish. Page/Section: Module-Import-Step4

Only Connections require credential validation.

This screen shows:

  • All selected Connections
  • Their current Status (initially Pending)
  • An Edit button for each row

Users must:

  • Open each connection using Edit
  • Enter required credentials
  • Save configuration

After credentials are correctly added, the status changes to Configured.

Click Finish to begin importing.


Step 5 — Final Result

Page/Section: Module-Import-Step5

After successful import, the system shows a summary table with:

  • Component Type
  • Imported Component Name
  • New ID assigned in the target project

The screen confirms completion with a message:

All components imported successfully.

A button Import Another allows the user to start a fresh import cycle. Page/Section: Module-Import-Step5

After the import completes, the final screen shows:

  • List of successfully imported components
  • Their new names
  • Their new IDs in the target project

A button Import Another allows repeating the import workflow.


Summary

Page/Section: Module-Import-Summary

The Import Wizard ensures structured and error-free migration by offering:

  • Clear step-by-step workflow
  • Bulk component selection
  • Optional renaming of components
  • Credential validation for connections
  • Detailed final report with new IDs

This module improves portability, reduces manual errors, and provides complete transparency throughout the migration lifecycle. Page/Section: Module-Import-Summary

The Import Module provides:

  • Multi-component migration
  • Step‑wise validation and renaming
  • Credential verification
  • Clear final output with new component IDs

This ensures safe and traceable migration of project assets from one project to another.