Overview
This guide walks you through the complete process of setting up, testing, and deploying a new integration subscription. You'll learn how to subscribe to integrations, test data flows in both directions, troubleshoot common issues, and prepare for production deployment.
Step 1: Subscribe to the Integration
Set up your initial subscription
Click Subscriptions > Marketplace and select your desired integration.
On the integration detail page, click Subscribe.
Configure settings for your integration on the Subscription Settings page.
Important: Make sure the Create Default Mappings checkbox is selected.
Step 2: Understand Data Dependencies
Critical: Implement data flows in the correct order to ensure dependent data exists when needed.
Common Dependencies
Transactions: Require existing SKUs, shipping methods, and payment methods.
Product categories: Must exist before assigning products to them.
Inventory records: Need inventory locations to exist first.
Product variants: Often require option values to be set up first.
Recommended Implementation Order
Customer Data
Customer Category
Company
Customer
Company/Customer Relationships
Addresses (Company and Customer)
Product Data
Location and Location Groups
Alternate ID Types
Product Categories and Catalog Category Sets
Products and related data:
Category assignments
Alternate IDs
Units and inventory
Options and option values
Variants and variant-specific data
Kits and components
Transaction Data
Shipping and Payment Methods
Gift Cards
Transactions and related data:
Addresses, discounts, line items
Notes, payments, taxes
Tracking numbers
Other Data Types
Employees and addresses
Timesheets and entries
Messages
Note: Not every integration uses all data types. Consult your integration's template mappings and documentation for specific requirements. |
Step 3: Test Your Connection
Once your connection is established, test data flows in both directions to verify proper setup and identify needed adjustments.
Testing Data Flow TO iPaaS.com
Prerequisites: Data must exist in the external system before testing inbound flows. Option A: Initialize Data (Recommended)
If your integration supports data initialization:
Look for the Initialize Data section on the Subscription Settings screen.
Click each data type (Product Category, Customer Category, Payment Method)you want to initialize.
This pulls existing data from the external system into iPaaS.com.
Option B: Manual Sync
Click Integration Monitoring and Diagnostics > Manual Sync.
Select your subscription from the System dropdown.
Choose a TO iPaaS flow from the Mapping Collection dropdown.
Select a scope from the Scopes dropdown.
Click Submit to sync data or Debug to preview results.
Note: For EXTERNAL ID syncing, consult your integration's documentation for proper ID format requirements. |
Verify Results
Navigate to the relevant data type (Customers, Locations, etc.) under Data Management to confirm your data transferred successfully.
Testing Data Flow FROM iPaaS.com
Best practice: Start with simple data types like payment methods, shipping methods, or categories, as these rarely depend on other data.
Create Test Data
Create a test record in iPaaS.com for a data type supported by your integration.
Keep it simple initially to avoid dependency issues.
Initialize or Sync
Follow the same process ti initialize data or use manual sync as the TO iPaaS flow, but select a FROM iPaaS mapping collection.
Important preparation steps:
Review mapping collection settings to ensure required variables are properly configured.
Check mapping collection filters to verify your data meets the criteria.
Verify Results
Check the external system to confirm that your data transferred successfully.
Step 4: Troubleshoot Issues
Check Error Logs
Click Integration Monitoring and Diagnostics > Error Logs to view any transfer errors.
Common error types include:
Error type | Error | Causes |
Connection Issues | Unable to communicate with the external system | Verify your connection configuration follows all setup instructions. |
ID-Related Errors | Unable to find an ID | Using external ID when internal ID was required (or vice versa).
Incorrect ID format (check integration documentation).
Wrong information used (e.g., category number instead of ID). |
Configuration Issues | Mapping Collection Configuration
Subscription Settings
| Check for unresolved configuration items required for your data type.
Verify that settings specific to your data type are properly configured. |
Monitor Processing Queue
Check the Events Queue to ensure all data has been processed and no items are stuck.
Step 5: Configure Mapping Collections
Review and Edit Mappings
In your subscription, click Manage Mappings.
Click Edit for each mapping collection.
Review these critical elements:
Mapping Filters
Verify filters match client specifications.
Ensure only the desired records will transfer.
Check the Description for important comments.
Error Filters
Confirm that the setup is correct and necessary.
Review any explanatory comments.
Individual Mappings
Open each mapping to verify correctness.
Check if source data or formulas need client-specific modifications.
Ensure formulas handle null values properly to prevent errors.
Look for red edit buttons indicating mapping issues.
Translation Collections
Verify values are correct for your specific client.
Add Custom Fields
Based on client requirements:
Add necessary internal and external custom fields.
Include them in your mappings.
Follow the integration documentation for naming conventions and capabilities.
Test Incrementally
Best practice: Test each change using manual sync functionality before proceeding. Create test data as needed and monitor error logs regularly.
Common Troubleshooting Scenarios
Separate collections: Check if add or update operations use different mapping collections.
Delete operations: Verify if delete mappings actually trigger updates instead.
Dynamic formulas: Ensure implementation-specific values are properly configured.
Custom field dependencies: Check if mappings expect specific custom field values.
Multiple collections: If multiple collections affect the same data, adjust mapping filters to prevent conflicts.
Step 6: Clean Up Unused Collections
Remove unnecessary mappings:
Delete unused collections (can be reactivated later if needed).
Add false filters (like
1==2) to prevent unused collections from running.
Step 7: Prepare for Production
Important: Complete all previous steps for every required data type before production.
Enable Automatic Data Transfer
For webhook-supported integrations: Enable webhooks in both inbound and outbound data flow sections.
For polling-based integrations: Configure polling events according to the integration documentation.
Sync Base Dataset
If you need to transfer a large initial dataset, follow the documentation for Syncing a Large Dataset using iPaaS.com and Postman Runner.
Final Checklist
Before going live, ensure you have:
Successfully tested data flows in both directions.
Resolved all error log issues.
Implemented proper data flow order for dependencies.
Reviewed and configured all necessary mapping collections.
Added required custom fields and mappings.
Removed or disabled unused mapping collections.
Enabled automatic data transfer mechanisms.
Completed any required base data synchronization.
Additional Resources
Integration-specific documentation for detailed capabilities and requirements.
Comprehensive QA Checklist for production readiness.
Large dataset transfer documentation.
Common error resolution guide.
For technical support or additional questions, consult your integration's specific documentation or contact your iPaaS.com support team.