SharePoint Action Framework (SAF) - extend Features, MSBuild or StsAdm.

Updated Wiki: Home

MarkQjones — Sun, 06 Jan 2013 17:40:18 GMT

Project Description
The SharePoint Action Framework is an extension to the SharePoint Feature framework, Stsadm or MSBuild. This is achived with Actions which are commands allowing automation of SharePoint (e.g. CreateWeb, AddUser, ImportList). Also possible to thread multiple Actions together.

Special Notice
If you are interested in discovering how to distribute and track policies and procedures in SharePoint - why not check out our policy management software called DocRead

Slide Deck
http://www.slideshare.net/MarkQJones/share-point-action-framework

Main Benefits of using SAF

Actions already available - SAF already includes some Actions (see below).
Integrate with existing methods - SAF Macros can be run from Features, STSAdm, MSbuild and soon WCF. In addition to this, purpose built Actions have been included allowing STSAdm and Powershell Commands to be called from within a Macro.
Develop your own Actions - If you don't see an Action in the list below, download SAF and create one, it's easy enough.
Parameterise your scripts - By using place holders statements like (e.g. ${CurrentWeb.Url}), would replace the Url of your current Web (at run time). (note. the current web, is the web you have activated your feature at, or the 'url' you pass in as an an argument at run time). Environment Variables are now supported!
Rollback supported - Each Action has a "Do" and also an "Undo", meaning you can rollback!! (Which is great during development and testing)
Extensive Logging - SAF includes LOTS of .Net Tracing statements, so you can monitor whats happening. (which is essential when running Features).
Adapters - Through the use of Adapters, you can run your Macros from either a Feature or STSAdm. (More on the way).
A common approach to writing 'tools' - SAF allows you to have a single approach to writing "tools" and "utilities" for SharePoint, meaning reuse should be higher and should also lower your TCO.

WSS Actions available in SAF

Action	Description	Example
AddLookupColumnToList	Creates a new <b>list</b>-scoped lookup column pointing to an existing list.	Download Quickstart
AddSiteColumnToContentType	Adds a site column to an existing content type.	Download Quickstart
AddSiteColumnToList	Adds a site column to an existing SharePoint list.	Download Quickstart
CreateLookupColumn	Creates a new <b>site</b>-scoped lookup column pointing to a field in an existing list.	Download Quickstart
EnsureSiteColumn	Adds or updates a SharePoint site column (allows the GUID to be specified for new columns).	Download Quickstart
ExportList	Exports a SharePoint list to a Content Migration Package (CMP) based on the web and list name.	Download Quickstart
ExportListItem	Exports a SharePoint list item to a Content Migration Package (CMP) based on the web, list name and list item ID.	Download Quickstart
ExportWeb	Exports a SharePoint web (SPWeb) to a Content Migration Package (CMP).	Download Quickstart
ImportList	Imports a lists items from a Content Migration Package (CMP).	Download Quickstart
ImportListItem	Imports a web (SPListItem) from a Content Migration Package (CMP).	Download Quickstart
ImportWeb	Imports a web (SPWeb) from a Content Migration Package (CMP).	Download Quickstart
AddContentTypeToList	Adds a specified content type to a SharePoint list.	Download Quickstart
EnsureContentType	Allows a content type to be added or updated in a SharePoint site.	Download Quickstart
SynchroniseContentTypes	Ensures that a child content type has the same columns (fields) as the parent content type.	Download Quickstart
AddFile	Adds a file to a list.	Download Quickstart
ApproveFiles	Approves a list of files contained within the list.	Download Quickstart
CheckInFiles	Checks in a list of files to one or more document libraries.	Download Quickstart
CheckOutFile	Used to check out a list of files in a one or more document libraries.	Download Quickstart
CopyFile	Copies a single file from a source list to a destination list (in SharePoint).	Download Quickstart
GetFiles	Reads the list of files (and urls) specified in the ListFileInfo, based on a List Name and Filter Pattern.	Download Quickstart
PublishFiles	Publishes a list of supplied files.	Download Quickstart
UpdateFileContent	Updates the file content in a list.	Download Quickstart
AddListItemEventReceiver	Adds a list event receiver to a SharePoint list.	Download Quickstart
DeleteList	Destroys (or recycles) a SharePoint list. Can also optionally delete data only.	Download Quickstart
ImportDataSetToList	Imports the given Dataset data into the list.	Download Quickstart
EnsurePropertyBagItems	Adds (or updates) a value in the relevant property bag. The web, site, web application and farm property bags can all be updated.	Download Quickstart
CreateUser	Creates a new user in the site (see documentation on SPWeb.SiteUsers) and can optionally make the user site collection admin.	Download Quickstart
CreateSite	Creates (or overwrites) a site collection (SPSite) in a web application.	Download Quickstart
CreateWeb	Creates a new web in a site collection.	Download Quickstart
SetMasterPage	Sets the current web master page. Can also (optionally) set child webs.	Download Quickstart
CreateWebApplication	Creates a new SharePoint web application.	Download Quickstart
ExtendWebApplication	Extends an existing web application in IIS.	Download Quickstart
AddWebParts	Allows multiple web parts to be added to a web part zone on a web part page.	Download Quickstart
ConnectWebParts	This action allows 2 web parts (provider and consumer) to be connected on a particular web part page.	Download Quickstart
RemoveWebParts	Allows multiple web parts to be removed from a web part page.	Download Quickstart
SetWebPartProperties	Sets the WebPart properties in a page.	Download Quickstart
StsAdmin	Allows a SQL Statement to be run against a database as specified by a supplied connection string.	Download Quickstart

MOSS Actions available in SAF :

Action	Description	Example
ShowInNavigation	Allows the current site to be included or excluded from the global and/or current navigation.	Download Quickstart
CreateRedirectPage	Creates a new redirect page using the standard SharePoint redirect page layout.	Download Quickstart
PublishPage	Attempts to publish a page in a SharePoint publishing 'Pages' library.	Download Quickstart
SetAvailablePageLayout	Adds or removes page layouts from the 'Available Page Layouts' collection in the current web.	Download Quickstart
SetAvailableSiteTemplates	Adds or removes site templates from the 'Available Site Templates' collection in the current web.	Download Quickstart
SetPageLayout	Updates a publishing page layout for a publishing page.	Download Quickstart
SetWelcomePage	Sets the 'Welcome Page' (default) page to a specific page in the 'Pages' library for the current publishing web.	Download Quickstart
UpdatePublishingPageFields	Adds or Updates a field to a specific page in the 'Pages' library for the current web.	Download Quickstart

Standard Actions available in SAF

Action	Description	Example
GetDataSetFromCSV	This action is responsible for getting a DataSet from a Comma Seperated File.	Download Quickstart
GetFiles	Gets a list of file names (with path) for the given criteria.	Download Quickstart
FtpUpload	This action will FTP one or many files to a destination FTP server.	Download Quickstart
ExecutePowershell	Allows 1 (or more) Powershell scripts to be run.	Download Quickstart
ExecuteSQL	Allows a SQL statement to be run against a database as specified by a supplied connection string.	Download Quickstart
NVelocity	This action requires a user defined collection and the name of an NVelocity Template, to create an instance of an outputted document.	Download Quickstart

Examples of Macros (multiple Actions)

To view more complex examples of a Macro illustrating how to chain together multiple Actions, please vist : SAF Macro examples

The Diagram below illustrates the high-level architecture for SAF

Updated Wiki: Home

MarkQjones — Sun, 06 Jan 2013 17:36:16 GMT

Actions already available - SAF already includes some Actions (see below).
Integrate with existing methods - SAF Macros can be run from Features, STSAdm, MSbuild and soon WCF. In addition to this, purpose built Actions have been included allowing STSAdm and Powershell Commands to be called from within a Macro.
Develop your own Actions - If you don't see an Action in the list below, download SAF and create one, it's easy enough.
Parameterise your scripts - By using place holders statements like (e.g. ${CurrentWeb.Url}), would replace the Url of your current Web (at run time). (note. the current web, is the web you have activated your feature at, or the 'url' you pass in as an an argument at run time). Environment Variables are now supported!
Rollback supported - Each Action has a "Do" and also an "Undo", meaning you can rollback!! (Which is great during development and testing)
Extensive Logging - SAF includes LOTS of .Net Tracing statements, so you can monitor whats happening. (which is essential when running Features).
Adapters - Through the use of Adapters, you can run your Macros from either a Feature or STSAdm. (More on the way).
A common approach to writing 'tools' - SAF allows you to have a single approach to writing "tools" and "utilities" for SharePoint, meaning reuse should be higher and should also lower your TCO.

WSS Actions available in SAF

Action	Description	Example
AddLookupColumnToList	Creates a new <b>list</b>-scoped lookup column pointing to an existing list.	Download Quickstart
AddSiteColumnToContentType	Adds a site column to an existing content type.	Download Quickstart
AddSiteColumnToList	Adds a site column to an existing SharePoint list.	Download Quickstart
CreateLookupColumn	Creates a new <b>site</b>-scoped lookup column pointing to a field in an existing list.	Download Quickstart
EnsureSiteColumn	Adds or updates a SharePoint site column (allows the GUID to be specified for new columns).	Download Quickstart
ExportList	Exports a SharePoint list to a Content Migration Package (CMP) based on the web and list name.	Download Quickstart
ExportListItem	Exports a SharePoint list item to a Content Migration Package (CMP) based on the web, list name and list item ID.	Download Quickstart
ExportWeb	Exports a SharePoint web (SPWeb) to a Content Migration Package (CMP).	Download Quickstart
ImportList	Imports a lists items from a Content Migration Package (CMP).	Download Quickstart
ImportListItem	Imports a web (SPListItem) from a Content Migration Package (CMP).	Download Quickstart
ImportWeb	Imports a web (SPWeb) from a Content Migration Package (CMP).	Download Quickstart
AddContentTypeToList	Adds a specified content type to a SharePoint list.	Download Quickstart
EnsureContentType	Allows a content type to be added or updated in a SharePoint site.	Download Quickstart
SynchroniseContentTypes	Ensures that a child content type has the same columns (fields) as the parent content type.	Download Quickstart
AddFile	Adds a file to a list.	Download Quickstart
ApproveFiles	Approves a list of files contained within the list.	Download Quickstart
CheckInFiles	Checks in a list of files to one or more document libraries.	Download Quickstart
CheckOutFile	Used to check out a list of files in a one or more document libraries.	Download Quickstart
CopyFile	Copies a single file from a source list to a destination list (in SharePoint).	Download Quickstart
GetFiles	Reads the list of files (and urls) specified in the ListFileInfo, based on a List Name and Filter Pattern.	Download Quickstart
PublishFiles	Publishes a list of supplied files.	Download Quickstart
UpdateFileContent	Updates the file content in a list.	Download Quickstart
AddListItemEventReceiver	Adds a list event receiver to a SharePoint list.	Download Quickstart
DeleteList	Destroys (or recycles) a SharePoint list. Can also optionally delete data only.	Download Quickstart
ImportDataSetToList	Imports the given Dataset data into the list.	Download Quickstart
EnsurePropertyBagItems	Adds (or updates) a value in the relevant property bag. The web, site, web application and farm property bags can all be updated.	Download Quickstart
CreateUser	Creates a new user in the site (see documentation on SPWeb.SiteUsers) and can optionally make the user site collection admin.	Download Quickstart
CreateSite	Creates (or overwrites) a site collection (SPSite) in a web application.	Download Quickstart
CreateWeb	Creates a new web in a site collection.	Download Quickstart
SetMasterPage	Sets the current web master page. Can also (optionally) set child webs.	Download Quickstart
CreateWebApplication	Creates a new SharePoint web application.	Download Quickstart
ExtendWebApplication	Extends an existing web application in IIS.	Download Quickstart
AddWebParts	Allows multiple web parts to be added to a web part zone on a web part page.	Download Quickstart
ConnectWebParts	This action allows 2 web parts (provider and consumer) to be connected on a particular web part page.	Download Quickstart
RemoveWebParts	Allows multiple web parts to be removed from a web part page.	Download Quickstart
SetWebPartProperties	Sets the WebPart properties in a page.	Download Quickstart
StsAdmin	Allows a SQL Statement to be run against a database as specified by a supplied connection string.	Download Quickstart

MOSS Actions available in SAF :

Action	Description	Example
ShowInNavigation	Allows the current site to be included or excluded from the global and/or current navigation.	Download Quickstart
CreateRedirectPage	Creates a new redirect page using the standard SharePoint redirect page layout.	Download Quickstart
PublishPage	Attempts to publish a page in a SharePoint publishing 'Pages' library.	Download Quickstart
SetAvailablePageLayout	Adds or removes page layouts from the 'Available Page Layouts' collection in the current web.	Download Quickstart
SetAvailableSiteTemplates	Adds or removes site templates from the 'Available Site Templates' collection in the current web.	Download Quickstart
SetPageLayout	Updates a publishing page layout for a publishing page.	Download Quickstart
SetWelcomePage	Sets the 'Welcome Page' (default) page to a specific page in the 'Pages' library for the current publishing web.	Download Quickstart
UpdatePublishingPageFields	Adds or Updates a field to a specific page in the 'Pages' library for the current web.	Download Quickstart

Standard Actions available in SAF

Action	Description	Example
GetDataSetFromCSV	This action is responsible for getting a DataSet from a Comma Seperated File.	Download Quickstart
GetFiles	Gets a list of file names (with path) for the given criteria.	Download Quickstart
FtpUpload	This action will FTP one or many files to a destination FTP server.	Download Quickstart
ExecutePowershell	Allows 1 (or more) Powershell scripts to be run.	Download Quickstart
ExecuteSQL	Allows a SQL statement to be run against a database as specified by a supplied connection string.	Download Quickstart
NVelocity	This action requires a user defined collection and the name of an NVelocity Template, to create an instance of an outputted document.	Download Quickstart

Source code checked in, #76924

Project Collection Service Accounts — Mon, 01 Oct 2012 21:29:18 GMT

Upgrade: New Version of LabDefaultTemplate.xaml. To upgrade your build definitions, please visit the following link: http://go.microsoft.com/fwlink/?LinkId=254563

Source code checked in, #76923

Project Collection Service Accounts — Mon, 01 Oct 2012 21:23:54 GMT

Checked in by server upgrade

Updated Wiki: Home

MarkQjones — Sun, 25 Mar 2012 11:11:50 GMT

Actions already available - SAF already includes some Actions (see below).
Integrate with existing methods - SAF Macros can be run from Features, STSAdm, MSbuild and soon WCF. In addition to this, purpose built Actions have been included allowing STSAdm and Powershell Commands to be called from within a Macro.
Develop your own Actions - If you don't see an Action in the list below, download SAF and create one, it's easy enough.
Parameterise your scripts - By using place holders statements like (e.g. ${CurrentWeb.Url}), would replace the Url of your current Web (at run time). (note. the current web, is the web you have activated your feature at, or the 'url' you pass in as an an argument at run time). Environment Variables are now supported!
Rollback supported - Each Action has a "Do" and also an "Undo", meaning you can rollback!! (Which is great during development and testing)
Extensive Logging - SAF includes LOTS of .Net Tracing statements, so you can monitor whats happening. (which is essential when running Features).
Adapters - Through the use of Adapters, you can run your Macros from either a Feature or STSAdm. (More on the way).
A common approach to writing 'tools' - SAF allows you to have a single approach to writing "tools" and "utilities" for SharePoint, meaning reuse should be higher and should also lower your TCO.

WSS Actions available in SAF

Action	Description	Example
AddLookupColumnToList	Creates a new <b>list</b>-scoped lookup column pointing to an existing list.	Download Quickstart
AddSiteColumnToContentType	Adds a site column to an existing content type.	Download Quickstart
AddSiteColumnToList	Adds a site column to an existing SharePoint list.	Download Quickstart
CreateLookupColumn	Creates a new <b>site</b>-scoped lookup column pointing to a field in an existing list.	Download Quickstart
EnsureSiteColumn	Adds or updates a SharePoint site column (allows the GUID to be specified for new columns).	Download Quickstart
ExportList	Exports a SharePoint list to a Content Migration Package (CMP) based on the web and list name.	Download Quickstart
ExportListItem	Exports a SharePoint list item to a Content Migration Package (CMP) based on the web, list name and list item ID.	Download Quickstart
ExportWeb	Exports a SharePoint web (SPWeb) to a Content Migration Package (CMP).	Download Quickstart
ImportList	Imports a lists items from a Content Migration Package (CMP).	Download Quickstart
ImportListItem	Imports a web (SPListItem) from a Content Migration Package (CMP).	Download Quickstart
ImportWeb	Imports a web (SPWeb) from a Content Migration Package (CMP).	Download Quickstart
AddContentTypeToList	Adds a specified content type to a SharePoint list.	Download Quickstart
EnsureContentType	Allows a content type to be added or updated in a SharePoint site.	Download Quickstart
SynchroniseContentTypes	Ensures that a child content type has the same columns (fields) as the parent content type.	Download Quickstart
AddFile	Adds a file to a list.	Download Quickstart
ApproveFiles	Approves a list of files contained within the list.	Download Quickstart
CheckInFiles	Checks in a list of files to one or more document libraries.	Download Quickstart
CheckOutFile	Used to check out a list of files in a one or more document libraries.	Download Quickstart
CopyFile	Copies a single file from a source list to a destination list (in SharePoint).	Download Quickstart
GetFiles	Reads the list of files (and urls) specified in the ListFileInfo, based on a List Name and Filter Pattern.	Download Quickstart
PublishFiles	Publishes a list of supplied files.	Download Quickstart
UpdateFileContent	Updates the file content in a list.	Download Quickstart
AddListItemEventReceiver	Adds a list event receiver to a SharePoint list.	Download Quickstart
DeleteList	Destroys (or recycles) a SharePoint list. Can also optionally delete data only.	Download Quickstart
ImportDataSetToList	Imports the given Dataset data into the list.	Download Quickstart
EnsurePropertyBagItems	Adds (or updates) a value in the relevant property bag. The web, site, web application and farm property bags can all be updated.	Download Quickstart
CreateUser	Creates a new user in the site (see documentation on SPWeb.SiteUsers) and can optionally make the user site collection admin.	Download Quickstart
CreateSite	Creates (or overwrites) a site collection (SPSite) in a web application.	Download Quickstart
CreateWeb	Creates a new web in a site collection.	Download Quickstart
SetMasterPage	Sets the current web master page. Can also (optionally) set child webs.	Download Quickstart
CreateWebApplication	Creates a new SharePoint web application.	Download Quickstart
ExtendWebApplication	Extends an existing web application in IIS.	Download Quickstart
AddWebParts	Allows multiple web parts to be added to a web part zone on a web part page.	Download Quickstart
ConnectWebParts	This action allows 2 web parts (provider and consumer) to be connected on a particular web part page.	Download Quickstart
RemoveWebParts	Allows multiple web parts to be removed from a web part page.	Download Quickstart
SetWebPartProperties	Sets the WebPart properties in a page.	Download Quickstart
StsAdmin	Allows a SQL Statement to be run against a database as specified by a supplied connection string.	Download Quickstart

MOSS Actions available in SAF :

Action	Description	Example
ShowInNavigation	Allows the current site to be included or excluded from the global and/or current navigation.	Download Quickstart
CreateRedirectPage	Creates a new redirect page using the standard SharePoint redirect page layout.	Download Quickstart
PublishPage	Attempts to publish a page in a SharePoint publishing 'Pages' library.	Download Quickstart
SetAvailablePageLayout	Adds or removes page layouts from the 'Available Page Layouts' collection in the current web.	Download Quickstart
SetAvailableSiteTemplates	Adds or removes site templates from the 'Available Site Templates' collection in the current web.	Download Quickstart
SetPageLayout	Updates a publishing page layout for a publishing page.	Download Quickstart
SetWelcomePage	Sets the 'Welcome Page' (default) page to a specific page in the 'Pages' library for the current publishing web.	Download Quickstart
UpdatePublishingPageFields	Adds or Updates a field to a specific page in the 'Pages' library for the current web.	Download Quickstart

Standard Actions available in SAF

Action	Description	Example
GetDataSetFromCSV	This action is responsible for getting a DataSet from a Comma Seperated File.	Download Quickstart
GetFiles	Gets a list of file names (with path) for the given criteria.	Download Quickstart
FtpUpload	This action will FTP one or many files to a destination FTP server.	Download Quickstart
ExecutePowershell	Allows 1 (or more) Powershell scripts to be run.	Download Quickstart
ExecuteSQL	Allows a SQL statement to be run against a database as specified by a supplied connection string.	Download Quickstart
NVelocity	This action requires a user defined collection and the name of an NVelocity Template, to create an instance of an outputted document.	Download Quickstart

New Post: Export /Import maintains the links integrity.

amit_ary — Wed, 22 Jun 2011 15:20:13 GMT

Scenario, I am changing my server & also the site heirarchy of SharePoint sites.

So, Is it possible to use ExportWeb & ImportWeb ?

And the ImportWeb would handle the change in links/hyperlinks/references inside dufferent SP objects like files, lists, javascipt etc?

New Post: Is this in Active Development?

MarkQjones — Thu, 12 May 2011 05:49:29 GMT

yes. i have a version working on 2010. just never checked it into TFS on codeplex. takes a while for a couple of reasons.

what are your plans to for it ?

On 11 May 2011, at 15:46, "AchimO" <notifications@codeplex.com> wrote:

From: AchimO

Hi, Mark,

I really would like to see this on Sp2010. So if ever you can spare the time, please upload.

Thank you!

Achim

New Post: Is this in Active Development?

AchimO — Wed, 11 May 2011 14:46:28 GMT

Hi, Mark,

I really would like to see this on Sp2010. So if ever you can spare the time, please upload.

Thank you!

Achim

New Post: Is this in Active Development?

MarkQJones — Thu, 31 Mar 2011 16:04:19 GMT

Yes it's still active and I do have a version that works well on SP2010. However, I haven't had time to upload it yet, but it's stable and been tested by a few companies now. If you are really interested in using it, I will upload (takes a few hours my side).

Many thanks

Mark

New Post: Is this in Active Development?

anandm — Thu, 31 Mar 2011 12:45:34 GMT

I dont see any activity from source code side or discussions. Is this still being actively developed and extended to support SharePoint 2010?

Source code checked in, #49966

_TFSSERVICE — Mon, 19 Jul 2010 20:19:27 GMT

Checked in by server upgrade

New Post: Compatible with SharePoint 2010?

MarkQjones — Mon, 19 Jul 2010 19:56:04 GMT

No worries - SP 2010 is deffo on the roadmap as I am currently building a GUI that will make it a breeze to configure and run Actions.

New Post: Compatible with SharePoint 2010?

mcolong — Mon, 19 Jul 2010 19:54:31 GMT

Thanks for the quick response, I'll be sure to check out the samples. Thanks ;)

New Post: Compatible with SharePoint 2010?

MarkQjones — Mon, 19 Jul 2010 19:52:22 GMT

I am testing it in between tasks - the Actions look to be 98% compatible, but it is going to need some work. Hence, for now, it isn't - sorry.

SAF can be used from a Feature / MSBuild Task, or StsAdm - whatever fits best for you. Please check out all the samples here : http://www.collaboris.co.uk/saf/doc/

If you click on Action there should be samples of how to run each Action.

Give me a shout if you need any help!

New Post: Compatible with SharePoint 2010?

mcolong — Mon, 19 Jul 2010 19:45:02 GMT

Hi, I just wanted to know if the SAF is compatible with SharePoint 2010, as it failed to complete the install.bat (I had changed the STSADM path in the bat file). Also, in my SharePoint 2007 environment it installed successfully, but how do I use it? Is it a feature you activate at farm/site level? Or is the SAF only to be used via the STSADM tool?

Reviewed: SAF 2.0.3900.09 (Jul 14, 2010)

mcolong — Wed, 14 Jul 2010 20:02:05 GMT

Rated 3 Stars (out of 5) - Is this compatible for SharePoint 2010? I ran the install.bat to install, but it just hangs. Oh, and I followed the install instructions to change the path where stsadm is.

Reviewed: SAF 2.0.3900.09 (Jul 14, 2010)

mcolong — Wed, 14 Jul 2010 19:53:09 GMT

Rated 3 Stars (out of 5) - Is this compatible for SharePoint 2010? I ran the install.bat to install, but it just hangs.

New Post: New Action Requests here....

MarkQJones — Wed, 03 Mar 2010 17:36:05 GMT

Security

Create Permission Level
Update Permission Level
Remove Permission Level
Break Inheritance on List
Break Inheritance on List Item
Break Inheritance on Web
Add Group
Add List Role Assignment
Add Web Role Assignment
Remove Group
Remove List Role Assignment
Remove Web Role Assignment
Delete Role

Updated Wiki: Home

MarkQjones — Tue, 02 Mar 2010 21:30:45 GMT

Project Description
The SharePoint Action Framework is an extension to the SharePoint Feature framework, Stsadm or MSBuild. This is achived with Actions which are commands allowing automation of SharePoint (e.g. CreateWeb, AddUser, ImportList). Also possible to thread multiple Actions together.

Installation Instructions
To install or upgrade the SAF WSP, please read this : http://www.collaboris.co.uk/Projects/SafWiki/SAF_WIKI/Installing_SAF.aspx

SAF Wiki
For the latest blog posts about SAF, please go here : http://www.collaboris.co.uk/Projects/SafWiki/SAF_WIKI/Contents_Page.aspx

Slide Deck
http://www.slideshare.net/MarkQJones/share-point-action-framework

Main Benefits of using SAF

Actions already available - SAF already includes some Actions (see below).
Integrate with existing methods - SAF Macros can be run from Features, STSAdm, MSbuild and soon WCF. In addition to this, purpose built Actions have been included allowing STSAdm and Powershell Commands to be called from within a Macro.
Develop your own Actions - If you don't see an Action in the list below, download SAF and create one, it's easy enough.
Parameterise your scripts - By using place holders statements like (e.g. ${CurrentWeb.Url}), would replace the Url of your current Web (at run time). (note. the current web, is the web you have activated your feature at, or the 'url' you pass in as an an argument at run time). Environment Variables are now supported!
Rollback supported - Each Action has a "Do" and also an "Undo", meaning you can rollback!! (Which is great during development and testing)
Extensive Logging - SAF includes LOTS of .Net Tracing statements, so you can monitor whats happening. (which is essential when running Features).
Adapters - Through the use of Adapters, you can run your Macros from either a Feature or STSAdm. (More on the way).
A common approach to writing 'tools' - SAF allows you to have a single approach to writing "tools" and "utilities" for SharePoint, meaning reuse should be higher and should also lower your TCO.

WSS Actions available in SAF

Action	Description	Example
AddLookupColumnToList	Creates a new <b>list</b>-scoped lookup column pointing to an existing list.	Download Quickstart
AddSiteColumnToContentType	Adds a site column to an existing content type.	Download Quickstart
AddSiteColumnToList	Adds a site column to an existing SharePoint list.	Download Quickstart
CreateLookupColumn	Creates a new <b>site</b>-scoped lookup column pointing to a field in an existing list.	Download Quickstart
EnsureSiteColumn	Adds or updates a SharePoint site column (allows the GUID to be specified for new columns).	Download Quickstart
ExportList	Exports a SharePoint list to a Content Migration Package (CMP) based on the web and list name.	Download Quickstart
ExportListItem	Exports a SharePoint list item to a Content Migration Package (CMP) based on the web, list name and list item ID.	Download Quickstart
ExportWeb	Exports a SharePoint web (SPWeb) to a Content Migration Package (CMP).	Download Quickstart
ImportList	Imports a lists items from a Content Migration Package (CMP).	Download Quickstart
ImportListItem	Imports a web (SPListItem) from a Content Migration Package (CMP).	Download Quickstart
ImportWeb	Imports a web (SPWeb) from a Content Migration Package (CMP).	Download Quickstart
AddContentTypeToList	Adds a specified content type to a SharePoint list.	Download Quickstart
EnsureContentType	Allows a content type to be added or updated in a SharePoint site.	Download Quickstart
SynchroniseContentTypes	Ensures that a child content type has the same columns (fields) as the parent content type.	Download Quickstart
AddFile	Adds a file to a list.	Download Quickstart
ApproveFiles	Approves a list of files contained within the list.	Download Quickstart
CheckInFiles	Checks in a list of files to one or more document libraries.	Download Quickstart
CheckOutFile	Used to check out a list of files in a one or more document libraries.	Download Quickstart
CopyFile	Copies a single file from a source list to a destination list (in SharePoint).	Download Quickstart
GetFiles	Reads the list of files (and urls) specified in the ListFileInfo, based on a List Name and Filter Pattern.	Download Quickstart
PublishFiles	Publishes a list of supplied files.	Download Quickstart
UpdateFileContent	Updates the file content in a list.	Download Quickstart
AddListItemEventReceiver	Adds a list event receiver to a SharePoint list.	Download Quickstart
DeleteList	Destroys (or recycles) a SharePoint list. Can also optionally delete data only.	Download Quickstart
ImportDataSetToList	Imports the given Dataset data into the list.	Download Quickstart
EnsurePropertyBagItems	Adds (or updates) a value in the relevant property bag. The web, site, web application and farm property bags can all be updated.	Download Quickstart
CreateUser	Creates a new user in the site (see documentation on SPWeb.SiteUsers) and can optionally make the user site collection admin.	Download Quickstart
CreateSite	Creates (or overwrites) a site collection (SPSite) in a web application.	Download Quickstart
CreateWeb	Creates a new web in a site collection.	Download Quickstart
SetMasterPage	Sets the current web master page. Can also (optionally) set child webs.	Download Quickstart
CreateWebApplication	Creates a new SharePoint web application.	Download Quickstart
ExtendWebApplication	Extends an existing web application in IIS.	Download Quickstart
AddWebParts	Allows multiple web parts to be added to a web part zone on a web part page.	Download Quickstart
ConnectWebParts	This action allows 2 web parts (provider and consumer) to be connected on a particular web part page.	Download Quickstart
RemoveWebParts	Allows multiple web parts to be removed from a web part page.	Download Quickstart
SetWebPartProperties	Sets the WebPart properties in a page.	Download Quickstart
StsAdmin	Allows a SQL Statement to be run against a database as specified by a supplied connection string.	Download Quickstart

MOSS Actions available in SAF :

Action	Description	Example
ShowInNavigation	Allows the current site to be included or excluded from the global and/or current navigation.	Download Quickstart
CreateRedirectPage	Creates a new redirect page using the standard SharePoint redirect page layout.	Download Quickstart
PublishPage	Attempts to publish a page in a SharePoint publishing 'Pages' library.	Download Quickstart
SetAvailablePageLayout	Adds or removes page layouts from the 'Available Page Layouts' collection in the current web.	Download Quickstart
SetAvailableSiteTemplates	Adds or removes site templates from the 'Available Site Templates' collection in the current web.	Download Quickstart
SetPageLayout	Updates a publishing page layout for a publishing page.	Download Quickstart
SetWelcomePage	Sets the 'Welcome Page' (default) page to a specific page in the 'Pages' library for the current publishing web.	Download Quickstart
UpdatePublishingPageFields	Adds or Updates a field to a specific page in the 'Pages' library for the current web.	Download Quickstart

Standard Actions available in SAF

Action	Description	Example
GetDataSetFromCSV	This action is responsible for getting a DataSet from a Comma Seperated File.	Download Quickstart
GetFiles	Gets a list of file names (with path) for the given criteria.	Download Quickstart
FtpUpload	This action will FTP one or many files to a destination FTP server.	Download Quickstart
ExecutePowershell	Allows 1 (or more) Powershell scripts to be run.	Download Quickstart
ExecuteSQL	Allows a SQL statement to be run against a database as specified by a supplied connection string.	Download Quickstart
NVelocity	This action requires a user defined collection and the name of an NVelocity Template, to create an instance of an outputted document.	Download Quickstart

Updated Wiki: Home

MarkQjones — Tue, 02 Mar 2010 21:30:11 GMT

Project Description
The SharePoint Action Framework is an extension to the SharePoint Feature framework, Stsadm or MSBuild. This is achived with Actions which are commands allowing automation of SharePoint (e.g. CreateWeb, AddUser, ImportList). Also possible to thread multiple Actions together.

Installation Instructions
To install or upgrade the SAF WSP, please read this : http://www.collaboris.co.uk/Projects/SafWiki/SAF_WIKI/Installing_SAF.aspx

SAF Wiki
For the latest blog posts about SAF, please go here : http://www.collaboris.co.uk/Projects/SafWiki/SAF_WIKI/Contents_Page.aspx

Slide Deck
Slide Deck:http://www.slideshare.net/MarkQJones/share-point-action-framework

Main Benefits of using SAF

Actions already available - SAF already includes some Actions (see below).
Integrate with existing methods - SAF Macros can be run from Features, STSAdm, MSbuild and soon WCF. In addition to this, purpose built Actions have been included allowing STSAdm and Powershell Commands to be called from within a Macro.
Develop your own Actions - If you don't see an Action in the list below, download SAF and create one, it's easy enough.
Parameterise your scripts - By using place holders statements like (e.g. ${CurrentWeb.Url}), would replace the Url of your current Web (at run time). (note. the current web, is the web you have activated your feature at, or the 'url' you pass in as an an argument at run time). Environment Variables are now supported!
Rollback supported - Each Action has a "Do" and also an "Undo", meaning you can rollback!! (Which is great during development and testing)
Extensive Logging - SAF includes LOTS of .Net Tracing statements, so you can monitor whats happening. (which is essential when running Features).
Adapters - Through the use of Adapters, you can run your Macros from either a Feature or STSAdm. (More on the way).
A common approach to writing 'tools' - SAF allows you to have a single approach to writing "tools" and "utilities" for SharePoint, meaning reuse should be higher and should also lower your TCO.

WSS Actions available in SAF

Action	Description	Example
AddLookupColumnToList	Creates a new <b>list</b>-scoped lookup column pointing to an existing list.	Download Quickstart
AddSiteColumnToContentType	Adds a site column to an existing content type.	Download Quickstart
AddSiteColumnToList	Adds a site column to an existing SharePoint list.	Download Quickstart
CreateLookupColumn	Creates a new <b>site</b>-scoped lookup column pointing to a field in an existing list.	Download Quickstart
EnsureSiteColumn	Adds or updates a SharePoint site column (allows the GUID to be specified for new columns).	Download Quickstart
ExportList	Exports a SharePoint list to a Content Migration Package (CMP) based on the web and list name.	Download Quickstart
ExportListItem	Exports a SharePoint list item to a Content Migration Package (CMP) based on the web, list name and list item ID.	Download Quickstart
ExportWeb	Exports a SharePoint web (SPWeb) to a Content Migration Package (CMP).	Download Quickstart
ImportList	Imports a lists items from a Content Migration Package (CMP).	Download Quickstart
ImportListItem	Imports a web (SPListItem) from a Content Migration Package (CMP).	Download Quickstart
ImportWeb	Imports a web (SPWeb) from a Content Migration Package (CMP).	Download Quickstart
AddContentTypeToList	Adds a specified content type to a SharePoint list.	Download Quickstart
EnsureContentType	Allows a content type to be added or updated in a SharePoint site.	Download Quickstart
SynchroniseContentTypes	Ensures that a child content type has the same columns (fields) as the parent content type.	Download Quickstart
AddFile	Adds a file to a list.	Download Quickstart
ApproveFiles	Approves a list of files contained within the list.	Download Quickstart
CheckInFiles	Checks in a list of files to one or more document libraries.	Download Quickstart
CheckOutFile	Used to check out a list of files in a one or more document libraries.	Download Quickstart
CopyFile	Copies a single file from a source list to a destination list (in SharePoint).	Download Quickstart
GetFiles	Reads the list of files (and urls) specified in the ListFileInfo, based on a List Name and Filter Pattern.	Download Quickstart
PublishFiles	Publishes a list of supplied files.	Download Quickstart
UpdateFileContent	Updates the file content in a list.	Download Quickstart
AddListItemEventReceiver	Adds a list event receiver to a SharePoint list.	Download Quickstart
DeleteList	Destroys (or recycles) a SharePoint list. Can also optionally delete data only.	Download Quickstart
ImportDataSetToList	Imports the given Dataset data into the list.	Download Quickstart
EnsurePropertyBagItems	Adds (or updates) a value in the relevant property bag. The web, site, web application and farm property bags can all be updated.	Download Quickstart
CreateUser	Creates a new user in the site (see documentation on SPWeb.SiteUsers) and can optionally make the user site collection admin.	Download Quickstart
CreateSite	Creates (or overwrites) a site collection (SPSite) in a web application.	Download Quickstart
CreateWeb	Creates a new web in a site collection.	Download Quickstart
SetMasterPage	Sets the current web master page. Can also (optionally) set child webs.	Download Quickstart
CreateWebApplication	Creates a new SharePoint web application.	Download Quickstart
ExtendWebApplication	Extends an existing web application in IIS.	Download Quickstart
AddWebParts	Allows multiple web parts to be added to a web part zone on a web part page.	Download Quickstart
ConnectWebParts	This action allows 2 web parts (provider and consumer) to be connected on a particular web part page.	Download Quickstart
RemoveWebParts	Allows multiple web parts to be removed from a web part page.	Download Quickstart
SetWebPartProperties	Sets the WebPart properties in a page.	Download Quickstart
StsAdmin	Allows a SQL Statement to be run against a database as specified by a supplied connection string.	Download Quickstart

MOSS Actions available in SAF :

Action	Description	Example
ShowInNavigation	Allows the current site to be included or excluded from the global and/or current navigation.	Download Quickstart
CreateRedirectPage	Creates a new redirect page using the standard SharePoint redirect page layout.	Download Quickstart
PublishPage	Attempts to publish a page in a SharePoint publishing 'Pages' library.	Download Quickstart
SetAvailablePageLayout	Adds or removes page layouts from the 'Available Page Layouts' collection in the current web.	Download Quickstart
SetAvailableSiteTemplates	Adds or removes site templates from the 'Available Site Templates' collection in the current web.	Download Quickstart
SetPageLayout	Updates a publishing page layout for a publishing page.	Download Quickstart
SetWelcomePage	Sets the 'Welcome Page' (default) page to a specific page in the 'Pages' library for the current publishing web.	Download Quickstart
UpdatePublishingPageFields	Adds or Updates a field to a specific page in the 'Pages' library for the current web.	Download Quickstart

Standard Actions available in SAF

Action	Description	Example
GetDataSetFromCSV	This action is responsible for getting a DataSet from a Comma Seperated File.	Download Quickstart
GetFiles	Gets a list of file names (with path) for the given criteria.	Download Quickstart
FtpUpload	This action will FTP one or many files to a destination FTP server.	Download Quickstart
ExecutePowershell	Allows 1 (or more) Powershell scripts to be run.	Download Quickstart
ExecuteSQL	Allows a SQL statement to be run against a database as specified by a supplied connection string.	Download Quickstart
NVelocity	This action requires a user defined collection and the name of an NVelocity Template, to create an instance of an outputted document.	Download Quickstart