Options

---

Options let you fine tune Security Zen to work best for you.  Options will automatically be saved upon closing the window.

"Security Protocol" may be set to use TLS 1.1 or TLS 1.2. 

Note that Salesforce is requiring the change to TLS 1.2 in 2019 per this knowledge article: Salesforce Disable TLS 1.1.

"ANT Package API Version" is the API version used while creating an ANT package.  This determines what Entity Types are available.  Set to a specific API version or set to 0 to automatically determine the API version based on the highest API version specified for Apex Classes in the connected environment.

"Retrieve Max Number of Polls" is the maximum number of times that the server will be contacted to determine retrieve status.

"Retrieve Poll Time (seconds)" is the amount of time to wait between Polls during a retrieve.

Note: For larger data sets, the above numbers may need to be increased.

"Load System Permissions" determines whether System Permissions should be added to the workspace when a retrieve is performed.  Available Options:

• Prompt: User is prompted each time to either load System Permissions or not.
• Always: System Permissions are always loaded without prompting the user.
• Never: System Permissions are never loaded and user is not prompted.

"Permission Set Entities Retrieved" determines what entities are retrieved when a Permission Set is specified.  Available Options:

• As Specified: Only entities specified in the Configure window are retrieved
• As Specified and All Entities Granted Permissions: Entities specified in the Configure window as well as all entities granted permissions in the Permission Set are retrieved.  When using this option, be advised that for entities not specified in the Configure window, only the Permission Set security is retrieved.  If a mixture of Profiles and Permission Sets is specified, the Profile security will only include entities specified in the Configure window.

"Color Scheme" determines the colors assigned to cells based on permissions.  Available Options:

• Red Yellow Green (stop light color scheme):
  • Red = no access
  • Yellow = some access
  • Green = full access
• Red Yellow Blue (high contrast color scheme):
  • Red = no access
  • Yellow = some access
  • Blue = full access

"Header Rotation" determines the rotation of column headers.  0 degrees is horizontal.  90 degrees is vertical.  A range of 70-85 degrees seems to provide a good balance of readability and data density.

"Font Size" determines the font size within the workspace.  Valid values are from 1 to 96, but more realistic values are usually between 6 and 12.  Default is 8.

Note that large font sizes may cause the column headers to take up the entire height of the screen which makes the scroll bars disappear.  Don't panic!  To correct this, either use a smaller font size or go to the bottom of the headers and resize the height of the headers to be smaller.

"Column Width" determines the column width in Pixels.  Default value is 70.  Specifying a Column Width of 0 enables Automatic Column Width which is based on the width of the Column Header.  Automatic Column Width is recommended in conjunction with a "Header Rotation" of 70-85 degrees.

"Sort Rows" will cause the rows to be sorted upon retrieval.  Version 3.1 has significantly improved this function and is now recommended to be checked.

"Active Users Only" determines whether all users, or just active users, are included in user queries.  This affects the following features:

• Number of users displayed in column headers for profiles and permission sets
• "List Users" displayed for profiles and permission sets when right clicking on column headers
• Selection of profiles and permission sets by user in Configure->Select->Security Files->Select By User
• Showing columns by user in Workspace Actions->Show Columns->By User
• Security Assignment Analysis

"Show Hints" displays hints on the backgrounds of windows such as the Workspace and the Configure window.

Changes in Display Options are applied during the next retrieve operation except as follows:

• "Column Width" is applied upon closing the Options window.
• "Active Users Only" affects the number of users per security file which is displayed in the workspace column headers.  The numbers displayed in the column headers are populated at the time of connection.  If you modify the "Active Users Only" flag, you will need to re-establish the connection in order to update the numbers displayed in the column headers.
• "Active Users Only" affects the following features at the time these features are used:
  • Column Header (right click)->List Users
  • Configure->Select->Security Files->Select By User
  • SF Actions->Security Assignment Analysis
  • Workspace Actions->Show Columns->By User

"Max Characters" sets a maximum number of characters per cell populated during the Security Assignment Analysis.  Default is 32,767 which is maximum number of characters in an Excel cell.  If 0 is specified, no maximum number of characters is imposed.

"Max Lines" sets a maximum number of lines per cell populated during the Security Assignment Analysis.  Default is 252 which is near the maximum number of lines in an Excel cell.  If 0 is specified, no maximum number of lines is imposed.

If "Max Characters" or "Max Lines" are specified and these are exceeded for a given cell, the last line of the cell will indicate how many more lines were not written.

If the maximums cell limits are not imposed and the contents of cells exceed the maximums that Excel support, columns may not display properly. 

"Deployment Method" determines the method used to deploy security changes to Salesforce (Deprecated in Version 3.1 due to Salesforce API changes):

• "API" deploys changes using an API call to Salesforce.  Security Files are grouped together in batches.  This method is frequently faster for small changes, but may time out on larger changes.
• "ANT" creates a single zip file of all changes and deploys the entire zip file at once.  This method is frequently faster for large changes in security.  This method creates an independent process on the Salesforce server and therefore will not time out.  See below for details about viewing/managing this independent process within Salesforce.

Starting in Version 3.1, the "ANT" deployment method is always used.

Options for ANT Deploy Method:

"Run Tests Before Deploy" controls whether tests are run as part of the ANT deploy.

• If checked, all tests are run and all tests must pass in order to successfully deploy changes.
• If unchecked, no tests are run.

Options for API Deploy Method (Deprecated in Version 3.1):

During an API deploy, Security Files are deployed in batches.  "API Batch Size" represents the number of security files deployed at one time when using the API deployment method.  Valid values for batch size are from 1 to 10.

Larger batch sizes will generally deploy slightly quicker, but there could be timeout issues with large batch sizes if you are deploying a large number of entities.

Smaller batch sizes will generally deploy slightly slower, but you are less likely to run into timeout issues.

Starting in Version 3.1, a browser window is automatically opened upon deploy, so you can monitor the deployment in Salesforce.  This change eliminated the need for the following Options:

"ANT Deploy Max Number of Polls" is the maximum number of times that the Salesforce server will be contacted from Security Zen to determine ANT deploy status.  (Deprecated in Version 3.1)

"ANT Deploy Poll Time (seconds)" is the amount of time to wait between Polls from Security Zen during an ANT deploy. (Deprecated in Version 3.1)