MOSS 2007
Windows Server 2003
Visual Studio 2008
SharePoint Extension for Visual Studio 2008

Setup

- In SharePoint, Set up two Document Libraries

• Source Document Library
• Destination Document Library

Instructions

- VS 2008/File/New/Project/Visual C#/Office/2007/SharePoint 2007 Sequential Workflow
- Name the Project
- OK

1st New Office SharePoint Workflow Dialog
- Keep name of Workflow
- Enter URL of the site contianing the Document Libraries ( ie, if the URL is http://localhost/Source Document Library, use http://localhost/ )
- Next

2nd New Office SharePoint Workflow Dialog
- [checked]Keep Automatically associate workflow (default)
- Library or List: Source Document Library
- History list: Workflow History (default)
- Taks list: Tasks (default)
- Next

3rd New Office SharePoint Workflow Dialog - Depends on what you are trying to accomplish
- [checked] Manually by others
- [checked] When an item is created
- [checked] When an item is changed
- Finish

- Double-click Workflow1.cs in Solution Explorer (if not already open)
- Click on onWorkflowActivated1
- In Properties, give the correlation token a name (something descriptive to the workflow)
- Expand CorrelationToken property. In the OwnerActivityName field, select Workflow1 from drop down. It’s Workflow1, which is the default name of the Workflow. If you change the name of your Workflow, you have to change this as well.

- From Toolbox, expand Windows Workflow v3.0
- Drag and drop the Code element under onWorkflowActivated1
- From Toolbox, expand SharePoint Workflow
- Drag and drop the LogToHistoryListActivity element under codeActivity1

- Double-click on onWorkflowActivated1 to open up the code window
- Add ‘public string logHistoryDescriptions;’ and ‘public string logHistoryOutcome;’ above the Workflow1 function
- Add ‘this.workflowId = workflowProperties.WorkflowId;’ in the onWorkflowActivated1_Invoked function

- On Workflow1.cs(Design), Double click the codeActivity1 to access the codeActivity1_ExecuteCode function
- Use the following code:

//Copy the document, using the same file name in the destination libarary
workflowProperties.Item.CopyTo(workflowProperties.Web.Url + “/” + “Destination Document Library/” + workflowProperties.Item.File.Name);

//log the activity
this.logHistoryDescriptions = “Attempted file copy of ” + workflowProperties.Item.File.Name +
” ” + “From: ” + workflowProperties.List.Title +
” ” + “To Destination Document Library”;

this.logHistoryOutcome = “Successful”;

- Click logToHistoryListActivity1 from the Workflow Design view
- On the properties screen, change the HistoryDescription property and the HistoryOutcome property.
- Select the HistoryDescription property (put your mouse in the empty text box beside it)
- Hit the ellipses control (will show up at the end of the empty text box. In the “Bind …. To an activity’s property” menu, choose logHistoryDescription which represents our internal variable (the one that we set in code).
- Do the same thing for the HistoryOutcome Property, choosing the logHistoryOutcome variable

- Build the project

- May possibly get Attach Security Warning dialog, Click Attach
- May get a Script Debugging Disabled dialog, Click Yes

- Project will open up the SharePoint site to the Source Document Library. The workflow should be automatically attached to the Source Document Library. If not, select Settings/Document Library Settings/Workflow Settings and attach the workflow.

∞

*These instructions assume you know how to create and deploy web parts using Visual Studio 2005 with SharePoint extensions.

Tools

Visual Studio 2005
SharePoint Extensions for Visual Studio 2005
WSPBuilder
STSADM Tool (C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\BIN) located on SharePoint Server with default installation

Set Up WSPBuilder

1. Download WSPBuilder if you haven’t already
2. Extract contents of zip file
3. Create a directory with the name you want for your master solution package
4. Move the following files from the extracted WSPBuilder directory to the master solution package directory:
 - WSPBuilder.exe
 - Mono.Cecil.dll
 - CabLib.dll
 - WSPBuilder.exe.config
5. For web part features, create a directory named GAC and a directory named 12 directly under the master solution package directory
6. Under the 12 directory, create a directory named TEMPLATE and a directory named FEATURES

The entire master solution structure at this point will look like this:

<Master Solution Package Name>
  <WSPBuilder.exe>
  <Mono.Cecil.dll>
  <CabLib.dll>
  <WSPBuilder.exe.config>
  <GAC>
  <12>
    <TEMPLATE>
    <FEATURES>

Create Web Part Solution Directories

1. Open the Visual Studio web part solution
2. Deploy the web part solution to your development SharePoint Server
3. Repeat for all web part solutions you want to be included in the master solution package

*The reason the web parts need to be deployed on your development SharePoint server is because it’s the only way to easily get the proper solution files needed for WSPBuilder.  It is possible to manually build these XML files but it’s much easier this way.  This only needs to be done once for each web part.  After the master solution package is built, you can simply update the .dll files in the GAC directory in your master solution package, rebuild and redeploy.  Details about this are in the steps below.

Remove Web Parts From the Development SharePoint Server

The steps in this section are optional if you choose not to test your master solution package on your development SharePoint server before deployment in the production environment.  It may not be a good idea to attempt this but it’s ultimately a matter of personal preference.

1. Deactivate Feature: stsadm -o deactivatefeature -name <webpartname> -url <site> -force
2. Uninstall Feature: stsadm -o uninstallfeature -name <webpartname> -force
3. Retract Solution: stsadm -o retractsolution -name <webpartname>.wsp -local -url <site>
4. Delete Solution: stsadm -o deletesolution -name <webpartname>.wsp
5. Repeat for all web part solutions you want to be included in the master solution package and were previously deployed

Add Web Part Solution Directories to Master Solution Package

1. Browse to the Visual Studio web part solution directory in Windows
2. Copy the directory <webpartname> located at bin/Debug/solution/ to <WSP Package Name>/12/TEMPLATE/FEATURES/
3. Copy the <webpartname>.dll from bin/Debug/solution/ to the <WSP Package Name>/GAC/
4. Repeat for all web part solutions you want to be included in the master solution package

The entire structure including a single web part feature will look like this:

<MasterSolutionPackageName>
  <WSPBuilder.exe>
  <Mono.Cecil.dll>
  <CabLib.dll>
  <WSPBuilder.exe.config>
  <GAC>
    <webpartname.dll>
  <12>
  <TEMPLATE>
    <FEATURES>
      <webpartname directory>
        <feature.xml>
        <webpartname directory>
          <webpartname.webpart>
          <webpartname.xml>

*It’s highly recommended that you take all files from the solution folder in each Visual Studio web part project for the initial build of master solution package, even though other copies of the files are available throughout the web part project.

Build Master Solution Package

1. Run WSPBuilder.exe in master solution directory.  It will produce two files, solutionid.txt and <mastersolutionpackagename>.wsp in the master solution directory.  The <mastersolutionpackagename>.wsp file is only file you’ll need.  It contains all of the XML files for each web part you chose to package as well as their associated .dll files.

Deploy Master Solution Package

As mentioned above, you may want to test this deployment on your development SharePoint server prior to attempting installation in the production environment.

1. Add Solution: stsadm -o addsolution -filename <C:/path/to/solution/<mastersolutionpackagename>.wsp>
2. Deploy Solution: stsadm -o deploysolution -name <mastersolutionpackagename>.wsp -url <siteurl> -local -allowgacdeployment

*When using the STSADM tool, file paths must not have spaces in them.  So it’s best to put solutions on the root of C: or somewhere close.

Activate Features Contained in Master Solution Package

Even though the master solution package is a single file, each web part contained within it needs to be activated as a feature on the SharePoint server.  Make sure you are activating the web part features that are in the master solution package and not the master solution package itself.  The activation of these features will only need to be done once unless, of course, they are deactivated.

1. Activate Feature: stsadm -o activatefeature -name <webpartname> -url <siteurl> -force
2. Repeat for all web part solutions included in the master solution package

Update Solution Package

As mentioned previously, the master solution package can be easily updated with new web parts or newer versions of web parts already contained within it.   To add new web parts, you’ll need add the solution directory for that web part to the package (steps above).  To update pre-existing web parts you only need to build your Visual Studio web part project, then copy the <webpartname>.dll file from the Debug directory of that project to the GAC directory of the master solution package.  Whether adding or updated a web part, you will need to run the WSPBuilder.exe file located at the root of your master solution package so that the changes are included in your final .wsp solution package file.

Delete Solution Package (should you need to)

stsadm -o retractsolution -name <solutionname>.wsp -url <siteurl> -local
stsadm -o deletesolution -name <solutionname>.wsp