Articles in this section

Upgrade to the multiple-environment structure

If your account still uses the legacy Production and Sandbox pair, Celigo prompts you to upgrade your Sandbox to a fully isolated environment. The upgrade is required and free. It moves your integrations, integration apps, flows, exports, imports, connections, and other Sandbox resources into a new Sandbox environment, and after it finishes, nothing is shared between environments. This article is for Production account owners and administrators. It walks you through starting the upgrade, what to do when it finishes, how each resource type is handled, and what to do if something goes wrong. For what the multiple-environment structure is, see Multiple environments overview.

Before you begin

  • Check your eligibility. Accounts on the Platform 2024 license type are eligible. If you're on an Endpoint license, upgrade to Platform 2024 first. See Manage your Celigo subscription. Upgrading your subscription from Professional to Enterprise uses this same process to move your Sandbox to the multiple-environment structure.
  • Know whether you have shared resources. Shared resources are stacks, iClients, on-premise agents, and API tokens that are used by both Production and Sandbox. If you have any, the upgrade recreates or updates them, you receive an assessment report by email, and you have post-upgrade steps to complete. See How the upgrade handles your resources.
  • Plan your upgrade window. Your Sandbox is unavailable while the upgrade runs, and all flows in your Sandbox are disabled until you re-enable them afterward. The upgrade takes a few minutes to an hour, depending on your shared resources. If your Sandbox has flows on a frequent schedule, choose a time when the disruption is lowest for your team.
  • Finish active work and pending transfers in your Sandbox. The upgrade can't start while your Sandbox has running jobs or pending transfers. Coordinate with your team before you begin.

Start the upgrade

  1. Sign in to integrator.io as the account owner or an administrator. In the ACTION REQUIRED: Upgrade to the new multiple environment structure banner at the top of the page, select Take action now.

    If you closed the banner earlier, it reappears the next time you sign in. The banner doesn't appear while your Sandbox has running jobs or pending transfers.

  2. In the Upgrade your environments dialog, select Start upgrade.

    If the dialog shows Your upgrade can't start yet, your Sandbox still has active work or pending transfers. See Your upgrade can't start yet.

The banner changes to Upgrade in progress, and Celigo emails you that the upgrade has started. If your account has shared resources, the assessment report is attached to that email. Your Sandbox is unavailable until the upgrade finishes; you can keep working in Production.

After the upgrade

When the upgrade finishes, Celigo emails you, and the next time you sign in, an Upgrade complete message points you to your new environment. The new Sandbox environment is enabled, and its flows are disabled until you re-enable them.

  1. If you have shared resources, review the assessment report attached to the email. It lists the resources that were recreated or updated and what to do about each one. Complete those steps before you re-enable your flows. See How the upgrade handles your resources.
  2. In the top bar, select Environment, and then select Sandbox. See Create and manage multiple environments.
  3. Re-enable your flows, either one at a time or with Enable all. Enable all turns on only the flows that were enabled before the upgrade; flows that were already disabled stay disabled. Flow schedules are preserved, so a re-enabled flow runs on its previous schedule. See Create custom flows.
  4. Update any external systems that reference resources the upgrade recreated, such as API tokens or on-premise agents.

You can now rename your Sandbox environment and create more environments. See Create and manage multiple environments.

If the upgrade fails

If the upgrade can't finish, your Sandbox is restored to its previous state and you don't need to do anything. The banner reads Couldn't complete the upgrade. Sandbox restored., and Celigo emails you the account, environment, region, and time of the attempt. Celigo support is notified automatically.

When the issue is resolved, Celigo emails you again, and a banner appears the next time you sign in. Select Retry upgrade in the banner, and then start the upgrade as before.

Notifications during the upgrade

Stage In integrator.io Email
Ready to upgrade Banner ACTION REQUIRED: Upgrade to the new multiple environment structure with Take action now —
Upgrade running Banner Upgrade in progress. Your sandbox environment is unavailable until it finishes. Upgrade started — assessment report attached if you have shared resources
Upgrade complete One-time Upgrade complete message on your next sign-in Upgrade complete, action required — assessment report attached if you have shared resources
Upgrade failed Banner Couldn't complete the upgrade. Sandbox restored. Upgrade incomplete
Ready to retry Banner ACTION REQUIRED: We've resolved the issue that stopped your upgrade. with Retry upgrade Retry your upgrade

How the upgrade handles your resources

Integrations, integration apps, flows, exports, imports, connections, and other resources move to the new Sandbox environment automatically. Resources that were shared between Production and Sandbox — stacks, iClients, on-premise agents, and API tokens — are recreated or updated so that each environment has its own copy. Resources that move keep their IDs; resources that are recreated get new IDs. See Do resource IDs stay the same after the upgrade?.

Assessment report — If your account has shared resources, Celigo attaches an assessment report (PDF) to the upgrade-started and upgrade-complete emails. The report lists each resource that was recreated or updated and the action to take, such as reinstalling an on-premise agent or updating an external system that uses an API token. Review it before you re-enable your flows.

API tokens

Token What happens
Full-scope token Recreated in the new Sandbox environment. The original token remains in Production.
Custom token with access to both Production and Sandbox Recreated in the new Sandbox environment, including its permissions to specific integrations and resources. The Production token is updated to remove references to resources that are no longer shared.
Custom token with access to Sandbox only Moved to the new Sandbox environment.
Custom token with access to Production only Unchanged.

Update any external system that uses a recreated token. See Manage API tokens.

iClients

iClient What happens
Shared between Production and Sandbox A new iClient is created in the new Sandbox environment and added to the resources that use it.
Sandbox only Moved to the new Sandbox environment.
Production only Unchanged.

On-premise agents

Agent What happens
Shared between Production and Sandbox A copy named <agent name> - copy is created in the new Sandbox environment.
Sandbox only Moved to the new Sandbox environment.
Production only Unchanged.

The agent that the upgrade creates or moves into your Sandbox environment is already counted against your account's on-premise agent entitlement. Before it can run flows, reinstall the agent software on your server for this agent (Windows | Linux). You can rename the agent (for example, remove - copy) at any time.

Caution: Don't delete the agent the upgrade created, and don't create an additional agent in the new environment. A deleted agent still counts toward your agent usage for the current usage period, so a replacement agent exceeds your entitlement and flow runs in that environment fail. Non-production environments have no overage allowance, so runs are blocked as soon as the entitlement is exceeded. If you've already deleted the agent, restore it from the recycle bin. A purged agent can't be recovered — contact Celigo support if you've purged it or want to purchase an additional agent entitlement. See Flow runs fail with "You have reached the maximum number of agents for your subscription".

Stacks

A stack shared between Production and Sandbox is recreated in the new Sandbox environment. See Run operations on different servers in stacks and Set up a wrapper connection.

Integration apps and templates

Integration apps move with the rest of your Sandbox and keep their status: an expired or disabled integration app is expired or disabled in the new environment too. Partially installed templates and integration apps keep their progress, so no work is lost.

Flows

All flows in your Sandbox are disabled when the upgrade starts and stay disabled in the new Sandbox environment until you re-enable them. Their schedules are preserved. See After the upgrade.

Troubleshoot the upgrade

Your upgrade can't start yet

Symptom: The Upgrade your environments dialog shows Your upgrade can't start yet. Your sandbox has active work or pending transfers. Resolve them, then start the upgrade. and Start upgrade is unavailable.

Cause: Your Sandbox has running flow jobs or transfers that haven't been accepted or declined.

Resolution: Wait for the jobs to finish or cancel them, resolve any pending transfers (go to Account Account icon, and then select Transfers), and then start the upgrade again.

The upgrade banner doesn't appear

Symptom: You've been told your account is ready to upgrade, but there's no banner at the top of the page.

Cause: The banner isn't shown while your Sandbox has running jobs or pending transfers, and it's hidden for the rest of your session after you close it. It's also shown only to the account owner and administrators in Production.

Resolution: Resolve running jobs and pending transfers in your Sandbox, make sure you're signed in to Production as the owner or an administrator, and sign in again.

Couldn't complete the upgrade

Symptom: The banner reads Couldn't complete the upgrade. Sandbox restored. Support has been notified and we'll let you know when you can retry., and you receive an email that the upgrade is incomplete.

Cause: The upgrade hit a problem it couldn't recover from.

Resolution: None needed. Your Sandbox is restored to its previous state, and Celigo support is notified automatically. When the issue is resolved, you receive an email and a Retry upgrade banner. See If the upgrade fails.

Flow runs fail with "You have reached the maximum number of agents for your subscription"

Symptom: Flows in your new Sandbox environment fail with You have reached the maximum number of agents for your subscription.

Cause: An agent other than the one the upgrade created is set up in the environment. The upgrade's agent (named <agent name> - copy) already counts against your entitlement — even if you've since deleted it, it counts for the current usage period.

Resolution:

  1. If you deleted the upgrade's agent, restore it from the recycle bin.
  2. Reinstall the agent software on your server for that agent (Windows | Linux), and point your connections to it.
  3. Remove any additional agents you created.

If the upgrade's agent was purged from the recycle bin, it can't be recovered — contact Celigo support.

FAQ

What entitlements does my new Sandbox environment have?

The same entitlements as Production — no additional licenses are required. The one exception is on-premise agents: because environments are independent, the agent the upgrade created or moved into your Sandbox environment must be reinstalled on your server before it can run flows. Don't create an additional agent; the upgrade's agent already counts against your entitlement. See On-premise agents.

My account had a Sandbox that expired. Is it upgraded?

No. Accounts with an expired Sandbox aren't included. If your account previously had a Sandbox that's no longer active, there's nothing to upgrade.

My account has CAM or VPM integration apps, or different licenses in Production and Sandbox. Can I upgrade?

Accounts with these configurations need help from Celigo. Contact your Celigo account team to coordinate the upgrade.

Do resource IDs stay the same after the upgrade?

For resources that move to the new Sandbox environment — flows, exports, imports, connections, scripts, and the Sandbox-only tokens, iClients, and agents — the resource ID (the _id value) stays the same. Resources that the upgrade recreates because they were shared between Production and Sandbox — API tokens, iClients, on-premise agents, and stacks — get new IDs in the Sandbox environment. If your own tooling or monitoring references resources by ID, review anything in the recreated category. See How the upgrade handles your resources.

Can I run production traffic from a non-production environment?

Non-production environments are for building and testing. Your subscription's entitlements — such as the number of flows and endpoints you can use — apply to your account as a whole, so usage in a non-production environment counts toward the same limits as usage in Production. Run production workloads in your Production environment, and keep your usage within your subscription.

Is there a deadline for the upgrade?

The upgrade is required, but Celigo hasn't set a deadline. Celigo prompts you in integrator.io when your account is ready to upgrade.

Does this apply when I upgrade my subscription from Professional to Enterprise?

Yes. A Professional-to-Enterprise subscription upgrade uses this same process to move your Sandbox to the multiple-environment structure.

Can I still use Integration Lifecycle Management (ILM) after the upgrade?

Yes. ILM works the same way after the upgrade. You can continue to pull changes between related integrations and revert to previous revisions. See Use multiple environments with Integration Lifecycle Management (ILM).