The CorasWorks Roll-Up Wizard™ consists of a single web part
used to create roll-up web parts that utilize your own custom schemas, so you
can create solutions that perfectly match your specific business
requirements. The Roll-Up Wizard enables
you to create any type of roll-up, including action-enabled roll-ups (Winter
2006 only), and use any list, library, or gallery in the SharePoint
environment. As of the Summer 2005
release of the Workplace Suite, you can also use the Roll-Up Wizard to modify
any existing roll-up web part on a page.
The Roll-Up Wizard is available only with the Developer
Edition and the Small Business Edition of the CorasWorks Workplace Suite; it is
not included in the Professional Edition.
NOTE: In order to
use the web parts you create with the Roll-Up Wizard, the server on which they
are placed must have the underlying CorasWorks web part installed as well. For example, if you create a custom Contact
Spreadsheet Roll-Up, the CorasWorks Spreadsheet Contact Roll-Up Advanced
must be installed on the server.
Last Modified: DATE \@ "MMMM yy" October 06
NOTE: This topic
applies only to Summer 2005 and later
releases of the Roll-Up Wizard. If you are working with a previous release
please see “Create a Roll-Up
(Pre-Summer 2005)” instead.
The basic steps for creating a new roll-up web part from
scratch via the Roll-Up Wizard are described below. If you want to modify an
existing roll-up, please refer to Modify an Existing Roll-Up.
1. On the main wizard interface, keep the default
selection of Create a new Roll-Up.
2. In the List
Site URL field, specify the URL that contains the lists for which you
want to create the roll-up. This can be any
SharePoint site that resides on the same server as the Roll-Up Wizard. If
you leave this field blank, it defaults to the site where the Roll-Up Wizard is
placed. The format for the URL must be: "http://Site-URL/SiteName".
3. Click Return Lists. This
loads the specified site’s lists into the Lists field.
NOTE: If you are working in an SPS
environment, do not create a roll-up that utilizes the Sites list where your
site collections are tracked. If you do this, the Title column in your roll-up
results will not display any values.
4. In the Lists field, select the list for which
you want to create the roll-up.
5. Use the Roll-Up Type field
to select the type of roll-up you want to create: Action, Calendar, Chart, My, Spreadsheet,
Tree-View. After choosing a roll-up type, the administration window will automatically
expand to display the chosen list’s fields, along with the properties in the
following steps.
6. Next, you need to enter a name for the schema
to be created, plus a name and description for the roll-up web part to be
created.
· The Schema Name will be included in the administration interface for
the new roll-up. You may want to prefix your schema names with an abbreviation,
such as the first two letters of your list type name. For example, all CorasWorks
schemas begin with a list type abbreviation like Task Roll-Up = TR. Your schema
names should be unique.
· The Web Part Name is displayed in the web part galleries and web
part libraries. Try to use self-describing names so the people who use your web
part will be able to identify its purpose without having to read about it.
· The Web Part Description is displayed when a mouse is placed over
the web part name on the Add Web Parts menu and when a web part is loaded onto
a page. It should be brief, but detailed enough to provide a quick overview of
the web part’s purpose. If possible, keep the description to one or two sentences.
7. In the lower section, select the fields you
want to display in your roll-up. You can set the properties described below for
each field.
NOTE: For performance reasons, CorasWorks roll-ups do not support
more than 20 columns of data, including search columns. As more columns are
added to a roll-up, the search process will become noticeably slower. From a
visibility and usability perspective, try to limit the number of columns to 6
or 7.
· Display
- Toggle this checkbox to include the field in your web part display. If the
checkbox is left blank, the field will not be included in the display.
NOTE: When creating a "My" roll-up, the column that is set for the
Assigned To column (where the roll-up looks for “me”) must be a displayed
column. It is not enough for that field to be searchable.
· Display
Order – (Optional) This field is
used to set the order in which the web part's columns will be displayed. If you
do not select a sort order, the fields will be displayed in the order that they
appear in the fields list.
· Display
% - (Optional) This field allows you
to select how wide you want each field column to be. After you set the Display
%, the total for all Display % fields should add up to 100. If you do not set a
Display % value, the roll-up web part will determine the width each time the
roll-up is displayed, based upon the width of the data in each column in each
group. To ensure a consistent column width from one group to another within the
roll-up display (so they all line up neatly), define a Display % here.
· Search
- Toggle this checkbox on for those fields you want to make available to any
searches users perform against the web part results. These fields do not
have to be displayed.
NOTE: The fields you identify here for searching are also made
available for use in filters.
· Sort
Order - (Optional) The sort order
determines how the web part you are creating will sort the results. For
example, if you are creating a roll-up for a Contact list, you might set the
Last Name field’s sort order to 1 and the First Name field’s sort order to 2.
This would display the contacts in alphabetical order first by Last Name and
then by First Name.
8. If you are creating a calendar-type roll-up,
you can select Begin, End, Title, and (optional) Recurrence, RecurrenceData,
and MasterSeriesItemID fields. These fields allow the Roll-Up Wizard to map list
field names to the corresponding calendar field names, and determine which
columns to use for the dates.
For example, an Event list uses Begin as the name of the field that
stores the date on which events are to begin. However, a German language site
may define the Begin field as Beginn. You might also create a custom field
and name it Start. It is possible to map any of these names to the Begin
field using the Field Name Mapping properties.
The following fields must be mapped
to a corresponding calendar field:
· Begin (DateTime)
· End (DateTime)
· Title (string)
If you want to support recurring events
for event type lists, the following fields also need to be mapped:
· Recurrence (boolean)
· RecurrenceData
(string)
· MasterSeriesItemID (integer)
In order for the field mapping to function
properly, the field being mapped must contain the same data type as the field
it is being mapped to.
9. In order for a “My” roll-up to display information
that is relative to a specific user, you must map the User Field to a corresponding
list field. For example, if you are creating a roll-up that will display all items
that are assigned to the currently logged in user, you might map the Assigned To
field to the User Field. Optionally, you could select the Modified By field to create
a roll-up that would display items that had been modified by the currently logged
in user.
10. When you are finished, click the Create
Web Part button and confirm that you wish to create the web part.
This saves the new roll-up web part and stores it in the specified web part gallery
or library. (See Web Part Properties for more
information on selecting these locations.)
You now have a roll-up web part that you can use in your
solutions. You can further customize this web part by dragging it from its web
part gallery or document library and using the web part’s administration
interface to modify its behavior. To learn more about using a web part you have
created, please refer to the online help for the corresponding CorasWorks
roll-up type.
TIP: When the
roll-up web part is created, you can right-click on the file name and save it
to your desktop or another location.
NOTES:
· This
topic applies only to Summer 2005 and
later releases of the Roll-Up Wizard. If you are working with a previous
release, you cannot modify an existing web part.
· The
Roll-Up Wizard does not load web parts directly from the web part gallery.
Instead, the web part must be instantiated on a page in order for it to be
loaded into the Roll-Up Wizard for modifications.
· The
Roll-Up Wizard does not modify existing web parts, but allows you to load
existing web parts that were created with the Roll-Up Wizard into its GUI. The modifications you make do not affect
existing instances of the roll-up; they only affect instances that are placed
on a page from that time going forward.
One of the key
enhancements made for the Summer 05 release of the Workplace Suite is the
ability to modify an existing roll-up web part that was created with the
Roll-Up Wizard. In the past, you could
not make changes to a roll-up after it had been created; if you wanted to add
fields or modify the order or searchable fields, you had to repeat the entire
process of creating the roll-up.
The Roll-Up Wizard now
makes it easy to make these changes to an existing roll-up. The procedures are
described below.
1. Place
the Roll-Up Wizard onto any page. You
can always delete it when you are finished modifying the roll-up.
2. Click
the radio button next to Create a new Roll-Up based on an existing
Roll-Up. Additional fields are
displayed directly below the button.
3. In the Roll-Up Site
URL field, type the URL where the web part you want to modify is
located. If it is on the current site, you can leave this field blank.
NOTE: Make sure the URL includes the
.aspx extension. This is required so the Roll-Up Wizard knows the exact page
where the existing web part exists.
4. Click
Return Roll-Ups. All available roll-up web parts on the
specified site are listed in the Roll-Ups field.
5. Select the desired roll-up web part
from the Roll-Ups field.
6. Select the list you want to reference from the
Lists field, and the type of roll-up you want to create from the Roll-Up Type
field. The display is expanded.
7. Make
the desired changes to any of the settings on the page.
· If
you want to create a new web part based on the settings of the existing one,
type a new name in the Web Part Name field and then make the rest of your
changes.
· If
you do not change the Web Part Name,
you will overwrite the existing roll-up web part file when you save your changes.
This will not affect any instances of the web part that already exist on any
sites, including the one you identified above.
Your changes will affect new instances of the web part that are placed
on a site from this point going forward.
NOTE 1: If you select a web part that
has multiple schemas, the Roll-Up Wizard will load the first schema in the
schemas list into the GUI.
NOTE 2: For performance reasons,
CorasWorks roll-ups do not support more than 20 columns of data, including
search columns. As more columns are added to a roll-up, the search process will
become noticeably slower. From a visibility and usability perspective, try to
limit the number of columns to 6 or 7.
8. When
you are finished, click Create Web Part. A confirmation
message is displayed. Click OK to save your changes and create
the modified web part.
NOTE: This topic
applies only to versions of the Roll-Up Wizard from before the Summer 2005 release. If you are working with Summer 2005
or a later release, please see 0Create
a New Roll-Up from Scratch (Summer 05 and Later)Help_D2HPrivate(-9,1620)Create
a New Roll-Up from Scratch0 instead.
The main interface for the Roll-Up Wizard displays the
following fields, which are used to define the roll-up you want to create or
modify.
(Optional) Enter the URL(s) for the site(s) from which you
want to return links, sites, and lists. This can be any SharePoint site that
resides on the same server as this web part. If you leave this field blank, it
defaults to the site where the Roll-Up Wizard is placed. The format for the URL
must be: "http://Site-URL/SiteName".
Examples:
http://www.sitename.com/;http://www.sitename.com;http://www.sitename2.com
http://www.sitename.com/site1
http://www.sitename.com/site1/site1a
Click this button to load the specified site’s lists into the
Lists field.
This drop-down field contains all the current lists returned
by the web part. Out of the box, the Roll-Up Wizard is designed to support the creation
of roll-ups for Announcements, Contacts, Documents, Events, Links, and Tasks list
types. Select the type of list for which you want to create or modify a web
part.
Select the type of roll-up that you want to create: Calendar,
Chart, My, Spreadsheet, or Tree-View. After choosing a roll-up type, the administration
window will automatically expand to display the chosen list’s fields, along with
the properties described below. If you are in the process of modifying an
existing web part, the saved settings are displayed.
This field is used to define the name for the schema to be
created. After you create a web part using the Roll-Up Wizard, this schema name
is shown in the web part’s Schemas list box. While not necessary, you may want
to prefix your schema names with an abbreviation, such as the first two letters
of your list type name. For example, all CorasWorks schemas begin with a list type
abbreviation like Task Roll-Up = TR. Your schema names should be unique.
This field is used to define the name for the web part to be
created. The web part name is displayed in the web part galleries and the web part
libraries. If possible, try to use self-describing names so that the people who
use your web part will be able to identify its purpose without having to read about
it.
If you are modifying an existing web part and:
· If
you want to create a new web part based on the settings of the existing one,
type a new name in the Web Part Name field and then make the your changes.
· If
you do not change the Web Part Name,
you will overwrite the existing roll-up web part file when you save your changes. This will not affect any instances of the web
part that already exist on any sites.
Your changes will affect new instances of the web part that are placed
on a site from this point going forward.
This field is used to provide a description for the web part
that to be created. The description is displayed when users place their mouse over
the web part name within the Add Web Parts menu and when a web part is loaded onto
a page. The description should have enough detail to give them a quick overview
of the web part's purpose. If possible, you should keep the description to one
or two sentences.
After you have identified all of the above information, click
the “Create Web Part” button to create your web part. This will create a Roll-Up
web part and store it in the specified web part gallery or library (see Web Part
Properties for more information on selecting these locations).
After you select a list to use for your web part, the list’s
fields will load into the Administration window. You can set the properties
described below for each field. If you are modifying an existing web part, the
previous selections are displayed.
NOTE: For
performance reasons, CorasWorks roll-ups do not support more than 20 columns of
data, including search columns. As more columns are added to a roll-up, the
search process will become noticeably slower. From a visibility and usability
perspective, try to limit the number of columns to 6 or 7.
The name of the field (column) in the list, provided for informational
purposes only.
Toggle this checkbox to include the field in your web part.
If the checkbox is left blank, the field will not be included in the display.
NOTE: When creating a "My" roll-up, the
column that is set for the Assigned To column (where the roll-up looks for
“me”) must also be a displayed column. It is not enough for that field to
be searchable.
This field is used to set the order in which the web part's columns
will be displayed. If you do not select a sort order, the fields will be displayed
in the order that they appear in the fields list.
This field allows you to select how wide you want each field
column to be. After you set the Display %, the total for all Display % fields should
add up to 100. If you do not set a Display % value, the roll-up web part will leave
the display size up to the browser.
Toggle this checkbox on for those fields you want included
in any search users perform against the web part.
The sort order determines how the web part you are creating will
sort the results. For example, if you are creating a roll-up for a Contact list,
you might set the Last Name field’s sort order to 1 and the First Name field’s sort
order to 2. This would display the contacts in alphabetical order first by Last
Name and then by First Name.
When you select Calendar or My roll-up types, the Field Name
Mapping options are displayed. These properties allow you to map list fields to
either user or calendar fields.
When creating Calendar type roll-ups, these fields allow the
Roll-Up Wizard 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
stores the date on which events are to begin. However, a German language site
may define the Begin field as Beginn. Further, you may create a custom field
and name it Start. It is possible to map any of these names to the Begin
field using the List Field Name Mapping property.
The following fields must be mapped to a corresponding calendar
field:
· Begin
(DateTime)
· End
(DateTime)
· Title
(string)
If you want to support recurring events for event type lists,
the following fields also need to be mapped:
· Recurrence
(boolean)
· RecurrenceData
(string)
· MasterSeriesItemID
(integer)
In order for the field mapping to function properly, the field
being mapped must contain the same data type as the field it is being mapped to.
In order for the My Roll-Ups to display information that is relative
to a specific user, you must map the User Field to a corresponding list field. For
example, if you are creating a roll-up that will display all items that are assigned
to the currently logged in user, you might map the Assigned To field to the User
Field. Optionally, you could select the Modified By field to create a roll-up that
would display items that had been modified by the currently logged in user.
After you have identified all of the above information, click
the “Create Web Part” button to create or update your web part. This will save
the new or modified roll-up web part and store it in the specified web part gallery
or library (see Web Part Properties for more
information on selecting these locations).
The web part properties for the Roll-Up Wizard can be
accessed by selecting “Modify Shared Web Part” from the web part menu.
This field is used to identify the URL to the WSS/SharePoint
web site where you want to store the roll-up web parts you create with this instance
of the Roll-Up Wizard. If you leave this field empty, the web parts will be stored
to the current site's web part gallery.
This is the name of the document library where you want to store
the roll-up web parts you create with this instance of the Roll-Up Wizard. If you
leave this property empty, the web parts will not be stored to a document library,
but to the site’s web part gallery instead.
NOTE: To store
the web parts in a document library, you must specify the Web Part Storage Site
in addition to the Web Part Storage Library. If you do not fill in both fields,
the web part will be stored to the current site's web part gallery.
Toggle this checkbox on to enable the creation and
modification of chart display roll-ups using the Roll-Up Wizard. In order to display
the chart roll-ups, you will need to have the CorasWorks Chart Display Advanced
Roll-Up installed on the server.
To learn more about the web parts that you can create using the
Roll-Up Wizard, please refer to the Calendar, Charting, My, Spreadsheet, or Tree-View
Roll-Up online help and the Capabilities Guide.
Toggle this checkbox on to enable the creation and
modification of My roll-ups using the Roll-Up Wizard.
Toggle this checkbox on to enable the creation and
modification of Tree View roll-ups using the Roll-Up Wizard.
Toggle this checkbox on to enable the creation and
modification of Spreadsheet roll-ups using the Roll-Up Wizard.
Toggle this checkbox on to enable the creation and
modification of Calendar display roll-ups using the Roll-Up Wizard.
Toggle this checkbox on to enable the creation and
modification of action-enabled roll-ups using the Roll-Up Wizard.
This property allows you to override the internal DWP file that
the Roll-Up Wizard uses to create new roll-ups from. By using this property, you
can modify the default behavior of the web parts you create with the Roll-Up Wizard.
For example, you could change the default behavior for the Allow Minimize property
from true to false. Any new web parts you create would have their Allow Minimize
property set to false.
When you modify the DWP XML property, you should start with the
following string and add or change values.
<?xml version=\"1.0\" encoding=\"utf-8\"?>
<WebPart xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xmlns=\"http://schemas.microsoft.com/WebPart/v2\">
<Title>%Title%</Title>
<FrameType>Default</FrameType>
<Description>%Description%</Description>
<IsIncluded>true</IsIncluded>
<ZoneID>Left</ZoneID>
<PartOrder>1</PartOrder>
<FrameState>Normal</FrameState>
<Height />
<Width />
<AllowRemove>true</AllowRemove>
<AllowZoneChange>true</AllowZoneChange>
<AllowMinimize>true</AllowMinimize>
<IsVisible>true</IsVisible>
<DetailLink />
<HelpLink>%HelpLink%</HelpLink>
<Dir>Default</Dir>
<PartImageSmall />
<MissingAssembly>This Web Part has failed to load due to a missing software
file. Please contact CorasWorks (http://www.corasworks.net)
and provide them with the name of the Web Part [%Assembly% - Created with Roll-Up
Wizard] and the URL in your browser.</MissingAssembly>
<PartImageLarge>%PartImageLarge%</PartImageLarge>
<IsIncludedFilter />
<Assembly>%Assembly%, Version=%Version%, Culture=neutral, PublicKeyToken=%PublicKeyToken%</Assembly>
<TypeName>%TypeName%</TypeName>
<ShowAdmin xmlns=\"%xmlns%\">true</ShowAdmin>
<LevelCount xmlns=\"%xmlns%\">3</LevelCount>
<ListTemplates xmlns=\"%xmlns%\">%Schema%</ListTemplates>
<ListFieldNameMapping xmlns=\"%xmlns%\">%ListFieldNameMapping%</ListFieldNameMapping>
Example:
<BaseDWP xmlns="CorasWSC.RollUp">BaseDWP</BaseDWP>
CorasWorks web parts have a number of properties that can 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.
The BaseDWP property allows you to override the internal DWP
file that the Roll-Up Wizard uses to create new roll-ups from. By using the BaseDWP
property, you can modify the default behavior of the web parts you create with the
Roll-Up Wizard. For example, you could change the default behavior for the Allow
Minimize property from true to false. Any new web parts you create would have their
Allow Minimize property set to false.
When you modify the BaseDWP property, you should start with the
following string and add or change values.
<?xml version=\"1.0\" encoding=\"utf-8\"?>
<WebPart xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xmlns=\"http://schemas.microsoft.com/WebPart/v2\">
<Title>%Title%</Title>
<FrameType>Default</FrameType>
<Description>%Description%</Description>
<IsIncluded>true</IsIncluded>
<ZoneID>Left</ZoneID>
<PartOrder>1</PartOrder>
<FrameState>Normal</FrameState>
<Height />
<Width />
<AllowRemove>true</AllowRemove>
<AllowZoneChange>true</AllowZoneChange>
<AllowMinimize>true</AllowMinimize>
<IsVisible>true</IsVisible>
<DetailLink />
<HelpLink>%HelpLink%</HelpLink>
<Dir>Default</Dir>
<PartImageSmall />
<MissingAssembly>This Web Part has failed to load due to a missing software
file. Please contact CorasWorks (http://www.corasworks.net) and
provide them with the name of the Web Part [%Assembly% - Created with Roll-Up Wizard]
and the URL in your browser.</MissingAssembly>
<PartImageLarge>%PartImageLarge%</PartImageLarge>
<IsIncludedFilter />
<Assembly>%Assembly%, Version=%Version%, Culture=neutral, PublicKeyToken=%PublicKeyToken%</Assembly>
<TypeName>%TypeName%</TypeName>
<ShowAdmin xmlns=\"%xmlns%\">true</ShowAdmin>
<LevelCount xmlns=\"%xmlns%\">3</LevelCount>
<ListTemplates xmlns=\"%xmlns%\">%Schema%</ListTemplates>
<ListFieldNameMapping xmlns=\"%xmlns%\">%ListFieldNameMapping%</ListFieldNameMapping>
Example:
<BaseDWP xmlns="CorasWSC.RollUp">BaseDWP</BaseDWP>
Set this property to “true” to enable the creation of chart
display roll-ups using the Roll-Up Wizard. In order to display the chart roll-ups,
you will need to have the CorasWorks Chart Display Advanced Roll-Up installed
on the server.
This is the name of a document library where you want to
store the roll-up web parts you create with this instance of the Roll-Up
Wizard. If you do not use this property, the web parts will not be stored in a
document library, but in the site’s web part gallery instead.
NOTE: To store
the web parts in a document library, you must specify the Web Part Storage Site
in addition to the Web Part Storage Library. If you do not fill in both fields,
the web part will be stored to the current site's web part gallery.
This property allows 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 administrators
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
Enter the URL(s) for the site(s) that you would like to
access and from which you want to return links, sites, and lists. This can be
any SharePoint site that resides on the same server as this web part. The
format for the URL must be: "http://Site-URL/SiteName".
Examples:
· http://www.sitename.com/;http://www.sitename.com;http://www.sitename2.com
· http://www.sitename.com/site1
· http://www.sitename.com/site1/site1a
If you do not specify both the Web Part Storage Site and the
Web Part Storage Library, your new roll-ups will be saved to the default web
part gallery on your server.
You need to be logged in to the site with Site Collection Administrator
rights. Only site collection administrators can save web parts in the web part gallery.
The Roll-Up Wizard does not load web parts directly from the
web part gallery. Instead, to load a web part into the Roll-Up Wizard, you must
have the web part instantiated on a page.
CorasWorks roll-ups do not support more than 20 columns of
data, including search columns. As more columns are added to a roll-up, the
search process will become noticeably slower. CorasWorks has also found that in
roll-ups with more than 20 columns, the data is not always returned as
expected. We recommend that for optimum visibility, usability, and consistency,
you try to limit the number of columns to 6 or 7.
The following updates have been made to the Roll-Up Wizard
since it was initially introduced to the CorasWorks Workplace Suite.
· Added ability to create or modify
an action-enabled roll-up
· Added
ability to edit an existing roll-up from a web page
· Added
ability to create My, Chart, and Calendar Roll-ups
· Changed
selection of web part type from radio buttons to drop-down list.
· Added
ability to select User field for My Roll-Up.
· Added
ability to select Begin, End, Title and optionally Recurrence, RecurrenceData, and
MasterSeriesItemID fields for Calendar.
· Removed
dependence on external DWP files. Now uses internal base DWP that can be altered
using the BaseDWP property.
· Added
property to allow support for Chart Display Roll-Up.
· Removed
List Types property.
· The
Roll-Up Wizard can now create roll-ups for any type of list.