Publishing

Publishing PageSeeder data to print, the Web or both

Task ps-upload-get

Used in upload processing scripts to download documents from the Loading Zone for the current user in the specified group.

Deprecation warning!

This task is now deprecated, use Task loadingzone-get instead.

Definition

   <ps:ps-upload-get
            destination="[destination]"
            group="[groupName]"
            path="[path]"
            jsessionid="[jsessionid]"
            port="[port]"
            host="[host]"
            siteprefix="[siteprefix]"
            servletprefix="[servletprefix]"
            output="[output]"
            failonerror="[true|false]"/>

Attributes

AttributeDescriptionRequired
jsessionidThe @jsessionid attribute (optional) is used for authentication. It is not required but it will always be used if specified.Yes, unless username/password or propertiesfile are specified
usernameIf @jsessionid attribute is not specified this can be used for authentication.Yes, unless jsessionid or propertiesfile are specified
passwordIf jsessionid is not specified this can be used for authentication.Yes, unless jsessionid or propertiesfile are specified
propertiesfileThe @propertiesfile attribute (optional) describes the location of the properties file to use to connect to the PageSeeder Server.
The value of the attribute can be the full path of the file, the relative path (the base directory is the location of the Ant script) or simply its name, in which case it MUST be located on the classpath.
Yes, unless (jsessionid or username/password) and host are specified
portThe port address of the PageSeeder Server - default: 80
(used when no properties file is specified)
No
hostThe host name of the PageSeeder Server
(used when no properties file is specified)
Yes, unless propertiesfile is specified
siteprefixThe PageSeeder site prefix defined - default: /ps
(used when no properties file is specified)
No
servletprefixThe PageSeeder servlet prefix defined - default: /servlet
(used when no properties file is specified)
No
destinationThe @destination attribute is the full path of the folder where the file will be downloaded, if it does not exist, it will be created. If creation fails, an error will be raised.Yes
groupThe name of the group the Loading Zone is in.Yes
pathThe @path attribute is the path in the Loading Zone of the file to download (not URL encoded).Yes
outputLocation of the output file. This is meaningful only when the path to download points to a folder (ends with "/"). The output file will contain the list of URIs downloaded.No
failonerrorWhether to fail if file can not be downloaded from loading zone (default true).No

Examples

<ps:ps-upload-get
     destination="${download}"
     path="${ps-uploadPath}"
     group="${ps-groupName}"
     jsessionid="${ps-jsessionid}" 
     host="${ps-host}" 
     port="${ps-port}"
     servletPrefix="${ps-servletPrefix}" 
     sitePrefix="${ps-sitePrefix}">

Created on , last edited on