Task loadingzone-get
Used in upload processing scripts to download documents from the loading zone for the current user in the specified group.
Definition
<ps:loadingzone-get
group="[groupname]"
destination="[destination file]"
path="[file path]"
paths="[file path list]"
config="[config name]" />
Attributes
| Attribute | Description | Required | Default |
|---|---|---|---|
| group | The name of the group the Loading Zone is in | Yes | |
| destination | The path of the folder where the file is to be downloaded, if it does not exist, it is created. If creation fails, an error is raised. | Yes | |
| path | The path in the Loading Zone of the file to download (not URL encoded) | Yes, if no paths | |
| paths | A pipe-separated list of paths in the Loading Zone of the files to download (not URL encoded) | Yes, if no path | |
| subfolders | Whether to save files in the same subfolders as in the loading zone | No | true |
| config | Universal PS config name | No | default |
Environment
This task uses the following ps:config environment properties:
- scheme – scheme for connecting to PageSeeder.
- host – host for connecting to PageSeeder.
- port – port for connecting to PageSeeder.
- servlet.prefix – servlet prefix for connecting to PageSeeder – default /ps/servlet.
- site.prefix – site prefix for connecting to PageSeeder – default /ps.
- user.token or jsessionid or username/password – access token or jsessionid or username/password for connecting to PageSeeder.
Examples
<ps:loadingzone-get
group="${ps.config.default.group.name}"
path=${ps.config.default.upload.path}"
destination="${ps.config.default.working}/download" />