Advanced Roll-Up (Calendar)

Overview XE "Overview:Calendar Roll-Up" XE "Calendar Roll-Up:Overview"

CorasWorks' Advanced Calendar Roll-Up™ web parts roll up (aggregate) data from across sites to provide you with a consolidated calendar. You can view items for a day, a week, or a month at a time. Calendar roll-ups are the only type of roll-up that show recurring items on all of the date(s) on which that item occurs; other roll-up types simply show the item’s start date. Searching and filtering are both available to decrease the amount of information that is presented by the web part. Calendar roll-ups also support complex filtering to allow for SQL-like queries.

CorasWorks calendar roll-ups support four schemas out of the box, including two for Event lists and two for Task lists. If you have the Developer or Small Business edition of the Workplace Suite (Winter 2005 or later), you can use the Roll-Up Wizard to create calendars for any type of list, library, or gallery that has a date field.

As of the Winter 2005 release, calendar displays include items with past dates. In previous versions, only items with today’s date or a future date were included on calendar roll-ups.

Last Modified: DATE \@ "MMMM yy" October 06

Admin: Sites and Lists Tab XE "Sites and Lists Tab:Calendar Roll-Up"

NOTE: This topic applies only to Summer 2005 and later Calendar Roll-Ups. If you are working with a prior release, please see “Administration Window” instead.

As of the Summer 05 release, the administration interface includes a Sites and Lists tab that is used to select the sites, portals, and/or sub-areas and lists to include in the user presentation of the roll-up. You can select any number of lists or libraries from any number of sites on the server that the web part is running on as the source for the roll-up.

When you are finished making your selections on this tab, make sure you click Apply to save your changes and keep the administration interface open, or click OK to save your changes and return to the roll-up display. Other tabs do not require you to click Apply to save changes; changes are saved automatically when you move from one tab to another. However, this tab differs in that clicking Apply loads your schema selections and other settings referenced by other tabs.

Return Type XE "Return Type:Calendar Roll-Up" XE "Selective Return Type:Calendar Roll-Up" XE "Line of Site Return Type:Calendar Roll-Up"

This field is used to specify how the web part should identify the sites and lists to include in the roll-up display.

· Selective allows you to select each specific list that you want to include.

· Line of Site enables you to identify a URL and the number of levels below that URL to include in the display. Any sites that exist now or are created in the future within the specified number of levels will be automatically recognized and included in the roll-up display. If you choose Line of Site, the page refreshes and the "List Selection Settings" section is removed from the display.

Did you know… With Selective roll-ups, you can reference a list to which your users have read access in a site to which they do not have access. This is because Selective roll-ups hard-code the URL of the site and list, and do not check to see if the user has access to the entire site, as Line of Site roll-ups do.

Site URL XE "Site URL:Calendar Roll-Up"

This optional field is used to define the URL for the site (or the top-level site) you want to access and from which you want to return list items. This can be any SharePoint site that resides on the same server as this web part. If this field is left blank, it will default to the URL where the roll-up web part is placed.

The format for the URL is http://Site-URL/SiteName.

Examples:

· http://www.sitename.com/

· http://www.sitename.com/site1

· http://www.sitename.com/site1/site1a

To include lists from more than one site, type the first URL you want to work with in the Site URL field and then click Add URL. The URL you just identified is placed in the box below the field. Type another URL in the Site URL field and click Add URL again. Repeat this process as many times as necessary.

To remove selected URLs from this area, highlight the URL you want to remove from the box below this field and click Remove. Alternatively, you can click Remove All to remove all URLs.

TIP 1: If the site that contains the lists you want to work with is displayed by the Workplace View Advanced web part, you can right-click on the site, select Copy Shortcut, and paste the URL in the Site URL field.

TIP 2: If you configure a roll-up as Line of Site and a user does not have rights to access a particular site, that site and any sites under that site will not be included in the roll-up. This is true even if the user does have rights to a site that’s below the site to which they do not have access. If you want the roll-up to include the site to which the user does have rights, you can take advantage of the ability to identify multiple URLs in the Site URL field and include the URL of the site to which they do have access.

Schemas XE "Schema Selection:Calendar Roll-Up"

This drop-down field lists all of the available schemas that can be used with this web part. Schemas contain the elements that identify a list: the list type, filter and search fields, display fields, and so on. When you select a schema, the elements of that schema will be used to find only those lists that match that schema profile. Lists of schemas can be found in the Supported Schemas section of this web part help.

NOTE: If you have created your own schemas, you will not be able to select them from the Schemas drop-down for the out-of-the-box CorasWorks Calendar roll-ups. You will need to create your own version of the roll-up web part that references your custom schema using the Roll-Up Wizard, which is available with the Developer and Small Business editions of the Workplace Suite.

Site Levels Searched XE "Site Levels:Calendar Roll-Up"

This optional field is used to define the number of levels to search within a site to find lists for the roll-up display. If this field is left blank, it will default to 0, which searches only the site named in the Site URL field. The maximum recommended number of levels is 10.

Please make sure that a number is entered in this field. If you spell out a number, it will result in an error and no lists will be found.

If you have chosen the Selective return type and you change the value identified in this field, click the “Refresh Available Lists” option to the right of this field. This updates the sites and lists identified in the Available Lists drop-down field, described below.

Available Lists (Selective Only) XE "Available Lists:Calendar Roll-Up"

This drop-down field displays the lists available to be chosen for return by the web part. This includes all available lists, even if they have already been selected and are displayed in the "Currently Selected Lists" field. The format for the lists displayed here is “Site Name | List Name.”

Click on a list to add it to your selection for the web part display. Click "Select All Sites & Lists" to include items from all of the available lists in the web part display.

Currently Selected Lists (Selective Only)

This area displays all of the lists you have selected to include in the roll-up display. The format for the lists displayed in this field is “Site Name | List Name.”

To remove a list, simply highlight the list and it will be removed from the display. Select "Remove All Sites & Lists" to remove all of the lists from the roll-up display.

Admin: Filtering Tab XE "Filtering Tab:Calendar Roll-Up" XE "Filtering:Calendar Roll-Up"

NOTE: This topic applies only to Summer 2005 and later Calendar Roll-Ups. If you are working with a prior release, please see “Web Part Properties” instead.

Filtering allows you to limit the items returned by a roll-up to only those that meet the criteria you define. When a filter is performed, the roll-up looks for text matches on the metadata returned by the roll-up. Users can further refine the results by performing searches on a filtered roll-up. Note that filtering allows you to locate data in a specific field, while searching locates data in any field in the list.

There are two available views on the Filtering tab:

· The default view is referenced as the “Filter Builder.” It provides a series of builder fields that make it easier for non-technical individuals to define filters because it is not necessary to know the correct syntax; the fields prompt you for each necessary piece of information.

· The other view is referenced as “Advanced Filter Settings” and it allows you to manually build a filter. You can use the Basic Filter field to define a filter, or you can use the CAML Filter field to define a filter that utilizes CAML. Click here to jump down to that section of the help.

This topic includes the following subjects:

· Defining a Filter with the Filter Builder

· Manually Defining a Filter

· Tips on Defining Filters

· Conversion to CAML

· Upgrading from Previous Versions

NOTE: To gain the best performance for filters, use the Filter Builder to build your filters; do not use complex, basic, or the feature to automatically convert basic filters to CAML. If a basic filter was used in a previous release and you want to have it permanently converted to CAML, simply open the Filter Builder and click Apply or OK. This converts the basic filter to CAML, loads the filter into the Filter Builder, and then saves the new CAML filter and deletes the old basic filter.

Defining a Filter with the Filter Builder XE "Filter Builder:Calendar Roll-Up"

When you first access the new Filtering tab, the Filter Builder is displayed as shown in the figure above. Each component of the filter is comprised of three fields:

· The first field presents a drop-down list of all of the fields that are available for filtering. Click to select the field you want to start building your filter with.

· The next field is used to select the desired operator for the filter (is equal to, is less than, contains, etc.).

· The third field is used to identify the value you want the filter to find. You can simply type in the value you want to find, or you can use a function (see “Supported Functions” below).

If you only want to filter on a single field and a single value, all you need to do is click OK or move to any other administration tab to save your filter. When your filter is saved, it will be converted to CAML automatically. This is done to help improve performance.

NOTE: Do not enter any CAML code in the Filter Builder. The Builder will automatically convert the criteria to CAML for you. If you have criteria that is too complex to enter in the Filter Builder, use the “Click to manually build a filter” link at the bottom of the tab and define the filter in the CAML Filter field.

The following values can be entered into the third entry field for filters based on Boolean fields:

· True

· False

· Yes

· No

· 0 (translates to False)

· 1 (translates to True)

To filter on multiple fields and/or values, you need to define additional filter components. The Filtering tab presents two groups of criteria that can be used:

· The group of fields on the top half of the tab are used to define the “and” components of the filter. The roll-up will only display items that meet all of the criteria entered here. (For example, Status is equal to In Progress AND Priority is equal to High.)

· The group of fields on the lower half of this tab allow you to define the “or” components of the filter. The roll-up will display items that meet any (one or more) of the criteria entered here. (For example, Status is equal to Not Started OR Status is equal to On Hold.)

To define multiple filter components on either the top or bottom half of the tab, click the “Add More Filter Criteria” link in the appropriate section. This adds another set of three builder fields so you can define additional criteria.

NOTE: The Filter Builder works as expected with one, two, or any even number of clauses. However, it needs help with three, five, or any other odd number of clauses. In these cases, the filter must be balanced. Rather than having an odd number of clauses, you will need to add a “dummy” query to create an even number. The dummy query can be an "is not Null" check and exists only to even out the query to be built by the Filter Builder.

The drop-down field in the middle of the tab (below the line) presents two options, Or and And. If you have defined components on both halves of the tab, select the appropriate option for your needs.

· Select “Or” if you want the filter to locate items that meet the criteria on the top half of the tab or any of the criteria on the lower half

· Select “And” if you want the filter to locate items that meet the criteria on the top half of the tab plus at least one of the criteria on the lower half

NOTE: The Filter Builder cannot be used to build the equivalent of this expression:

(A AND B) OR (C AND D)

If you want to create this type of filter, the filter will need to be defined manually.

Supported Functions XE "Filter Functions:Calendar Roll-Up" XE "Functions (Filter):Calendar Roll-Up"

The Filter Builder supports the functions listed below. The date functions are all relative to the current date, and can only be used if the filter is defined based on a date field.

· [ME] – The currently logged in user

· [Today] – Today's date

· [CurrentWeekStart] – The first day in the current week

· [CurrentWeekEnd] – The last day in the current week

· [CurrentMonthStart] – The first day in the current month

· [CurrentMonthEnd] – The last day in the current month

· [CurrentYearStart] – The first day in the current year

· [CurrentYearEnd] – The last day in the current year

· [Quarter1Start] – The first day in the first quarter of the current year

· [Quarter1End] – The last day in the first quarter of the current year

· [Quarter2Start] – The first day in the second quarter of the current year

· [Quarter2End] – The last day in the second quarter of the current year

· [Quarter3Start] – The first day in the third quarter of the current year

· [Quarter3End] – The last day in the third quarter of the current year

· [Quarter4Start] – The first day in the fourth quarter of the current year

· [Quarter4End] – The last day in the fourth quarter of the current year

· [OneWeekAgoStart] – The first day of the previous week

· [OneWeekAgoEnd] – The last day of the previous week

· [TwoWeeksAgoStart] – The first day of the week before last

· [TwoWeeksAgoEnd] – The last day of the week before last

· [OneWeekFromNowStart] – The first day of next week

· [OneWeekFromNowEnd] – The last day of next week

· [TwoWeeksFromNowStart] – The first day of the week after next

· [TwoWeeksFromNowEnd] – The last day of the week after next

· [OneMonthAgoStart] – The first day of last month

· [OneMonthAgoEnd] – The last day of last month

· [OneMonthFromNowStart] – The first day of next month

· [OneMonthFromNowEnd] – The last day of next month

NOTE: The filter functions [SiteTitle] and [SiteURL] functions are no longer supported.

Sample Filters

To help you see how filters can be set up, a few sample screen captures are provided here.

Example 1

In this example from the Partner Extranet Dashboard, a filter is defined to locate leads that have been created within the past 30 days.

Example 2

This example is taken from the Picture Phone Book solution. It looks for contact items where the last name starts with A, B, C, or D.

Example 3

In this example, a filter is defined to look for all items that are due in the third quarter of this year AND EITHER:

· High priority OR

· Not started

Manually Defining a Filter XE "Manual Filter Definition:Calendar Roll-Up"

To access the fields used to manually build a filter, click the “Click to manually build a filter” link at the bottom of the Filter Builder on the Filtering tab. Two main fields are displayed, one where you can build a basic filter and one where you can build a CAML filter. Another link at the bottom of this view allows you to return to the Filter Builder view.

The format for a basic filter (placed in the Basic Filter field) is "Field=SearchText" (Example: Postal Code=11111). You can use > and < when filtering date fields. (Example: "Date<7" will return items that are older than 7 days from today) 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.

The following values can be used for filters based on Boolean fields:

· True

· False

· Yes

· No

· 0 (translates to False)

· 1 (translates to True)

Some common examples of filters and connectors are shown here:

Example 1: Show all tasks that are assigned to me and are due within seven days
Assigned To=[ME] && Due Date>-1 && Due Date<7

Example 2: Show all tasks that are assigned to me or to someone else
Assigned To=[ME] || Assigned To=UserName

Where:

· && = And

· || = Or

· [ME] = Currently Logged In User

<> (Not) is not supported.

NOTE 1: The majority of the date functions available with the Filter Builder only work with CAML filters. They will not work if you manually build a filter in the Basic Filter field. The date functions that will work with CAML, basic, or complex filters are:

· [Today]

· [CurrentWeekStart]

· [CurrentWeekEnd]

· [CurrentMonthStart]

· [CurrentMonthEnd]

· [CurrentYearStart]

· [CurrentYearEnd]

NOTE 2: If you define a CAML filter on this page, you cannot return to the Filter Builder unless you delete the CAML filter. This is by design.

For more information on filters, visit this site: http://office.microsoft.com/en-us/assistance/HA011611751033.aspx.

Override Filter

If this checkbox is selected and a row or cell connection has been established with another web part, the filter defined above will be overridden if a user selects a field in the connected web part. This can be helpful if you would like to have a defaulted view of information returned based upon of the fields from the other web part, so as to control the amount of information returned on the page.

Allow Complex Filter

Select this checkbox to enable Complex Filters. For more details, see Using Complex Filters.

Tips on Defining Filters XE "Filtering:Tips:Calendar Roll-Up"

These tips apply whether you choose to use the Filter Builder or manually define a filter.

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. Only searchable columns will be listed in the drop-down field in the Filter Builder. To make a column searchable, the Search box must selected when the roll-up is created or modified via the Roll-Up Wizard. By default, all columns that are selected in the Roll-Up Wizard for display are also marked as searchable.

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.

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 is equal to True (using the Filter Builder) OR
column=True (manually defining the filter)
(replace “column” with the name of your column)

· To filter on a non-selected (No) value, the filter would be
column is not equal to True (using the Filter Builder) OR
column<>True (manually defining the filter)

When you use a Choice column with Yes and No options, the filter should be defined as:
column is equal to value (using the Filter Builder) OR
column=value (manually defining the filter)

Balancing Your Filters

The Filter Builder works as expected with one, two, or any even number of clauses. However, it needs help with three, five, or any other odd number of clauses. In these cases, the filter must be balanced. Rather than having an odd number of clauses, you will need to add a “dummy” query to create an even number. The dummy query can be an "is not Null" check and exists only to even out the query to be built by the Filter Builder.

When You DON’T Want to Use the Filter Builder

The Filter Builder cannot be used to build the equivalent of this expression:

(A AND B) OR (C AND D)

If you want to create this type of filter, the filter will need to be defined manually.

Conversion to CAML XE "CAML:Calendar Roll-Up" XE "Filters and CAML:Calendar Roll-Up" XE "Conversion to CAML-Filters:Calendar Roll-Up"

As of the Summer 2005 and later releases, all filters defined via the Filter Builder are automatically converted to Collaborative Application Markup Language (CAML) when they are saved. The Filter Builder only builds CAML filters.

Unlike some of the other roll-up types, with calendar roll-ups, filters that are manually defined in the Basic Filter field are not and cannot be converted to CAML at run-time.

The benefit of CAML is that it applies the filter to list items before they are collected and stored by the web part, thereby improving the web part’s performance. This is particularly beneficial when roll-ups search through a large number of lists to locate data, yet the amount of data returned could be small. It is also useful for more complex filtering.

You do not need to know how to write CAML code; the conversion will be done automatically. However, if you prefer to manually define a CAML filter or if the filter you want to create is too complex for the builder GUI, you can access the Filtering tab on the administration interface and select the “Click to manually build a filter” link. A CAML field will be provided for your entry. Do NOT enter any CAML code in the Filter Builder.

Upgrading from Previous Versions XE "Upgrading from Previous Versions:Calendar Roll-Up" XE "Filtering:Conversion of Existing Filters – Calendar Roll-Up"

Invalid Web Part IDs

NOTE: This topic only applies to customers upgrading from a previous release to Summer 2006.

In the past, there was an issue with Microsoft Front Page and the way it identified web part zones. This issue was resolved in Service Pack 2 (SP2). Prior to the release of SP2 for FrontPage, when new web part zones were created, they were assigned invalid web part zone IDs. So if you created any web part zones or solutions before installing SP2, the zones are invalid.

What does this mean to you? In the case of calendar roll-ups, this means:

· If you have an existing site with a calendar roll-up that is placed in an invalid web part zone, that roll-up will revert to the previous version, rather than automatically updating to the Summer 2006 version.

· If an administrator drags the new calendar roll-up into an invalid web part zone, they will get an error message. The message will notify them that the web part zone ID is invalid and to use FrontPage with SP2 or greater to change the web part zone ID.

By installing Service Pack 2, you ensure that all current and future CorasWorks web parts and SharePoint upgrades will work as expected. If you aren’t sure whether or not you have SP2, open FrontPage and go to Help/About Microsoft FrontPage. At the top of the window, you will see a release number that should be followed by “SP2.” If you do not have SP2 installed, you can select Help/Check for Updates and follow the instructions.

The For Developers online help topic provides further details about this issue, as well as procedures to replace an invalid web part zone.

Conversion of Existing Filters

NOTE: This topic applies to customers upgrading from a previous release to Summer 2005. It does not apply to customers upgrading from Summer 2005 to Winter 2006.

If you defined a filter in a previous version of the Workplace Suite and then upgrade to the Summer 2005 release, the web part will automatically attempt to convert the existing filter to CAML and display it in the Filter Builder; the existing filter will not be displayed in the Basic Filter field.

When you see the filter expressions in the Filter Builder, you may notice that a filter you had defined in a previous release has been converted differently than you expected. This is due to the way filters were processed in previous releases, and these conversions ensure that you see the same results you have always seen. The operators that are converted differently are:

· = (equals) – Converted to “contains”

· Not equal to – Converted to two separate expressions, one with the “not equal to” operator and one with the “is not null” operator, placed on the lower (“or”) section of the Filter Builder

You can change the operators, or any other aspect of the filter, in the Filter Builder if you wish. However, you should be aware that the results may vary from what you are used to seeing.

There are a few exceptions when filters will not be converted to CAML. They are:

· When the basic filter includes an apostrophe (‘)

· When both a basic filter and a CAML filter have been specified

· When a basic filter is entered and the “Convert basic filter to advanced filter at run-time” checkbox has been cleared

· When a complex filter has been defined

· When a CAML filter was manually entered that is too complex for the Filter Builder to display it

In these cases, the Filter Builder will not be displayed. Instead, the Basic Filter and CAML Filter fields for manual entry will be displayed. This error message will be displayed: “The Filter Builder does not support the current filter settings and cannot be displayed.”

If a complex filter was defined and you want to access the Filter Builder, you will need to delete the filter, make sure the Allow Complex Filters checkbox is NOT selected, and click Apply. Once this has been done, you can click the link to access the Filter Builder.

Admin: Search Tab XE "Search Tab:Calendar Roll-Up" XE "Define a Search:Calendar Roll-Up"

NOTE: This topic applies only to Summer 2005 and later Calendar Roll-Ups. If you are working with a prior release, please see “Web Part Properties” instead.

The Search tab on the administration interface contains fields that allow you to:

· Define where to begin the search

· Show or hide the Search box

· Require the user to enter search criteria before results are displayed

· Define a required search, in which you define the criteria for the data to be displayed and remove the user's ability to perform a search

· Configure the Search box to present a drop-down list of criteria to select from, instead of allowing a free-form search

When you are finished making your selections on this tab, click any other administration tab to save your changes and keep the administration interface open, or click OK to save your changes and return to the roll-up display.

Wait for Search XE "Wait for Search:Calendar Roll-Up"

When this feature is enabled, the web part will not return any 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. This option was previously named “Show Nothing At Startup.”

Required Search Criteria XE "Required Search Criteria:Calendar Roll-Up"

(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 this 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.

List URL

The Search box provided in a roll-up display can be configured to present a drop-down list of criteria to select from, instead of allowing a free-form search. The List URL field is used to define the site from which this list of criteria is pulled.

The list can be located anywhere in the system. If the list exists within the same site as this web part, you can leave the Site URL field blank. 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 search box that provides a drop-down list of customers that comes from the Sales Department site.

List Name

This field should state the Display Name of the list that you want to use to populate the set of available search criteria. The Display Name is the name displayed in the "Documents and Settings" area of SharePoint; it is not the URL name of the list.

NOTE: The %user% function is not supported in the administration interface. 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 %user% parameter in the web part properties tool pane.

List Field Name

Enter the 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.

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 identified in the schema. If you are working with a custom schema, the searchable fields are the ones you identified in the “Search” column in the Roll-Up Wizard.

Admin: Color Coding Tab

NOTE: This topic applies only to Summer 2006 and later Calendar Roll-Ups; this feature was not available before Summer 2006.

The properties on the Color Coding tab are used to define categories that color-code the entries in a calendar roll-up for greater visibility. Any items that are not color-coded (do not match a defined filter) will be displayed in the default color.

Color Legend Label

When you color-code the items on a calendar roll-up, a legend is displayed horizontally at the top of the calendar. The Color Legend Label property is used to identify the text that defines the meaning of each color.

Each color (category) is displayed in the legend in the order in which it is identified.

Filter

The Filter property is used to limit the items returned in the category (color). Only the items that meet the criteria identified here will be displayed in the colors selected below.

The format for this field is Field=Search Text

· For example, Event Type=Corporate

Filter grouping with parentheses ( ) is not permitted. These values can be used for filters based on Boolean fields:

· True

· False

NOTE: The filters defined here are not converted to CAML. Only filters defined on the Filtering tab are converted to CAML.

Background Color

The Background Color property is used to select the background color for each item in this category to be displayed. Click Choose Color to the right of the field to select the desired color, or you can enter the color in hex format.

Font Color

The Font Color property is used to identify the text color for each item in this category to be displayed. Click Choose Color to the right of the field to select the desired color, or you can enter the color in hex format.

Remove Color Code

Use this link to remove the settings from the above set of fields.

Add Color Code

Use this link to display an additional set of color-coding fields so another category can be defined.

Admin: Display Tab XE "Display Tab:Calendar Roll-Up" XE "Calendar Display" XE "Calendar Formatting Properties" XE "Formatting:Calendar Roll-Up"

NOTE: This topic applies only to Summer 2005 and later Calendar Roll-Ups. If you are working with a prior release, please see “Web Part Properties” instead.

The fields on this tab are used to define the format for the items displayed by the calendar roll-up.

Time Separator Character

This field is used to define the character used to separate hours and minutes when displaying time within the calendar.

AM Caption

This field is used to define the text used to specify "AM" time.

PM Caption

This field is used to define the text used to specify "PM" time.

Default Calendar Period

(Winter 2006 and later releases only.) This field is used to define the default time period for which the calendar roll-up will be displayed. If nothing is selected from this drop-down, it will default to Month. This property can be set to a different value on your “my page” and a “shared page.”

Time Format

This field is used to define whether the calendar displays time using a 12-hour or a 24-hour format.

Date Format XE "Date Format:Calendar Roll-Up"

This field is used to define the format in which the date is displayed in the calendar's heading. Options are provided to state the day, month, and year in a variety of orders.

First Day of Week

This field is used to define the day of the week that the calendar displays as the first day of the week.

Display Appointment Time

NOTE: This property applies to Summer 2006 and later releases only.

When this property is enabled, the appointment time will be displayed for each item included in the roll-up display. When it is not enabled (not selected), the appointment time will not be displayed.

Item Display Format

This field is used to define the display format of the sites returned by the roll-up. You can use any combination of these three variables, in any order:

· <%Site%> - Site title where list item exists

· <%List%> - List title where lists item exists

· <%ListItem%> - List item "Title" returned

For example, to show the List Title along with the List Item Title, you would type "<%List%> & <%ListItem%>" in this field. If you prefer, you can substitute the "&" with any character or phrase. Alternatively, you could switch the order by placing the "<%ListItem%>" before the "<%List%>".

Admin: Localization Tab XE "Localization Tab:Calendar Roll-Up" XE "Localization:Calendar Roll-Up" XE "Language:Calendar Roll-Up" XE "Translation:Calendar Roll-Up"

NOTE: This topic applies only to Summer 2005 and later Calendar Roll-Ups. If you are working with a prior release, please see “Web Part Properties” instead.

The Localization tab allows you to customize all of the text on the administration interface, including tab and descriptions, field names, drop-down field options, and button labels. Content is grouped by the tab on which it appears.

An additional section on this tab, which is labeled with the web part name, allows you to modify the following:

· Administration interface tab names

· Messages displayed to users (e.g., no items found, web part time out, prompt to execute a search)

· Text used for “View by Day/Week/Month” links

· Text used for “Actions” and “Show Version” options on web part menu

· Text used for options presented when “Actions” is selected from web part menu

To customize any of this information, simply locate the text you want to change and type over it with the desired content.

Use the filter at the top of the tab to easily find content. Just type the content you're looking for and then click Filter.

To reset a value back to its default, delete the value in the text box and apply the changes by clicking OK or another administration tab. The next time the corresponding tab loads, the default value will be displayed.

You may find it helpful to open another browser session and view the results of your customizations as you save your changes.

NOTE 1: A new DisplayXML property replaces the LCIDXML property. For users that have entered LCIDXML in previous roll-ups, the LCIDXML will be upgraded to the new DisplayXML property automatically. The Summer 2005 and later releases do not support manual edits of the DisplayXML. The Localization tab should be used instead.

NOTE 2: The DisplayXML for Summer 2005 and later releases does not support more than one language. If your previous LCIDXML property was set up for multiple languages, the ‘default’ LCID will be used.

Admin: Other Tab XE "Other Tab:Calendar Roll-Up" XE "Performance Features:Calendar Roll-Up" XE "Caching:Calendar Roll-Up" XE "SPS My Site:Calendar Roll-Up"

NOTE: This topic applies only to Summer 2005 and later Calendar Roll-Ups. If you are working with a prior release, please see “Web Part Properties” instead.

Thread Web Part XE "Thread Web Part:Calendar Roll-Up"

When this checkbox is selected, the web part (Web Part A in the example below) is allowed 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

· Web Part A is being used for heavy transactions against SQL server, returning 1000+ Items

· There is a heavy user load on web part A

· You have configured the IIS application pool corresponding to the virtual server to use multiple worker processes (a.k.a. Web Garden)

Enabling this option on Web Part A may not improve the performance of Web Part A. However, this option is designed to allow Web Part A 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” Web Part A is running.

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

If you enable this option and notice that the web part times out, you will 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 which states "<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.

Cache Data After Filter

When this checkbox is selected, the web part will cache the data after a filter operation has been completed. This setting is overridden if a web part connection has been enabled.

Cache Per User

When this checkbox is selected, the roll-up results will be cached per user instead of for all users. The difference is that if your users have the same access to the same data collected by the web part, it may be more prudent to turn this off so the data is stored in memory only once. The opposite holds true if your users have access to different pieces of data; in this case, it would be more effective to enable Cache Per User.

Enable Cache

When this checkbox is selected, caching of the data collected by the web part is enabled. When enabled, all information collected by the web part will be stored in the server’s memory for future use. This can save on performance, as data is not collected each time a hit is completed on the web part. Since the web part executes a double-hit against the page to create the calendar image, it is recommended you activate this property.

Cache Interval (minutes)

This field is used to define an integer to reflect the number of minutes for which information will be cached. The default is 1 minute, but this can be increased or decreased as necessary. The only entry permitted here is a number.

Filter Cell Name (connectability)

This field is utilized when a cell consumer connection has been established between another web part and this one. It identifies the cell that you want to filter on for the results that are collected by this web part. For instance, if you have collected the Date Due field and you want to compare it to the End column from another web part, you would type Date Due in this field. Once that is done, all filters would be performed via the "Date Due" column.

SPS My Site Path

This field allows you to change the default SPS My Site characteristics of the web part. By default, the web part will modify the URL "/mysite" to point to "/personal/User". This allows the web part to search through the MySite section of SharePoint Portal Server. However, SPS allows the administrator to alter the URL definition for each SPS server. To accommodate this, the SPS My Site Path field allows you to alter the web part to support your organization’s SPS MySite setup.

Root Folder for Documents

This field is used to identify the root folder where documents reside within a list. This property is required in order to permit editing and/or linking to an item. Since this list property is language-dependant, the equivalent (URL Dir Name) must be entered if a different language is chosen.

Direct Location of Documents

This field is used to identify the direct location where documents reside within a list. This property is required in order to permit direct linking to an item. Since this list property is language-dependant, the equivalent (Encoded Absolute URL) must be entered if a different language is chosen.

Go Directly to Attachment XE "Attachments:Calendar Roll-Up" XE "Go Directly to Attachment:Calendar Roll-Up"

When this checkbox is selected and an item in a document library is returned by the web part, the item link will go directly to the document returned. When the checkbox is left blank, the item link will take the user directly to the edit page for the item. This property only functions for document library types.

Administration Window (Pre-Summer 2005 only) XE "Administration Window:Calendar Roll-Up"

NOTE: This topic applies only to versions of Calendar Roll-Ups from before the Summer 2005 release. If you are working with the Summer 2005 or a later release, please see “Admin: Sites and Lists Tab” instead.

The Administration View of a roll-up web part is displayed when you first drag and drop the web part onto a page. It can also be accessed via the Actions menu. This view is used to select the sites, portals, and/or sub-areas and lists to include in the user presentation of the roll-up. You can select any number of lists or libraries from any number of sites on the server that the web part is running on as the source for the roll-up.

Return Type XE "Return Type:Calendar Roll-Up" XE "Selective Return Type:Calendar Roll-Up" XE "Line of Site Return Type:Calendar Roll-Up"

This field is used to specify how the web part should identify the sites and lists to include in the roll-up display.

· Selective allows you to select each specific list that you want to include. If you choose Selective, the "Available Lists" and "Current Lists" fields will be activated.

· Line of Site enables you to identify a URL and the number of levels below that URL to include in the display. Any sites that exist now or are created in the future within the specified number of levels will be automatically recognized and included in the roll-up display. If you choose Line of Site, the "Available Lists" and "Current Lists" fields are not used. Make sure you click the "Save Selection" button to save the settings entered in the "Site URL" and "Levels Searched" fields.

Site URL XE "Site URL:Calendar Roll-Up"

The format for the URL is http://Site-URL/SiteName.

Example:

· http://www.sitename.com/

· http://www.sitename.com/site1

· http://www.sitename.com/site1/site1a

To include lists from more than one site at a time, you can place a semicolon (;) between the URLs you want to access. Make sure there is no space between the first URL, the semicolon, and the second URL.

Example:
http://www.sitename.com;http://www.othersitename.com/site
This applies to both Selective and Line of Site return types.

TIP: If the site that contains the lists you want to work with is displayed in the Workplace View Advanced, you can right-click on the site, select Copy Shortcut, and paste the URL in the Site URL field.

Levels Searched XE "Levels Searched:Calendar Roll-Up"

This optional field is used to define the number of levels to search within a site to find lists for the roll-up display. If this field is left blank, it will default to 0, which searches only the site named in the “Site URL” field. The maximum recommended number of levels is 10.

Please make sure that a number is entered in this field. If you spell out a number, it will result in an error and no lists will be found.

Schema(s)

If you have created your own schemas, you will not be able to select them from the Schemas drop-down for the out-of-the-box CorasWorks Calendar roll-ups. You will need to create your own version of the roll-up web part that references your custom schema using the Roll-Up Wizard, which is available with the Developer and Small Business editions of the Workplace Suite.

Return Sites & Lists (Selective Only)

This button will execute a search of the chosen site structure and then display the sites and lists that match your criteria in the "Available Lists" drop-down field.

Save Selection (Line of Site Only)

This button will save your web part settings for the Line of Site return type. You must click this button if a change has been made to the selections in the “Site URL”, “Levels Chosen”, or “Schema” fields.

Available List(s) (Selective Only) XE "Available Lists:Calendar Roll-Up"

This area displays the lists available to be chosen for return by the web part. This includes all available lists, even if they have already been selected and are displayed in the "Current List(s)" field. The format for the lists displayed in this field is “Site Name | List Name.”

Select a list to add it to the web part display. Select "Add All Sites & Lists" to include all of the lists returned in the web part display.

Current List(s) (Selective Only) XE "Current Lists:Calendar Roll-Up"

This area displays all of the lists you have selected to include in the roll-up display. The format for the lists displayed in this field is “Site Name | List Name.”

To remove a list, simply highlight the list and it will be removed from the display. Select "Remove All Sites & Lists" to remove all of the lists from the roll-up display.

Close Administration

This button closes the administration view and returns you to the web part’s data view.

Web Part Properties (Pre-Summer 2005 only) XE "Web Part Properties:Calendar Roll-Up"

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

Cache Properties XE "Performance Features:Calendar Roll-Up" XE "Caching:Calendar Roll-Up" (Shared View Administration Only)

Enable Cache

This toggle allows you to activate or deactivate caching of the data collected by the web part. If this is enabled, all information collected by the web part will be stored in the memory of the server for future use. This can save on performance, as you will not be collecting the data each time a hit is completed on the web part. Since the web part executes a double-hit against the page to create the calendar image, it is recommended you activate this property.

Cache Interval

This text box is used to define an integer to reflect the number of minutes for which information will be cached. The default is 1 minute, but this can be increased or decreased as necessary. The only entry permitted here is a number.

Cache Per User

This toggle is used to indicate whether you want to cache the results returned per user or for all users. The difference here is that if your users have the same access to the same data collected by the web part, it may be more prudent to turn this off so the data is stored in memory only once. The opposite holds true if your users have access to different pieces of data; in this case, it would be more effective to enable Cache Per User.

Cache Data After Filter

This toggle allows the web part to cache the data after a filter operation has been completed. This is overridden if a web part connection has been enabled.

Connectable Properties XE "Connectability:Calendar Roll-Up"

Cell Field Name

This text box is utilized when a cell consumer connection has been established between another web part and this one. You must enter the cell that you would like to filter on for the results that are collected by this web part. For instance, if you have collected the Date Due field and you want to compare it to the End column from another web part, you would type Date Due in this field. Once that was done, all filters would be performed via the "Date Due" column.

Click here for more information about connectability.

Administration Properties XE "Administration Properties:Calendar Roll-Up"

Enable Multi-Threading XE "Performance Features:Multi-Threading-Calendar Roll-Up"

This performance enhancement feature allows the web part (web part A 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

· Web part A 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 (a.k.a. 'Web Garden')

Enabling this option on web part A may not improve the performance of web part A. However, this option is designed to allow web part A 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” web part A 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 Roll-Up Administration (Version 3.25 only)

This selectable choice shows the web part’s administration view, 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.

Calendar Formatting Properties XE "Calendar Formatting Properties" XE "Formatting:Calendar Roll-Up"

Calendar List Item Return Format (Required)

This allows the items returned within the calendar to be formatted to contain information that may be pertinent. The format of this return allows for three variables:

· <%Site%> - Site title where list item exists

· <%List%> - List title where lists item exists

· <%ListItem%> - List item "Title" returned

You can format the return in any way, provided that the variables entered are correct. An example would be to return the List Title along with the List Item Title. This can be done by placing "<%List%> & <%ListItem%>" within the text box, where "&" can be substituted for any character or phrase, or it can remain an ampersand. You can also switch the order by placing the "<%ListItem%>" before the "<%List%>".

Time Separator Character

Here you can specify the character used to separate hours and minutes when displaying time within the calendar.

Time Format

Enter either “0” or “-1” to specify whether the calendar displays time using a 12-hour or a 24-hour format.

· 0 = 12 hour

· -1 = 24 hour

Date Order

Enter “0”, “1”, or “2” to specify the format in which the date is displayed in the calendar's heading.

· 0 = Month/Day/Year

· 1 = Day/Month/Year

· 2 = Year/Month/Day

First Day of Week

Enter “0” through “6” to specify the day of the week that the calendar displays as the first day of the week.

· 0 = Monday

· 1 = Tuesday

· 2 = Wednesday

· 3 = Thursday

· 4 = Friday

· 5 = Saturday

· 6 = Sunday

AM Caption

The text used to specify "AM" time.

PM Caption

The text used to specify "PM" time.

Return Properties XE "Return Properties:Calendar Roll-Up"

Show Nothing At Startup XE "Performance Features:Show Nothing At Startup - Calendar Roll-Up" XE "Show Nothing at Startup:Calendar Roll-Up"

This performance enhancement toggle allows the calendar to display no results until the user completes a search. This can save much-needed performance when accessing multiple lists and/or sites. With some configuration, this can also allow you to have more than one roll-up on a page without harming performance. In that case, each roll-up would point to a different list with a different schema and utilize 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.

Allow Complex Filters XE "Complex Filters:Allowed in a Calendar Roll-Up " XE "Allow Complex Filters:Calendar Roll-Up"

When this is checked, Complex Filters are enabled. For details, see Using Complex Filters.

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 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.

A noticeable difference between this filter and older CorasWorks filters is that this is designed to use only a complex filter. Old Filters (field=text) are no longer permitted and now use the new complex filter format. For details regarding how to create a complex filter, see Complex Filters.

Because standard complex filters cannot handle the Date Add function, CorasWorks has built in an add function that can be used within the filter. The format for the add function is ":add:date(optional):#:add:" If you do not wish to place a date within the :add: function, the format would alter and look like ":add:#:add:". The # signifies a number and can be a positive or negative integer.

Examples:

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

Use:
[Assigned To]='[ME]' AND [Due Date]>#:add:-1:add:# AND [Due Date]<#:add:today:7:add:#

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

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

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

Use:
Not [Assigned To]='[ME]'

Where...

[ME] = Currently Logged In User
[TODAY] = Today's Date
:add:7:add: = Add To Today's Date 7 Days
:add:1/1/2002:7:add: = Add 7 Days to 1/1/2002 (1/8/2002)

The following filter helpers are made available for use by 4.0 Complex Filters. These are not recommended for use here, but are available if you wish.

[Today] = Today's Date
[CurrentYearStart] = Current Years First Day Date
[CurrentYearEnd] = Current Years Last Day Date
[CurrentWeekStart] = Current Weeks First Day Date
[CurrentWeekEnd] = Current Weeks Last Day Date
[CurrentMonthStart] = Current Months First Day Date
[CurrentMonthEnd] = Current Months Last Day Date

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 =

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.

· 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”.

Override Filter

If a row or cell connection has been established with another web part, you can set up the filter above to be overridden if someone chooses a field in the connected web part. This can be helpful if you would like to have a defaulted view of information returned based upon of the fields from the other web part, so as to control the amount of information returned on the page.

Search List Properties XE "Search List Properties:Calendar Roll-Up"

The following properties allow you to connect another list from any other site and list 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.

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.

Actions Menu XE "Actions Menu:Calendar Roll-Up"

The Actions menu allows both administrators and users to execute common actions in lieu of utilizing search commands. The Show Version action is available to all users on the system.

To use the Actions menu and view version information, go to the web part and drop down the web part menu options by clicking on the down arrow on the top right hand side of the web part. Drag your mouse over "Actions" and then choose the desired option.

Show Admin XE "Administration View:Calendar Roll-Up"

If you are working with the Summer 2005 or a later release, this option causes the administration interface to be displayed. If you are working with a prior release, this option causes the web part’s administration window to be displayed. In either case, the resulting display allows administrators to determine the lists and schemas utilized by the web part. This option is only available to administrators.

Show Version XE "Version:Calendar Roll-Up" XE "Show Version:Calendar Roll-Up"

This selection will show version information within the web part area, including application, version, organization, authors, and build date. The link to Close Version Window returns the page back to it original state.

NOTE: Because all CorasWorks web parts utilize this command for version viewing, every CorasWorks web part on the page will respond to the Show Version action. This will allow you to view version information for all CorasWorks web parts at once.

Search Commands XE "Search Commands:Calendar Roll-Up" XE "Shortcuts:Calendar Roll-Up"

CorasWorks has built in a few commands so that certain actions can be activated directly from the Search textbox in the web part, bypassing the need to access the web part properties. These commands can be activated by typing the desired phrase and clicking on the Search button.

:admin:

This will display the administration interface (Summer 05 and later releases) or the administration window (previous releases) within the web part area, allowing the administrator to define the sites and lists returned to the web part. This option is only available to site collection and/or site/web administrators and in shared view.

:refresh: XE "Caching:Refresh - Calendar Roll-Up"

This will refresh the current cache if caching is enabled. If Cache Per User is chosen, this will only refresh the cache for the user activating this command. If the opposite is true, the cache will be reset for all users.

:version:

This will show the version window within the web part area to the current user, allowing them to view the application, version, organization, authors, and build date of the web part. The Close Version Window link returns the page back to its original state. No other users will see the version information; the version information is actually displayed on a separate page with “?version=coras” at the end of the URL.

NOTE: Because all CorasWorks web parts utilize this as a means for viewing the version, all CorasWorks web parts on the page will respond when this action is selected. This allows you to identify all web parts created by CorasWorks, with the corresponding information.

[Me] XE "Search for \"My\" Records:[ME] – Calendar Roll-Up"

This will search throughout all the returned lists for items with the login name of the individual executing the search. This command does not function for anonymous users.

Using Complex Filters XE "Complex Filters:Used in a Calendar Roll-Up"

Advanced calendar roll-ups support complex filtering, which allows for SQL-like information queries. They can be comprised of any number of fields and values. For example, you can build a filter that looks for records that are not started, due within seven days, and have a high priority.

Operators XE "Complex Filters:Operators - Calendar Roll-Up"

When defining complex filters, concatenation is allowed using Boolean AND, OR, and NOT operators. You can use parentheses to group clauses and force precedence. The AND operator has precedence over other operators. For example:
(LastName = 'Smith' OR LastName = 'Jones') AND FirstName = 'John'

The following operators are allowed when creating comparison complex filters:

· <

· >

· <=

· >=

· <>

· =

· IN

· LIKE

The following arithmetic operators are also supported in complex filters:

· + (addition)

· - (subtraction)

· * (multiplication)

· / (division)

· % (modulus)

String Operators XE "Complex Filters:String Operators - Calendar Roll-Up"

Use the + character to concatenate a string. Whether string comparisons are case-sensitive or not is determined by the value of the DataSet class's CaseSensitive property. However, you can override that value with the DataTable class's CaseSensitive property.

Wildcard Characters XE "Complex Filters:Wildcard Characters - Calendar Roll-Up" XE "Wildcard Characters:Calendar Roll-Up"

Both the * and % characters can be used interchangeably as wildcards in a LIKE comparison. If the string in a LIKE clause contains a * or %, those characters should be escaped in brackets ([]). If a bracket is in the clause, the bracket characters should be escaped in brackets (for example [[] or []]). A wildcard is allowed at the beginning of a pattern, at the end of a pattern, or both. For example:

· ItemName LIKE '*product*'

· ItemName LIKE '*product'

· ItemName LIKE 'product*'

Wildcards are not allowed in the middle of a string. For example, 'te*xt' is not allowed.

Aggregates

The following aggregate types are supported:

· Sum (Sum)

· Avg (Average)

· Min (Minimum)

· Max (Maximum)

· Count (Count)

· StDev (Statistical standard deviation)

· Var (Statistical variance).

Column Names

When creating a complex filter, use the Column Name to refer to columns. For example, if the Column Name for one column is "UnitPrice" and another is "Quantity", the complex filter would be: UnitPrice * Quantity

Also, enclose strings with single quotes: LastName = 'Jones'

The following characters are special characters and must be escaped (wrapped in brackets) if they are used in a column name, as explained below.

\n (newline)	+
\t (tab)	-
\r (carriage return)	*
~	%
(	&
)	\|
#	^
\	'
/	"
=	[
>	]
<

If a column name contains one of the above characters, the name must be wrapped in brackets. For example, to use a column named Column# in a complex filter, you would reference the column as shown here:
Total * [Column#]

Because brackets are special characters, you must use a slash (\) to escape the bracket if it is part of a column name. For example, a column named Column[] would be written:
Total * [Column[\]] (Only the second bracket must be escaped.)

The same holds true if a column name contains a space. For example, to use a column named First Name in a complex filter, you would type the column name as shown here:
[First Name]='John'

User-Defined Values

User-defined values may be used within complex filters and compared against column values. String values should be enclosed within single quotes. Date values should be enclosed within pound signs (#). Decimals and scientific notations are permissible for numeric values. For example:

· FirstName = 'John'

· Price <= 50.00

· Birthdate < #1/31/82#

For columns that contain enumeration values, cast the value to an integer data type. For example:
EnumColumn = 5

Null Identifiers

If a column does not contain data, the use of a column='' is not permissible and will not return the results that you are looking for. Since the column row is empty, it will not respond with a String result, but rather a NULL response. Because of this, you need to use the "IS NULL" or "IS NOT NULL" request to see if a column contains or does not contain any data. For example:

· [First Name] IS NULL

· [First Name] IS NOT NULL

Connectability XE "Connectability:Calendar Roll-Up"

NOTE: In order for web part connections to function, Allow Complex Filter must be enabled (see Admin: Filtering Tab).

Connectability is a standard protocol that is supported within a SharePoint environment. CorasWorks navigation and roll-up components can utilize the connectability interface so CorasWorks web parts can “talk” to one another and one web part can receive information from another web part. This information can be used to alter the data displayed within the current web part.

You can only activate a connection when the page is in Design mode. Once in Design mode, access the web part menu and select Connections. Then specify the type of connection you want and the web part you want to connect to.

The three currently supported types of connections are List Consumer, Row Consumer, and Cell Consumer.

List Consumer XE "List Consumer:Calendar Roll-Up" XE "Connectability:List Consumer - Calendar Roll-Up"

This type of connection allows you to “consume” a list of URLS from the Workplace View Advanced 3.5 (WVA) or the SPS Workplace View Advanced 3.5 (SPS WVA). This allows you to set up your site information within one web part and have its setting reflect within this web part. This type of connection does not accept information from any other web part.

For example, imagine that there are multiple roll-up views on a page. All of these roll-ups can be connected to the WVA. When you change the sites and lists in the WVA, the roll-ups will update to show the information selected. This reduces the time to reconfigure individual web parts and ensures that they all have the correct configuration.

Row Consumer XE "Row Consumer: Calendar Roll-Up " XE "Connectability:Row Consumer - Calendar Roll-Up "

This type of connection allows you to consume a row of information from within another web part. The connection filters against each column displayed in the other web part.

The Row Filter performs a filter on the titles of the rows collected form the other web part. This means that if the other web part display includes Title and Due Date, your current list to be collected must also contain the same row titles in order for the filter to function.

Row consumer connections that include fields with calculated values are not supported.

Cell Consumer XE "Cell Consumer: Calendar Roll-Up" XE "Connectability:Cell Consumer - Calendar Roll-Up"

This type of connection allows you to consume a specific cell from within another web part. After a connection has been established, you will be asked what cell you would like to read from the other web part. After you have chosen a specific field (cell), the title of the column from the other web part will be used to filter against by default. If you want to filter on a different cell within your returned data, you can specify this within the Connectable Properties section of the web part properties.

Cell consumer connections that include calculated values are not supported.

As an example, imagine that you want to provide a salesperson with information about a customer. You may want to create a page that has contact information about the customer, order information, call history, and support calls. Using connectability, you can connect the web parts so that when you select a customer, the other views for orders, call history, and support calls will automatically update to display that customer’s information.

Because CorasWorks roll-ups can show information from any sites or portal sub-areas, the data, such as the call history list or the support calls, can be stored in different sites, such as departmental sites. With connectability, you can simply select a customer and all of the information for that customer is displayed. This type of scenario would also apply, for instance, in situations where you want to see information about projects which are stored in sites for different departments. The key is that each list has to have a field with the exact same name and the same data type, such as Customer ID or Project ID.

Modifiable DWP Properties XE "DWP Properties: Calendar Roll-Up"

CorasWorks web parts have a number of properties that can only be modified by manually editing the DWP file associated with this web part. You can edit a DWP file by exporting the web part to a location of your choice, making the desired changes, and then uploading it back onto your site.

The properties described here allow you to change the function and display of the web part. Please keep in mind the XML namespace of the web part you are changing, or these properties will not be enabled within the web part. XML namespaces for all CorasWorks web parts are provided in the 0For DevelopersHelp_D2HPrivate(-9,656)Overview0 help topic.

Also note that some of these properties some may require the use of a "<", ">", or "&" symbol. If that is the case, you will need to replace these characters with their encoded equivalents of "<", ">", and "&" respectively.

These properties are only viewable in the DWP if the default settings have been changed.

NOTE: As of the Summer 05 release of the Workplace Suite, a Localization tab on the administration interface allows you to make many of the localization changes described below. Before you make these changes in the DWP, you may want to review the available settings that can be modified on the Localization tab.

AllowComplexFilters (Boolean)

This property is used to enable complex filters.

AM Caption

This property is used to define the text used to specify "AM" time.

PM Caption

This is the text used to specify "PM" time.

CacheInterval (String)

This property allows you to identify the number of minutes for which information will be cached. By default is set to 1 minute but this can be increased or decreased as necessary. The only entry permitted here is a number.

CachePerUser (Boolean)

This property is used to indicate whether you want to cache the results returned per user or for all users. The difference here is that if your users have the same access to the same data collected by the web part, it may be more prudent to turn this off so the data is stored in memory only once. The opposite holds true if your users have access to different pieces of data, which would require that Cache Per User be enabled.

CacheDataAfterFilter (Boolean)

This property allows the web part to cache the data after a filter operation has been completed. This property is ignored if a web part connection has been enabled.

CAML (String)

This performance enhancement feature allows you to have a pre-collection CAML query execute against lists accessed by this web part. This can greatly improve performance of this web part as information will not be collected that is not pertinent to the view attempting to be achieved. For more information about CAML queries, please see: Collaborative Application Markup Language. It is important to note that since CAML by its nature is XML and a DWP is XML you must encode the CAML query replacing < with a <, > with a >, & with a &, and " with a ". If you do not do this then the DWP will error and web part will not function.

Use: <CAML xmlns="webpart_namespace">CAML Query</CAML>

Example: <CAML xmlns="CorasWSC.My.Task.RollUp"><Where><Neq><FieldRef Name='Status'/><Value Type='Text'>Completed</Value></Neq></Where></CAML>

CellFieldName (String)

This property is utilized when a cell consumer connection has been established between another web part and this one. It is used to identify the cell that you want to filter on for the results collected by this web part.

For instance, if I have collected the Date Due field and I want to compare it to the End column from another web part, I would identify "Date Due" here and all filters would be done via the "Date Due" column.

Date Order

This property determines the order which the Days, Weeks, and Months options are displayed in the calendar's heading.

· 0 = Month/Day/Year

· 1 = Day/Month/Year

· 2 = Year/Month/Day

EnableCache (Boolean)

This property allows you to activate or deactivate caching of the data collected by the web part. If it is enabled, all information collected by the web part will be stored in the memory of the server for future use. This can save on performance, as you will not be collecting the data each time a hit is completed on the web part. Since the web part will execute a double-hit against the page to create the image, this is a recommended property to be activated.

Filter (String)

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'). Alternatively, you can use > and < when filtering date fields. (Example: "Date<7" will return items that are older than 7 days from today) 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.

Examples:

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

Use:
[Assigned To]='[ME]' AND [Due Date]>#:add:-1:add:# AND [Due Date]<#:add:today:7:add:#

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

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

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

Use:
Not [Assigned To]='[ME]'

Where...

[ME] = Currently Logged In User
[TODAY] = Today's Date
:add:7:add: = Add To Today's Date 7 Days
:add:1/1/2002:7:add: = Add 7 Days to 1/1/2002 (1/8/2002)

The following filter helpers are made available for use by 4.0 Complex Filters. These are not recommended for use here, but are available if you wish.

[Today] = Today's Date
[CurrentYearStart] = Current Year’s First Day Date
[CurrentYearEnd] = Current Year’s Last Day Date
[CurrentWeekStart] = Current Week’s First Day Date
[CurrentWeekEnd] = Current Week’s Last Day Date
[CurrentMonthStart] = Current Month’s First Day Date
[CurrentMonthEnd] = Current Month’s Last Day Date

First Day of Week

Determines the day that the calendar displays as the first day of the week.

· 0 = Monday

· 1 = Tuesday

· 2 = Wednesday

· 3 = Thursday

· 4 = Friday

· 5 = Saturday

· 6 = Sunday

LevelCount (String)

Enter the amount of levels to be searched to return the list items displayed by the web part. Do not spell out the number, or you will receive an error and no lists will be found.

ListFieldNameMapping (String)

This property allows the web part to map list field names to the corresponding calendar field names. For example, an Event list uses Begin as the name of the field that events are scheduled to begin on. However, for a German language site, the Begin field is named Beginn. It is also possible to create a custom field and name it Start. The List Field Name Mapping property is used in order for the Calendar Roll-Up web part to map the different names to the calendar’s Begin field.

The following fields can be mapped to a corresponding Calendar field.

· BeginDate (DateTime)

· EndDate (DateTime)

· Title (string)

If the list is an Events list type, the following fields can be mapped, in addition to the fields above, to allow for recurring events to be displayed properly:

· Recurrence (boolean)

· RecurrenceData (string)

· MasterSeriesItemID (integer)

In order for the field mapping to function properly, the field being mapped from must contain the same data type as the field being mapped to.

The XML below displays a sample of how to use the List Field Name Mapping XML. Each ID attribute has the SharePoint Web’s LCID listed as an attribute. The CorasWorks node supports multiple CalendarRollUpAdvanced nodes, allowing for the same web part to be used on multiple sites. When the web part loads, the language of the site that the web part is hosted in will automatically be used, provided an ID attribute for the site’s CalendarRollUpAdvanced node has been defined. Otherwise, the CalendarRollUpAdvanced node with an attribute of "default" will be used.

Events List XML Example:

<? xml version="1.0" ?>
<CorasWorks>
<CalendarRollUpAdvanced id="default">
<BeginDate>Begin</BeginDate>
<EndDate>End</EndDate>
<Title>Title</Title>
<Recurrence>Recurrence</Recurrence>
<RecurrenceData>RecurrenceData</RecurrenceData>
<MasterSeriesItemID>MasterSeriesItemID</MasterSeriesItemID>
</CalendarRollUpAdvanced>
</CorasWorks>

Tasks List XML Example:

<xml version="1.0">
<CorasWorks>
<CalendarRollUpAdvanced id="default">
<BeginDate>Start Date</BeginDate>
<EndDate>Due Date</EndDate>
<Title>Title</Title>
</CorasWorks>

NOTE: For clarity, the XML above has been displayed using standard XML characters. However, the XML characters must be encoded to their HTML equivalent characters.

The following list shows the ID attributes you can use for each CalendarRollUpAdvanced node.

LCID Language

1025 Arabic
2052 Chinese - Simplified
1028 Chinese - Traditional
1029 Czech
1030 Danish
1043 Dutch
1033 English
1035 Finnish
1036 French
1031 German
1032 Greek
1037 Hebrew
1038 Hungarian
1040 Italian
1041 Japanese
1042 Korean
1044 Norwegian
1045 Polish
2070 Portuguese
1046 Portuguese – Brazilian
1049 Russian
1034 Spanish
1053 Swedish
1054 Thai
1055 Turkish

Use:
<ListFieldNameMapping xmlns='webpart_namespace'> List Field Name Mapping XML</ListFieldNameMapping>

ListNames (String)

The lists available to be chosen for return by the web part.

ListTemplates (String)

This is the list of the WSS List types the Roll-Up Wizard works with.

ListType (String)

This property allows you to alter the generic schema used by the web part. Currently, events and tasks are supported. Once this is changed, the generic schema that is stored in the DLL will be reset to utilize this property

Use:
<ListType xmlns='webpart_namespace'>List Type</ListType>

Example:
<ListType xmlns='CorasWSC.Chart.Display'>Tasks</ListType>

ListView (String)

This property allows the Calendar return to contain information that may be pertinent. The format of this return allows for three variables:

· <%Site%> - Site title where list item exists

· <%List%> - List title where lists item exists

· <%ListItem%> - List item "Title" returned

The format can be returned in any way, provided that the variables entered are correct.

MySite (String)

This property will allow you to change the default MySite characteristics of the Web Part. Currently the Web Part will modify the URL "/mysite" to point to "/personal/User". This allows the web part to search through the MySite section of SharePoint Portal Server. SPS allows the Administrator to alter the URL definition for each SPS server. Because of this, the DWP Property "MySite" was designed to allow the Administrator to alter the web part in order to support their SPS MySite setup.
Use:<MySite xmlns="webpart_namespace">/sites/<%Domain%> AND/OR <%User%></MySite>
Example: <MySite xmlns="CorasWSC.Document.RollUp">/personal/<%User%></MySite>
Settings: <%User%> = User Name, <%Domain%> = Domain Name

OverrideFilter (Boolean)

If a row or cell connection has been established with another web part, you can set up the filter above to be overridden if someone chooses a field in the connected web part. This is good if you want to have a defaulted view of information returned based upon of the fields from the other web part so as to control the amount of information returned on the page.

PM Caption

This property is used to define the text used to specify "PM" time.

ReqSearchString (Boolean)

Users are permitted to search for specific phrases to return only the information that pertains to them. However, administrators can deactivate this feature by using this property to define a valid search phrase. 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 this property is utilized, the Search function will be deactivated for general users.

ReturnType (String)

This property allows you to specify the function of the web part when searching through lists. "Selective" allows you to select the specific lists that you want to have returned within the web part. When "Selective" is chosen, the "Available Lists" and "Current Lists" select boxes will be activated. "Line of Site" enables the web part to automatically access lists within the site URL and levels chosen. Once "Line of Site" is chosen the "Available Lists" and "Current Lists" fields are deactivated or removed from the display, depending on your version of the Workplace Suite.

SchemaUsed (String)

This property identifies the schemas used to determine the list type, search fields, display fields, and so on. If you select a schema, the elements of that schema will be used to only find those lists that match the schema profile chosen. The configuration of each schema can be found in the “Supported Schemas” section of this help.

SearchListFieldName (String)

SearchListListName (String)

This property is used to define the "Display Name" of the list you want 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.

SearchListSiteURL (String)

This property is used to define the URL for the site (or the top-level site) you want to access and from which you want to return list items. This can be any SharePoint site that resides on the same server as this web part. If the list exists within the same site as the web part, you do not need to define a URL.

ShowAdmin (Boolean) (version 3.25 only)

This property is used to show the administration window to the administrator, allowing them to manage the sites and lists returned to the web part. This view is only available to administrators of the site or web, or it can be accessed within in a Shared View.

SiteURL (String)

Enter the URL(s) for the site(s) you want to access and return lists from. This can be any SharePoint site that resides within the Global Configuration Database where this web part resides. Format for the URL must be "http://Site-URL/SiteName". (Examples; "http://www.sitename.com/", "http://www.sitename.com/site1", "http://www.sitename.com/site1/site1a", or "http://www.sitename.com/site 1"). You can also enter multiple URLs separated by a semicolon to access more than one site at a time. There should be no spaces between the URLs and the semicolon. This applies to both "Selective" and "Line of Site."

ThreadWebPart (Boolean)

This property is used to reset the web part to thread its execution against SharePoint. Enabling this is useful under the following four conditions:

1. Have a multi-processor box

2. Are using this web part for heavy transactions against SQL server. Returning +1000 Items

3. Heavy User Load on this one web part

4. Multiple Worker Processes

Enabling this choice will better regulate the transactions being processed on your server, improving the overall performance. While the effect of this may not alter the performance of this one web part, the server itself will react much better for other pages. If you are on a multi-processor or multi-worker process server, this can also help with improving performance of the web part as the threads are better shared by each process.

If you enable this feature, you may be required to update the web.config for the virtual server hosting the site where this web part is being used. The web.config has a line which states "<WebPartWorkItem Timeout="7000" />". This relates to 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 longer, you must change this to the value you require. (Example: 60 Seconds = 60000).

Time Separator Character

The character used to separate hours and minutes when displaying time within the calendar.

Time Format

This property is used to identify whether the calendar will display time using a 12-hour or a 24-hour format.

· 0 = 12 hour

· -1 = 24 hour

WaitForSearch (Boolean)

When this property is enabled, the web part will not return any 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.

UseLike (Boolean)

This property is used after a cell consumer connection has been established to define whether the filter used will do so with a LIKE phrase or a direct "=" phrase. The default is LIKE, so those lists which contain choice or lookup fields will be relatively searched within.

Use:
<UseLike xmlns='webpart_namespace'>true/false</UseLike>

Example:
<UseLike xmlns='CorasWSC.Chart.Display'>true</UseLike>

Modifiable DWP Properties for Document Libraries XE "DWP Properties:Document Libraries - Calendar Roll-Up "

CorasWorks web parts have a number of properties that can only be modified by manually editing the DWP file associated with this web part. The property described here applies specifically to document libraries. You can edit a DWP file by exporting the web part to a location of your choice, making the desired changes, and then uploading it back onto your site.

The properties described here allow you to change the function and display of the web part. Please keep in mind the XML namespace of the web part you are changing, or these properties will not be enabled within the web part. XML namespaces for all CorasWorks web parts are provided in the 1For DevelopersHelp_D2HPrivate(-9,656)Overview1 help topic c.

This property is only viewable in the DWP if the default settings have been changed.

GoDirectlyToItem (Boolean)

This property allows an administrator to specify whether or not an item in a document library returned by the web part should be linked to the editform.aspx, or go directly to the document itself.

If you set this property to true, the item link will go directly to the document returned. If you set this property to false, the item link will take the user directly to the edit page for the item. This property only functions for document library types.

Use:
<GoDirectlyToItem xmlns="webpart_namespace">true/false</GoDirectlyToItem>

Example:
<GoDirectlyToItem xmlns= "CorasWSC.My.Document.RollUp">true</GoDirectlyToItem>

Modifiable DWP Properties for Localization XE "Localization via DWP: Calendar Roll-Up " XE "DWP Properties:Localization - Calendar Roll-Up " XE "Translation:Calendar Roll-Up" XE "Language:Calendar Roll-Up"

NOTE: This topic only applies to releases of the Workplace Suite prior to the Summer 2005 release. As of the Summer 2005 release, the Localization tab on the administration interface allows you to make all of the localization changes described below. As a result, the Summer 2005 and later releases do not support manual modification of DWP properties for localization.

CorasWorks web parts have a number of properties that can only be modified by manually editing the DWP file associated with this web part. The properties described here relate specifically to localization. You can edit a DWP file by exporting the web part to a location of your choice, making the desired changes, and then uploading it back onto your site.

The properties described here allow you to change the function and display of the web part. Please keep in mind the XML namespace of the web part you are changing, or these properties will not be enabled within the web part. XML namespaces for all CorasWorks web parts are provided in the 2For DevelopersHelp_D2HPrivate(-9,656)Overview2 help topic.

Also note that some of these properties some may require the use of a "<", ">", or "&" symbol. With the exception of the LCIDXML property, you must replace these characters with their encoded equivalents of "<", ">", and "&" respectively.

These properties are only viewable in the DWP if the default settings have been changed.

LCIDXML (Winter 2005)

This property allows you to localize the user interface. The easiest way to use this property is to follow these steps:

Copy the sample code below into Notepad and make the appropriate translations to the content between each tag.

Replace any double quotes (“) with single quotes (‘). Make sure there aren’t any brackets ([ ]) anywhere in the text. If there are, replace them with parentheses ( ). The XML nodes must appear in the exact order as they are shown below; you can not omit nodes or reorder them. (You can use brackets in other areas of the .dwp, but not in this section. This is because the CDATA expression (added later in these procedures) uses brackets to identify the boundaries of the text to work on.)

Export the web part you want to localize and add this: <LCIDXML xmlns="webpart_namespace"><![CDATA[]]></LCIDXML> (where ”webpart_namespace” is the web part namespace identified in the .chm file included in the Developer and Small Business editions of the Workplace Suite) Remember that web part namespaces are case-sensitive.
For example: <LCIDXML xmlns="CorasWSC.Calendar.RollUp"><![CDATA[]]></LCIDXML>

Copy the modified LCIDXML content from Step 2 and place it after the opening bracket after CDATA.

Save the localized web part and import it into your site. CorasWorks recommends that you use a naming convention that makes it clear which language(s) are supported by the web part.

Sample Code:
<?xml version='1.0' ?>
<CorasWorks>
<CalendarRollUpAdvanced id='default'>
<Today>Today</Today>
<ViewByDay>View by Day</ViewByDay>
<ViewByWeek>View by Week</ViewByWeek>
<ViewByMonth>View by Month</ViewByMonth>
<Search>Search</Search>
<ReturnType>Return Type:</ReturnType>
<Administration>Administration</Administration>
<SiteUrl>Site URL:</SiteUrl>
<LevelsSearch>Levels Searched:</LevelsSearch>
<Schemas>Schema(s):</Schemas>
<AvailableLists>Available List(s):</AvailableLists>
<CurrentLists>Current List(s):</CurrentLists>
<CloseAdministration>Close Administration</CloseAdministration>
<Status>Status:</Status>
<ReturnSitesList>Return All Sites & Lists</ReturnSitesList>
<Selective>Selective</Selective>
<LineofSite>Line of Site</LineofSite>
<UtilizeAllSChemas>Utilize All Schemas</UtilizeAllSChemas>
<SaveSelection>Save Selection</SaveSelection>
<SelectAllSiteLists>Select All Sites & Lists</SelectAllSiteLists>
<RemoveAllSiteLists>Remove All Site & Lists:</RemoveAllSiteLists>
<AddList>Add List</AddList>
<RemoveList>Remove List</RemoveList>
<SelectSearchCriteria>Select Search Criteria</SelectSearchCriteria>
<Search>Search</Search>
<AddItem>Add Item</AddItem>
<NoItemsFound>NoItems Found - Please check your Lists, Filter, or Search Criteria</NoItemsFound>
<ExecuteSearch>Please execute a search to see results</ExecuteSearch>
<ShowAdmin>Show Admin</ShowAdmin>
<ShowVersion>Show Version</ShowVersion>
<TimeExceeded>This Process Is Exceeding Its Time Limitations</TimeExceeded>
<ActionMenu>Actions</ActionMenu>
</CalendarRollUpAdvanced>
</CorasWorks>

The CorasWorks node supports multiple CalendarRollUpAdvanced nodes, allowing for the same web part to be used on multiple sites. When the web part loads, the language of the site that the web part is hosted in will automatically be used, provided an ID attribute for the site’s CalendarRollUpAdvanced node has been defined, otherwise, the CalendarRollUpAdvanced node with an attribute of 'default' will be used.

To localize the web part for multiple languages, repeat these tags (and the content in between) for each language. However, instead of using ‘default’ after the web part ID, use one of the 4-digit LCIDs provided below. Copy the rest of the LCIDXML text and place it between these tags for each desired language, making the appropriate translations for each language.

The following list shows the LCID for each language.
LCID Language
1025 Arabic
2052 Chinese - Simplified
1028 Chinese - Traditional
1029 Czech
1030 Danish
1043 Dutch
1033 English
1035 Finnish
1036 French
1031 German
1032 Greek
1037 Hebrew
1038 Hungarian
1040 Italian
1041 Japanese
1042 Korean
1044 Norwegian
1045 Polish
2070 Portuguese
1046 Portuguese – Brazilian
1049 Russian
1034 Spanish
1053 Swedish
1054 Thai
1055 Turkish

LCIDXML (Update 1)

This property allows you to localize the user interface.

The XML below displays a sample of how to use the LCIDXML. Each ID attribute has the SharePoint Web’s LCID listed as an attribute. The CorasWorks node supports multiple CalendarRollUpAdvanced nodes, allowing for the same web part to be used on multiple sites. When the web part loads, the language of the site that the web part is hosted in will automatically be used, provided an ID attribute for the site’s CalendarRollUpAdvanced node has been defined, otherwise, the CalendarRollUpAdvanced node with an attribute of "default" will be used.

<?xml version='1.0' ?>
<CorasWorks>
<CalendarRollUpAdvanced id='default'>
  <Today>Today</Today>
  <ViewByDay>View by Day</ViewByDay>
  <ViewByWeek>View by Week</ViewByWeek>
  <ViewByMonth>View by Month</ViewByMonth>
  <Search>Search</Search>
</CalendarRollUpAdvanced>
</CorasWorks>

NOTE: For clarity, the XML above has been displayed using standard XML characters, however, the <>& characters must be encoded to their HTML equivalent characters (< > &). When using the & symbol in a node's text value, you must encode it as &amp;. For example, <SelectAllSiteLists>Select All Sites & Lists</SelectAllSiteLists> would encode to <SelectAllSiteLists>Select All Sites &amp; Lists</SelectAllSiteLists>

Also note that the XML nodes must appear all on a single line, in the exact order as they are displayed above. You can not omit nodes or reorder them.

Use:
<LCIDXML xmlns='webpart_namespace'>Interface Localization XML</LCIDXML>

Example:
<LCIDXML xmlns= 'CorasWSC.Calendar.RollUp'>Interface Localization XML</LCIDXML

URLDirName (String)

This property is used to determine the root folder of where a document resides within a list. In order to permit the edit and/or linking to an item, this property is required. Since this list property is language-dependant, the equivalent (URL Dir Name) must be entered if a different language is chosen.

Use:
<URLDirName xmlns="webpart_namespace">URL Dir Name</URLDirName>

Example:
<URLDirName xmlns= "CorasWSC.My.Document.RollUp">Home directory URL</URLDirName>

EncodedAbsoluteURL(String)

This property is used to determine the direct location of where a document resides within a list. This property is required in order to permit the linking to an item directly. Since this list property is language-dependant, the equivalent (Encoded Absolute URL) must be entered if a different language is chosen.

Use:
<EncodedAbsoluteURL xmlns="webpart_namespace">Encoded Absolute URL</EncodedAbsoluteURL>

Example:
<EncodedAbsoluteURL xmlns= "CorasWSC.My.Document.RollUp">URL assoluto codificato</EncodedAbsoluteURL>

Supported Schemas XE "Schemas:Calendar Roll-Up" XE "Supported Schemas:Calendar Roll-Up"

Schemas are what allow roll-up web parts to access, understand, and display a list. They contain all of the elements that identify the list: the list type, the fields to look for, the fields to display and in what order, which fields can be used in a search or a filter, and the percentage of the display that each column should take up.

The following schemas are supported by CorasWorks Roll-Up Advanced (Calendar) web parts out of the box. If you have created your own schemas, they will not be available for selection from this version of the web part; if you want to work with additional schemas and you have either the Developer or Small Business edition of the Workplace Suite, you can use the Roll-Up Wizard to create a modified version of this web part that utilizes the additional schemas. This allows you to create calendars from any type of list, library, or gallery that has a date field.

NOTE: In order for a roll-up to work correctly, each list that is referenced by the roll-up must contain the fields named as “List Template Required Fields” below. Additional fields may be included in the list, but the ones named in each schema below are required.

Events (ER0001)

Display Fields: Title (Main Field), Begin (DATE), End (DATE)
Search Fields: Title (Main Field), Begin (DATE), End (DATE), Location, Description, ID, Recurrence, RecurrenceData, MasterSeriesItemID
Filterable Fields: Title (Main Field), Begin (DATE), End (DATE), Location, Description, ID, Recurrence, RecurrenceData, MasterSeriesItemID
Order By: Title
List Template Type: Events
List Template Required Fields: Title (Main Field), Begin (DATE), End (DATE), Location, Description, ID, Recurrence, RecurrenceData, MasterSeriesItemID

Events Publish (ER0002)

Display Fields: Title (Main Field), Begin (DATE), End (DATE)
Search Fields: Title (Main Field), Begin (DATE), End (DATE), Location, Description, Publish, ID, Recurrence, RecurrenceData, MasterSeriesItemID
Filterable Fields: Title (Main Field), Begin (DATE), End (DATE), Location, Description, Publish, ID, Recurrence, RecurrenceData, MasterSeriesItemID
Order By: Title
List Template Type: Events
List Template Required Fields: Title (Main Field), Begin (DATE), End (DATE), Location, Description, Publish, ID, Recurrence, RecurrenceData, MasterSeriesItemID

Tasks (TR0001)

Display Fields: Title (Main Field), Start Date (DATE), Due Date (DATE)
Search Fields: Title (Main Field), Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), ID, Description
Filterable Fields: Title, Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), ID, Description
Order By: Title
List Template Type: Tasks
List Template Required Fields: Title (Main Field), Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), ID, Description

Tasks Publish (TR0002)

Display Fields: Title (Main Field), Start Date (DATE), Due Date (DATE)
Search Fields: Title (Main Field), Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), ID, Description, Publish
Filterable Fields: Title, Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), ID, Description, Publish
Order By: Title
List Template Type: Tasks
List Template Required Fields: Title (Main Field), Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), ID, Description, Publish

Troubleshooting XE "Troubleshooting:Calendar Roll-Up " XE "FAQs:Calendar Roll-Up " XE "Errors:Calendar Roll-Up "

Some of my users see scroll bars on individual days of a calendar roll-up and some do not. Why?

If some of your users utilize Firefox and others utilize Internet Explorer, you may find that your IE users see a scroll bar on the calendar for days that contain more items than can be displayed in the available space. Firefox users will not see the scroll bar.

I recently upgraded to Summer 2006 and I don’t see any of the new calendar roll-up features. Why not?

The web part has most likely been placed into a web part zone with an invalid web part zone ID.

What this means is, if you have a calendar roll-up in a zone that has an invalid web part zone ID, the roll-up will not automatically update when you install the Summer 2006 release. If you want to take advantage of the calendar’s newest features, you will need to replace the invalid web part zone ID as described in the 3For DevelopersHelp_D2HPrivate(-7,656)Overview3 help topic.

I don't see an event that I created six months into the future in the calendar.

The calendar roll-up web part utilizes the "Current Events" view, so only the next 50 upcoming events will be displayed on the calendar. This is by design, so as not to overload the server at web part implementation. If you want to see more than 50 upcoming events, you can modify the "Current Events" view to display more than 50 events at a time. This is the only acceptable change permitted to the "Current Events" view.

I do not see items from the same sites that someone else does.

This is because you do not have the same rights as someone else. You can only see those sites which you have permission to access.

I created an event list and added a new column. I pointed the calendar roll-up to this list and configured it to look at this new column as a search field. It creates a drop-down list as I expected for the search, but it doesn’t work consistently. Why?

The out-of-the-box event calendar roll-up can only search on the Title and Date columns. The search described above looks for data from another column. If you want to do this, you will need to use the Roll-Up Wizard (Developer and Small Business editions only) to create a custom calendar roll-up that includes the new column as a searchable field.

I receive the error "The List Being Returned XML is incorrectly formatted."

This indicates that manual administration of the shared web part property "Lists Being Returned" was attempted. Please remove and add the web part to the page and then select the lists to be returned again.

The calendar doesn't display any items.

This indicates one or more of the following:

· The search criteria and/or filter criteria is incorrect

· The user doesn't have access to the list(s) selected

· The list or site no longer exists

· There is no data within any of the lists you have searched

To test your search text, try searching for text taken directly from one of your target lists to see if anything is returned. To test your filter criteria, try choosing a different filter field and searching for the same text to see if anything is returned.

If your search continues to yield no results, check that your target lists are populated, that your target lists and sites still exist, and that you have access to them.

I don't see items from a list that I know exists within the site.

This can occur for a few reasons:

1) The list must have all of the List Template Required Fields within one of the List Templates Supported (see the “Supported Schemas” help topic)

2) The list must have been created utilizing the proper list template.

How must a list be set up in order to be returned by the web part?

Lists should be created via SharePoint’s default list template, or with a CorasWorks-generated list like Updated Contacts, to be returned within the web part for selection.

Does the list returned have to be named the same as the web part (i.e., Document Roll-Up Advanced - Documents)?

No, it does not. You must make sure that the list in question was created with the proper list template and that the fields required are within it. Outside of that, you can name the list anything that you want.

The response time seems slow. Does CorasWorks have any suggestions for improvement?

The following suggestions apply to all roll-ups:

· Do not put more than one roll-up web part on a page. Since roll-ups are processed serially, adding several roll-ups to a page can cause a considerable delay in returning the page to the user, although this depends on the configuration of the web parts.

· While roll-ups can be set to pull data from an unlimited number of levels, users will experience the best performance if you configure the roll-up to look no more than 6 or 7 levels deep. As the number of levels increases, the number of sites and lists queried also increases exponentially.

· Limit the number of lists queried.

· Limit the number of fields returned.

· If you have no choice but to hit a large number of sites and lists, use CAML to filter the list before the data is returned. Collaborative Application Markup Language (CAML) is an XML-based language used in SharePoint. Pre-filtering performed through CAML reduces the number of list items received by the roll-up. You can build a CAML filter on the Filtering tab of the administration interface.

· Since the information returned by a calendar roll-up comes directly from the "Current Events" view, the total number of events returned and distributed into the calendar display will decrease your performance once you have 200 events or more. This is due to your browser and bandwidth, not the web part. Because your browser can only handle so much information and rendering at a given time, it will begin to slow down the rendering when too many events exist. To deal with this issue, you can control how many items are returned in the "Current Events" view to cut down the response so that it will not overload the browser.

Build Updates XE "Build Updates:Calendar Roll-Up" XE "Updates:Calendar Roll-Up" XE "Releases:Calendar Roll-Up"

The following updates have been made to calendar-type advanced roll-ups since they were initially introduced.

Summer 2006 Release

· Support for color coding

· Ability to show or hide appointment time for items in the roll-up

· Resolved the following issues:

o Searching and use of a data connection with parentheses (e.g., (1) High,
(2) Normal, etc.) are now both allowed

o Items that have URL-type columns with a URL and a plus sign (+) are now correctly displayed and linked

o When configured with Wait for Search, roll-up will return data when the user clicks Next to bring back the next set of data, or when the user clicks on a column to change the sort

Winter 2006 Release

· Added Default Calendar Period property to Display tab

Summer 2005 Release

· Added administration interface

· Added builders: Filter, localization, site URL

· Ability to use calculated fields in filter

· Added several date functions for filtering (CAML only)

Spring 2004 Release

· Actions menu for Show Admin and Show Version

· Line of Site capability

· Ability to go directly to item for document libraries

· Ability to hide icons for document library

· Ability to change tree-view background and text color

· Ability to change wording for Search, Add Item, Type, and URL Dir Name for language support

· Ability to UnLink Item Title

· Added commands :admin:, :version:, :corasworks:, :search: to search command box

· Update [ME] to support any cases of "me"

· Updated order by encoding to support embedded ASC/DESC commands in schema

· Changed administration interface for easier use, including "Close Administration" button

· Support for multiple URL(s) for Site URL within the administration window (Example: url1;url2)

· Ability to expand sites without expanding lists, as well

Winter 2004 Release

· Modified web part properties, developing three groups (Administration, Display, and Return)

· Capability to handle not operand "<>" for filter

· Capability to choose schema and then lists by schema for Administration view

· Improved performance in initial list search from Administration view

· Toggle for site/list title with/without links

· Ability to add all or remove all sites/lists from selection boxes in Administration view

· Improved performance for maximum return times

· Multiple filter capability

· Function for [ME]

· Property for showing empty lists