Skip to main content

 Publishing

Publishing PageSeeder data to print, the Web or both

Task upload

This task lets the Ant Script go through the files referenced by the fileset and upload them on a PageSeeder server.

This task is available in PageSeeder v5.8115 and higher.

Definition

Minimal definition:

<ps:upload
    group="[groupname]">
  <fileset dir="[source]" />
</ps:upload>

 Full definition:

<ps:upload
    group="[groupname]"
    folder="[folder]"
    doclabels="[label1,label2]"
    docidisfilename="[true|false]"
    overwrite="[true|false]"
    overwriteproperties="[true|false]"
    unzip="[true|false]"
    deletezip="[true|false]"
    resolve="[true|false]"
    index="[true|false]"
    validate="[true|false]"
    saveuris="[file path]"
    failonerror="[true|false]"
    pollinginterval="[milliseconds]"
    config="[config name]">
  <notification subject="[subject]"
                content="[content]"
                labels="[label3,label4]"
                notify="[silent|normal|announce]" />
  <workflow status="[status]"
            priority="[priority]"    
            assignto="[member id]"
            due="[due date]"
            content="[content]"
            labels="[label3,label4]"
            notify="[silent|normal|announce]" />
  <fileset dir="upload"
           includes="*.psml"/>
</ps:upload> 

Attributes

AttributeDescriptionRequiredDefault
groupThe name of the group to upload toYes
folderThe folder for the upload relative to group (default is group root folder). As of PageSeeder v5.9802, this can be the full URL to the folder.No
doclabelsA comma-separated list of labels to apply to all documentsNo
docidisfilenameIf true, sets the doc id to the filename of the uploaded document (without the extension)No
overwriteOverwrite existing filesNofalse
overwritepropertiesOverwrite existing document properties such as title, docid, labels - requires overwrite=trueNofalse
unzipIf true, unzip any .zip files that are uploadedNofalse
deletezipIf true, delete a zip file after unzipping itNotrue
resolveIf true, cross-references and images found in the content are resolvedNotrue
indexIf true, uploaded files are indexedNotrue
validateIf true, uploaded files are validated using their default.sch schematron if definedNotrue
saveurisIf specified, save the URIs uploaded to this path as XMLNo
failonerrorIf true, stop ANT build script on errorNotrue
pollingintervalThe number of milliseconds between each check to see if the upload is completeNo5000
configUniversal PS config nameNodefault

Elements

Element <notification>

If specified, set the notification message details.

AttributeDescriptionRequiredDefault
subjectThe subject of the messageYes
contentThe content of the messageYes
labelsA comma-separated list of labels for the messageNo
notify

Can be one of the following:

  • silent – no email notification.
  • normal – send email notification to the group.
  • announce – send email notification to ALL group members.
Nosilent

Element <workflow>

If specified, create a workflow step for all documents uploaded.

If there are more than maxWorkflowNotifications (default 20) documents uploaded, then notify is forced to silent.
AttributeDescriptionRequired
statusThe document status to set (e.g. Initiated, In Progress, Complete)Yes
priorityThe priority of the workflow (e.g. Low, Medium, High)No
assigntoThe member ID to assign the workflow to (a positive integer)No
dueThe due date of the workflow in ISO date format (e.g. 2016-10-25)No
labelsA comma-separated list of labels for the messageNo
notify

Can be one of the following (default silent):

  • silent – no email notification.
  • normal – send email notification to the group.
  • announce – send email notification to ALL group members.
No

Element <fileset>

The standard ANT fileset  element must be used to specify the files to be uploaded.

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.
  • jsessionid or username/password – jsessionid or username/password for connecting to PageSeeder.

Save URIs format

Following is the XML format used to save the uploaded URIs if saveuris is specified.

<uris>
  <uri id="[id]"
       scheme="[scheme]"
       host="[host]"
       port="[port]"
       path="[path]"
       decodedpath="[decodedpath]"
       external="[true|false]"
       [archived="true"]
       [folder="true"]
       [docid="[docid]"]
       [mediatype="[mediatype]"]
       [documenttype="[documenttype]"]
       [title="My Document"]
       [created="[created]"]
       [modified="[modified]"]>
    <displaytitle>My Document</displaytitle>
    [<description>This is my document</description>]
    [<labels>mylabel1,mylabel2</labels>]
  </uri>
  ...
</uris>

Errors

Possible errors are:

  • Document already exists and overwrite is disabled.
  • Validation errors.
  • No source URIs belong to specified group.
  • Failed to load URI with ID.
  • A source URI is not within the specified context.

Examples

Stand alone script examples:

<ps:upload group="acme-demo"
           folder="documents">
  <fileset dir="c:\ps\upload"
           includes="**"/>
</ps:upload>
<ps:upload
    group="acme-demo"
    folder="documents/demo"
    overwrite="true"
    overwriteproperties="true"    
    unzip="true"
    resolve="false"
    saveuris="c:\ps\uris.xml">
  <notification subject="New demo"
                content="This demo was just uploaded"
                notify="normal" />
  <workflow status="In Progress" />
  <fileset dir="zip">
    <include name="demo.zip"/>
  </fileset>
</ps:upload>

 Publish script examples:

<ps:upload
    group="${ps.config.default.group.name}"
    folder="documents">
  <fileset dir="${ps.config.default.working}/upload"
           includes="**"/>
</ps:upload>
<ps:upload
    group="${ps.config.default.group.name}"
    folder="documents/demo"
    overwrite="true"
    overwriteproperties="true"    
    unzip="true"
    resolve="false"
    saveuris="${ps.config.default.working}/uris.xml">
  <notification subject="New demo" 
                content="This demo was just uploaded"
                notify="normal" />
  <workflow status="In Progress" />
  <fileset dir="${ps.config.default.working}/zip">
    <include name="demo.zip"/>
  </fileset>
</ps:upload>
<zip destfile="${ps.config.default.working}/upload.zip"
     basedir="${process}"/>
    
<ps:upload
    group="acme-specs"
    folder="website${ps.config.default.uri.path.no.group}"
    unzip="true"
    overwrite="true"
    overwriteproperties="true"
    validate="false">
  <fileset
        file="${ps.config.default.working}/upload.zip" />
</ps:upload>
Created on , last edited on