Importing Entities
Learn how to import entities from JSON files with conflict detection and resolution
Importing Entities
Import allows you to import entities from JSON export files back into the system. The import process includes automatic conflict detection and resolution options.
Import Process Overview
The import process consists of:
- File Upload: Upload JSON export file
- Conflict Check: System analyzes file for conflicts
- Conflict Review: Review detected conflicts (if any)
- Conflict Resolution: Resolve conflicts using resolution options
- Import Execution: Import entities based on resolutions
Importing Entities
Step-by-Step
- Upload File: Click "Choose File" and select JSON export file
- Start Import: Click "Import" button
- Conflict Check: System checks for conflicts automatically
- Review Conflicts: Review detected conflicts (if any)
- Resolve Conflicts: Choose resolution for each conflict
- Complete Import: Import executes based on resolutions
Conflict Detection
The system automatically detects conflicts when importing:
Conflict Types
- Field Addition: New fields being added to existing Objects
- Field Deletion: Fields being removed from existing Objects
- Field Update: Field properties being changed in existing Objects
Conflict Analysis
The conflict check analyzes:
- Schema Differences: Differences between import and existing schemas
- Field Changes: Additions, deletions, and updates to fields
- Non-Conflicting Objects: Objects that can be imported without conflicts
Conflict Resolution
When conflicts are detected, you can resolve them:
Resolution Options
Approve Changes
Approve import changes and use import fields:
- Field Additions: Add new fields from import
- Field Updates: Update fields with import values
- Field Deletions: Remove fields as specified in import
Use Case: Accept all changes from import file
Revert Changes
Keep existing fields and use existing values:
- Field Additions: Skip adding new fields
- Field Updates: Keep existing field properties
- Field Deletions: Keep existing fields
Use Case: Keep existing configuration and skip changes
Skip Objects
Skip importing conflicting objects entirely:
- No Import: Object is not imported
- Other Objects: Other non-conflicting objects still import
Use Case: Skip problematic objects
Batch Resolution
Resolve all conflicts at once:
- Approve All: Approve all changes from import
- Revert All: Keep all existing fields
- Individual Resolution: Resolve conflicts individually
Conflict Window
The conflict window displays:
Conflict Information
- Entity Type: Type of entity with conflict
- Entity Name: Name of the conflicting entity
- Conflict Type: Type of conflict (addition, update, removal)
- Conflict Details: Detailed information about the conflict
Conflict Details
For each conflict, you can see:
- Field Name: Name of the field with conflict
- Field Type: Type of the field
- Change Type: What will change (addition, update, removal)
- From/To Values: Current and import values
Import Sessions
Import sessions track import progress:
Session Features
- Session ID: Unique identifier for import session
- Conflict Analysis: Stored conflict analysis
- Non-Conflicting IDs: List of non-conflicting object IDs
- Expiration: Sessions expire after 24 hours
Session Usage
- Conflict Resolution: Resolve conflicts using session ID
- Import Execution: Import using session ID
- Progress Tracking: Track import progress
Non-Conflicting Import
Objects without conflicts are imported automatically:
- Automatic Import: Non-conflicting objects import immediately
- No Resolution Needed: No resolution required for non-conflicting objects
- Import Count: Number of imported objects shown
Import Warnings
Warnings may appear during import:
- Schema Warnings: Warnings about schema differences
- Data Warnings: Warnings about data issues
- Validation Warnings: Warnings about validation failures
Handling Warnings
- Review Warnings: Review warning messages
- Continue Import: Import continues despite warnings
- Address Issues: Address warnings if needed
Import Best Practices
Before Importing
- Backup Data: Backup existing data before importing
- Review Export File: Review export file contents
- Check Conflicts: Understand potential conflicts
- Test Import: Test import in non-production environment first
Conflict Resolution
- Review Carefully: Review conflicts carefully before resolving
- Understand Impact: Understand impact of resolution choices
- Use Batch Carefully: Use batch resolution only when appropriate
- Document Resolutions: Document resolution choices
After Importing
- Verify Import: Verify imported entities
- Check Relationships: Verify relationships are correct
- Test Functionality: Test functionality of imported entities
- Update Documentation: Update documentation if needed
Import Limitations
Supported Entity Types
- Object: Object definitions
- MFlow: Workflow definitions
- MReport: Report configurations
- MForm: Form definitions
- MData: Object data records
Import Constraints
- File Format: Must be valid JSON export file
- Entity Existence: Entities must exist in target system (for updates)
- Schema Compatibility: Schemas must be compatible
- Session Expiration: Import sessions expire after 24 hours
Related Introduction
- Exporting Entities - Learn how to export entities
- Objects Introduction - Understand Objects that can be imported
- Workflows Introduction - Learn about workflows that can be imported