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 For Developers 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.
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>
This property allows you to alter the return of those fields which are of a date type. SharePoint, by default, will store any date/time field as MM/dd/yyyy, hh:mm:ss. If you wish to have all dates or times returned show only a time or a date, you can use the following parameters.
|
d |
The day of the month. Single-digit days will not have a leading zero. |
|
dd |
The day of the month. Single-digit days will have a leading zero. |
|
ddd |
The abbreviated name of the day of the week, as defined in AbbreviatedDayNames. |
|
dddd |
The full name of the day of the week, as defined in DayNames. |
|
M |
The numeric month. Single-digit months will not have a leading zero. |
|
MM |
The numeric month. Single-digit months will have a leading zero. |
|
MMM |
The abbreviated name of the month, as defined in AbbreviatedMonthNames. |
|
MMMM |
The full name of the month, as defined in MonthNames. |
|
y |
The year without the century. If the year without the century is less than 10, the year is displayed with no leading zero. |
|
yy |
The year without the century. If the year without the century is less than 10, the year is displayed with a leading zero. |
|
yyyy |
The year in four digits, including the century. |
|
gg |
The period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string. |
|
h |
The hour in a 12-hour clock. Single-digit hours will not have a leading zero. |
|
hh |
The hour in a 12-hour clock. Single-digit hours will have a leading zero. |
|
H |
The hour in a 24-hour clock. Single-digit hours will not have a leading zero. |
|
HH |
The hour in a 24-hour clock. Single-digit hours will have a leading zero. |
|
m |
The minute. Single-digit minutes will not have a leading zero. |
|
mm |
The minute. Single-digit minutes will have a leading zero. |
|
s |
The second. Single-digit seconds will not have a leading zero. |
|
ss |
The second. Single-digit seconds will have a leading zero. |
|
f |
The fraction of a second in single-digit precision. The remaining digits are truncated. |
|
ff |
The fraction of a second in double-digit precision. The remaining digits are truncated. |
|
fff |
The fraction of a second in three-digit precision. The remaining digits are truncated. |
|
ffff |
The fraction of a second in four-digit precision. The remaining digits are truncated. |
|
fffff |
The fraction of a second in five-digit precision. The remaining digits are truncated. |
|
ffffff |
The fraction of a second in six-digit precision. The remaining digits are truncated. |
|
fffffff |
The fraction of a second in seven-digit precision. The remaining digits are truncated. |
|
t |
The first character in the AM/PM designator defined in AMDesignator or PMDesignator, if any. |
|
tt |
The AM/PM designator defined in AMDesignator or PMDesignator, if any. |
|
z |
The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8". |
|
zz |
The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08". |
|
zzz |
The full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00". |
|
: |
The default time separator defined in TimeSeparator. |
|
/ |
The default date separator defined in DateSeparator. |
By default, CorasWorks Web parts will attempt to categorize text as a URL. If you have text with a format of "http://www.site.com" it will translate this text to a URL and automatically place the correct tags around it to make it clickable. If you do not want this to occur, toggle this switch on to disable this automatic feature.
This entry allows you to automatically group items by the values in a particular field. For example, if you have a task list with five different statuses, the tasks can be grouped by status. If you add a sixth status value, any items with that status are automatically included in the display and grouped under that new status.
The field you identify must be one of the display fields within the web part, and only one field can be used at a time.
This entry allows the administrator to specify the look and feel of the dynamic grouping by identifying the background color, font style, and whether or not the results should be expanded or contracted. If no property is chosen the default properties and/or "FontSytle" or "TDColor" will be used. Each element of this property must be separated by a comma, with no space is separated between each element and the comma. Colors can be defined using either hex format or the direct color name.
Use: Row Color,Font Style,true/false
Example:
blue,font-family: Verdana; font-size: 8pt; color: white; font-weight:
bold,true
Settings: First Element = Tree-View TD Background Color, Second
Element = Tree-View Font Style, Third Element = Expanded/Contracted
(true/false)
If you would prefer to only expand the sites returned, saving screen real estate, toggle this switch to enabled. This allows the web part to only expand sites, not lists. If you toggle "Show Expanded" on, it will override this setting.
Administrators can use the Filter field to control the web part’s return at a higher level. Unlike the Required Search String (above), Administrators can specify the field to search and, if anything is entered here, users will still be able to search on the filtered return.
The format for this property is "Field=SearchText" (Example: Postal Code=11111) with no space between the field and the search text. You can also use > and < when filtering date fields. (Example: "Date<7" will return items that are older than 7 days from today.) This only works on filterable fields that are designated as date fields. Filter grouping with parentheses () is not permitted.
The fields available to use for filtering are identified in the Supported Schemas section of this help, on the “Filterable Fields” line of each identified schema.
Examples:
Requirement 1:
Show me all tasks
that are assigned to me and are due within seven days
Use:
Assigned To=[ME] && Due
Date>-1 && Due Date<7
Requirement 2:
Show me all tasks
that are assigned to me or to someone else
Use:
Assigned To=ME' || Assigned To=UserName
Requirement 3:
Show me all tasks
that are not assigned to me
Use:
Assigned To<>[ME]
Where:
• && = And
• || = Or
• <> = Not
• [ME] = Currently Logged In User
This option is used to define the font style utilized for sites and lists returned by the roll-up. This is useful if your site utilizes a color structure that is not matched by a grey background and blue text. The style is based upon CSS definitions. While the CSS class cannot be entered, you can enter any text oriented toward a font style class like, such as "Font-Size:8; Color:Red"
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.
The lists available to be chosen for return by the web part.
This is the list of the WSS List types the Roll-Up Wizard works with.
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
(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.
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.
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.
This property allows you to start the collection of list items for roll-up display one level above the site identified in the Site URL field. This applies to Line of Site roll-ups only.
Enter 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.
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.
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.
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.
This Property allows of the hiding and showing the "Powered
By CorasWorks" text. By setting this property to true the user will see the
"Powered By CorasWorks" text. By setting this property to false the user will
not see this text. This property can be changed from true to false or false to
true by executing the proper search command.
Use: <ShowCorasWorks
xmlns='webpart_namespace'>true/false</ShowCorasWorks>
Example:
<ShowCorasWorks
xmlns='CorasWSC.My.Announcement.RollUp'>true</ShowCorasWorks>
Enable this property to return only the items that have been created by the currently logged in user. If this property is used, it will override the Assigned To functionality built into the web part.
This activates the "Add Item" link and "Edit Item" icon in the web part return. If activated, users will be able to edit and create list items from the web part. If deactivated, users will only be able to view the list item.
When this property is enabled, every list set up to be searched by the web part will be returned, regardless of whether or not any items are available in that list.
If a filter is applied and this option is enabled, only those lists that contain items that meet the filter criteria will be displayed; any lists that do not contain items that meet the criteria will not be shown.
This property allows you to expand the lists and list items returned by the web part. If this is enabled, the return will be expanded, showing all lists and list items returned by the web part. If this is deactivated, the display will be contracted.
This property controls whether or not each item included in the web part return includes a hyperlink to the item. This can be used in conjunction with ShowLinks to remove a user's ability to go directly to a list from within the web part.
This property controls whether or not the site name and list name shown for each list item include a hyperlink to the site/list.
Enable this property to return only the items that have been modified by the currently logged in user. If this property is used, it will override the Assigned To functionality built into the web part.
This property enables the Search bar.
This entry allows you to define the display format of the sites returned by the roll-up. For example, to display the site title and URL, you would place the following in this field: <%SiteTitle%> (<%SiteURL%) This would display the information as follows: Site 1 (http://www.site.com/site1).
Alternatively, you could enter text before the site title, as in Site: <%SiteTitle%>
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."
This property is used to define the target window for the links provided in the web part. For example, if you wanted any links that are clicked on to open in a new window, you would set the property to _new. Other values include _blank, _parent, and _self
This option is used to define the background color utilized for each site and list returned. By default, this color is grey (#DDDDDD), but this can be changed. This field supports hexadecimal characters or direct color notations (#DDDDDD, Grey).
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).
This feature allows the web part to return no results until the user completes a search. It can save much-needed performance when accessing multiple lists and/or sites. With some configuration, this allows you to have multiple roll-ups on a page, each pointing a different list with a different schema, and utilizing a form web part or another connected web part as a search mechanism for all roll-ups on that page.