Task export

This task is used to export individual, or multiple, documents to the Universal Portable Format. The output of this task is a list of files and their metadata.

Documents are selected in the following order:

If srcuris is specified, select documents with those URI IDs.

Otherwise if src or (context and group) are specified, select the document with that path, or if a folder then:

if <filter> specified, search for documents within that folder.

if includes or excludes is specified, also use that to filter the documents.

If xrefdepth or <xrefs> is specified, apply them to selected files and add referenced documents.

If loadimages="true", add referenced images.

Definition

Minimal definition:

<ps:export src="[source]" dest="[destination]"/>

 Full definition:

<ps:export src="[source]" or srcuris="[uriids]"
           dest="[destination]"
           group="[group name]"
           context="[context]"
           allurls="[true|false]"
           includes="[patterns]"
           excludes="[patterns]"
           xrefdepth="[forward xref depth]"
           version="[version]"
           compareto="[compare version]"
           publicationid="[publication ID"
           interpublicationxrefs="[true|false]"
           metadataonly="[true|false]"
           loadimages="[true|false]"
           loadalternates="[true|false]"
           binarymetadataonly="[true|false]"
           failonerror="[true|false]"
           config="[config name]">
  <filter with="[facet values]"
          since="[modified date]"
          ranges="[range values]"
          indexcomplete="[true|false]" />
  <xrefs forward="[forward xref depth]"
         reverse="[reverse xref depth]"
          types="[xref types]" />
</ps:export>

Attributes

Elements

Elements can be used to specify more detailed options than their attribute equivalent. It is an error if both the attribute and element are specified.

Element <filter>

Element <xrefs>

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.
• username – username of member for export
• user.token or jsessionid or password – access token or jsessionid or  username’s password for connecting to PageSeeder.
• uri.scheme or group.scheme – scheme for src documents.
• uri.host or group.host – host for src documents.
• uri.port or group.port – port for src documents.

Errors

Possible errors are:

• Required attribute or environment property missing.
• Attribute or property invalid.
• Src not contained in context.
• Download access denied.
• Resolve image access denied.
• Resolve image not found.
• Image URI ID not found.
• Download not found.

Examples

<ps:export src="/ps/acme/specs/documents/spec.psml"
           dest="c:\working\export"
           xrefdepth="2" />

<ps:export src="/ps/acme/specs/documents"
           dest="c:\working\docs"
           xrefdepth="1"
           version="2.0">
  <filter since="2012-08-31" />
</ps:export>

<ps:export src="/ps/acme/specs/documents"
           dest="c:\working\docs"
           xrefdepth="1">
  <filter with="psstatus:Approved" indexcomplete="true" />
</ps:export>

<ps:export src="/ps/acme/specs/website/content/books/book1"
           dest="c:\working\"
           context="/acme/specs/website/" />