Importing and Exporting Workspace Settings

An administrator can save workspace settings as a JSON file (create a backup) and, if necessary, apply the saved settings to the workspace. 

Importing and Exporting Workspace Settings Saving workspace settings does not save content (assets and their metadata). If you need to restore content, please contact the support service at support@picvario.com.

List of settings included in the JSON file:

  • Authentication and Authorization › Groups
  • Content › Collection types
  • Content › Content types
  • Content › Content_link_types
  • Content › List values
  • Content › Preview prop set relations
  • Content › Preview prop sets
  • Content › Preview props
  • Content › Prop groups
  • Content › Props
  • Content › Tree items
  • Content_Export › Export restrictions (questionable)
  • Content_Export › Meta templates
  • Content_Export › Stat fields
  • Content_Import › Meta templates
  • Options › Options
  • Organizations › Organizations
  • Permissions › File type permissions
  • Permissions › Public props
  • Permissions › Rules
  • Proxy_File_Options › Proxy types
  • Search › Custom filters
  • Search › Filter props
  • Security › Password policy
  • Security › Security settings
  • Workflow › Processes

The file also specifies the release version.

Backup Histories

This section contains the history of workspace settings imports and exports. The name of each item consists of:

  • Event — settings import or export.
  • Status — ok or fail, if the process was successful or unsuccessful, respectively.
  • Date and time of the event.
Backup hystories.jpg

The user can click on an item to open its details card. In addition to the parameters mentioned above, it will indicate:

  • Author — the user who initiated the settings import or export.
  • Errors
  • Import or export logs in case of errors.
Backup hystory export.jpg

Backup Records

This section (Home › Settings_Backup › Backup_records) stores the last three system settings records.

Backup records.jpg

Each newly generated file (if 3 files have already been generated) replaces the oldest export file. The user can:

  • Download the record as a JSON file. To do this, click the Download button next to the desired item.
  • Restore the system based on an existing JSON file. To do this, click the Restore button next to the requiered item.

Backup Schedules

In this section, the user can configure the frequency of saving settings and check when the settings were last saved. By default, the settings export frequency is once every 24 hours. To do this:

  1. In the Home › Settings_Backup › Backup schedules section, click on the «every 24 hours» item.
  2. In the «Automatic Export period (hours)» field, you can enter the period in hours. For example, if you enter 2 instead of 24, the settings will be automatically saved every 2 hours.
  3. The «Last run» field indicates when the last automatic settings save occurred.
  4. Click Save to save the changes.
Backup schedules.jpg

Manual Settings Export

The administrator can manually save a settings file to use it later for import and system rollback.

Export settings.jpg
  1. Go to the Home › Settings_Backup section.
  2. Click the Export settings button. The JSON file will be downloaded to the device. The settings are saved at the current moment, at the time the Export settings button is clicked.

Manual Settings Import

A saved settings file can be imported manually to roll back the system to the settings state recorded in the JSON file.

Import settings.jpg
  1. Go to the Home › Settings_Backup section.
  2. Click the Import settings button.
  3. Click the Choose file button, select the file on your device.
  4. Click the Submit button. 

If the settings are applied successfully, a «Settings imported» notification will appear at the top. Refresh the workspace interface for the updated settings to take effect. If a file of a different format (not JSON) was imported or if there is an error in the JSON file, an error notification will appear at the top.

.

Can’t find what you’re looking for?

Submit a request