Description Format Dialog Boxes - CADWorx - Help

CADWorx Spec Editor

PPMProduct
CADWorx
PPMCategory_custom
Help
Version_CADWorx
20.1 (2020 R1)

CADWorx Spec Editor View tab: Display > Properties > <Description Type> Format Setup ellipsis

Specifies the description format.

Descriptions display in the Short annotation, Long annotation, Tag, and Code boxes shown in the Component Edit dialog box in CADWorx Plant. For more information, see Local Edit in the CADWorx Plant Users Guide.

The information the software displays in the Component Edit dialog box is based on the associated component definition in the specification. The component definition in the specification contains fields for Short Annotation, Long Annotation, Tag, and Part Number. These boxes can be populated with text data or by setting the schema in the Long, Short, Tag, and Part Number Format Dialog Boxes or Description Format Dialog Box.

You can access the Long Description Format, Short Description Format, Tag Format, and Part Number Format dialog boxes for components from the Define User Shape dialog box. These formats can only be defined during or after you have created a user shape. If you do not define formats for the user shape, then the format is based on the specification level or the project level set in the Description Format dialog boxes in the CADWorx Spec Editor. After creation of the user shape the Long, Short, Tag, and Part Number of the Define User Shape dialog box displays in the same place as all other components.

You can configure a description schema for the short annotation, long annotation, tag, and part number boxes at the project level, the specification level, and the component level. If you define a schema at any of these levels, then the software derives the description from that level.

Component level schemas take precedence over specification level schemas and specification level schemas take precedence over project level schemas. For instance, if the sub-category Nipple under Pipe in the Component List tree has a schema defined, then the information displaying in CADWorx for Nipple derives from this schema. If you remove the schema definition from the Nipple sub category, then when you place a Nipple in the model, the schema derives from the Pipe category description schema under the Component List tree.

If you remove the description schema in Pipe, the description derives from the Component description schema in the Component List tree. If you delete all of the description schemas at the component level, then the software repeats the above process internally at the specification level. Next, the software repeats this process at the project level.

When the description format is empty at the component level, then the box under Description in the New and Edit Component Pane reads Using Specification Format. If the description format is empty at the component level and at the specification level, then the box under Description in the New and Edit Component Pane reads Using Project Format.

You can only access the New and Edit Component Pane and the Description Format dialog boxes in the CADWorx Spec Editor. For more information on these features, see New and Edit Component Pane and Description Format Dialog Box in the CADWorx Spec Editor Users Guide. For more information on the component level, see Long, Short, Tag, and Part Number Format Dialog Boxes.

You can use Legacy Keywords in the Description Format dialog boxes, by typing the legacy keyword in curly brackets, such as {MAIN}. For more information, see Legacy Keywords.

Components List

Displays the available list of components. The Component List consists of levels of formats as described above. The main Component level covers all components. Next, the category level covers each category type of component. The next level contains the individual components. The software reads the schemas that you place in each of these areas in order from bottom to top. The software always reads the individual components level first. If the individual component format is empty, then the software reads the category component level. If the category component level is empty, then the software reads the main component format.

Component Tables drop-down

Displays the list of catalog tables to choose a format.

  • Component Tables

Lists the format types available for component tables in Table Fields.

  • Material Tables

Lists the format types available for material tables in Table Fields.

  • Size Tables

Lists the format types available for size tables in Table Fields.

  • Schedule Tables

Lists the format types available for schedule tables in Table Fields.

  • DBCode Tables

Lists the format types available for database code tables in Table Fields.

  • IndexCode Table

Lists the format types available for index codes tables in Table Fields.

  • Thickness Tables

Lists the format types available for thickness tables in Table Fields. This table is not available in Part Number Format.

  • End Type Tables

Lists the format types available for end type tables in Table Fields.

  • Spec Tables

Lists the format types available for spec tables in Table Fields. This table is not available in Part Number Format.

  • End Prep Tables

Lists the format types available for the end prep tables in the Table Fields. This format contains the END_PREP_PTN schema. Select the END_PREP_PTN schema to add the PTN value from the end preparation table to your descriptions. You must select an End Prep Table Name in the specification Properties for the end preparation part number to display correctly. Then, set the Apply Pipe End Prep Rule to Automatic in CADWorx Plant for the END_PREP_PTN to display in your model. For more information, see PipeDescriptionCat and Apply Pipe End Prep Rule in the CADWorx Plant Users Guide. To add an end preparation table, see End Prep Table.

Table Fields

Lists the formats for the chosen table and enables you to add the table field to the format.

The DEFINED COMPTYPE in the Component Types view affects the COMPTYPE_CMP_TBL table field. Changing the value in the DEFINED COMPTYPE box changes the descriptions using COMPTYPE_CMP_TBL. The software reads the DEFINED COMPTYPE you specified for the component. The software then displays the new DEFINED COMPTYPE value as the description when using the COMPTYPE_CMP_TBL table field schema. For more information, see Component Types.

<Description Type> Format

Lists the format and enables you to add the needed formats from the Table Fields box. If you have added a space or text in the Format box, then you can select and edit the space or text. Select the space or text, right-click, and then select Edit.

Format

Displays the appearance of the format. You can now add a space or text to the format. When you click in the <Description Type> Format the space or text you have added appears. You can then edit the information here or in the <Description Type> Format. Blue words in Format are keywords and can be selected to copy. Black text is a simple text string and can be edited as needed.

Example

Displays an example of the format as it would appear in the software.

Import

Imports formats from other projects.

Export

Exports formats for use in other projects.

  1. Open an existing project or create a new project. The <Description Type> Format dialog boxes can be opened in both places. If creating a new project, skip to the second part of step 3.

  2. Click the View tab, and then select Properties in the Display panel.

  3. Click the Long Desc, Short Desc, Tag, or Part Number Format Setup box in the Properties window, and then click an ellipsis.

    OR

    Click Long Desc, Short Desc, Tag, or Part Number in the New Project window when creating a new project.

    The <Description Type> Format dialog box displays.

  4. Select a component from the Components List.

    You can also import a format, and then edit it as needed. If you import a format and do not want to edit it, skip to step 9.

  5. Select a table from the tables list above Table fields.

  6. Use the left or right arrows to move table boxes from one field to another. Alternatively, you can drag or double-click a format to add it from Table Fields to the format box.

  7. Use the up or down arrows to move the format if needed.

    If you want to remove a format, select it, and then press DELETE.

  8. To edit the format appearance, select the format in the <Description Type> Format box, and then change the format in the Format box.

  9. Click OK when finished.

    You can export the format for use in other specifications.

  10. Click File > Save to save changes to the project.

The <Description Type> Format dialog boxes can also be accessed using the Add Specification command from the Home tab in the Specification panel.