SharePoint Library Sync Task
The SharePoint Library Synchronization Task provides the ability to synchronize content located in a Windchill repository with a SharePoint document library. The following tables detail the Attributes and Parameters along with their description.
Attributes
Attribute Name |
Description |
name |
Descriptive name of the task. |
type |
“SPLibrarySync” |
Parameters
Parameter Name |
Description |
repository |
The name of the repository as defined in the repository configuration. A Parameter is required. |
collection |
The name of the collection as defined in the collections element. Parameter is required. |
fullSync |
Indicates if a full or incremental sync should be performed. Valid values are true or false. Default value is “false”. |
mirrorRepositoryFolderPaths |
Indicates if the repository folder structure should be mirrored on the local file system. If true, the container and folders will be mirrored. If false, all files will be synced to a single folder. |
spRepository |
The name of the SharePoint repository as defined in the repository configuration. A Parameter is required. |
site |
URL fragment of the site within SharePoint. This will be added to the repository URL to determine the final URL. |
libraryTitle |
Contains display name of the sync library. The display name is the document library name that is visible to the user. |
libraryName |
Contains the internal name of the sync document library. The internal name can be found in the URL while viewing the library. The libraryTitle and libraryName may be different. |
Contains Elements
-
MetadataMappings
-
Task Hook
Example
<Task name="Production" type="SPLibrarySync"> <Param name="repository" value="Windchill"/> <Param name="collection" value="Released Documents"/> <Param name="fullSync" value="false"/> <Param name="mirrorRepositoryFolderPaths" value="true"/> <Param name="spRepository" value="SharePoint"/> <Param name="mirrorRepositoryFolderPaths" value="true"/> <Param name="site" value="Manuals"/> <Param name="libraryTitle" value="SME Reviews"/> <Param name="libraryName" value="Sally Fields"/> </Task>