Web Part Properties (Pre-Summer 2005 only)

NOTE: This topic applies only to versions of Advanced Tree View Roll-Ups from before the Summer 2005 release. If you are working with Summer 2005 or a later release, please see the corresponding “Admin” topic instead.

Administration Properties

Enable Multi-Threading

This performance enhancement feature allows the web part (webpartA in the example below) to manage its own threads rather than submitting threads to be serially queued in the SharePoint thread management process. This allows parallel execution of multiple web parts, improving server performance under heavy loads.

NOTE: This option should only be enabled if you meet the following criteria.

      Your web server has multiple processors

      WebpartA is being used for heavy transactions against SQL server, returning 1000+ Items

      There is a heavy user load on webpartA

      You have configured the IIS application pool corresponding to the virtual server to use multiple worker processes (aka 'Web Garden')

Enabling this option on webpartA may not improve the performance of webpartA. However, this option is designed to allow webpartA to run independently of the SharePoint web part queue. This means that control will be returned to the SharePoint process more rapidly, allowing other web parts and web part pages to be rendered while the “expensive” webpartA is running.

IMPORTANT! Only perform the following steps if you understand the use and impact of editing the web.config file.

If you enable ThreadWebPart and notice that the web part times out, you will be be required to update the web.config for the virtual server hosting the site where this web part is being used.

NOTE: Make a copy of the web.config file before attempting the following.

The web.config file has a line "<WebPartWorkItem Timeout="7000" />". This specifies the amount of time given to a thread to collect and present data. If you are collecting large amounts of data, this may need to be increased to support this higher load. The 7000 represents 7000 milliseconds. If you wish to allow a thread to execute for a longer period, you must change this to the value you require. (Example: 60 Seconds = 60000). Some experimentation may be required.

Show Search Bar

This option enables the search bar in the roll-up display.  You can disable the search bar via a search command, but you cannot re-enable it in the same manner. Toggle this option on to re-enable the Search bar.

Show Roll-Up Administration (version 3.25 only)

This option shows the web part’s administration window, allowing administrators to manage the lists and schemas utilized by the web part. This view is only available to administrators of the Site or Web, or it can be viewed within in a Shared View.

Back to Top

 

Display Properties

Show Edit/Create Ability

This option activates the "Add Item" link and "Edit Item" icon on the roll-up display. When activated, users can add and edit items from the web part.  When deactivated, users can only display the list item.

Show Link to Sites/Lists

When this option is enabled, a selectable link is provided when the site name and list name are shown for each list item.

Show Link To Item

When this option is enabled, users can click a link to go directly to the item within the roll-up display. Use this in conjunction with the Show Links to Site/Lists option to remove a user’s ability to go directly to a list from within the web part.

Show List Expanded

When this option is enabled, the web part display will be expanded, showing all lists and list items returned. When it is deactivated, all lists and list items will be contracted within a tree-view which can be expanded by the user.

Expand Sites - Not Lists

When this option is enabled, only the sites (not lists) returned by the web part will be expanded, saving screen real estate. If the Show Lists Expanded option is enabled, it will override this setting.

Show Empty Lists

When this option is enabled, every list set up to be searched by the web part will be returned, regardless of whether or not any items are available in that list.

If a filter is applied and this option is enabled, only those lists that contain items that meet the filter criteria will be displayed; any lists that do not contain items that meet the criteria will not be shown.

Show URLs As Text Only

By default, CorasWorks Web parts will attempt to categorize text as a URL. If you have text with a format of "http://www.site.com" it will translate this text to a URL and automatically place the correct tags around it to make it clickable. If you do not want this to occur, toggle this switch on to disable this automatic feature.

Site Tree-View Display

This entry allows you to define the display format of the sites returned by the roll-up. For example, to display the site title and URL, you would place the following in this field: <%SiteTitle%> (<%SiteURL%) This would display the information as follows: Site 1 (http://www.site.com/site1).

Alternatively, you could enter text before the site title, as in Site: <%SiteTitle%>

Tree-View Font Style

This option is used to define the font style utilized for sites and lists returned by the roll-up. This is useful if your site utilizes a color structure that is not matched by a grey background and blue text. The style is based upon CSS definitions. While the CSS class cannot be entered, you can enter any text oriented toward a font style class like, such as "Font-Size:8; Color:Red"

Tree-View Node Background Color

This option is used to define the background color utilized for each site and list returned. By default, this color is grey (#DDDDDD), but this can be changed. This field supports hexadecimal characters or direct color notations (#DDDDDD, Grey).

Back to Top

 

Return Properties

Show Nothing At Startup

This feature allows the web part to return no results until the user completes a search. It can save much-needed performance when accessing multiple lists and/or sites. With some configuration, this allows you to have multiple roll-ups on a page, each pointing a different list with a different schema, and utilizing a form web part or another connected web part as a search mechanism for all roll-ups on that page.

Required Search String

(Optional) Users are permitted to search for specific phrases to return only the information that pertains to them. However, Administrators can deactivate this feature by placing a valid search phrase in the Required Search String field. When this is done, the web part will return the items found via the search phrase. The fields that can be utilized in this search string are identified in the Supported Schemas section of this help, on the “Search Fields” line of each identified schema.

NOTE: If anything is entered in this field, the Search function will be deactivated for general users.

Filter

(Optional) Administrators can use the Filter field to control the web part’s return at a higher level. Unlike the Required Search String (above), Administrators can specify the field to search and, if anything is entered here, users will still be able to search on the filtered return.

The format for this property is "Field=SearchText" (Example: Postal Code=11111) with no space between the field and the search text. You can also use > and < when filtering date fields. (Example: "Date<7" will return items that are older than 7 days from today.) This only works on filterable fields that are designated as date fields. Filter grouping with parentheses () is not permitted.

The fields available to use for filtering are identified in the Supported Schemas section of this help, on the “Filterable Fields” line of each identified schema.

Keep in mind the fact that filters look for values in a specific field. If you want to look for a specific value in any field, use a search, instead.

Examples:

Requirement 1:
Show me all tasks that are assigned to me and are due within seven days

Use:
Assigned To=[ME] && Due Date>-1 && Due Date<7

Requirement 2:
Show me all tasks that are assigned to me or to someone else

Use:
Assigned To=ME' || Assigned To=UserName

Requirement 3:
Show me all tasks that are not assigned to me

Use:
Assigned To<>[ME]

Where:

      && = And

      || = Or

      <> = Not

      [ME] = Currently Logged In User

 

Tips on Defining Filters

1. Available Columns for Filter Definition

Columns do not have to be displayed in order to be referenced in a filter, but they do need to be searchable.  To make a column searchable, the Search box must selected when the roll-up is created via the Roll-Up Wizard. Be default, all columns that are selected in the Roll-Up Wizard for display are also marked as searchable.

2. Contains vs. Is Equal To or =

Because SharePoint sometimes stores data differently than the way it is displayed, you may find that you get better results from your filters when you use the "Contains" operator instead of "Is Equal To" or “=”.

For example, you may see the name "Bob Smith" in a list item that includes the Assigned To field. However, SharePoint stores this name with extra characters, so the actual stored value may be something like "3;#Bob Smith." Therefore, if you want to filter on records that were assigned to Bob, you get the desired results if you build the filter with the "Contains" operator.

3. Using Yes/No Columns vs. Choice Columns with Yes/No Options

It is important to understand the difference between Yes/No columns and Choice columns with Yes and No options.

When you use a Yes/No column, SharePoint stores a “True” value when the field is selected and leaves it blank when it is not selected. As a result, if you want to filter on a Yes/No column, you need to set the filter to look for the appropriate value:

      To filter on a selected (Yes) value, the filter would be “column=True” (replace “column” with the name of your column)

      To filter on a non-selected (No) value, the filter would be “column<>True”

When you use a Choice column with Yes and No options, the filter should be defined as “column=value”.

Back to Top

 

Dynamic Grouping

This entry allows you to automatically group items by the values in a particular field.  For example, if you have a task list with five different statuses, the tasks can be grouped by status.  If you add a sixth status value, any items with that status are automatically included in the display and grouped under that new status.

The field you identify must be one of the display fields within the web part, and only one field can be used at a time.

NOTE: Tree view roll-ups do not support special characters such as “@” in dynamic grouping. If the Dynamic Grouping Field you identify contains this character, it will result in an error. The grouping will show correctly, but the group will not open when you try to expand it. The @ character is supported in dynamic grouping in action-enabled roll-ups.

Dynamic Grouping Properties

This entry allows the administrator to specify the look and feel of the dynamic grouping by identifying the background color, font style, and whether or not the results should be expanded or contracted. If no property is chosen the default properties and/or "FontSytle" or "TDColor" will be used. Each element of this property must be separated by a comma, with no space is separated between each element and the comma. Colors can be defined using either hex format or the direct color name.

Use: Row Color,Font Style,true/false
Example: blue,font-family: Verdana; font-size: 8pt; color: white; font-weight: bold,true
Settings: First Element = Tree-View TD Background Color, Second Element = Tree-View Font Style, Third Element = Expanded/Contracted (true/false)

Displayable Date Format

This property allows you to alter the return of those fields which are of a date type. SharePoint, by default, will store any date/time field as MM/dd/yyyy, hh:mm:ss. If you wish to have all dates or times returned show only a time or a date, you can use the following parameters.

d

The day of the month. Single-digit days will not have a leading zero.

dd

The day of the month. Single-digit days will have a leading zero.

ddd

The abbreviated name of the day of the week, as defined in AbbreviatedDayNames.

dddd

The full name of the day of the week, as defined in DayNames.

M

The numeric month. Single-digit months will not have a leading zero.

MM

The numeric month. Single-digit months will have a leading zero.

MMM

The abbreviated name of the month, as defined in AbbreviatedMonthNames.

MMMM

The full name of the month, as defined in MonthNames.

y

The year without the century. If the year without the century is less than 10, the year is displayed with no leading zero.

yy

The year without the century. If the year without the century is less than 10, the year is displayed with a leading zero.

yyyy

The year in four digits, including the century.

gg

The period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string.

h

The hour in a 12-hour clock. Single-digit hours will not have a leading zero.

hh

The hour in a 12-hour clock. Single-digit hours will have a leading zero.

H

The hour in a 24-hour clock. Single-digit hours will not have a leading zero.

HH

The hour in a 24-hour clock. Single-digit hours will have a leading zero.

m

The minute. Single-digit minutes will not have a leading zero.

mm

The minute. Single-digit minutes will have a leading zero.

s

The second. Single-digit seconds will not have a leading zero.

ss

The second. Single-digit seconds will have a leading zero.

f

The fraction of a second in single-digit precision. The remaining digits are truncated.

ff

The fraction of a second in double-digit precision. The remaining digits are truncated.

fff

The fraction of a second in three-digit precision. The remaining digits are truncated.

ffff

The fraction of a second in four-digit precision. The remaining digits are truncated.

fffff

The fraction of a second in five-digit precision. The remaining digits are truncated.

ffffff

The fraction of a second in six-digit precision. The remaining digits are truncated.

fffffff

The fraction of a second in seven-digit precision. The remaining digits are truncated.

t

The first character in the AM/PM designator defined in AMDesignator or PMDesignator, if any.

tt

The AM/PM designator defined in AMDesignator or PMDesignator, if any.

z

The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8".

zz

The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08".

zzz

The full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00".

:

The default time separator defined in TimeSeparator.

/

The default date separator defined in DateSeparator.

 

Target Frame

This entry allows you to have a different target for all links displayed in the web part. If you wish to have any item clicked on open a new window you can enter "_blank" or "_new". If you wish to have any link click on open within the current browser window you can enter "_parent" or "_self".

Back to Top

 

Search List Properties

The following properties allow you to connect another list from any other site to this web part. This allows you to use the results stored in one field for searches within the web part, providing your users a list of standard search criteria to select from, instead of a free-form search.

The list can come from a column of any list located anywhere in the system.  As an example, say you have a list of customers located in your Sales Department sites.  In your Customer Service site, you track the calls from customers.  You can configure a roll-up view in Customer Service to include a drop-down list of customers that comes from the Sales Department site.

NOTE: Searches look through all searchable fields in the schema for the identified text or data.  If you only want to look at a specific field for the text or data, a filter should be used, instead.

Site URL

Enter the Site URL of the site that you would like to access a list from. If the list exists within the same site as this web part, no Site URL is required.

List Name

Enter the "Display Name" of the list that you would like to return. The Display Name is the name displayed in the "Documents and Settings" area of SharePoint. It is not the URL name of the list. If you wish to see a list of users from the site you have chosen as a site URL or the current site, you can use the parameter "%USER%".

Field Name

Enter the Field Name of the field that you want to use to populate the search drop-down. The web part will look at all results within the list and return items from that list field, removing any duplicates.

If you identified the "%USER%" parameter in the List Name field above, you can utilize the "email", "loginname", or "username" field. These will allow you to select the email address, login name, or user name of the individuals who have access to the site.

NOTE: Keep in mind that this field is referenced to determine the values displayed in the search drop-down. This is not the name of the field that will be searched when the search is executed; searches look at all searchable fields in the schema.

Back to Top