Deferred Copy Document Plug-in
The Deferred Copy Document plug-in is used to create a copy of a document or a supporting document (or both). Documents or supporting documents are copied to a file system or a folder inside a File Library. This plug-in only works with the custom Excel workflow.
This plug-in is the same as the Copy Document plug-in except for the fact that it runs in the background.
Note: To save the file, the AppPool user must have permission to the given directory.
Properties
Name | Description | Mandatory |
---|---|---|
directory |
The file system directory into which you copy the document. Example: Direct value: D:\Files\Public\Users\ Value from solution field: [field1] |
No |
datafilename |
Specifies the new name for the data file document. The extension in the copied document will remain the same as that of the original document. If the new name is not specified, the document copy will retain its original name. Example: Direct Value : Daily-Records.xlsx Value from solution field: [field1] |
No |
includeitem |
Specifies the item to include. DataFile: Copy the datafile only. SupportinDocument: Copy supporting documents only. Both: Copies both the datafile and the supporting document. |
Yes |
waitforprocessend |
This is a boolean value designating when to copy the document(s). If set to true, the document is copied when the process is completed. If set to false, the document is copied when the plug-in is executed, irrespective of the process status. The default value is false. If this parameter is set to true, the 'Continue Without Waiting' property of the plug-in must also be set to true. |
No |
supportingfilename |
Specifies the new name for the supporting file document(s). The extension in the copied document will remain the same as that of the original document. If the new name is not specified, document copy will retain its original name. If there are multiple supporting documents, an underscore and a number is added at the end of each supporting document name, as follows: <SupportingDocumentName>_1, <SupportingDocumentName>_2. Example: Direct Value : Daily-Records.xlsx Value from solution field: [field1] |
No |
folder | Folder name for the File Library into which the document is copied. | No |
Example
- folder – [Due Date]
- list – MOCs
- name – [NewID].[BaseName].[FileType]
- site – http://acme.com/sv/DocEx
This example copies the process’s associated document to the folder contained in the SharePoint column Due Date in the list MOCs in the site http://acme.com/sv/DocEx. The file will be renamed to the value in the NewID field, followed by a _, followed by the base name of the document, followed by the file’s extension.
To add multiple columns to be updated, click the Add button (top right corner), enter the column name (such as [Approved By]), and then enter the value to be set for the column.