CARIS Process Designer : CARIS Batch : HPD Processes : ProductBuilder License : Import Product Definition
 

Import Product Definition

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

Input

An XML file containing the product definition.

Output

A URI of an HPD schema.

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

The usages that are assigned as the product source.

TRUE

This must be specified explicitly.

--product-group-id

-G

The product group that the new product is assigned to.

FALSE

This must be specified explicitly.

--product-id

-I

The identifier of the product type.

This must match an entry in the product information file. See the Support Files guide for more information.

FALSE

This must be specified explicitly.

--product-version

-V

The version of the product type.

This must match an entry in the product information file. See the Support Files guide for more information.

FALSE

This must be specified explicitly.

--product-template-id

-T

The template for the product.

FALSE

This must be specified explicitly.

--sounding-rounding

-S

Th sounding rounding rule used by the product. Valid values are rule names from the configuration file SoundingRounding.xml.

The default rule is Truncated.

FALSE

Example

Example

Objective

You want to 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

The product group ID is 1.

--product-group-id 1

The product will be in the S-101 format.

--product-id S-101

This version for the product will be 1.0 Final Draft.

-product-version "1.0 Final Draft"

The template will be created using template 1.

--product-template-id "1"

The product definition file is named productdefinition.xml and is located in D:\Data.

D:\Data\productdefinition.xml

The new product will be created in the OracleDB database. The credentials for the database are:

Username: User1

Password: DefaultPass1!

hpd://User1:DefaultPass1!@OracleDB

Command Line

carisbatch -r ImportProductDefinition --usage-id 3 --usage-id 4 --product-group-id 1 --product-id S-101 --product-version "1.0 Final Draft" --product-template-id "1" D:\Data\productdefinition.xml hpd://User1:DefaultPass1!@OracleDB