--update-folder

The folder to search for S-57 update files.

If not set, the base file's folder is used to locate updates.

Use the Recurse option as well to search in subfolders.

FALSE

Optional.

--recurse

If set, the update folder is recursed when searching for updates.

If set but the UpdateFolder option is not used, the base S-57 file's folder is recursed when looking for updates.

FALSE

Optional.

--export-type

A string specifying the next export type.

• NEW_EDITION: The product's next export will be a new edition.The product's edition number will be set to the S-57 dataset's edition number, incremented by 1. The update number will be 0.

• NEW_UPDATE: The product's next export will be a new update. The product's update number will be set to the S-57 dataset's update number, incremented by 1. The edition number will remain the same.

• OVERWRITE: The product's next export will overwrite the current edition and update.The edition number and update number will remain the same as the S-57 dataset, thus overwriting the last base/update file.

FALSE

Required.

--issue-date

A string specifying the issue date for the S-57 product.

Dates are specified in the standard ISO 8601 extended format for batch processes, which is YYYY-MM-DD or YYYY-DDD. See ISO 8601 documentation for more information.

This is the ISDT sub-field in the DSID section of the S-57 header.

If not set, the date will default to "Set Date on Export", which sets the issue date to the current date on export.

FALSE

Optional.

--sounding-rounding

Sounding rounding rule that is applied to soundings on export.

Valid values are NONE (apply no sounding rounding on export) or the rule names listed in the SoundingRounding.xml configuration file.

If not set, the default value is NONE.

FALSE

Optional.

--exchange-set-type

A string specifying the exchange set type.

• CREATE_NEW

• UPDATE_EXISTING

• NONE

If not set, the default value is NONE.

FALSE

Optional.

--exchange-set-name

A string specifying the exchange set name.

FALSE

Required if ExchangeSetType is not NONE.

--exchange-set-location

A string specifying the exchange set location.

FALSE

Required if ExchangeSetType is not NONE.

--use-s63-folder-structure

If set, the exchange set will be created using the S-63 folder structure.

If not set, all files will be placed directly in the ENC_ROOT folder.

Ignored if ExchangeSetType is not NONE.

FALSE

Optional.

--read-me-file

A string specifying the readme.txt file to add to the exchange set.

If not set, a readme.txt file will not be added to the exchange set.

Ignored if ExchangeSetType is NONE.

FALSE

Optional.

--exchange-set-comment

A string specifying the comment for the exchange set.

If not set, a comment will not be added.

Ignored if ExchangeSetType is NONE.

FALSE

Optional.

-exchange-set-long-file-name

A string specifying the long file name for the exchange set.

If not set, a long file name will not be added.

Ignored if ExchangeSetType is NONE.

FALSE

Optional.

Objective

Create a new update for an S-57 product.

Description

Command Line Syntax

Create a new update.

--export-type NEW_UPDATE

S-57 base file.

C:\datasetFile.000

New S-57 product file.

C:\newProduct.prd

Command Line

carisbatch --run CreateS57ProductFromDataset --export-type NEW_UPDATE C:\datasetFile.000 C:\newProduct.prd

Outcome

A new update export for the S-57 product is created.

Objective

Overwrite the S-57 product.

Description

Command Line Syntax

Overwrite the current S-57 product edition.

--export-type OVERWRITE

Set the issue date to November 16, 2023.

--issue-date 2023-11-16

Do not apply a sounding rounding rule on export.

--sounding-rounding NONE

Do not set an exchange set type.

exchange-set-type NONE

S-57 base file to overwrite.

C:\datasetFile.000

New S-57 product file.

C:\newProduct.prd

Command Line

carisbatch --run CreateS57ProductFromDataset --export-type OVERWRITE --issue-date 2023-11-16 --sounding-rounding NONE --exchange-set-type NONE C:\datasetFile.000 C:\newProduct.prd

Outcome

The S-57 product is overwritten while keeping the same edition and update numbers.

Objective

Create a new edition of an S-57 product.

Description

Command Line Syntax

Search for updates in this folder.

--update-folder C:\updates

Recurse the update folder when searching for updates.

--recurse

Create a new edition.

--export-type NEW_EDITION

Set the issue date to November 23, 2023.

--issue-date 2023-11-23

Apply the IHO sounding rounding rule.

--sounding-rounding IHO

Create a new exchange set.

--exchange-set-type CREATE_NEW

Name of the new exchange set.

--exchange-set-name myExchangeSet

Location of the new exchange set.

--exchange-set-location C:\Exports

Create the new exchange set using the S-63 folder structure.

--use-s63-folder-structure

Path of the README file added to the new exchange set.

--read-me-file "C:\Program Files\CARIS\HPD\5.0\system\S57Config\system\README.TXT"

Comment added to the new exchange set.

--exchange-set-comment "Test Comment"

Long file name for the new exchange set.

--exchange-set-long-file-name "My Product's Long File Name"

S-57 base file.

C:\datasetFile.000

New S-57 product file.

C:\newProduct.prd

Command Line

carisbatch --run CreateS57ProductFromDataset --update-folder C:\updates --recurse --export-type NEW_EDITION --issue-date 2023-11-23 --sounding-rounding IHO --exchange-set-type CREATE_NEW --exchange-set-name myExchangeSet --exchange-set-location C:\Exports --use-s63-folder-structure --read-me-file "C:\Program Files\CARIS\HPD\5.0\system\S57Config\system\README.TXT" --exchange-set-comment "Test Comment" --exchange-set-long-file-name "My Product's Long File Name" C:\datasetFile.000 C:\newProduct.prd

Outcome

A new edition export and a new exchange set for the S-57 product are created.