cable_decoration_type

Sets a default cable decoration type when you use the Add Cable Decoration command to add a new cable decoration.

Format: cable_decoration_type constrained to a list of 13 default cable decorations in the design and user-defined decorations.

def_grouping

Defines the default packing or grouping at an entry port. This parameter is set on a port or the parent of the port.

Format: def_grouping constrained to ‘flat’, ‘round’, and ‘wire’.

description

A description of the catalog item.

Format: description text string.

do_not_export

Defines if the object will be included in XML export.

Format: do_not_export constrained to ‘true’ to omit from export or ‘false’ to allow export.

gender

The gender of a connector.

Format: gender constrained to ‘MALE’ or ‘FEMALE’

harness

The name of the harness.

Format: harness text string.

layer

The artifact shape layer. This parameter is constrained to the list of layers in the design.

Format: layer constrained to a list of layers in the design.

layer_func

Automatically sets the value of the layer parameter from a connected or surrounding artifact.

Format: layer_func.

model_name

The name of the 3D model representing the component.

Format: model_name text string.

name_format

The format of the component name.

Format: <name># text string. For example, the name of a connector is con##. The connectors placed would be con01, con02, and so on.

Additional format: <parameter>-C# sets the name to <parameter value>-C1, <parameter value>-C2, and so on.

num_of_pins

The number of physical pins on a component or connector.

Format: num_of_pins integer.

obj_type

Defines the type of object.

Format: obj_type constrained to ‘WIRE’, ‘CABLE’, ‘PREFAB’, ‘COMPONENT’ and ‘CONNECTOR’.

phantom

Sets the port to be excluded or not in BID-WID harness verification.

Format: phantom constrained to ‘true’ to omit from verification or ‘false’ to include in verification.

ref_des

The reference designator assigned to the component. By default the name parameter is used when communicating with cabling and piping designs. When the ref_des parameter is applied to an instance it is used instead of name.

Format: ref_des text string.

spool_name

The name of the cable or wire spool. This is a required parameter for cables and wires.

Format: spool_name text string.

term_auto_assign

A port parameter that allows assigning a terminator from a terminator table.

Format: term_auto_assign constrained to ‘true’ or ‘false’ to ignore the port when assigning a terminator table to the design.