CARIS HPD : CARIS® Batch : HPD® Processes : ProductBuilder License : Import Product Definition
 

Import Product Definition

The ImportProductDefinition process creates an S-57 or S-101 ENC product in an HPD database using a product definition file.

Input

XML file containing the product definition.

Output

URI of an HPD schema.

Command Line Syntax

carisbatch --run ImportProductDefinition --usage-id <value> --product-group-id <value> --product-id <value> --product-version <value> --product-template-id <value> [options] <input> <output>

Options

Long

Short

Description

Can Repeat

Notes

--usage-id

-U

Usage(s) that are assigned as the product source.

Usage Ids are defined in the HPD Admin Tools utility.

TRUE

Must be specified explicitly.

--product-group-id

-G

Product group that the new product is assigned to.

Product Group Ids are defined in the HPD Admin Tools utility.

FALSE

Must be specified explicitly.

--product-id

-I

Identifier of the product type.

This must match an entry in the productinfo.xml file. Product information xml files are located in the C:\Program Files\CARIS\HPD\<version>\Modules\support\\Compilation2\ProductInfoFiles folder. See the Support Files section in the help for more information.

FALSE

Must be specified explicitly.

--product-version

-V

Version of the product type.

This must match an entry in the productinfo.xml file. Product information xml files are located in the C:\Program Files\CARIS\HPD\<version>\Modules\support\Compilation2\ProductInfoFiles folder. See the Support Files section in the help for more information.

FALSE

Must be specified explicitly.

--product-template-id

-T

Template for the product.

Product Template Ids are defined in the HPD Admin Tools utility.

FALSE

Must be specified explicitly.

--sounding-rounding

-S

Sounding rounding rule that is applied to the product. Valid values are rule names from the configuration file SoundingRounding.xml.

The default value is Truncated.

FALSE

Examples

S-101

Objective

Create a new S-101 product using a product definition file from an S-57 product.

Description

Command Line Syntax

Usages 3 and 4 are to be used for the product source.

--usage-id 3 --usage-id 4

Product group ID is 1.

--product-group-id 1

Product will be in the S-101 format.

--product-id S-101

The version for the product will be 1.1.0.

--product-version "1.1.0"

Template will be created using template 7.

--product-template-id "7"

Product definition file is named productdefinition.xml.

C:\ProductDefinition\productdefinition.xml

New product to be created in the database.

hpd://username:password@database

Command Line

carisbatch -run ImportProductDefinition --usage-id 3 --usage-id 4 --product-group-id 1 --product-id S-101 --product-version "1.1.0" --product-template-id "7" C:\ProductDefinition\productdefinition.xml hpd://username:password@database

ENC

Objective

Create a new ENC product using a product definition file from an ENC.

Description

Command Line Syntax

Usages 3 and 4 are to be used for the product source.

--usage-id 3 --usage-id 4

Product group ID is 1.

--product-group-id 1

Product will be in ENC format.

--product-id ENC

The version for the product will be 3.1

--product-version "3.1"

Template will be created using template 2.

--product-template-id "2"

Product definition file is named productdefinition.xml.

C:\ProductDefinition\productdefinition.xml

New product to be created in the database.

hpd://username:password@database

Command Line

carisbatch --run ImportProductDefinition --usage-id 3 --usage-id 4 --product-group-id 1 --product-id ENC --product-version "3.1" --product-template-id "2" C:\ProductDefinition\productdefinition.xml hpd://username:password@database