Getting Started with EZY Integrations

EZY Integrations moves data between systems by combining three building blocks: connection profiles (the credentials for each system), mapping configurations (the field-level rules for transforming data), and jobs (instances that link a source profile to a target profile and run the pipeline). This guide walks you through the complete setup from a fresh tenant to a running job.

User journey overview

flowchart LR
    A[Meet prerequisites] --> B[Create credentials]
    B --> C[Choose connector]
    C --> D[Author mapping]
    D --> E[Create job]
    E --> F[Run ad-hoc]
    F --> G[Review results]
    G --> H[Schedule recurring runs]
    H --> I[Monitor and troubleshoot]

Step 1 — Meet tenant and workspace prerequisites

Before you configure anything, make sure your tenant is provisioned and your user account has the necessary access. If you are setting up EZY Integrations for the first time, work through the Tenant Onboarding checklist first.

You will also need:

• Administrator or Integration Manager role within the tenant.
• Access credentials for every source and target system you plan to connect (for example, a Shopify Custom App client ID and secret, or an SAP Business One database login and Service Layer URL).

Step 2 — Create connection profiles

A connection profile stores the credentials for one system. You need at least one profile for the source system and one for the target system.

1. In the left navigation, open Connection Profiles.
2. Click New Profile.
3. Enter a descriptive name (for example, My Shopify Store or Portal Production).
4. Select the System type that matches your system.
5. Fill in the credential fields. The fields shown depend on the system type you chose — refer to the connector page for field descriptions:
   • EZY Portal
   • SAP Business One
   • Shopify
   • WooCommerce
   • Wix
   • Flat File
   • Generic API
6. Click Save.
7. Use the Test Connection button to verify the credentials are correct before continuing.

For more detail on how credentials are stored and protected, see Credentials and Secrets.

Step 3 — Choose a connector

The connector determines which system you are connecting to and what entity types it supports. If you are unsure which connector to use, start with the Connectors overview for a side-by-side comparison of supported systems, directions, and entity types.

For a new integration, you will need to understand:

• Whether your system acts as a source (data comes from it), a target (data goes into it), or both.
• Which entity types you want to sync (for example, items, business partners, orders).

Step 4 — Author a mapping configuration

A mapping configuration is a JSON document that tells EZY Integrations exactly how to extract records from the source system and how to map each source field to a target field. You edit mapping configurations in the built-in JSON editor, which includes an AI assistant that can generate a first draft based on your source and target systems.

1. In the left navigation, open Mapping Configs.
2. Click New Mapping Config.
3. Select the source system type and target system type.
4. Select the entity type (for example, item).
5. Use the AI Assist button to generate a starting draft, or write the JSON manually.
6. Review the generated mapping, adjust field names and transformers as needed, then click Save.

For a full explanation of the mapping document structure, see Mapping Configuration.

Step 5 — Create a job and run it manually

A job (also called an instance) links a source connection profile, a target connection profile, and one or more mapping configurations into a single runnable unit.

1. In the left navigation, open Instances.
2. Click New Instance.
3. Enter a name for the job.
4. Select the Source profile you created in Step 2.
5. Select the Target profile.
6. Assign the mapping configurations that apply to this job.
7. Click Save.

To trigger a manual run immediately:

1. In the left navigation, open Sync Trigger.
2. Select your job from the list.
3. Click Run Now.
4. Watch the status indicator — when the run completes, click through to view the results.

For full detail on managing and triggering runs, see Manual Runs.

Step 6 — Review the run results

After a run completes, open Sync Logs (or Run History under Monitoring) to see what happened.

Each run entry shows:

• Start time and duration.
• Number of records processed, succeeded, and failed.
• Error messages for any records that could not be written.

If records failed, check whether they appear in the failed-message recovery queue. You can inspect the error details and replay the messages after fixing the underlying issue. See Run History for filtering and drill-down options.

Step 7 — Schedule recurring jobs

Once a manual run has succeeded, you can set a schedule so the job runs automatically.

1. In the left navigation, open Schedules.
2. Click New Schedule.
3. Select the job you want to schedule.
4. Choose a recurrence — either a simple interval (for example, every 6 hours) or a cron expression for precise timing.
5. Click Save. The schedule becomes active immediately.

For the full schedules reference, see Schedules.

Step 8 — What to do when something fails

If a run ends with errors, work through these steps in order:

1. Open Run History and locate the failed run.
2. Click into the run to read the error messages for each failed record.
3. Fix the root cause (wrong credentials, a missing field in the mapping, a validation error in the target system).
4. If messages were sent to the failed-message recovery queue, open DLQ and Replay and replay them once the issue is resolved.
5. If the error is not self-explanatory, see Common Errors for a list of known issues and resolutions.

Next steps

• Architecture — understand the full source-to-target data flow.
• Pipeline Stages — deep-dive into what happens at each stage.
• Connectors — explore the connector that matches your source or target system.
• Mapping Configuration — learn all the options available in a mapping document.