Skip to main content

Settings

Brobench allows you to configure/customize some aspects of the application. These capabilities are described below.

Preferences

Preferences tab allows you to customize various settings to adjust the app to your needs.

FieldDescription
TimezoneTime Zone used to format all Date Time values in the app. Defaults to Connection time zone.
Main Tabs LayoutCustomize which Main tabs are shown by default and in which order.
Object Tabs LayoutCustomize which Object Tabs are shown by default and in which order.
Hide System FieldsControls if System Fields (like CreatedDate, CreatedById) are hidden when you open the Object Fields list. If turned on, then System Fields will be hidden by default but you can still shown them but unchecking the Hide System Fields in the filter.
Hide Blank FieldsIf checked, Blank fields will be hidden by default in Record Viewer and Record Editor.
Popup Opens in Full ScreenControls if app should always open in new tab/full page mode when you click on the Brobench app launcher in the Sfdc Page.
Popup Position Top/Width/HeightControls where and size of the Popup that is open when you click on the Brobench app launcher.
OAuth Connected App Client IdIf you want to Brobench to use your own OAuth Client Id to connect to Salesforce Orgs, specify the Client Id here. You can use this capability to allow Brobench to connect to your with API Control enabled.

Workspace Dir

Workspace Dir is the directory that you can grant access to Brobench to read/write files and directories within that directory. This is required to make use of some of the Brobench capabilities like Saved Debug Logs.

Backup

This tab allows you to take manual backup and configure auto-backup settings.


caution

Backup uses Workspace Dir to save backup files. If you do not have Workspace Dir set, go setup first, and then you can take backups.

To take a backup, click on the 'Take Backup Now' button. App will export all configuration data into a JSON file, zips, and save the file to backup folder in the Workspace Dir.

If you are Essential+ user, then you can enable to create auto-backups of the data. To enable Auto Backups, check the Enable Auto Backup checkbox and select the appropriate backup interval.

Backups are stored as Zipped JSON file in {Workspace Dir}/data/backup folder. For ex., if your Workspace Dir is /Usres/john/BrobenchWorkspace and backups will be stored in /Usres/john/BrobenchWorkspace/data/backup To import a backup, use Import tab.

Export

While the majority of data that you see in Brobench is coming from Salesforce, while it is cached, it doesn't need to be backed up. However, the app does store some configuration items like Query Templates, Query History, Connections, etc.,

You can lose this data if you remove the extension and install it or if you delete the data by yourself through the app or other means. By backing up, you can keep the configuration safe and import it back later when in need.

There are two ways to backup. Via Backup tab or in this Tab. In backup tab, app will export all config as Json, zips and saves to a local Workspace Dir. In this tab, it shows you full Json content which you can copy and save it to a file.

Import

warning

Import feature overwrites all your current configuration with config being imported. If you are not sure if you are going to lose any configuration, backup first

To import a backup, unzip the file if it is zipped, select the JSON file or enter the JSON content and click Import button. App will prompt you twice to confirm and then proceeds to import the provided config. Note that some config data is not imported, like the Master Password example or License activation etc., which needs to be done manually.