CARIS Process Designer : CARIS Batch : HPD Processes : PaperChartBuilder License : Export Atlas
 

Export Atlas

The ExportAtlas process exports Atlas pages to an output folder, along with associated charts and external files. The process can export either individual pages in an Atlas or all pages.

When an entire Atlas is exported, an XML file is created in the output folder that contains both Atlas and chart metadata. This XML file can be combined with an XSLT file in a third-party desktop application.

Input

URI containing an Atlas ID.

Output

Path and folder where the exported Atlas files are stored.

Syntax

carisbatch --run ExportAtlas [options] <input> <output>

Parameters

Long

Short

Description

Can Repeat

Notes

--page-number

-p

Page for export. This option is used if exporting individual pages to an output folder. If the parameter is omitted, all pages are exported.

TRUE

Optional

Example

To use this process, refer to the following example.

Example

Objective

Export pages 3 and 5 from an Atlas to the MyAtlas folder.

Description

Command Line Syntax

Export page 3 from the Atlas

--page-number 3

Export page 5 from the Atlas

--page-number 5

Atlas ID from which pages are to be exported

hpd://username:password@DB/db?atlasid=42

Folder for exported Atlas pages

c:\data\MyAtlas\

Command Line

carisbatch --run ExportAtlas --page-number 3 --page-number 5 hpd://username:password@DB/db?atlasid=42 c:\data\MyAtlas\