The interface of cloneworx Backup has five pages, and all of them are built from the same building blocks. This article introduces these building blocks: pages, views, tiles, messages, menus and lists.
The five pages
The plugin is in the WordPress menu under cloneworx. Below it, each menu item leads to one page. Switching between the pages does not reload anything.
- Backup is one of the five menu items. The menu item of the open page is highlighted.
- The topmost tile is the main tile of the page. Here it shows what was backed up last and where to, the last run and the next backup.
- Back up now is a button of the main tile.
- Schedule backup is the second button of the main tile.
- Backups is the title of another tile, here with a list.
- More … opens the menu of a row.
- Show more adds further rows to the list.
- Extended switches the view.
| Page | Purpose | |
|---|---|---|
| Overview | Shows at a glance whether your website is backed up: the state, the backup plans and the last three backups. | The “Overview” page |
| Backup | Here you start a backup, manage the backup plans and see the list of all backups. | The “Backup” page |
| Restore | Here you restore a backup, import a backup from a file and keep a restore or undo it. | The “Restore” page |
| Targets | Here you decide where your backups go: set up targets, test the connection, check and find backups at a target. | The “Targets” page |
| Settings | Everything that applies to the whole website, for example the notifications. Settings that belong to a backup plan or to a target are made there, not here. | The “Settings” page |
At the bottom right of every page of the plugin you see the version of the plugin.
Compact and Extended
Every page except the Overview comes in two views. The switch is at the bottom left: in the Compact view it shows an arrow pointing down and Extended, in the Extended view an arrow pointing up and Compact. Your choice applies to all pages of the plugin and is remembered. The default is Compact. The Overview has only one view and no switch.
The views differ in the number of tiles and fields. What you can do with a backup is the same in both.
| Page | What Extended shows in addition |
|---|---|
| Backup | The tile Backup plans is always visible; in Compact it only appears after a click on Schedule backup. The button Schedule backup therefore exists only in Compact. Next backup is also followed by the name of the plan. Each plan’s row additionally shows the last run, the scope, Max. backups and, if it is switched on, the snapshot. The form of a plan has three further fields: What is backed up, Max. backups and Back up the database as a snapshot. The list of backups also has the filters by plan, target and status and the column Plan, and it can be collapsed and expanded. In addition there is the tile Targets and space. |
| Restore | In Prepare restore you choose the areas of the backup individually and see the switches. The list of backups also has the column Plan. In addition there is the tile Recent restores. |
| Targets | The form of a target shows further fields, for example Port. For each target the list shows the last transfer and the backups stored there, and it also shows removed targets. In addition there is the tile Targets and space. |
| Settings | The tiles Scheduler, Performance, Retention, Exclusions, Log, Licenses and Uninstall, and in the tile System and support the block Diagnosis. |
Tiles and folding tiles
Every page consists of tiles stacked one below the other. The topmost is the main tile: a coloured edge on the left, a large symbol, a title, a few lines and below them the buttons. If a tile has a cross in a circle at the top right, you can close the tile with it.
A folding tile has a title row with an arrow at its right end.
- The title row. A click anywhere on the row expands the tile and collapses it again.
- The arrow does the same. It always shows what the next click does: pointing down means Show details, pointing up Hide details.
When a page is opened, the folding tiles are collapsed; the plugin does not remember what you had expanded. Two tiles are expanded when the page opens: the tile Notifications in the settings and the list Backups on the Backup page. The list can be collapsed only in the Extended view; in Compact it has no arrow and is always expanded.
The status tile and its colours
The main tile of the Overview is the status tile. Edge, symbol and title state a result: how the backups of your website are doing.
- Your website is backed up. is the title in the green state.
- Last backup shows the time, size and target of the last backup.
- Next backup shows the earliest next run of all active plans and the name of the plan.
- Back up now runs a backup plan right away. If there are several plans, you choose the plan first.
- Restore backup leads to the Restore page. The button is only there if a valid backup exists.
| Colour | Title | Meaning |
|---|---|---|
| red | The last backup failed. | The last finished backup failed. The tile shows the time, the cause, the next step and the last valid backup. |
| red | The plan “…” has not made a backup for …. | An active plan is overdue: it has not made a valid backup for longer than its rhythm plus a tolerance allows. Depending on the case, the title names the plan or the website. |
| yellow | The storage target “…” is disconnected. | A target is disconnected: backups skip it until you connect it again. |
| yellow | Your website is backed up, with warnings. | The last backup ended with warnings. The tile lists them. |
| green | Your website is backed up. | The last backup was complete. |
| grey | Your website is not backed up yet. | There is no finished backup yet. |
If more than one state applies, the tile shows the one that is higher up in the table. Aborted and running backups do not change the result. Every state with its lines and buttons is explained in The “Overview” page.
The main tiles of the pages Targets and Settings use the same colours for their own result. The main tiles of the pages Backup and Restore are blue: these pages are about an action, not about a state. The main tile of the Restore page is yellow only as long as a restore can still be undone.
Messages
Every page shows its messages in one place: directly below the main tile. The colour shows the kind of message: green for success, yellow for a warning, red for an error.
- A green message closes by itself after 8 seconds.
- The bar along the top edge shrinks to the left and shows the time that remains. As long as the mouse pointer rests on the message, the time is paused.
- Dismiss closes the message immediately.
- A red message stays until you close it or begin a new action. The same applies to a yellow one.
- Dismiss
- If a backup fails at a target, the message names the target and the reason. Below it you see the original message from the target or from the client.
- The link to the log of this backup.
- If you begin a new action, the previous message disappears, even a red one.
- After a backup or a check, a yellow or red message has the link Log. It opens the log of this job.
- A red message that belongs to no job has the link Show global log, for example when a backup could not be started. It opens the global log with the last 500 lines. The yellow message after a failed connection test on the Targets page has the same link.
- The message A job is already running. has no link.
The dialog window is always called Log. More on this: Progress, messages and log.
The “More …” menu
In the lists of backups and targets and in the tile Backup plans of the Backup page, you find More … at the end of every row. The menu contains all actions for this row. The picture shows the menu of a backup.
- Restore leads to the Restore page.
- Check backup checks whether the backup is readable and complete.
- Lock backup protects the backup from deletion. For a locked backup, this reads Unlock backup.
- Download is only available for a backup that is stored completely at a local target.
- Log opens the log of this backup.
- Delete backup is shown in red below a separator line and asks for confirmation before deleting.
Which entries a menu has depends on the row. A failed or aborted backup offers only Log and Delete entry, a running one only Log. The menu of a backup is the same in both views and on the Overview. On the Restore page it has only the entries Restore, Lock backup and Log; there, Restore opens Prepare restore for the backup of the row.
Lists
The lists of backups on the pages Backup and Restore show seven rows, the newest backup first. The same goes for the list Recent restores.
- Show less shortens the list to seven rows again.
- Show more appends the next rows and is only there as long as there are further rows.
- The lists of backups on the pages Backup and Restore have a header row. A click on a word in it sorts the list by that column. The sorted column is marked with a small triangle; a second click reverses the order.
- The dot at the start of a row has the colour of the status: green for complete, yellow for with warnings, red for failed, grey for aborted. A running backup is shown as the first row with a spinning ring.
- Lists and tables always give the date in full. Only the main tiles use “today”, “yesterday” or “tomorrow”.
- The Overview shows the last three backups. The list is missing only in the grey state, without a finished backup. All backups leads from there to the Backup page.
Tooltips on symbols
Some symbols have a meaning of their own, for example the lock in front of the date of a locked backup. You see the tooltip for it when you point the mouse at the symbol, tap it or reach it with the keyboard.
- The tooltip on the lock reads: Locked: this backup is never deleted automatically and is not counted for “Max. backups”. It can only be deleted by hand after “Unlock backup”.
The green tick and the red cross in front of the date of a checked backup are explained in the same way. In forms, some labels have a dotted underline: their tooltip also appears only when you point at them.
See also
- Initial setup: install and create the first backup
- How to read the images in this guide
- Terms explained briefly
- The “Overview” page
- Progress, messages and log
On the command line
WP-CLI not set up yet? How to install WP-CLI.
The interface exists only in the browser. WP-CLI also outputs the result of the status tile, plus the last backup, the last valid backup, an overdue plan, a disconnected target and the number of active plans and of targets. The output is in English. All commands are listed in The commands at a glance.
# Show the state of the website wp cloneworx-backup status