Deferred Copy Document Plug-in
The Deferred Copy Document plug-in is used to create a copy of a document, a supporting document, or both. These documents can be 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 runs in the background. This is the only way in which it differs from the Copy Document plug-in.
To save the file, AppPool users must have permission to the given directory.
This plug-in copies documents (and supporting documents) to one location only. If you provide directory and file parameters, the plug-in will work for the directory only. To copy documents to multiple places, use multiple plug-ins.
Properties
Name | Description | Mandatory | Group Name | Modes |
---|---|---|---|---|
directory |
The file system directory into which you copy the document. Example: Direct value: D:\Files\Public\Users\ Value from solution field: [field1] |
No | Document Target | Directory |
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 Value from solution field: [field1] |
No | Document Details | All |
includeitem |
Specifies the item to include. DataFile: Copy the data file only. SupportinDocument: Copy supporting documents only. Both: Copies both the data file and the supporting document. |
Yes | Document Details | All |
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 | Document Details | All |
supportingfilename |
The new name for the supporting file document(s). The extension in the copied document remains the same as that of the original document. If the new name is not specified, the 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 | Document Details | All |
folder | The folder name for the File Library into which the document is copied. | No | Document Target | File Library |