Folder Synchronization Task

The Folder synchronization Task provides the ability to synchronize content located in a repository with the local file system. The following tables detail the Attributes and Parameters along with their description.

Attributes

Attribute Name	Description
name	Descriptive name of the task.
type	“FolderSync”

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”.
exportToFolderPath	Location on the local file system where content will be synced to.
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.
fileReferenceAttributes	A comma delimited list of all attribute names that contain an xml or graphical reference, delimited by commas. Default value is “href”.
exportAllReferencedGraphics	Indicates if any graphics referenced by the xml is also synced, whether it is in the collection or not.
enforceFileUniqueness	Indicates if the system should ensure that local file names are unique. If true, the Windchill document number will be appended to the filename. If false, only the Windchill filename will be used. Duplicate files will be overwritten. Default value is “true”.
outputMetadataFile	Indicates if the system should generate an XML .properties file along with the exported content file. If true, a properties file having the same base name as the content file will be created and contain all attributes returned by the filter. Additional attributes can be returned by using the filter includeMetadata parameter. If false, no properties file will be created. Default value is “false”.
outputJSONMetadataFile	If set to true, code will be executed to convert metadata to format natively supported by Titania in a HARP-META/metadata.json file. This feature creates a new metadat file for each sync and does not compound the metadata synchronized from previous sync jobs.

Contains Elements

Task Hook

Example

<Task name="Production" type="FolderSync">
	<Param name="repository" value="Windchill"/>
	<Param name="collection" value="Released Documents"/>
	<Param name="fullSync" value="false"/>
	<Param name="exportToFolderPath" value="c:\temp\export"/>
	<Param name="mirrorRepositoryFolderPaths" value="true"/>
	<Param name="fileReferenceAttributes" value="href"/> <!--  separated by commas -->
	<Param name="exportAllReferencedGraphics" value="true"/>
	<Param name="ensureFileUniqueness" value="true"/>
</Task>

Titania Sync Reference Guide

Folder Synchronization Task