Using SpecGen V8i

Over View

SpecGen is AutoPLANT's stand-alone application that can create/edit spec data, create/edit catalogs, and create/edit specs for AutoPLANT.  AutoPLANT uses Specs and Catalogs to create a set of data specific to a project.  With out the creation of a spec or specs with correct data the components placed in AutoPLANT may reflect the required data for the project.  And by not limiting a spec by removing unnecessary components errors may be incurred by the placement of the wrong pipe, valve, elbow etc... 

The SpecGen help files are an excellent resource for SpecGen functions and many links in this blog are directed to a specific section of the SpecGen V8i help file located on the local hard dive such as C:\Program Files\Bentley\Plant V8i\Help\specgen.chm.

Requirements

Because Specgen is installed with AutoPLANT the requirements are the same for AutoPLANT V8i.

Database

By default SpecGen uses Microsoft Access databases for catalogs and specs; however Microsoft Access is not a required install to used SpecGen.  There are no issues with multiple users pulling data from the spec at the same time in access because this is a read only operating.   However a the Administrator for the AutoPLANT projects should have Microsoft Access available.  Access allows the viewing of specs and catalogs out of the SpecGen interface and the use of Compact & Repair functions.

SQL and Oracle databases can be used to house specs for greater security and stability.  Database compatibility is the same as AutoPLANT V8i.  Please consult a qualified DataBase Administrator (DBA) or I.T. specialist for creation and maintenance of an SQL or Oracle database.

The Basics: Specs and Catalogs

Catalogs

A catalog are the repository for all component data regardless of any specific project needs. The standard installed catalogs are there to be a general library for all component data and any filtering for a project should be done though the spec. The standard installed catalogs has most of the components required by all AutoPLANT users. Data in the catalogs should not filtered in for a project.

A review of the standard imperial catalogs can be found in SpecGen help file.

Specs

A Spec is a filtered list of component data from selected catalogs. For example the base spec CS150 only has components with a pressure ratings of 150lb and 300lb. Creating comprehensive specs prior to starting a project errors by reducing the available components for placement. All filtering of components should be done though the spec.

A review of the standard imperial Specs can be found in the SpecGen help file.

Catalogs


A catalog are the repository for all component data regardless of any specific project needs. The standard installed catalogs are there to be a general library for all component data and any filtering for a project should be done though the spec. The standard installed catalogs has most of the components required by all AutoPLANT users. Data in the catalogs should not filtered in for a project.

SpecGen opens Specs and Catalogs differently because each as a distinct user interface. When SpecGen is opened it will prompt the user to open a specific project. As a convince SpecGen will change the default folders opened to the project's Master Specs Folder. This features does not disallow the selection of other specs or catalog. Once SpecGen is open any spec or catalog can be opened.

After project selection SpecGen will give the following prompt:

SpecGen has a distinct user interface for is for editing and manipulating the tables and data in catalogs. If "Open Catalog Editor" is selected and a spec database is opened SpecGen will give the following dialog:


Do not add the CatalogTables to the selected file. If the selected file is a Spec in use the spec will be changed to a catalog.

Catalog Editor


Catalog editor is used for the creation or new components or customization of current components. The catalog editor allows direct access to all spec's data fields as seen below. The records are organized into tables such as BOLT, FLANGE, ELBOW, PIPE, etc.. Data in each table can be filtered using

Create a New Spec Record


The simplest way to create a new spec record is to first find an existing spec record that is similar to required data. Once a suitable spec record or records are found simply select the record or records right click and choose copy then paste. A copy of the spec records will be placed at the bottom of the current table. The copied records will be the same as the original excepted for the SYS_ID field; SpecGen will auto populate the SYS_ID with a new value for any new spec record created in SpecGen.

All specs should be edited or created in SpecGen because SpecGen automatically handles the generation of SYS_ID data. The SYS_ID is a unique value associated to every spec record for sorting records for the creation of Specs. If SpecGen is bypassed and a record is created in access then the unique SYS_ID will not be created which can cause issues when modeling. Below is a sample of SYS_IDs for a group of components; the last SYS_ID was automatically generated when the new spec record was created:


Once copied the spec record can be manipulated as needed; the description fields can be edited with out affecting the component connections or size in any way:

  • SHORT_DESC
  • LONG_DESC

Wile the following fields will change the basic connection type of the component which will affect what will connect to the component:

  • END_COND_1
  • END_COND_2
  • END_COND_3
  • FACEING_1
  • FACEING_2
  • FACEING_3

Finally the following fields (for a flange) when changed will affect the actual appearance of the component in the 3D model:

  • PIPE_OD_M
  • COMP_LEN
  • FLNG_OD_M
  • FLNG_TH_M

To find the basic fields that can be edited to affect the component size of the component edit the component in the 3D model space. The Edit Component dialog in this example a weld neck flange will have a general diagram of the flange with information as seen in the screen capture below:


Once the new spec records are entered in the catalog the catalog must be rebuilt by going to Catalog>Build Catalog.


Specs


A Spec is a filtered list of component data from selected catalogs. For example the base spec CS150 only has components with a pressure ratings of 150lb and 300lb. Creating comprehensive specs prior to starting a project errors by reducing the available components for placement. All filtering of components should be done though the spec.

SpecGen opens Specs and Catalogs differently because each as a distinct user interface. When SpecGen is opened it will prompt the user to open a specific project. As a convince SpecGen will change the default folders opened to the project's Master Specs Folder. This features does not disallow the selection of other specs or catalog. Once SpecGen is open any spec or catalog can be opened.

After project selection SpecGen will give the following prompt:

SpecGen has a distinct user interface for is for filtering the data from catalogs to create a usable spec. If "Open an existing spec" is selected and a catalog database is opened SpecGen will give the following dialog:


Adding Components to a Spec


When a new spec is created it does not contain any records by default. To add components to the spec the spec must reference a catalog. To add the catalog Ansi-asme.mdb go to Catalog>Select Catalogs and then choose Ansi-asme.mdb. Once added as a catalog the spec still does not have components. To add components to the spec a Section must be added.


Sections are groups of like components and once a section such as "Valve" (a default value) is added by going to Spec>Add Section spec records for valves will now be available in the spec. While choosing the default "Valve" section will add vales to the current spec it does not go to the catalog or catalogs and finds all valve records to the spec. The Valve section is actually list of CLASS_NAMEs; and the Valve section which by default includes CLASS_NAME that correspond to valve spec records. If a new section is added with a section name such as "Test Section" by typing this name in the Add New Spec Section:

Then a new section will be added named Test Section:

However this section will not have any component records because there are no CLASS_NAMES associated with this section:

The CLASS_NAMEs of the components for this section must be added for records to be pulled form the catalog. If Test Section is for elbows from the base module only; then all of the all of the class names with "AT_ELBOW_" will have to be added to the Selected Classes. The classes added to the section control the spec records added to the section not the name of the section.


Spec Constraints

A section with out constrains will pull every spec record from the catalog. Because of the huge number of records using all of the available records in a project can cause confusion as to which component is required. Using constraints will reduce the total record count.

For example the previous example of adding elbows to a section will produce a section with 1678 elbow spec records as seen below:

Using the constrains allows the spec records to be paired down to the necessary. For example if the current project will only use pipe sizes between 3 and 6 inches the following constrains can be added:

With the addition of the min and max size constrains the record count is now 299.


What if the project will only use rating 150 and 300. ratings 150 and 300 can be selected individuallyby pulling down the rating section and choosing the bottom entry "...". Choosing "..." will bring up a the following dialog:


Once the 150 and 300 rating are selected the records are paired down to 24 records:


Adding Constraint Types


Sections have a default list of available constrains (min size, max size, schedule, rating, etc...). If an additional constrain type is required then it can be easily added by pressing the Modify Constraints field:


Using this dialog a new constraint type can be added. As an example LONG_DESCR is added to list of constraints as seen below:


Dynamic Filtering

Dynamic filtering is a new feature added to SpecGen V8i. Dynamic Filtering will automatically remove options in the constraint pull downs when they are not available because another constraint. For example with Dynamic Filtering on if a max size is set to 1 then min size will now only have sizes 1/8 to 1 available. When Dynamic Filtering is off if max size is set to 1 min size will show all sizes.

Dynamic Filtering On

Dynamic Filtering Off


Specification Selection Error

AutoPLANT pulls data from a selected spec when a command is chosen. If the component selected is in the spec AutoPLANT will place the component. If the component is not in the spec then an error will appear similar to the following:

Use the following Technote http://communities.bentley.com/Products/Plant/Design___Engineering/w/Plant_Design_and_Engineering__Wiki/specification-selection-error.aspx 
on the BeCommunities wiki site which details how to find components using specgen or use the method described later using component manager.


Component Manager

Component Manager is simply SpecGen specific search engine. Component Manager may be the most useful tool in SpecGen and its use will aid in the creation of a new catalog or spec. It has features that are able to search though the following:

  • Catalogs, single or multiple
  • Specs, single or multiple
  • All record fields including CLASS, CATALOG, GTYPE, STYPE, MAIN_SIZE, LONG_DSCR, etc...


How to find a Component Using CLASS_NAME

A common issue for AutoPLANT users is that they require a component for a new spec but the user is unable to find what catalog and table the spec record is located. This is understandable considering there are thousands of spec records spanning 120 catalogs. To find specific components use the following method using the component's CLASS_NAME.

Find the CLASS name

All AutoPLANT components have a CLASS_NAME (e.g. a pipe's CLASS_NAME is AT_PIPE and a ball valve's is AT_VALVE_BALL); because every type of component has its own CLASS_NAME and the CLASS_NAME is used as the main ID to pull components it is the perfect value to use as a search criteria.

To find the CLASS_NAME of a component that will place such as a 90 degree long radius elbow from the CS150spec edit the component and select the second page. The CLASS_NAME is the third field in Database Information as seen below.

Using the CS150 Spec a True Wye will not place (Piping>Branching Components>True Wye). Once the attempt of placing the True Wye has failed use the keyboard command Shift + Up Arrow to cycle though the previous AutoCAD commands. Shift + Up Arrow once and the True Wye CLASS_NAME will appear as displayed below:

In SpecGen start Component Manager then add all catalogs to the search ALT+ A. Then in the Filter Builder section select the CLASS_NAME and enter AT_TRUE_WYE in the string criteria. Add this criteria to the filter and search the catalogs. This Filter Builder is the same as the one in the catalog interface only the String Criteria will not auto populate.

The search results for a CLASS_NAME of AT_TRUE_WYE shows that there are 3 catalogs that have True Wye components located in the MISC_FIT table as shown below.

This procedure can be used to find any component using an AutoPLANT command from any module.

Reports

SpecGen has built in reports which will output data about all components in the spec. The provided reports allow for a comprehensive spec review. Default reports are limited to the following:

• Detail By Size
• Detail By Subtype
• Entire Spec
• MINIMAX Repot
• Spec Sheet

New Specgen reports can be created and existing reports can be edited. Unlike AutoPLANT which uses Business Objects Crystal Reports for its reports; SpecGen Reports are created using Microsoft Access.

SpecGen's help file has an excellent walkthrough on how to create a New SpecGen Report and a walkthrough about how to Customize a Specgen Report.

Spec Upgrade Wizard

Using Spec Upgrade Wizard is required when using specs created with a version of SpecGen prior to version 7.0. When SpecGen opens a spec created prior to 7.0 SpecGen will automatically run Spec Upgrade Wizard.

The average user may never need to use Spec Upgrade Wizard because Specs that would require an upgrade would be 5+ years old.

SpecGen Error Log

When SpecGen has an error it will output the error its error log. The error are logged in the file ErrLog.txt in the following path C:\Program Files\Bentley\Plant V8i\Specgen. The error in the log can be very specific to what has caused the error. Other times the error will be nondescript and can reference database drivers. When there is an issue with SpecGen that requires an AutoPLANT support call please include the error log when creating the Service Ticket.

Below are sample errors from the error log.

 

4/21/2009
8:28:36 AM
Warning: The following table was not found in CatalogELBOW
--------------------------------------------------------------------------------
8/19/2009
2:46:23 PM
Warning: One of the fields in the following where clause:{ WHERE [COMP_LEN] = 0.125 AND ([MAIN_SIZE] IN('1/4', '3/8', '1/2', '3/4', '1', '1+1/4', '1+1/2', '2', '2+1/2', '3', '3+1/2', '4', '5', '6', '8', '10', '12', '14', '16', '18', '20', '22', '24', '26', '28', '30', '32', '34', '36', '38', '40', '42')) AND [RATING] = '150LB' AND [FACING_1] IN ('FF','RF') AND [CATALOG] = 'ASME/ANSI B16.20' AND [CLASS_NAME] IN ('AT_BOLT', 'AT_GASKET', 'AT_LUG_BOLT', 'AT_WELDGAP') } are missing from table: BOLT.
--------------------------------------------------------------------------------
8/24/2009
10:31:25 AM
Warning: One of the fields (SPEC_CRITERIA_ROW and/or SPEC_GROUP) is/are missing from table: volet
--------------------------------------------------------------------------------

Moving Specs & Catalogs

Because Specs are linked to Catalogs moving specs to a different location will cause the spec to be unable to connect to its catalogs. If the spec or catalog is moved the following error will occur indicating that the spec cannot find a catalog.

After selecting "OK" the user will be prompted with the new location of the catalog. Navigate to the new location of that catalog then select the catalog then press "OK". The spec now has the new location of that catalog saved.

 

Database Maintenance


The Spec and Catalog database can become corrupted and SpecGen will be unable to access the data. When this happens there are 2 recourses that can be taken to recover the database Compact and Repair using Microsoft Access or a restore from a backup.

Compact and Repair will remove extra data entries from the database and repair data tables. Also when a Catalog has been edited out of Specgen the size of the database can be multiplied by several times. For example a catalog that a user edited though access to add a random part number to each record had ballooned in size to over 1.5 gigs. Once Compact and Repair was run the database size was reduced to under 50 megs. Because the user had several catalogs over a gigabyte in size the spec would take over an hour to build.

Compact and Repair can also be used on Specs if the spec is not performing correctly.

In Access 2003 Compact an Repair can be found On the Tools menu, point to Database Utilities, and then click Compact and Repair Database/Project; in the following location in Access 2007.