CARIS HPD : CARIS® Batch : HPD® Processes : ProductBuilder License : Export HPD S-57 Product
 

Export HPD S-57 Product

Description

The ExportHPDS57Product process exports an HPD S-57 product.

If the product version is closed, the file associated with that version will be downloaded from the server.

The exchange set will be updated if the product attributes are configured as such.

Input

HPD URI containing a Product Version ID and Project ID.

Output

Exported S-57 (.000) file as named in the product attributes.

Command Line Syntax

carisbatch --run ExportHPDS57Product [options] <input>

Options

Long

Short

Description

Can Repeat

Notes

--destination-folder

Folder where the S-57 file will be created.

If this option is not set, by default the file is placed in the exchange set location defined in the product attributes, or in a temporary folder if the exchange set location is not defined.

FALSE

Optional

--create-test-version

If set, an unofficial test version is exported. The DestinationFolder option must be provided if this is set.

An S-57 file is created that may include unverified features.

This does not update the exchange set, or change the state of the HPD product, or record an export event for the test.

The issue date may be set in the created file but it is not set in the database.

If the product version is closed, this option cannot be used.

FALSE

Optional

Example

Objective

Export an HPD S-57 product and create a test version in the specified folder.

Description

Command Line Syntax

Create a test version.

--create-test-version

Set the folder where the S-57 file will be created.

--destination-folder C:\Users\Username\Documents\CARIS\HPD

Path of the HPD product to export.

hpd://username:password@database?ProductVersionId=3;ProjectId=1

Command Line

carisbatch --run ExportHPDS57Product --create-test-version --destination-folder C:\Users\Username\Documents\CARIS\HPD hpd://username:password@database?ProductVersionId=3;ProjectId=1

Outcome

A test version of the HPD S-57 product is created in the specified folder.