Delete and restore a custom module

A workspace can delete a custom module it built in Studio. Deleting takes the module away for everyone in the workspace, and Recently deleted on the Studio Projects page brings it back, with its records.

This is different from Delete project. Delete project only clears a module's Studio chats and drafts and leaves the module and its records alone. Delete module removes the module itself.

#Who can delete a module

All of these must be true:

• You can use Studio, which means a Super Admin or a Manager. See Studio: change modules and build your own.
• You are a Super Admin, or your access to that module is All or Admin. A Manager whose level was lowered to Own or None cannot delete it, because deleting sends everyone's records to the Trash.
• The module is one this workspace built. Built in modules are not deleted from Studio. A module that has been deployed to another workspace is refused, with a message such as "Vehicles has been deployed to another workspace, so it cannot be deleted or restored from Studio."
• The workspace can be changed. A read only workspace shows no delete or restore action.

#Delete a module

Delete module is shown only to people who may delete the module, in three places:

• The sidebar: right click the module's row (or focus it and press the menu key or Shift+F10). The same menu has Open in Studio.
• The module's card menu on Projects. Every custom module has a card there, even after its Studio project was deleted.
• The module's builder, in the top bar next to Delete project, on narrow screens too. After the delete you land on Projects.

A centered confirmation, for example "Delete Vehicles?", checks what goes with the module and then says:

• How many records go to the Trash (a module with no records says so).
• Which scheduled automations are paused, by name if you may open Automations, otherwise as a count.
• Whether another module still needs it, which blocks the delete.
• That its Studio chats and drafts are deleted too, and that you can restore it, with its records, from Recently deleted.

Select Delete module to confirm, or Cancel. A message then says, for example, "Vehicles was deleted. 12 records went to Trash."

#What the delete does

• The module leaves the sidebar, the Store, and Studio for everyone in the workspace.
• Every live record of the module goes to the Trash at once, all marked with the same time, so a restore can bring back exactly those records.
• Scheduled automations aimed at the module are paused, so they stop running and failing. An automation counts when it starts on a schedule and has a step that names the module.
• The module's Studio project goes: its chats, drafts that were not applied, and its cover. The records of changes you already applied stay as the audit trail.
• The delete is written to the activity log.

Nothing is erased for good. The module's definition, its fields, and its version history are kept, and the module's key is never handed to a new module. Its records do not expire from the Trash, because custom module records wait there for a restore.

While a module is deleted:

• A relation field in another module that points at it, if the field is optional, stays in place and reads as unavailable.
• Automations that start from its records, such as record created or record changed, fire on nothing.
• Its approval rules gate nothing, and its dashboard widgets leave every dashboard.

All of these work again after a restore.

#When the delete is blocked

The Delete module button stays disabled, and the confirmation says why.

If the record count changed while the confirmation was open, the delete does not run: the confirmation shows the new count ("The module now has N records. Check the number and confirm again.") so you confirm what is true now.

#Restore a module

1. Open Studio, then Projects.
2. Select Recently deleted in the page header. A centered dialog lists deleted modules, newest first, with when, by whom, and how many records went with each.
3. Select Restore on the module.

You see only modules you may restore, under the same rule as deleting: a Super Admin, or All or Admin access to the module.

A restore brings back:

• The module in the sidebar and the Store.
• Exactly the records the delete took. A record that was in the Trash for another reason before the delete stays there.
• The module's Studio project on the Projects page.

A message confirms it, for example "Vehicles is back in the sidebar. 12 records came back from Trash."

Paused automations stay paused. The dialog names the scheduled automations the delete paused, or counts them if you cannot open Automations, and tells you to turn them on again in Automations when you are ready.

A restore can be refused when a required relation of the module points at a module this workspace no longer has. The message names it: "Maintenance log needs Vehicles in its Vehicle field. Restore or install Vehicles first, then restore Maintenance log." Bring the other module back first, then restore this one.

#Troubleshooting

#There is no Delete module item

See Who can delete a module. A draft that is not a module yet has no Delete module either.

#The module is not in Recently deleted

It lists only modules this workspace built and deleted from Studio that you may restore; a module deployed to another workspace is not restored from Studio.

#I restored the module but its automations do not run

Restoring never turns automations back on. Open Automations and switch on each scheduled automation the dialog named.