Compatibility:
SharePoint 2013 Foundation (SPF) and Server (SPS) SharePoint 2010 Foundation (SPF) and Server (SPS) Windows SharePoint Services (WSS) 3.0 / Microsoft Office SharePoint Server (MOSS) 2007
SPF & SPS 2013 • 2010 • 2007
User Voices
(Loading...)
« FilterZen BCS/BDC Business Data Item Builder Web Part | Reference: URL Settings Parameters »
Sunday
Apr262009

Configuration Settings

The following configuration settings are available to administrative users on the Configuration page in your FilterZen Studio, which you can access via Site Settings / FilterZen Studio / Configuration Settings.

Each setting has a global value scoped to the SharePoint server farm, and this value can optionally be overridden on the Site Collection level. The following settings are available:

User Interface Language

FilterZen has been localized for multiple languages. In addition to English and German, if you have added partial translations in other languages (via Site Settings / FilterZen Studio / DIY User Interface Localization), these languages will be available for selection here. Changing this setting affects all FilterZen user interfaces except captions and descriptions of Features, List Templates, Column Types, Content Types or Web Part Templates (those are always loaded directly by SharePoint based on the current Web Site locale).

You can pick one of the following options on the Configuration page in the FilterZen Studio:

  • (Like site, or English)
  • English
  • Deutsch

Hard limit for pickable choices in drop-down filters

Interactive drop-down filters (such as Choice, List Lookup, SQL, User and BCS/BDC Filters) use this threshold to limit the number of visibly pickable choices. This is recommended both for usability and performance reasons. To disable the limit (not recommended), set this setting to 0. If you don't specify a valid integer number, the default value of 150 will be used.

After you have customized this setting, you can click the Reset to Default Value link on the Configuration page in the FilterZen Studio to restore the following default value:

150

How to deal with 'Edit in Datasheet'

Datasheet Views don't support Web Part Connections and instead of simply ignoring these, unfortunately they usually just fail to display. As a result, when a user clicks 'Edit in Datasheet' in your FilterZen-connected List View, an error message is displayed in place of the data. You can resolve this by either ticking the On pages with nothing but a single List View, automatically filter it connectionless check-box option in the Advanced Filtering Settings section of the FilterZen Web Part's settings tool-pane (SharePoint 2010 only) — or alternatively, if you manually add a new, separate, dedicated (public) Datasheet View to the List, then FilterZen can automatically redirect your users to this separate Datasheet View page when they select 'Edit in Datasheet' in any View.

Select the 'Auto-redirect' choice to allow this kind of redirection of users to your dedicated Datasheet View when they click 'Edit in Datasheet' on a non-Datasheet View. If you select 'Ignore', then 'Edit in Datasheet' on a connected List View page may result in the error message: "There is no valid configuration for these connected parts to run in." (Note: SharePoint 2010 also lets you disable datasheet views on a per-List basis via List Settings / Advanced Settings.)

You can pick one of the following options on the Configuration page in the FilterZen Studio:

  • Ignore problem (displays Microsoft error message)
  • Auto-redirect if dedicated separate Datasheet View exists

In CAML Direct filtering mode, override List View Web Part folder display only when filters are active (only limited support for this feature in SharePoint 2010)

The CAML Direct filtering mode allows you to "override the default display of folders" when connected to List View Web Parts. On the Configuration page in the FilterZen Studio, tick this check box to only attempt this override when active filter values have been sent, instead of always.

Custom image URL for "Loading..." spinner animation

When filters are applied or cleared, FilterZen by default shows a SharePoint-typical animation (the green spinner) to indicate that an operation is in progress. If desired for design customization or branding purposes, you can enter an alternative picture URL to use for this animation. This can be an absolute or a server-relative URL such as /_layouts/images/roxority_FilterZen/k.gif for example.

In Text filters' List-based AutoSuggest drop-downs, 1-character entries use BeginsWith instead of Contains

When connected to List View Web Parts, Text Filters can be set up to offer end users a "List-based AutoSuggest drop-down, if possible", providing find-as-you-type suggestions for assisted input completion. This drop-down (always limited to the maximum number of entries configured below) invokes an AJAX search against the connected List for the Column targeted by the Text Filter, and returns values containing the current text box input. For huge datasets, it might be more desirable to only match values that start with (rather than contain) the currently typed in letter as long as only a single one has been typed, so that entering B shows all values starting with B. The drawback to this might be end user confusion because the AutoSuggest drop-down will revert to "contains" logic as soon as more letters are typed. (Note: when the Text Filter has its own filter operator set to Begins with, the AutoSuggest will always use begins-with instead of contains logic.) On the Configuration page in the FilterZen Studio, tick this check box to use begins-with rather than contains for single-letter inputs.

Maximum number of choices in Text filters' List-based AutoSuggest drop-downs

In an AutoSuggest drop-down, when more than say 20-30 items are displayed, users are much more likely to further refine their text input rather than scan hundreds of choices, and a low limit drastically improves performance of List-based auto-completion drop-downs in Text filters. To customize this, enter an integer number higher than 1, otherwise the default value of 40 will be used as the limit.

After you have customized this setting, you can click the Reset to Default Value link on the Configuration page in the FilterZen Studio to restore the following default value:

40

End-user instructions for Text Filters' List-based AutoSuggest drop-downs

If desired, use this setting to compose an explanatory note for end users, to be displayed at the bottom of all Text Filters' List-based AutoSuggest drop-downs.

After you have customized this setting, you can click the Reset to Default Value link on the Configuration page in the FilterZen Studio to restore the following default value:

(Showing max. 40 results)

No-Filter Parameter Names (URL / Page Request Filters)

When using catch-all URL / Page Request Filters, optionally specify the request parameter names (one per line) that should never be sent as filters. Including the SharePoint-typical URL parameters in this setting's default value is recommended.

After you have customized this setting, you can click the Reset to Default Value link on the Configuration page in the FilterZen Studio to restore the following default value:

ContentTypeId
DisplayMode
FolderCTID
InitialTabId
IsDlg
Paged
PageView
PageFirstRow
RootFolder
SortDir
SortField
Source
View
VisibilityContext
p_ID
p_FSObjType
p_FileLeafRef
p_Title
FilterField1
FilterValue1
FilterField2
FilterValue2
FilterField3
FilterValue3
FilterField4
FilterValue4
FilterField5
FilterValue5
FilterField6
FilterValue6

ADO.NET Database Connection Providers for SQL Data Access

Specify the ADO.NET database connection providers that your Database/SQL Data Sources should support (one per line, using the pattern "Provider display name: full provider IDbConnection Type name, full assembly name").

After you have customized this setting, you can click the Reset to Default Value link on the Configuration page in the FilterZen Studio to restore the following default value:

SQL Server: System.Data.SqlClient.SqlConnection, System.Data
Oracle: System.Data.OracleClient.OracleConnection, System.Data.OracleClient
ODBC: System.Data.Odbc.OdbcConnection, System.Data
OLE DB: System.Data.OleDb.OleDbConnection, System.Data

Delimiter for indenting nested pickable List Lookup filter choices

If you (think you) need this feature, please read or join the related support forum thread.

Never offer the following pages in List View Pickers

The "List View Picker" filter type lets end users select a different List View to apply to the connected List View Web Part. View pages whose URL paths contain any one of the values specified here (one per line) will NOT be offered for end user selection by this filter type.

combine.aspx refers to the built-in Merge Documents view, repair.aspx to the built-in Relink Documents view, webfldr.aspx to the 2007 Explorer view. These are generally not desirable in a List View Picker context.

After you have customized this setting, you can click the Reset to Default Value link on the Configuration page in the FilterZen Studio to restore the following default value:

/forms/combine.aspx
/forms/repair.aspx
/forms/webfldr.aspx

External Filter Types

Specify the additional or third-party FilterZen filter types to make available to FilterZen Filter Web Parts in this Farm (one per line, using the pattern "full roxority_FilterZen.FilterBase inheritor class type name, full assembly name"). CAUTION: uninstalling an external filter type assembly will break all Filter Web Parts that still use a filter of that type.

When remembering filter values, store by name only (and share across FilterZen Web Parts)

FilterZen Web Parts can be set to 'Remember filter values last used for each user'. By default these stored values are unique to the user, the filter name and the FilterZen Web Part storing them. On the Configuration page in the FilterZen Studio, tick this check box to store and restore values only based on the user and filter name instead, which lets you share filter values of the same name between multiple individual FilterZen Web Parts.

Storage location for 'Remembered filter values last used'

FilterZen Web Parts can be set to 'Remember filter values last used for each user'. By default these values are stored both in the user agent (browser) and in the SharePoint content database, but this configuration settings lets you override that default hybrid storage model. Client-side cookies may be cleared by users or blocked due to corporate security policies. Server-side storage may in rare configurations fail silently due to administrative access restrictions even for elevated code, or with large user bases may inflate the content database over time.

You can pick one of the following options on the Configuration page in the FilterZen Studio:

  • Both (recommended)
  • Server-side content database
  • Client-side browser cookies

Remove Parameters from URL

Enter the URL Parameters that FilterZen should remove from the URL when in use (if the Web Part's Override Web Part settings from URL parameters check-box option is ticked), one per line.

Enable Web Part Connections menu option 'Send single data value to'

When this option is selected, FilterZen Filter Web Parts will act not only as 'filter providers' and 'data row providers' but also as 'data cell providers'. This is usually not necessary because row providers can always also be used as cell providers and provide a better user experience for the Web Part Page designer. If unsure, don't select this option.

By default, no inclusion of jQuery library v1.8.3 (NOT recommended)

Some FilterZen end user-facing artifacts may require, and load into the respective host pages, the jQuery library. Embedding jQuery more than once in a single page can sometimes cause issues. On the Configuration page in the FilterZen Studio, tick this check box only if your master pages, web pages or third-party extensions also already include jQuery globally (not just on some individual pages) and do so independently of FilterZen, to prevent FilterZen from loading jQuery redundantly. If you do so, you need to make sure jQuery (any version higher than 1.4 BUT lower than 1.9) is loaded on each page also hosting FilterZen user interface artifacts, or FilterZen will appear broken. This is a global default setting that may be optionally overridden locally where applicable.