Workplace Wizard
Overview
XE "Overview:Workplace Wizard" XE "Workplace Wizard:Overview" XE "Site Creation" XE "Create a Site" XE "Build a Site"
The CorasWorks Workplace Wizard™ is a module that
dramatically decreases the amount of time and effort to create anything from a
single site to an entire site collection with multiple sites and hierarchies.
With the Workplace Wizard, everything can be done from a
single page in just a matter of moments.
You simply select a solution blueprint, review the settings, and click a
button to build it. The site or
workplace is created for you, complete with connections between all of the
appropriate workplace elements. If you
want to change the default title, description, or URL, you can easily do so
before you proceed with the build.
You can still create customized sites and workplaces using the
traditional, “manual” method – create each site individually, set up the necessary
navigation, select a template, permission settings, and so on at each site. However, if you have repetitive
administrative requirements, the Workplace Wizard is an extremely powerful
productivity tool.
For users and administrators who have become used to the
time and effort it takes to manually build a solution, the ease, speed, and power
of the Workplace Wizard are amazing.
What used to take anywhere from five minutes to hours, depending on the
number of sites being built and configured, now takes about a minute or two. Once you have a blueprint defined, you can
build and roll out an entire solution almost instantaneously.
NOTE: New with
the Winter 2006 Update, the Workplace Wizard runs as a web service. This makes
it less susceptible to time-outs in large builds. This version of the Wizard
utilizes
Last Modified: DATE \@ "MMMM yy" October 06
Main Interface XE "Workplace Wizard:Fields"
The main interface of the Workplace Wizard displays the
fields that are utilized to make the key selections to build a new
workplace. It is displayed when you first
drag and drop the Workplace Wizard web part onto a page.
NOTE: The Site URL, Site Title, and Site Description fields
can be used if you want to override the default values defined in the blueprint
for the top-level site to be created. They do not affect any lower-level sites
created by the Workplace Wizard.
Site URL
(Optional) This is the URL of the new workplace to be created.
You can leave this field blank to create a site in the default location, you
can specify the new site’s fully qualified URL (e.g., like http://yoursite/newsite),
or you can append the new site to the current site URL by preceding your new
site’s name with a "/" (e.g., /newsite). The latter two options will override
the URL value defined in the blueprint.
Winter 2006 Update
Enhancements
As of the Winter 2006 Update, sites can be built from both
http and https URLs.
Another change made for the Winter 2006 Update affects the
way the Workplace Wizard verifies URLs and determines how to build out
blueprints with multiple parallel sites. Now, the Wizard will verify the
user-provided URL, with the assumption that the identified site has already
been built and you want to build under it, and will display an error if the
site does not exist yet. The build will not proceed.
When the Workplace Wizard was originally developed, it was
designed to build a single hierarchy of sites. It was not created to build
multiple parallel, top-level sites; it assumed there was only one top-level
site. The Winter 2006 Update version of the Wizard allows greater scalability
and consistency. Regardless of how the beginning URL is defined, you can always
create multiple parallel sites and the expected site hierarchy is always
preserved.
· If you do not identify a URL in the
Site URL field, the Wizard will begin the build directly under the current
site.
· If you identify a relative URL, the
Wizard will verify that the relative URL exists and then begin the build
directly below the relative URL.
· If you identify a full URL, the
Wizard will verify that the URL exists and then begin the build directly below
that URL.
Site Title
(Optional) This field is used to define the title for the
top-level workplace to be created. You can leave this field blank to use the
default site title defined in the blueprint, or you can specify your own. This will override the title value defined in
the blueprint.
Site Description
(Optional) This field is used to identify the description
for the workplace to be created. You can leave this field blank to use the
default site description defined in the blueprint, or you can specify your
own. This will override the description value
defined in the blueprint.
Review Settings
Click this button to review all your entries. A status table
will appear for each item, indicating an OK or an ERROR in each row.
Build It
Click this button to build the workplace. This button is only
available if there are no errors when you click Review Settings. When the build
is complete, a status is provided.
Web Part Properties
XE "Workplace Wizard:Web Part Properties" XE "Web Part Properties:Workplace Wizard"
These properties can be modified by accessing the web part
property tool pane. To do this, select Modify Shared Web Part from the web part
menu.
Workplace
Properties
Workplace
Blueprint
XE "Blueprint" XE "Workplace Blueprint"
The blueprint is comprised of XML text that includes
properties that tell the Workplace Wizard what should be built and how to do
it. The basic format of the XML is as follows:
<?xml version="1.0" ?>
<Workplaces>
<Workplace id="ID NAME">
<Workspace>
<Title>Title</Title>
<Description>Workplace Description</Description>
<URL>/Workplacename</URL>
<Template>template file name</Template>
<Language>1033</Language>
</Workspace>
</Workplace>
</Workplaces>
You can create additional blocks of instructions that start
with <Workplace> tags for each new workplace, and place them within the
<Workplaces> tags.
The following properties are specified in the Workplace
Blueprint:
Workplace ID
XE "Workplace ID:Workplace Wizard"
This property is used to define the name
used to identify the blueprint. This is
the ID the user sees when they select a blueprint to use. CorasWorks uses the following standard: CWBL###-Name. For example, CWBL201-Our Workplace.
Title
This property is used to define the default title of the workplace.
Description
This property is used to define the default description for the
workplace.
URL
This property is used to define the default URL of the new workplace
to be created. The name should be preceded by "/" and will be appended
to the current site URL.
Template
This property is used to name the site template used to create
the workplace. The template must exist
in the template gallery of the site collection, or the web part will return an
error when the user reviews the settings.
NOTE: If the template
was installed to the Site Template Gallery, you should identify the name minus
the trailing ".stp". If the template was installed to the Global Catalog
using the CorasWorks Software Manager or STSADM command, use the template title
you specified to be associated with the template file during installation.
Language
This property is used to specify the ID for the language to
be used when a site is created using this blueprint. A list of valid LCIDs can
be found in the “Modifiable DWP
Properties for Localization” topic.
Using Different Blueprints XE "Blueprint:Loading a Blueprint"
A
blueprint is a set of XML text that includes properties that tell the Workplace
Wizard what should be built and how to do it.
A single set of XML text can define multiple blueprints. Blueprints are defined in one of the
Workplace Wizard web part properties called Workplace Blueprint.
CorasWorks provides a few sample blueprint definitions as
text files for you to use, or you can create and save your own blueprint
definitions. If you want to use a
different set of blueprints than the default ones defined by the Workplace
Wizard, you can copy and paste the desired blueprint definition(s) into the Workplace
Wizard web part.
CorasWorks recommends that you open the desired blueprint
definition(s) in Notepad and make any necessary changes there, and then copy
and paste the contents into the web part property. It’s easier to lay out a blueprint in Notepad
because the web part property window used for editing within SharePoint wraps
all of the blueprint definitions onto one continuous line.
To load a new set of blueprint definitions:
1. Open the desired blueprint
definition(s) in Notepad.
2. Make any necessary changes and
then copy the contents of the file.
3. Access the Workplace Wizard
web part menu and select Modify Shared Web Part.
4. Expand the Workplace
Properties section and click inside the Workplace Blueprint field.
5. Click the ... button to the
right of the field to open a window for editing.
6. Highlight and delete the
existing contents, then paste the contents you copied from the Notepad.
7. Click OK twice to apply the
changes and return to the Workplace Wizard.
Refresh the page, and the new/edited blueprints are available for use.
Actions Menu
XE "Actions Menu:Workplace Wizard"
The Actions Menu allows both administrators and users quick
access to information about the web part. To view version information:
1. Within the web part, drop down
the web part menu options by clicking on the down arrow on the top right hand side
of the web part.
2. Drag your mouse over "Actions"
and then choose "Show Version."
Show Version
XE "Version:Workplace Wizard" XE "Show Version:Workplace Wizard"
This selection shows version information within the web part
area, including:
· Application
· Version
· Organization
· Authors
· Build Date
The
link to Close Version Window will return the page back to its 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 allows you to
view version information for all CorasWorks web parts at once.
Modifiable DWP Properties XE "DWP Properties:Workplace Wizard"
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.
MySite (String)
This property allows you to change the default My Site characteristics
of the web part. The default characteristic modifies the URL "/mysite"
to point to "/personal/User". This allows the web part to search through
the My Site section of SharePoint Portal Server. SPS allows administrators to alter
the URL definition for each SPS server. To accommodate for this, the DWP Property
"MySite" was designed to allow administrators to alter the web part to
support their particular SPS My Site setup.
Use:
<MySite xmlns='webpart_namespace'>/sites/<%Domain%>
AND/OR <%User%></MySite>
Example:
<MySite xmlns='CorasWSC.Document.Spreadsheet.RollUp'>/personal/<%User%></MySite>
Settings:
<%User%> = User Name
<%Domain%> = Domain Name
WorkplaceXML (String)
Enter the XML to describe the workplace to be created. The
format for the XML is as follows:
<?xml version="1.0" ?>
<Workplaces>
<Workplace id="ID NAME">
<Workspace>
<Title>Title</Title>
<Description>Workplace Description</Description>
<URL>/Workplacename</URL>
<Template>template file name</Template>
<Language>1033</Language>
</Workspace>
</Workplace>
</Workplaces>
Modifiable DWP Properties
for Localization
XE "Localization:Workplace Wizard" XE "DWP Properties:Localization –
Workplace Wizard" XE "Translation:Workplace Wizard" XE "Language:Workplace Wizard"
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 language 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.
These properties 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.
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
(String)
This property allows you to localize the user interface. The easiest
way to use this property is to follow these steps:
1. Copy the sample code below into
Notepad and make the appropriate translations to the content between each tag.
2. Remove all of the carriage returns
and 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.
3. Export the web part you want to
localize and add this: <LCIDXML xmlns="webpart_namespace"><![CDATA[]]></LCIDXML> (where "webpart_namespace" is the web
part name identified in the .chm file included in the Developer and Small Business
editions of the Suite)
For example: <LCIDXML xmlns="CorasWSC.Workplace"><![CDATA[]]></LCIDXML>
4. Copy the modified LCIDXML content
from Step 2 and place it after the opening bracket after CDATA.
5. 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>
<WorkplaceWizard id="default">
<CreateWorkplace>Build It</CreateWorkplace>
<ReviewSettings>Review Settings</ReviewSettings>
<SelectWorkplace>Select Blueprint</SelectWorkplace>
<Status>STATUS:</Status>
<CannotCreateWorkplace>Error(s) found,
cannot be built.</CannotCreateWorkplace>
<YouMayNow>All settings OK, please
click "Build It."</YouMayNow>
<CouldNotCreate>Error(s) Found, Could
Not Create Workplace. Please delete any sites created, verify the Blueprint setup,
and try again. If you continue to experience errors, please see the manual instructions
for creating your Workplace.</CouldNotCreate>
<Congratulations>CONGRATULATIONS!!!
[REPLACENAME] Has Been Created.</Congratulations>
<PleaseSelect>Please Select a Blueprint.
|| Site URL, Site Title, and Site Description are optional parameters.</PleaseSelect>
<YouMust>You Must Be An Administrator.</YouMust>
<SiteURL>Site URL:</SiteURL>
<SiteTitle>Site Title:</SiteTitle>
<SiteDescription>Site Description:</SiteDescription>
<WorkplaceType>Blueprint:</WorkplaceType>
<Review>Review:</Review>
<Final>Final:</Final>
<FieldHeader>Field</FieldHeader>
<ResultHeader>Result</ResultHeader>
<StatusHeader>Status</StatusHeader>
<TitleRequired>Title Required.</TitleRequired>
<OK>OK</OK>
<Error>Error</Error>
<Completed>Completed</Completed>
<TemplateAlreadyApplied>Template Already
Applied, URL Unavailable, URL Required or URL Incorrect.</TemplateAlreadyApplied>
<TemplateNotFound>Template Not Found
or Template Required.</TemplateNotFound>
<SiteTemplate>Site Template:</SiteTemplate>
<SiteLanguage>Site Language:</SiteLanguage>
<LanguagePack>Language Pack Not Found
or Language Required.</LanguagePack>
<ErrorOccured>Error Occured, Please
Verify Blueprint, Delete Sites, and Try Again.</ErrorOccured>
<CustomizeTopLevel>Customize Top Level</CustomizeTopLevel>
</WorkplaceWizard>
</CorasWorks>
The CorasWorks node supports multiple Workplace Wizard 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 Workplace Wizard node has been defined,
otherwise, the Workplace Wizard 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
Troubleshooting
XE "Troubleshooting:Workplace Wizard" XE "FAQs:Workplace Wizard" XE "Errors:Workplace Wizard"
I receive an error when I click Review Settings.
This means that the URL you entered in the web part’s Site URL
field can not be understood, or that your blueprint is not formatted correctly.
To correct your Site URL, please go to the Site URL field and double-check how
you specified the URL. The format of the URL must be either http://Site-URL or http://Site-URL/Sub-Site-Name,
and must be a valid URL.
To correct your blueprint, make sure it is formatted as
follows, and that the referenced site template exists.
<?xml version="1.0" ?>
<Workplaces>
<Workplace id="ID NAME">
<Workspace>
<Title>Title</Title>
<Description>Workplace Description</Description>
<URL>/Workplacename</URL>
<Template>template file name</Template>
<Language>1033</Language>
</Workspace>
</Workplace>
</Workplaces>
Build Updates
The following updates have been made to the Workplace Wizard
since it was initially introduced.
Winter 2006 Update
· Modified to run as a web service
· Supports sites built from both http
and https URLs
· Modified to provide a status update
when finished building
Winter 2005
· Initial release