The CreateS100ProductFromDataset process creates a new S-100 standalone product from an S-100 dataset.
Input
S-100 base file to create the product from. The base file must be an existing S-100 ISO-8211 .000 file or an S-100 GML file. Any updates (for ISO-8211) must reside in the same folder as the base file or in the folder specified by the UpdateFolder option.
Output
New S-100 product file, which must be a new .prd file. The file location must already exist. The file name will be used as the product's name.
Command Line Syntax
carisbatch --run CreateS100ProductFromDataset --export-type [options] <input> <output>
User Interface Command
File > New > Product > From S-100 Dataset
Options
Long | Description | Can Repeat | Notes |
|---|---|---|---|
--update-folder | The folder to search for S-100 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. Applies only to S-100 ISO-8211-type files. |
--recurse | If set, the update folder is recursed when searching for updates. If set but the UpdateFolder option is not used, the base S-100 file's folder is recursed when looking for updates. | FALSE | Optional. Applies only to S-100 ISO-8211-type files. |
--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-100 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-100 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-100 dataset, thus overwriting the last base/update file. | FALSE | Required. |
--dataset-reference-date | A string specifying the dataset reference date for export. 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. If not set, the date will default to "Set Date on Export", which sets the dataset reference 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. |
--exchange-catalogue-metadata | Path to the XML file that contains the exchange catalogue metadata for the new exchange set. This XML file must include a single S100XC:S100_ExchangeCatalogue node in the format defined by S100_ExchangeCatalogue. | FALSE | Required only if creating a new exchange set. |
--dataset-discovery-metadata | Path to the XML file that contains the exchange catalogue dataset discovery metadata. This file must include a single S100XC:S100_DatasetDiscoveryMetadata node in the format defined by S100_DatasetDiscoveryMetadata. | FALSE | Required only if creating or updating an exchange set. |
Examples
Objective | Create a new update for an S-100 product. | |
Description | Command Line Syntax | |
Create a new update. |
| |
S-100 base file. |
| |
New S-100 product file. |
| |
Command Line |
| |
Outcome | A new update export for the S-100 product is created. | |
Objective | Overwrite the S-100 product. | |
Description | Command Line Syntax | |
Overwrite the current S-100 product edition. |
| |
Set the dataset reference date to November 16, 2023. |
| |
Do not apply a sounding rounding rule on export. |
| |
Do not set an exchange set type. |
| |
S-100 base file. |
| |
New S-100 product file. |
| |
Command Line |
| |
Outcome | The S-100 product is overwritten while keeping the same edition and update numbers. | |
Objective | Create a new edition of an S-100 product. | |
Description | Command Line Syntax | |
Search for updates in this folder. |
| |
Recurse the update folder when searching for updates. |
| |
Create a new edition. |
| |
Set the issue date to November 23, 2023. |
| |
Apply the IHO sounding rounding rule. |
| |
Create a new exchange set. |
| |
Name of the new exchange set. |
| |
Location of the new exchange set. |
| |
Location of the exchange catalogue metadata file for the new exchange set. |
| |
Location of the exchange catalogue dataset discovery metadata. |
| |
S-100 base file. |
| |
New S-100 product file. |
| |
Command Line |
| |
Outcome | A new edition of the S-100 product and a new exchange set are created. | |