doc.copy-file-action.md Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of module-file Show documentation
Provides file handling for igor.
The newest version!
# 'Copy file' Action

## Description
This action copies a file.

Details about the action's parameters are added to processed data items under the 'copiedFile' key. 

A data item processed by this action could look like this:
``` json
{
  "data": {
    "filename": "KeyGenerator.png",
    "lastModified": "2007-03-19T20:52:58+01:00",
    "directory": "/pub/example/"
  },
  "meta": {
    "jobId": "e0b925ed-104f-45b1-81b7-5d79ea46a633",
    "simulation": true,
    "timestamp": 1601302694149
  },
  "copiedFile": {
    "sourceDirectory": "/pub/example/",
    "targetFilename": "KeyGenerator.png",
    "targetDirectory": "/volume1/data/test/",
    "sourceFilename": "KeyGenerator.png"
  }
}
```

## Parameters
The action can be configured by the following parameters:

Parameter | Description
---|:---|
Source | A file-connector providing access to the file to copy.
Source directory | The directory containing the file to copy. Either a fixed value or a mustache expression selecting a property from the data item. If a mustache expression is used, the property's value will be used as directory name.
Source filename | The name of the file to copy. Either a fixed value or a mustache expression selecting a property from the data item. If a mustache expression is used, the property's value will be used as filename.
Target | A file-connector providing access to the filesystem the file should be copied to.
Target directory | The target directory for the copied file. Either a fixed value or a mustache expression selecting a property from the data item. If a mustache expression is used, the property's value will be used as directory name.
Target filename | The target name of the copied file. Either a fixed value or a mustache expression selecting a property from the data item. If a mustache expression is used, the property's value will be used as filename.
Append transfer suffix | If checked, the filename on the target connector will be appended with '.igor' during transfer. This is useful to indicate that the file is currently copied.
Append filtype suffix | If checked, igor will try to determine the file type and append it to the target filename (e.g. '.html').
Num threads | The number of threads this action uses to process data items.