Setup Guide
This documentation has been deprecated! While we will no longer update this documentation set, it will remain available for a short time while users transition to the new documentation site.
To see SmartBackup’s current documentation, go to and bookmark https://docs.acuworkflow.com
| HOME | Installation Guide | Setup Guide | User Guide | Reference Guide | Support Guide |
|---|
- Tenants - once-off configure backup users, it may be altered in time
- Vault - once-of setup the vault, it may be altered in time
- Settings - optionally advanced users can alter runtime defaults
This is not required for Enterprise Editions.
The Tenants file is mandatory and must be supplied. Edit the SmartBackup.csv file to contain entries for every Smartsheet User(Tenant) you want to backup. Note column names must be spelled exactly as shown and are case-sensitive. Ideally modify this file via the console ui.
| Name | Value |
|---|---|
| Status | Must be set to 'Enabled' for processing tenant entry. To disable an entry on backup run change to the Status value to ‘Disabled’ |
| Tenant | Name of Tenant e.g. Joe Blocks |
| TenantID | Email address of Tenant e.g. joe.blocks@acme.com |
| TenantOrg | Organization Name of Tenant e.g. Acme Corp |
| TenantToken | Smartsheet API Token of Tenant (Backup Source) |
| VaultID | Smartsheet Workspace ID of Workspace where designated Vault resides |
| VaultLink | Smartsheet Workspace Link of Workspace where designated Vault resides |
- You can have multiple Tenant Files each containing differing configurations based on your setup
- At run time associate the Tenant file you want to use for that particular run
- To get TenantToken
- Login to Smartsheet, click on Account top right
- Select Apps & Integrations, then API, Generate Token
- Token becomes your TenantToken in tenantfile, that way the backup knows who you are and therefore what files to backup
Once-off configure a Smartsheet Workspace that will act as the backup container. To do this:
- Login to Smartsheet, select Workspaces, right-click and then select Create new Workspace
- Name the Workspace aptly, such as
VaultorBackup VaultorSmartBackup Vault - Right-click on Vault Workspace and select Properties
- Copy the Workspace ID to tenantfile VaultID, in so doing it becomes the designated Target Backup area
- Copy the Workspace Link to tenantfile VaultLink
Note, Smartsheet restricts the number of sheets allowed for non-Enterprise licenses. Usually it is 100 per User or aggregate thereof e.g. 10 Users = 1000 Sheets. In the event that you are running into these restrictions decrease the backup scope or make use of the Export capability.
Use the Settings section in the Console UI for further setup and configuration.
Advanced users or Administrators can further customize the platform by editing \data\config.yml or access from the settings screen