Legacy Keywords - CADWorx - Help

CADWorx Spec Editor

PPMProduct
CADWorx
PPMCategory_custom
Help
Version_CADWorx
20.1 (2020 R1)

You can use Legacy Keywords in specification descriptions that automatically insert information during placement of a component. You can use Legacy Keywords anywhere within the Tag, Short Description, and Long Description fields. You can also use Legacy Keywords in the Index Code data file. The Legacy Keywords shown below are for the express use in the Specification Editor Description Format Dialog Boxes and do not apply to other documented keyword usages.

When you type a Legacy Keyword in the Format or Description field in the Specification Editor, the Legacy Keywords do not show examples in the Example field. Legacy Keyword values auto-populate in the 3D model when you place a component that contains a Legacy Keyword.

For example, an out-of-the-box gate valve in the 150 specification has the following Legacy Keywords assigned: {MAIN}, {SPEC}, {MAINTHK}, {REDTHK}, {LENGTH}, {BORE}, {MAINACT}, {TAG}, {LINENUM} in the Long Description in your Specification Editor. The Tag property has the words TESTTAG assigned. When you insert the component in the 3D model, the Long annotation box displays the following: 6", 150, 0.280, 0, 10 1/2", 6.065, 6 5/8", TESTTAG, 6"-150. The software pulls this information from the drawing, the catalog data table, and the Tag field based on the keyword assigned. The specific Legacy Keywords depend on the component placed, the data listed as part of the data table, and the items as defined on the component in the model space, such as with {LINENUM}, which pulls the data from the line number of the placed component. Some keywords may not have a value as they may not apply to that specific component, such as when using {RED}, {REDTHK}, {REDACT}, {REDDEC}, {REDACTDEC}, or {PIPETHKRED} Legacy Keywords with non-reducing components.

Legacy Keywords are:

  • MAIN - Displays the Main NPS Size of the component when placed in the 3D model.

  • RED - Displays the Reduction NPS Size of the component when placed in the 3D model.

  • SPEC - Displays the specification of the component when placed in the 3D model.

  • MAINTHK - Displays the main side thickness of the component when placed in the 3D model.

  • REDTHK - Displays the reducing side thickness when placed in the 3D model.

  • LENGTH - Displays the length of the component when placed in the 3D model.

  • BORE - Displays the ID of the component when placed in the 3D model.

  • MAINACT - Displays the Main Size OD of the component when placed in the 3D model.

  • REDACT - Displays the Reduction Size OD of the component when placed in the 3D model. Applies to reducing components only.

  • TAG - Displays the tag, if specified in the specification, of the component when place in the 3D model. The software pulls this information from the Specification Editor Tag field, and not from the Tag field in the Component Edit dialog box. Editing the Tag field in the component does not update the {TAG} keyword listing.

  • MAINDEC - Displays the Main NPS Size of the component when placed in the 3D model.

  • REDDEC - Displays the Reduction NPS Size of the component when placed in the 3D model. Applies to reducing components only.

  • MAINACTDEC - Displays the Main Size OD of the component when placed in the 3D model.

  • REDACTDEC - Displays the Reduction Size OD of the component when placed in the 3D model. Applies to reducing components only.

  • PIPETHK - Displays the main side thickness of the component when placed in the 3D model.

  • PIPETHKRED - Displays the reducing side thickness when placed in the 3D model. Applies to reducing components only.

  • LINENUM - Displays the line number associated with the component when placed in the 3D model. The software pulls this information from the Line Numbering System, and not from the Line Number field in the Component Edit dialog box. Editing the Line Number field in the component does not update the {LINENUM} keyword listing. Editing the Line Number System also does not automatically update the {LINENUM} value of any already placed component. However, any component placed after update, does contain the new value.

  • SPECINFONOMINALRATING - Displays the Component Class, if specified in the specification, of the component when placed in the 3D model.

  • SPECINFOTEMPERATURE- Displays the Temperature Rating, if specified in the specification, of the component when placed in the 3D model.

  • SPECINFOPRESSURE - Displays the Pressure Rating, if specified in the specification, of the component when placed in the 3D model.

  • SPECINFOPIPINGMATERIAL - Displays the Temperature Rating, if specified in the specification, of the component when placed in the 3D model.

  • SPECINFOGASKETMATERIAL - Displays the default spec material assigned piping components, if specified in the specification, of the component when placed in the 3D model.

  • SPECINFOSTUDMATERIAL - Displays the default spec material assigned stud components, if specified in the specification, of the component when placed in the 3D model.

  • SPECINFOBOLTMATERIAL - Displays the default spec material assigned bolt components, if specified in the specification, of the component when placed in the 3D model.

  • CWDBCODE - Displays the Code, if specified in the specification, of the component when placed in the 3D model.

The Legacy Keywords {BORE}, {PIPETHK} and {PIPETHKRED} are calculated from the pipe data table in the specification instead of the component's data file. For example, for a 4"x1" reducer, {PIPETHK} would get the values from the 4" pipe data table as listed in the specification. {PIPETHKRED} would get values from the 1" pipe data table. A 4"x1" reducer with {MAINTHK} or {REDTHK} would get the keyword values from the reducer data table as listed in the specification. Olet data files do not have any thickness values listed. Olet {MAINTHK} or {REDTHK} values are always read from the appropriate pipe data table.

The {BORE} Legacy Keyword is a calculation of the inside diameter of the main pipe size. It is calculated using the following formula: {BORE} = [ (Pipe Outside Diameter of Main Size) - (2*Pipe Wall Thickness of Main Size) ].

Some ways in which Legacy Keywords can be used are below:

  • PIPE, {MAIN} {MAINTHK}" API-5L GR.B DSAW, PSL2

  • FLANGE, {MAIN} ANSI 150 RFWN {BORE}" BORE ASTM A105, ASME B16.5

  • NIPPLE, PIPE {MAIN} x {LENGTH} XS ASTM A106 GR.B

  • WELDOLET, {MAIN} {MAINTHK}" x {RED} {REDTHK}" ASTM A105, ASME B31.8

  • VALVE, PLUG {MAIN} ANSI 150 WE API 6D TWT {PIPETHK}" API-5L GR.B PIPE REG PAT LO

  • GASKET, INSULATING KIT {MAIN} ANSI 600, RF, B={BORE}, PIKOTEK VCS WITH ZINC PLATED WASHERS, GRE INSULATING WASHERS AND SLEEVES

  • BOLT, STUD {MAIN} x {LENGTH} ALLOY STEEL ASTM A193 CL 2A GR B7 W/2 HEX NUTS ASTM A194 CL 2B GR 2H (FOR {MAINDEC}" 150# FLG.)

User Defined Keywords:

User defined keywords are now associated with user defined columns inside Spec Editor and can be created in catalog tables and projects by Custom Data in Properties.

Legacy Keyword Formatting:

The numeric values are formatted based on the SystemMeasure. The tables below explain the different formatting for each of the keywords. The AlphaSizeControl is read from the current configuration file.

Keyword

SystemMeasure - English/Inch

MAIN, RED

AlphaSizeControl

MAINACT, REDACT

AlphaSizeControl

MAINDEC, REDDEC

Always 3 decimal places

MAINACTDEC, REDACTDEC

Always 3 decimal places

MAINTHK, REDTHK

Always 3 decimal places

BORE, PIPETHK, PIPETHKRED

Always 3 decimal places

LENGTH

Based on DIMLUNIT, DIMDEC, DIMLFAC

SPEC

Specification filename without extension

Keyword

SystemMeasure - Metric/Inch

MAIN, RED

AlphaSizeControl

MAINACT, REDACT

LUPREC and DIMZIN control number of decimals

MAINDEC, REDDEC

Always 3 decimal places

MAINACTDEC, REDACTDEC

Always 1 decimal places

MAINTHK, REDTHK

Always 1 decimal places

BORE, PIPETHK, PIPETHKRED

Always 1 decimal places

LENGTH

Based on DIMLUNIT, DIMDEC, DIMLFAC

SPEC

Specification filename without extension

Keyword

SystemMeasure - Metric/Metric

MAIN, RED

AlphaSizeControl

MAINACT, REDACT

AlphaSizeControl

MAINDEC, REDDEC

Always 1 decimal places

MAINACTDEC, REDACTDEC

Always 1 decimal places

MAINTHK, REDTHK

Always 1 decimal places

BORE, PIPETHK, PIPETHKRED

Always 1 decimal places

LENGTH

Based on DIMLUNIT, DIMDEC, DIMLFAC

SPEC

Specification filename without extension