Description

This program is a console application designed for synchronization of SharePoint content site with files on your hard disk. The program can operate in three modes: checkout (downloading files from SharePoint-site to your hard drive), update (update files on your hard drive) and commit (upload data from your hard drive to the site). In addition, if an optional parameter -overwrite existing files will be overwritten, regardless of their existence and the date changes. WssSync allows the user if necessary to specify username (possibly together with the domain name) and password under which the operation will be performed with files on the site.

Often a situation arises when the user does not need to synchronize all the files, but only some. Therefore WssSync provides an opportunity to set rules for content filtering (for more details about filter rules, see below). The first time you perform an operation-checkout in the working folder, the application creates a file WssSync.options, which stores the entered Url site and the rules for content filtering.

Running

To run the program you must enter the following:
WssSync -commit|-update|-checkout [-url=<siteUrl>] 
[-dir=<local_directory>] [-username=<user_name>] [-password=<password>]
[-overwrite]


Let us examine each of the parameters in more detail:
  • Operators (If none of the operations is not specified, an error occurs)
    • Checkout: Download files from a folder on your hard disk. If the file on your hard disk already exists, it will not be overwritten.
    • update: Update files on your hard drive and add the missing. If the version of the file on your hard drive newer, it will not be overwritten.
    • commit: Download files from the hard drive to the site and update existing files on the site. If the file version on the site over the new, it will not be overwritten.
  • url: URL (or folder of the site), which is synchronized. After the first operation - checkout WssSync.options stored in a file and then you can not ask. This is a mandatory parameter.
  • dir: The path to a folder on your hard drive. By default, the current folder of the application.
  • overwrite: If this option is to overwrite files regardless of their version and that, if they existed previously.
  • username and password: username and password under which the operations are performed with the files on the site.

Content Filtering

WssSync all filters are divided into two categories: AllowFilters and IgnoreFilters.
  • AllowFilters specify which files will be processed by our program (no other files will not be processed). If none of these filters is not specified, then our program will process all the files.
  • IgnoreFilters determine which files (already passed through AllowFilters) will not be processed. If none of IgnoreFilters not specified, will be processed all the files that are not screened out through the past AllowFilters.

Sami filters are of three different types: Extension, Folder and Regexp.
  • Extension: filter files by their extension. Example: <Extension>.aspx;.css;.jpg</Extension>
  • Folder: filter files by their location in specific folders. Takes a path expression to the files on the current veby. In ways, the separator can be used as a symbol / and the \ character. The symbol "." Refers to the root folder veby. Example: <Folder>/_catalogs/masterpage; Documents\Forms;.;</Folder>
  • Regexp: filter the files that are on the way veby satisfies the specified regular expressions. Example: <Regexp>.\.aspx;.\.xml</Regexp>

Filters of the same type can be recorded in the individual tags, or in the same tag in character ";". Thus, the following two entries are equivalent:
<Extension>.aspx; .css; .jpg</Extension>
And
<Extension>.aspx</Extension>
<Extension>.css</Extension>
<Extension>.jpg</Extension>

Here is an example file WssSync.options
<?xml version="1.0"?>
<WssSyncConfig>
  <SiteLocation>http://localhost</SiteLocation>
  <AllowFilters>
    <Extension>.aspx</Extension>
    <Folder>.</Folder>
    <Regexp>.+\.aspx</Regexp>
  </AllowFilters>
  <IgnoreFilters>
    <Extension>.xml</Extension>
    <Folder>Pages</Folder>
    <Regexp>.+\.xml</Regexp>
  </IgnoreFilters>
</WssSyncConfig>

Last edited Apr 22, 2012 at 8:13 PM by epranav, version 7

Comments

davidebrevi Jan 7, 2011 at 3:03 PM 
Hi,
I receive an error using this WssSync tool.
"generic error: Could not retrieve the server extension version"

Do you have clue to solve it?
Thanks!
d