Copy Files

An AgilePart that copies one or more files from one SharePoint folder or library to another SharePoint folder or library.



Navigation

  1. In AgilePoint Envision, open a process template.
  2. Navigate to the SharePoint stencil.
  3. On the SharePoint stencil, drag the Copy Files AgileShape, and drop it on the process template.
  4. To view the entire list of properties, in the Design Tasks pane, click Show Properties.

Properties for This AgileShape

Field Name Definition

Filter

Definition:
Specifies the file name or a set of files expressed using the filter expression you want to search within the specified source location. For example, files to be downloaded by the Download Files AgilePart, to be uploaded by the Upload Files AgilePart, or to be converted to PDF by the PDF Converter AgilePart.
Allowed Values:
  • A file name.
  • A filter string that uses asterisks (*) as wildcards.
Default Value:
${DocName}
Custom Attributes:
Yes
Example:
Following are some examples of filter expressions:
  • *.* - All files are searched.
  • *.xml - The files that have the .xml file extension are searched.
  • *.doc - The files that have the .doc file extension are searched.
  • MyFile.xml - Only the specific file MyFile.xml is searched.

The filter action is performed at the source location, that vary depending upon the AgileShape.

OverWriteFile

Definition:
Specifies whether the AgileShape overwrites the files if they already exist at the specified destination location.
Allowed Values:
  • False - The AgileShape does not overwrite any existing file.
  • True - The AgileShape overwrites the file if it exists with the same name at the destination location.
Default Value:
False

Recursive

Definition:
Determines whether the AgileShape's specified action - such as copying, uploading, or deleting - is recursive. In other words, it determines whether the action is repeated in subfolders of the target folder or document library.
Allowed Values:
  • False - The AgileShape performs the action only on the files located at the specified source folder. Files within subfolders aren't affected.
  • True - The AgileShape performs the action on the files located at the specified source folder, as well as the files that are located within the subfolders.
Default Value:
False

SourceFolderUrl

Definition:
Specifies the URL for the SharePoint document library or subfolder which contains the files to be copied to the destination location.
Allowed Values:
A valid SharePoint document library or folder URL.
Default Value:
${SPServer}/${SitePath}/${DocLibPath}
Custom Attributes:
Yes
Example:
  • http://[machine name]:[port]/sites/[site name]/[document library name]
  • http://[machine name]:[port]/sites/[site name]/[document library name]/[folder name]

TargetFolderUrl

Definition:
Specifies the URL for the SharePoint document library or subfolder where you want the files to be copied from the source location.
Allowed Values:
A valid SharePoint document library or folder URL.
Default Value:
None
Custom Attributes:
Yes
Example:
  • http://[machine name]:[port]/sites/[site name]/[document library name]
  • http://[machine name]:[port]/sites/[site name]/[document library name]/[folder name]

Common AgilePart Properties

This AgilePart inherits the following common properties. For more information, see AgilePart - Common Setup. Note that only the relevant properties are available in AgilePoint Envision. Unneeded properties are hidden.

Name, (UID), Description, Debug, Audit Level, SessionMode, Wait All Incoming, AssemblyName, ClassName, Method, Optimizing, Activity Entry Message (Email), Task Completed Message (Email), ConfigureAttachments, Reference URL, ExceptionHandlerScope, SaveErrorMessageTo, SaveStatusTo, Configure Yammer Credentials, Retries, HandleException

BPMN Properties

Each AgileShape includes a set of BPMN properties. For more information, see Adding or Modifying BPMN Properties for an AgileShape.