Export S-100 Product

The ExportS100Product process exports an S-100 product (.prd file) as produced by the S-100 Composer application.

The input data consists of a product (.prd) file and its sub-folder containing an H2O (.h2o) file. The product file, sub-folder and the H2O file it contains have the same root name (e.g., gb4x0000 is the root name for gb4x0000.prd and gb4x0000/gb4x0000.h2o). Note that the product (.prd) file and the sub-folder must be contained in the same folder.

The S-100 product (.prd) file specifies the name and path for the S-100 file to be exported. It also specifies a number of parameters that are used by the export process. Options may override some of the parameters in the S-100 product file. Overriding options are written to the S-100 product (.prd) file.

Long	Short	Description	Can Repeat	Notes
--create-new-edition	-N	Increment the edition in the product file by one, and apply the new edition to the new S-100 file.	FALSE	Optional. if this Boolean option is set, the edition number will be incremented in the product (.prd) file, overriding the existing Edition Number value. The new edition number will be exported to the S-100 file and to the exchange set (if an exchange set is being exported). S-100 GML files do not currently support a dataset edition. If exporting an S-100 GML file, the dataset edition will be exported only to the dataset discovery metadata node of the exchange set. If exporting an S-100 ISO-8211 file, the dataset edition is stored in the .000 file and in the dataset discovery metadata mode of the exchange set. If exporting to an exchange set, the edition will be exported to the editionNumber field in the dataset discovery metadata.
--dataset-reference-date	-D	The dataset reference date for the S-100 dataset, which will override the date given in the product (.prd) file. Dates are specified in the standard ISO 8601 extended format for batch processes: • YYYY-MM-DD, or • YYYY-DDD. See ISO 8601 documentation for more information.	FALSE	Optional. This value will be saved in the product (.prd) file, overriding any existing Dataset Reference Date value. The new dataset reference date will be exported to the S-100 file and to the exchange set (if an exchange set is being exported). For S-100 ISO-8211 formats, the date will be exported to the DSRD (dataset reference date) sub-field of the DSID (dataset identification) field. For S-100 GML formats, the date will be exported to the datasetReferenceDate field in the metadata section of the file. If exporting to an exchange set, the dataset reference date will be exported to the issueDate field in the dataset discovery metadata.

Long

Short

Description

Can Repeat

Notes

--create-new-edition

-N

Increment the edition in the product file by one, and apply the new edition to the new S-100 file.

FALSE

Optional.

if this Boolean option is set, the edition number will be incremented in the product (.prd) file, overriding the existing Edition Number value. The new edition number will be exported to the S-100 file and to the exchange set (if an exchange set is being exported).

S-100 GML files do not currently support a dataset edition. If exporting an S-100 GML file, the dataset edition will be exported only to the dataset discovery metadata node of the exchange set.

If exporting an S-100 ISO-8211 file, the dataset edition is stored in the .000 file and in the dataset discovery metadata mode of the exchange set.

If exporting to an exchange set, the edition will be exported to the editionNumber field in the dataset discovery metadata.

--dataset-reference-date

-D

The dataset reference date for the S-100 dataset, which will override the date given in the product (.prd) file.

Dates are specified in the standard ISO 8601 extended format for batch processes:

• YYYY-MM-DD, or

• YYYY-DDD.

See ISO 8601 documentation for more information.

FALSE

Optional.

This value will be saved in the product (.prd) file, overriding any existing Dataset Reference Date value. The new dataset reference date will be exported to the S-100 file and to the exchange set (if an exchange set is being exported).

For S-100 ISO-8211 formats, the date will be exported to the DSRD (dataset reference date) sub-field of the DSID (dataset identification) field.

For S-100 GML formats, the date will be exported to the datasetReferenceDate field in the metadata section of the file.

If exporting to an exchange set, the dataset reference date will be exported to the issueDate field in the dataset discovery metadata.

Example
Objective	Export the `gb4x000.prd` file to an S-100 file with the same name. A new edition and issue date are created for both files.
Description		Command Line Syntax
Increment the file edition		--create-new-edition
Set the issue date to October 21, 2021		--dataset-reference-date "2021-10-21"
Command Line	carisbatch --run ExportS100Product --create-new-edition --dataset-reference-date "2021-10-21" gb4x0000.prd