Settings Lockdown

Laserfiche offers many settings for users to customize their experience in the repository, but in some cases administrators may want to restrict some or all users from modifying certain settings. For instance, administrators might want to prevent users from modifying search settings that could impact search performance, or prevent users from changing the way that imported documents will be stored.

Using settings lockdown, you can lock down certain sets of options, either for the entire repository or for specific users or groups. Any existing settings for the affected users will be ignored, and users will be unable to make changes to those settings in the options menu of the Laserfiche web or Windows client. You can then establish a global default that will be used instead. Settings lockdown and global defaults are configured using trustee attributes.

Locking Down Settings for Users or Groups

The settings lockdown syntax allows you to lock settings by user or group, or to lock settings for everyone. In addition, you can lock any combination of the settings lockdown categories. For example, you might want to lock both the document viewer panes and the advanced import settings for the Sales group, the advanced import settings but not the document viewer panes for the Scanner Operators group, and the search settings for everyone. You could do so by setting different attributes for the various groups.

Note: Lockdown settings will be ignored for users with the Set Trustee Privileges, Manage Trustees, or Manage Entry Access privileges.

Settings lockdown is configured using trustee attributes on the Everyone group. (This is true even if you are not locking the settings category for everyone.) Which user or group to lock is specified using the trustee's security identifier (SID).

The attribute should be constructed with the following name:

[Lockdown]TrusteeName

where TrusteeName is the name of the trustee.

Use the following syntax to specify the trustee and settings categories to which you want to apply the lockdown:

SID=LockdownCategory1,LockdownCategory2,LockdownCategory3

where SID is the security identifier of the trustee you want to lock down, and the lockdown categories correspond to the settings categories you want to lock down for that user. You can combine any number of categories, separating them with commas. The following settings categories can be locked down:

• SearchSettings
• DocViewPanes
• AnnotationStyle
• QuickSearch
• AdvancedImport

See the list of settings lockdown categories below for more information on these lockdown categories.

You will need to configure a separate attribute for each user or group to lock down. To lock a setting for all users, lock the Everyone group (SID: S-1-1-0). The SID of a user or group can be obtained by exporting the trustee definition; the SID is listed in the resulting XML.

Important: The settings lockdown trustee attribute must be set on the Everyone group, even if you are locking down another trustee. The [Lockdown] attribute will be ignored if added to any other trustee.

Setting Repository Defaults for Locked Categories

When a settings category has been locked down for a user or group, affected users will use the default settings for that category. Any previously-configured settings for that user will be ignored, and the user will be prevented from modifying the relevant settings. If you have not set any custom repository defaults for the relevant settings, the standard repository defaults will be used.  

To change the default setting for all users in the repository, you can set attributes for the Everyone group. The Everyone group setting will function as a new default value. Users who have been locked down for a settings category related to the setting will use that setting and will not be able to change it; other users will use the new setting by default, but will be able to customize it themselves. For more information, see the settings lockdown categories, below.

Settings Lockdown Categories

There are five settings lockdown categories, each covering a variety of related settings.

Search Settings (SearchSettings)

The search settings lockdown category controls the following search settings:

• Fuzzy search: Whether fuzzy search is enabled. If fuzzy search is enabled, this also controls what percentage or how many letters of the word can differ from the search criteria and still be considered a search result. Disabling fuzzy searches, or limiting the fuzzy search percentage to 25% or less, can improve search performance. See [Search]Option, [Search]Error, [Search]LastError, and [Search]AltError in the trustee attributes reference for more information.
• Partial matches and root word search: Whether partial matches and variations on root words will be returned when performing a quick search or common search. Disabling partial match searches can improve search performance. See [Settings]SearchPartialMatches and [Settings]EnableStemming in the trustee attributes reference for more information.
• Case sensitivity: Whether to use the default case sensitivity settings, and, if not, what case and accent sensitivity settings to use. See [Settings]UseDefaultCollation and [Settings]SearchCollationRule in the trustee attributes reference for more information.
• Resolve shortcuts: Whether to search the documents referenced by shortcuts if you are searching in folders containing the shortcuts. Disabling this option can significantly improve search performance. See [Search]IncludeShortcuts in the trustee attributes reference for more information.
• Link group membership: Whether to include only the most recent members of link groups in search results, excluding older versions of the link group. See [Search]LatestVersionsSearch in the trustee attributes reference for more information.
• Search result limits: Whether to return only a certain number of results during searches. The most relevant results will be returned. Limiting search results can improve search performance. See [Settings]LimitSearchResults and [Search]FullTextSearchLimit in the trustee attributes reference for more information.

Document Viewer Panes (DocViewPanes)

The document viewer settings lockdown category prevents affected users from opening, closing, or rearranging the panes in the Laserfiche Windows client's document viewer. (This setting has no effect on the web client.) 

Users will be locked to their current document viewer pane layout. They can reset their panes to return to the default layout, but they will not be able to modify them further after that point.

Annotation Styles (AnnotationStyle)

The annotation styles settings lockdown category prevents affected users from creating private or protected annotations; all annotations created by affected users will be public annotations. Existing annotations will retain their original annotation style and will not be affected by this setting. This settings lockdown category does not control any attributes.

Quick Search Settings (QuickSearch)

The quick search settings lockdown category allows you to control which searches will be performed when affected users use the quick search bar in the Laserfiche web or Windows client. You can enable or disable the default quick search options, and you can also provide a custom quick search option. You can also disable the quick search bar entirely by setting the values of the relevant attributes to blank. See the quick search attributes in the trustee attributes reference for more information.

Advanced Import Settings (AdvancedImport)

The advanced import settings lockdown category controls the following import settings:

• Signing: Whether to sign documents on import. See [Settings]SignOnImport and [Settings]EnforceNSASuiteB in the trustee attributes reference for more information.
• Page generation: Whether to generate pages when importing PDFs. See [Settings]ImportPDFPages in the trustee attributes reference for more information.
• Outlook email import: Whether to file attachments in imported Outlook emails with the email or separately, what template to use for imported emails, and whether to retain information such as the sender and recipient list in the document's fields. As Outlook email import settings can be complex to configure, we recommend configuring the settings jn the Laserfiche web or Windows client, and then copying the email import attributes from your user account's trustee attributes to the Everyone group.
• Name conflict: How to handle document naming when there is a name conflict. See[Settings]ImportNameConflictOption and [Settings]ImportNameConflictVersionControlOption attributes in the trustee attributes reference for more information.
• Image file conversion: Whether to convert various image types into Laserfiche imaged documents or keep them as electronic files. See [Options]ImportConversionList in the trustee attributes reference for more information.
• File extension: Whether to retain the file extension for electronic documents. See [Options]RetainFileExtensions in the trustee attributes reference for more information.
• Volume: Which volume to import documents into by default. See [Settings]ImportVolume in the trustee attributes reference for more information.