Academy · Developer

Installing into a project you already use

In one line. Install here puts a solution into the project you are in and can’t be fully undone: items with the same name are replaced, the solution’s flows are switched on or off as it set them, its events are added beside yours (both may run), its data sources can start straight away, it can make the project readable without signing in, the project’s settings and menu change, and some items can end up twice — the screen does not ask first. Install as new leaves your other projects’ own items alone, but the new project’s flows and events go live with the publisher’s addresses. Either way, shared functions other projects use can be replaced. You’ll be able to. Pick the right install button, know what an install overwrites, merges, adds beside or keeps, and know what a restore point can and cannot take back. Where this lives. The Hubs chip on the Studio top bar — Hubs ▸ Solutions for whole solutions, Hubs ▸ Agents for a single agent. Restore points are listed in Studio ▸ Governance ▸ Snapshots.

Will installing overwrite what I already have?

It can, it can’t be fully undone, and the screen does not ask first. When your project already has an item with the same name as one in the solution — an agent, a taxonomy, a lifecycle, a flow, a form or a role — Install here replaces yours with the solution’s, and the solution’s flows are switched on or off as the solution set them. Its events are added beside yours, so both may run. Its data sources replace yours of the same name and can start straight away, and its schedules can switch on. Collections and tables are merged. The project’s settings and menu change to the solution’s. Some kinds of item are matched by their own id rather than their name, so a same-named one of yours stays and the solution’s is added beside it. Shared functions other projects use can be replaced too. The compatibility check (Check install compatibility) looks at the platform version, the models, the connections and the keys the solution needs — not at your items, and nothing lists which of them share a name.

Anything in the solution with a name your project does not have is added beside your own items. Nothing is renamed.

Install here or Install as new

Hubs ▸ Solutions offers two buttons on a solution:

Button Where the solution goes Your existing items
Install here Into the project you are in, straight away — no dialog. Overwritten, merged or added beside (table below). A restore point is attempted first (below).
Install as new Into a new project. Import as Project asks for its name; Confirm & Import creates it. Your other projects’ own items are left alone, but shared functions other projects use can be replaced (below). The new project is live at once: it can be readable without signing in, its flows are switched on or off as the solution set them, its flows and events carry the publisher’s webhook addresses and email recipients, its schedules can go live, its roles can add people already in the workspace, and demo documents are added if the solution has them. If the install fails, the new project is removed again.

When you want the solution beside your work rather than inside it, Install as new is the safe choice. You can open both projects and move over what you need.

What happens to each kind of item

What an Install here does when your project already has one of these:

In your project What the install does
The project’s settings and menu Take the solution’s values — anonymous access, the landing page, working days and the other settings the solution carries. The navigation menu is replaced as a whole, so Studio, Chat or the assistant can end up hidden. The live pages, brand and skin the solution carries replace yours.
An agent of the same name Replaced by the solution’s version (left as it is when identical). A deleted agent of that name is purged first.
Taxonomies and their labels, lifecycles, dashboards, guard rails, input forms Replaced by the solution’s version.
Data sources (ingestion) Replaced, or added, and run — a source with the same id or the same name as yours is replaced and run again; a new one is added and runs or queues straight away. Only sources tied to a data sheet the solution carries come in; the rest are dropped. New connectors and jobs arrive switched off.
Reading without signing in Takes the solution’s setting — if the solution allows it, the project becomes readable without signing in.
Schedules — evaluation runs and RPA bots Take the solution’s schedules, so they can switch on.
How people add data to a collection (Add-Data settings) Replaced by the solution’s.
Flows (XFlows) Replaced, and every flow the solution carries is switched on or off as the solution set it — a flow you had turned off can come back on, with the solution’s triggers, stages and schedule. A step with a name the solution’s flow also uses is swapped for the solution’s step.
Events Added beside yours; both may run. Events are matched by their own id, not their name, so a same-named event of yours stays beside the solution’s. Where an id does match, who is emailed, the webhook address, what triggers it and the stages it watches all become the solution’s.
Roles Replaced: a same-named role takes the solution’s permissions and what it can see. A new role can add people who are already in the workspace.
Collections and datasheets of the same name Merged — the solution’s definition is laid over yours. Rows in a same-named table collection are added, or overwritten when their key matches. A collection you had deleted can come back with the documents that were deleted with it.
Prompts, skills, agent flows and pages Matched by their own id, not their name. The same one is updated; a same-named one of yours with another id stays, and the solution’s is added as a second copy.
A lifecycle stage of the same name Matched by its own id too: a same-named stage with another id is not merged, and that stage fails to install.
Shared functions Function libraries shared across the platform are replaced by the solution’s — on Install as new too — so other projects that use them change as well.
A custom tool of the same name, or a connection with the same id Replaced by the solution’s version — a replaced one loses its saved key; enter it again afterwards.
Language models The solution’s agents are pointed at your models by name; models the project lacks are added without keys.
Files in the Drive Kept — a file already there is left alone; only missing files are added.

Installing the same solution again, or a newer version of it, updates the items it installed before — even ones you renamed since — rather than adding copies.

A single agent from Hubs ▸ Agents behaves the other way round: if your project already has an agent with that name, yours is kept unchanged and the solution’s version is not written. The screen still reports “imported successfully”, so check the agent afterwards if you expected the new version.

Your documents

An install does not edit your uploaded documents or what was extracted from them — but it is not without effect on them:

  • A collection you had deleted can come back with the documents deleted with it.
  • Rows of a table collection whose key matches one of the solution’s are overwritten.
  • Flows and schedules the install switches on, and the events and data sources it brings, can start acting on your documents straight away.

Sample data. None lands in a project you already use. A solution’s sample files come only with Install as new, when you tick Also add this solution’s sample data; its demo records, if it has any, go only into a new project.

The restore point, and what it cannot undo

Just before an Install here, the platform attempts a restore point of the project, named after the solution and its version, listed in Studio ▸ Governance ▸ Snapshots. Do not count on it:

  • It is best effort. A part of the project it cannot capture is skipped, and the install goes ahead anyway.
  • It does not cover the rows of table collections.
  • Going back to it does not remove anything the install added — second copies, new items and new models stay.

So an Install here cannot be fully undone. When you are not sure, use Install as new.

Before you install into a project you use

  1. Read the solution’s Setup guide and Overview tabs, and run Check install compatibility.
  2. Compare what the solution carries with your project: agents, taxonomies, lifecycles, flows, forms and roles of yours with the same names will be replaced, flows and schedules can switch on or off, the solution’s events will run beside yours, data sources of the same name will be replaced and run, and your project’s settings and menu will change.
  3. If something of yours shares a name and must stay as it is, rename it first — or use Install as new.
  4. Afterwards, enter the keys the install asks for, check your connections and custom tools, and look over which flows, events and data sources are on — including any that now run twice.

Updating a solution you installed earlier is a separate step: the update panel’s Upgrade current project says plainly that it “overwrites workflows, prompts, and database schemas with the latest version” and saves a rollback snapshot first (Hubs & distribution).

Where to go next

Prefer learning inside the product? The same academy lives in the platform's Learn menu — every screen links to the chapter that explains it.

See the platform live