CARIS Process Designer : CARIS Batch : S-100 Processes : Edit S-100 Exchange Set
 

Edit S-100 Exchange Set

 
Metadata files

The EditS100ExchangeSet process edits an existing S-100 exchange set.

The initial exchange set is created when the ENC is exported from the application. The ExchangeSet folder contains:

a file called CATALOG.XML This is a master list, describing the entire contents of the exchange set.

a subfolder for each dataset

a single subfolder for all support files . The name of that subfolder is specified in CATALOG.XML.

Support files are supplementary information which are linked to the features by the complex attribute information, the sub-attribute file reference, and the simple attribute pictorial representation.

When EditS100ExchangeSet is used to add a dataset or support file to an exchange set, a subsection is added to CATALOG.XML. The process needs an input metadata file, which must be created by the user in advance. See Metadata files for more information

Input

The location of the S-100 exchange set to be modified. This directory must contain the S-100 exchange set catalogue file (CATALOG.XML).

Syntax

carisbatch --run EditS100ExchangeSet [options] <input>

Options

Long

Short

Description

Can Repeat

Notes

--file-to-add

-a

This option requires the following two arguments, in the specified order:

<New File>: The path to the file to add to the exchange set. This can be a dataset file (new edition or update) or a support file. It must include the full path and file name including extension.

<Metadata>: The path to the XML file that contains the exchange catalogue discovery metadata for the file. See Metadata files for details.

TRUE

--file-to-remove

-d

The name of the file to remove from the exchange set.

This can be a dataset file (new edition or update) or a support file. It must include the full file name including extension.

TRUE

--dataset-to-cancel

-c

The name of the dataset to cancel.

This must be a base S-101 dataset file (*.000) and must include the full file name including extension.

TRUE

--dataset-to-reissue

-R

The name of the dataset to reissue.

This must be a base S-101 dataset file (*.000) and must include the full file name including extension.

TRUE

Examples

Example

Objective

Modify an exchange set as follows:

add a dataset file with metadata

remove a support file

cancel a dataset file

reissue a new dataset file

Description

Command Line Syntax

File to add and the appropriate metadata file.

--file-to-add C:\datasetFile1.000 C:\datasetFile1_base_metadata.xml

File to remove

--file-to-remove supportFile2.txt

Cancel a dataset

--dataset-to-cancel datasetFile3.000

Reissue a dataset

-dataset-to-reissue datasetFile4.000

Input file -- the exchange set to modify

C:\exchangeSets\testExchangeSet

Command Line

carisbatch --run EditS100ExchangeSet --file-to-add C:\datasetFile1.000 C:\datasetFile1_base_metadata.xml --file-to-remove supportFile2.txt --dataset-to-cancel datasetFile3.000 --dataset-to-reissue datasetFile4.000 C:\exchangeSets\testExchangeSet

Example

Objective

Modify an exchange set as follows

add a dataset file with metadata

add a second dataset file with metadata

add a third dataset file with metadata

Description

Command Line Syntax

First dataset file to add and the appropriate metadata file.

--file-to-add C:\datasetFile1.000 C:\datasetFile1_base_metadata.xml

Second dataset file to add and the appropriate metadata file.

--file-to-add C:\datasetFile1.001 C:\datasetFile1_update_metadata.xml

Third dataset fileFile to add and the appropriate metadata file.

--file-to-add C:\supportFile1.txt C:\supportFile1_metadata.xml

Input file -- the exchange set to modify

C:\exchangeSets\testExchangeSet

Command Line

carisbatch --run EditS100ExchangeSet --file-to-add C:\datasetFile1.000 C:\datasetFile1_base_metadata.xml --file-to-add C:\datasetFile1.001 C:\datasetFile1_update_metadata.xml --file-to-add C:\supportFile1.txt C:\supportFile1_metadata.xml C:\exchangeSets\testExchangeSet

Example

Objective

Modify an exchange set as follows

remove a support file

remove a second support file

Description

Command Line Syntax

The file to remove.

--file-to-remove datasetFile2.001

The second file to remove.

--file-to-remove supportFile2.txt

Input file -- the exchange set to modify

C:\exchangeSets\testExchangeSet

Command Line

carisbatch --run EditS100ExchangeSet --file-to-remove datasetFile2.001 --file-to-remove supportFile2.txt C:\exchangeSets\testExchangeSet

Example

Objective

Modify an exchange set by cancelling a dataset file.

Description

Command Line Syntax

The file to cancel.

--dataset-to-cancel datasetFile3.000

Input file -- the exchange set to modify

C:\exchangeSets\testExchangeSet

Command Line

carisbatch --run EditS100ExchangeSet --dataset-to-cancel datasetFile3.000 C:\exchangeSets\testExchangeSet

Example

Objective

Modify an exchange set by reissuing a dataset file.

Description

Command Line Syntax

The file to be reissued.

--dataset-to-reissue datasetFile4.000

Input file -- the exchange set to modify

C:\exchangeSets\testExchangeSet

Command Line

carisbatch --run EditS100ExchangeSet --dataset-to-reissue datasetFile4.000 C:\exchangeSets\testExchangeSet