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: The 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 property is used to enable complex filters.
This property is used to define the text used to specify "AM" time.
This is the text used to specify "PM" time.
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.
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.
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.
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 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.
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
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.
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
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
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.
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.
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>
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 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>
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.
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.
This property is used to define the text used to specify "PM" time.
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.
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.
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 "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.
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.
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 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).
The character used to separate hours and minutes when displaying time within the calendar.
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
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.
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>