AspenBasicEngV7 0 Start

Aspen Basic Engineering V7.0

Getting Started Guide

Version: V7.0 July 2008

Copyright © 1981 – 2008 Aspen Technology, Inc. All rights reserved.

Aspen Basic Engineering, Aspen Plus®, Aspen HYSYS®, and the aspen leaf logo are trademarks or registered trademarks of Aspen Technology, Inc., Burlington, MA.

All other brand and product names are trademarks or registered trademarks of their respective companies.

This documentation contains AspenTech proprietary and confidential information and may not be disclosed, used, or copied without the prior consent of AspenTech.

ASPENTECH MAKES NO WARRANTY OR REPRESENTATION, EITHER EXPRESSED OR IMPLIED, WIT RESPECT TO THIS DOCUMENTATION, ITS QUALITY, PERFORMANCE, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

Aspen Technology, Inc. 200 Wheeler Road Burlington, MA 01803-5501 USA Phone: (781) 221-4300 Toll free: (888) 996-7001 Website http://www.aspentech.com

Contents iii

Contents

1 About This Guide ..................................................................................................1 About Aspen Basic Engineering ........................................................................ 1 Related Documentation................................................................................... 1 Technical Support .......................................................................................... 2

Phone and E-mail ................................................................................. 3

2 Aspen Basic Engineering Applications ..................................................................5 Datasheet Applications.................................................................................... 5

Datasheet Editor .................................................................................. 5 Datasheet Definer ................................................................................ 6 Datasheet Generator ............................................................................ 7

Drawing Applications ...................................................................................... 8 Drawing Editor..................................................................................... 8 Graphics Definer .................................................................................. 9

Configuration Applications ............................................................................... 9 Administration ..................................................................................... 9 Class Library Editor .............................................................................10

Interface Applications ....................................................................................13 Bridge ...............................................................................................13 Costing Interface.................................................................................13 Object Mapper ....................................................................................13 Simulator Interface..............................................................................13 Rules Editor........................................................................................14

Explorer.......................................................................................................14 Packages ...........................................................................................14

Project Management and Smartplant ...............................................................15 Project Management within Aspen Basic Engineering ................................15 Project Support within Smartplant .........................................................15

3 Aspen Basic Engineering Basics .........................................................................17 Starting Aspen Basic Engineering ....................................................................17 Opening Workspaces .....................................................................................18 Aspen Basic Engineering Windows ...................................................................19

Toolbars ............................................................................................19 Status Bar..........................................................................................19

4 Using Aspen Basic Engineering ..........................................................................21 Working with Database Objects.......................................................................21

Creating Database Objects ...................................................................21 Deleting Database Objects....................................................................22 Copying Database Objects ....................................................................22

iv Contents

Cloning Database Objects.....................................................................22 Working with Holds..............................................................................23 Current Object Filters...........................................................................23

Working with Cases .......................................................................................24 Creating Cases....................................................................................24 Deleting Cases....................................................................................24 Renaming Cases .................................................................................24 Copying Cases ....................................................................................25

Working with Documents................................................................................25 Accessing Documents ....................................................................................25

Creating New Datasheets .....................................................................26 Creating New Diagrams........................................................................27 Opening Existing Documents.................................................................27 Viewing Document Status.....................................................................28 Printing Documents .............................................................................28 Renaming Documents ..........................................................................28

Document Revision Control.............................................................................29 Submitting a Document........................................................................31 Checking a Document ..........................................................................32 Issuing a Document.............................................................................33 Deleting a Document ...........................................................................34 Removing a Document from the Revision Process ....................................34

5 Glossary .............................................................................................................35 Glossary of Terms .........................................................................................35

Administration User .............................................................................35 AES...................................................................................................35 Aggregation........................................................................................35 Annotation .........................................................................................35 API datasheet .....................................................................................35 Application .........................................................................................36 Application Interface............................................................................36 As-Built .............................................................................................36 Association.........................................................................................36 Attribute ............................................................................................36 ATESA ...............................................................................................36 Authoring Application...........................................................................36 Base Class .........................................................................................36 BEDD ................................................................................................36 Boolean .............................................................................................37 Bridge ...............................................................................................37 Case..................................................................................................37 Case Fixed .........................................................................................37 Category............................................................................................37 CCDM................................................................................................37 Claim ................................................................................................37 Class .................................................................................................37 Class Library ......................................................................................38 Class Store.........................................................................................38 Class View..........................................................................................38 Clone ................................................................................................38 Clone Fixed ........................................................................................38

Contents v

Composite (Class) View........................................................................38 Conceptual Data Model.........................................................................38 Configuration User...............................................................................38 Connection.........................................................................................39 Copy .................................................................................................39 Data Model.........................................................................................39 Data Model Construct...........................................................................39 Datasheet ..........................................................................................39 Datasheet Builder................................................................................39 Datasheet Group.................................................................................39 Default Fixed ......................................................................................39 Delete ...............................................................................................40 Destroy .............................................................................................40 Discipline ...........................................................................................40 Display Name .....................................................................................40 Document ..........................................................................................40 Drawing.............................................................................................40 End User............................................................................................40 Engineering Framework........................................................................41 Enumeration Data Type........................................................................41 Equipment List....................................................................................41 EXPRESS............................................................................................41 FEED .................................................................................................41 Field..................................................................................................41 Field Lock...........................................................................................41 Field Status ........................................................................................41 Fitting................................................................................................42 Folder................................................................................................42 GAIP .................................................................................................42 Generalization ....................................................................................42 Global Case ........................................................................................42 Graphic Hold.......................................................................................42 GUI...................................................................................................42 Hold ..................................................................................................42 Knowledge Base (KB)...........................................................................42 Link...................................................................................................43 Link set .............................................................................................43 Lock ..................................................................................................43 Mapping.............................................................................................43 Mass Balance Header ...........................................................................43 Mass Balance Column ..........................................................................43 MMC..................................................................................................43 Multiplicity .........................................................................................43 Object ...............................................................................................44 Overspill ............................................................................................44 Overspill Sheet ...................................................................................44 Page..................................................................................................44 PIP Datasheet.....................................................................................44 Piping System.....................................................................................44 Privilege.............................................................................................44 Project...............................................................................................45 Quantity Type.....................................................................................45 Reference Point...................................................................................45

vi Contents

Remove .............................................................................................45 Restricted Case...................................................................................45 PFD...................................................................................................45 Role (1) .............................................................................................45 Role (2) .............................................................................................46 Role Members.....................................................................................46 Simulator Interface..............................................................................46 Smart Plant Foundation (SPF) ...............................................................46 Snapin...............................................................................................46 STEP .................................................................................................46 STEP File............................................................................................46 Stream ..............................................................................................46 Subclass ............................................................................................46 Superclass .........................................................................................46 Summary Sheet ..................................................................................47 System Class......................................................................................47 System Library ...................................................................................47 Table.................................................................................................47 Smartplant® ......................................................................................47 Transaction Lock .................................................................................47 UO ....................................................................................................47 UOM..................................................................................................47 User Library .......................................................................................47 User Lock...........................................................................................48 W3C..................................................................................................48 Workspace .........................................................................................48 Workspace Package .............................................................................48

Index ....................................................................................................................49

1 About This Guide 1

1 About This Guide

This guide provides an overview of the Aspen Basic Engineering application set and takes a first-time user through basic Aspen Basic Engineering procedures.

After completing this guide, you will be able to open/close workspaces, work with database objects, cases, documents (drawings and diagrams) and understand document control and revision processes.

About Aspen Basic Engineering Aspen Basic Engineering is a client/server application that allows multiple process designers to be connected to a single workspace or project.

Changes made by one client are immediately reflected in the information shown to other clients.

To generate a process design, you create database objects that represent the real world process. You can view and modify data for these objects using drawings, or datasheets (Before you can work with datasheets or diagrams, you must open a Workspace or Project).

Related Documentation In addition to this document, the following documents are provided to help users learn and use the Aspen Basic Engineering applications: Title Content

What’s New This guide provides an overview of new features and functionality within the Aspen Basic Engineering application set and describes how to work with Aspen Basic Engineering Projects within Aspen Basic Engineering and within Smartplant®

2 1 About This Guide

Title Content

Administrator Reference Manual

This manual contains advanced details of Aspen Basic Engineering applications and functionality. Contents include details of the Aspen Basic Engineering processes applicable to a user with Administrative rights. The following sections/functions are covered: • Generating datasheets, (and using the Datasheet Definer)

including preparing datasheets in Microsoft Excel 2000/XP • Using the Graphics Definer (including defining symbols and

labels, with worked examples and extracting legacy symbols and labels)

• Using the Explorer application, including interaction with Smartplant®

• Using the Administration application • Using the Class Library Editor application • Using the Rules Editor (and Knowledge Bases) • Using the Bridge application

On-line Help A comprehensive set of help systems are also provided with Aspen Basic Engineering. Help within specific applications (for example Bridge Help) is available from the Help menu of the open application

A generic, self-contained Help system (detailing all Aspen Basic Engineering applications, their use and interaction) is available by clicking on the Help icon within the windows Start | Programs | AspenTech | Aspen Basic Engineering path

Technical Support

Online Technical Support Center AspenTech customers with a valid license and software maintenance agreement can register to access the Online Technical Support Center at:

http://support.aspentech.com

You use the Online Technical Support Center to:

• Access current product documentation.

• Search for technical tips, solutions, and frequently asked questions (FAQs).

• Search for and download application examples.

• Search for and download service packs and product updates.

• Submit and track technical issues.

• Search for and review known limitations.

• Send suggestions.

Registered users can also subscribe to our Technical Support e-Bulletins. These e-Bulletins proactively alert you to important technical support information such as:

• Technical advisories.

http://support.aspentech.com/

1 About This Guide 3

• Product updates.

• Service Pack announcements.

• Product release announcements.

Phone and E-mail Customer support is also available by phone, fax, and e-mail for customers who have a current support contract for their product(s). Toll-free charges are listed where available; otherwise local and international rates apply.

For the most up-to-date phone listings; please see the Online Technical Support Center at:

http://support.aspentech.com Support Centers Operating Hours

North America 8:00 – 20:00 Eastern time

South America 9:00 – 17:00 Local time

Europe 8:30 – 18:00 Central European time

Asia and Pacific Region 9:00 – 17:30 Local time

http://support.aspentech.com/

4 1 About This Guide

2 Aspen Basic Engineering Applications 5

2 Aspen Basic Engineering Applications

This section provides an overview of Aspen Basic Engineering applications and functionality within the applications listed below:

• Administration

• Bridge

• Class Library Editor

• Common Core Data Model – CCDM

• Costing Interface

• Datasheet Editor

• Datasheet Definer

• Drawing Editor

• Datasheet Generator

• Explorer

• Graphics Definer

• Project Management

• Object Mapper

• Simulator Interface

• Smartplant®

• Rules Editor

Datasheet Applications

Datasheet Editor The Datasheet Editor is one of three key end user tools (the others are the Drawing Editor and Explorer. This application is used to create and edit datasheets and move these documents through your work process.

The datasheet editor can also be used to perform a range of basic operations on objects contained within the Aspen Basic Engineering Workspace, such as

6 2 Aspen Basic Engineering Applications

copy, delete and so on. It can also be used to launch rules on the data contained within the workspace.

It is intended for all general users of the software. However, datasheet templates must already exist for the documents you wish to work on. You can use the delivered templates or use your own (see Datasheet Definer below).

Recent improvements to the Datasheet Editor include:

• Multiple-page Datasheet option – Multiple-page datasheets can be:

o Created

o Opened

o Added: From another template to the current document

o Reordered: Modify the order of the pages in a document

o Removed: Delete pages from the current document

• Removed: Datasheet groups – multi-page datasheets provide replacement functionality. Other flexibility provided by datasheet groups will be retro-fitted into subsequent releases.

• Radio Buttons can be set, unset and cleared individually.

• Check Boxes can be selected, unselected and cleared.

• Support for other new data types such as Date, Booleans, and Enumerations.

• Support for background color.

• Insert page.

• Datasheet templates can be changed and reapplied to a workspace without loss of document format information.

• Overspill pages functionality has been returned (existed in 11.1).

Datasheet Definer The Datasheet Definer is a tool used to develop templates for Datasheets based on Microsoft Excel 2000/XP (previous versions of Excel are incompatible). You must pre-install Microsoft Excel 2000/XP to use the Datasheet Definer – refer to the Installation Guide).

Datasheet Definer features include:

• Class View Browsing – Routes are defined using Class Views provided by the new Data Model.

• Generate function – It is now possible to generate the datasheet and obtain a template file using the new .xml file format.

• New definition of fields – All existing fields are definable using the new cell based definition metaphor. This has the following capabilities and side-effects: o No need for a design mode, no need for a separate executable and so

no need to switch windows. The menu bar disappears and is replaced by a dockable Excel toolbar. There is no need to manually attach the AddIn as it is now a COM AddIn.

o Cells can be 'tagged' as being a field. So no controls float above the spreadsheet that are moved and sized independently. Cells are the Fields.


o A Single file is produced with the extension .ztf that replaces both .gdf and .tpl files. No .raw file is required.

o Remark fields have now been removed.

o Multi-page datasheets: Documents can now be defined as separate worksheets, in the same workbook, in the Excel definer (a single datasheet page on each spreadsheet sheet).

o Radio Buttons: Radio buttons can be defined and grouped together - different shapes and check marks for buttons can also be defined.

o Check Boxes: Create user-defined check boxes and define different shapes and check marks for buttons.

o “Other” fields: Create user-defined “Other” fields in radio button group.

o Qualified Fields: You can now add qualified fields and groups.

o Generate Template File: User-generated (valid) template file from datasheet definition.

• Excel drawing shapes can be used to produce sketches on the datasheet. As the datasheet generator uses the excel file to produce its final document, any drawing will be reproduced faithfully when exported. However, when viewing in the datasheet editor not all shapes will appear as only basic shapes are supported (check the datasheet definer help for details). It means that drawings appearing in the datasheet editor may have missing details depending on the shapes and formatting you use. This is a practical limitation of the datasheet editor as it does not emulate Excel in this respect.

Datasheet Generator This tool (launched from Start | Programs | AspenTech | Aspen Basic Engineering | Excel Datasheet Generator) enables you to bring a datasheet file created in the Datasheet Editor (exported as .xml format) into Microsoft Excel. You must install Microsoft Excel 2000/XP to use the Datasheet Definer – refer to the Installation Guide supplied on the product. Previous versions of Excel are incompatible.

Once in Excel 2000/XP, the file (in .xls format) is independent of the Aspen Basic Engineering database and can be used, for example, for further distribution or review.

Datasheets generated by the Datasheet Generator and opened in Excel are completely accurate and reproduce the original definition sheets exactly. Changes to the data in the spreadsheet cannot be re-imported later. This tool is intended for report purposes only.


Drawing Applications

Drawing Editor The Drawing Editor is a primary tool used for creating drawings as part of your engineering project. It is configured out of the box with symbols and labels used to produce PFD drawings.

You can create as many drawings as required in your workspace. You build up drawings by dragging and dropping symbols and labels onto the drawing canvas. Connections are created by using one of the available connection symbols. Some symbols operate as fittings and can be simply dropped into lines. Connection gapping and un-gapping are also supported along with numerous features required to produce professional drawings.

Objects placed on a drawing create equipment objects on the database. These are also added to the stockpile of objects that you can view with the Drawing Editor. The stockpile is the actual view of the content of the database. You can remove symbols/objects from the drawing without deleting them from the stockpile/database, or you can permanently delete them from both the drawing and stockpile/database, or indeed reinstate an object back onto a drawing if it only exists in the stockpile.

Recent Drawing Editor features include the following:

• Label Fields – Support all the data types of the new version system, including: o Real and integer fields with prefix/suffix and substitution text

o Boolean fields with drop down on/off/yes/no select list

o Date fields with date picker and dropdown calendar

o Enumerations with drop down list

o Format options specific to the data types

• Piping Systems – An improved user interface makes editing piping systems easier.

• Mouse/selection improvements to assist usability when making connections or when placing and moving symbols.

• Project support by de-emphasizing symbols not in the project scope and disallowing connectivity edits to symbols that are not within the project scope.

Note: Parametric Symbols The supplied parametric symbol "Parametric Column.sym" has had the width parameter removed. This is to enable fittings to fit the column width. If you need to change to the width, scale the symbol by using the corner handles (rectangular). This way, any fittings attached will "Inherit" this scaling and therefore fit correctly. Height of column can still be set parametrically using the single (diamond) handle at the apex of the column.


Graphics Definer The Graphics Definer enables you to produce templates of Symbols and Labels for use with Aspen Basic Engineering.

You construct symbols and the graphical elements of labels by using the available drawing tools to lay down lines, arcs, text, rectangles etc onto the drawing canvas. The tool has all the usual drawing tool features such as snap to grid, rotate, reflect, scale plus dynamic drag features (for stretching for example).

The tool also uses Intergraph SmartMouse features that allow you to snap to geometry (for example interception points).

In recent versions, the Graphics Definer allows you to use the Class View features of Aspen Basic Engineering. This means that you are presented with a browser to find the class view attribute to be associated with a label.

Value fields of labels can now have a description as well a tag, so that label designers can reduce clutter and overlap of fields. Furthermore, the symbol extraction functionality has been improved.

Configuration Applications

Administration The Administration application is used to administer (view, edit and create, Aspen Basic Engineering Workspaces - previously Workgroups), configure user and user group privileges and set security options.

A Wizard is provided for setting up a new Workspace. This prompts you for information relating to your chosen OLEDB database, Class Store to be used, and so on.

Other features include:

• View Workspace Users (and applications) connected to a workspace and change them.

• View Roles and change them.

• Add/remove Data Servers.

• Import/Export Access Policy File:

o Import a policy file to add Users and Roles into a workspace instead of by working with the user interface – this helps reuse of information between projects.

o Export a policy file to record Users and Roles configured for a workspace for later reuse.

• The application is a Microsoft Management Console Snap-in. The format of the user interface is identical to that provided by many ‘Management Tools’ installed on your PC. It means you can plug the snap-in into a single console along with others such as the standard Windows users and groups management snap-in and possibly the configuration snap-in for


your chosen RDB (such as Oracle or SQL Server). This gives you a single customized window for all your administrative tasks.

Class Library Editor The Class Library Editor application allows configuration users to create and edit a Data Model to be used by Aspen Basic Engineering. The Data Model source is held in a collection of Class Libraries and the Editor is used to write these and to compile them into a Class Store. A Class Store, nominated during Workspace configuration (see the Administration Tool), is loaded into the server to support a Workspace. This organization of a collection of Class Libraries is used to give flexibility in combining data model fragments into different Class Stores, and to allow you to more easily manage your data model customizations.

• A Class Library comprises a collection of class definitions and related data model definitions. Typically, the set of definitions contained in each class library will be related by a common purpose, e.g. a class library may contain constructs for rotating equipment, or constructs for heat transfer.

The Class Library Editor is designed as a purpose made tool for working with the new 3-Tier Data Model Architecture. In Version 11.1 and many other database products you work directly with the core data model and all applications of the data map explicitly to the model via ‘routes’ or ‘paths’ to the required attributes. This is fine until the data model becomes difficult for the ordinary user to navigate or comprehend. Imagine the scenario with applications needing access to process data:

• Here many applications want access to the CORRECT attribute in an engineering sense. At the same time, when you work with the data model, you have to ensure the route you use is the correct one for the purposes of SHARING data with all the other applications accessing the data.


• The problem is made complex for ordinary users as the data model is very, very rich in content and is highly structured either from a hierarchical perspective or by inheritance. If you were to customize the Aspen Basic Engineering Data Model it would take significant effort to ensure you did not inadvertently overwrite some key attribute which was being input into some design calculation.

• The 3-Tier data model solves this problem by making everything much more transparent:

Class Views The top tier contains Class Views. A Class View is a simple, engineer friendly, mini-data model of an applications use of data. The principles exclude inheritance and they are usually flat or have only very shallow hierarchies. The idea is that the attributes of a class view are the properties of the application in the applications terminology. So a Class View for a simulator


may sensibly use Model Variable names as attributes. Similarly, a datasheet attribute name would be taken almost directly from the datasheet text.

Once (for example) a datasheet is mapped to a Class View the datasheet need never change if the lower tiers of the data model change. Also the mapping exercise becomes much faster in the first place as you are linking two highly related engineering views. This helps dramatically in subsequent maintenance efforts.

Composite Class Views Composite Class Views are the glue between the outside world defined by Class Views, and the core data model. In the middle tier of the data model, they allow engineers to ensure data is shared correctly across applications independently of the core model. One or many related applications represented by Class Views map to a single Composite Class View which in turn has a unique mapping to the core data model.

Using the Class Library Editor you perform many operations using drag and drop to simplify and speed the mapping processes. You can also view the usage of individual attributes so you can explicitly see which class views (and therefore applications) use the attribute. The Editor also maintains some integrity to your data modeling by retaining mappings when you make simple name changes.

Classes These are the fundamental building blocks of the Class Library. These support all the modeling richness of Aspen Zyqad 11.1, and add support for Associations and a range of new data types supported by Aspen Basic Engineering. The Class Library Editor allows you to create and edit these with the ability to check your work at the click of a button. Errors and warnings are produced if necessary, and from these you can navigate to the source of the problem. Graphical views are also provided to help model understanding.

Common Core Data Model (CCDM) The Aspen Basic Engineering delivered Equipment Model is the Common Core Data Model or CCDM. Class Views and Composite Class Views have been added to support all of the interfaces, datasheets and applications delivered with Aspen Basic Engineering. All of the classes that make up the system level needs (not equipment) are broken out into a separate class store called the System Model.

Customizations are now stored in separate class libraries and ‘include’ libraries from the delivered class stores (that are now read only). Multiple class stores can be combined to produce different model combinations. Existing delivered data model elements can be customized at will even though these are read only. All changes are stored as extensions to the out of the box data model.


Interface Applications

Bridge The Aspen Basic Engineering bridge application is used to create a bridge allowing two-way data transfer between an Aspen Basic Engineering Workspace and either Microsoft Word or Microsoft Excel files. Users can interact with the transfer process, data can be viewed as it is transferred and a bridge object can be configured to link data objects in applications.

New Bridges are defined in the design mode of the application. You define ‘links’ between Aspen Basic Engineering Class Views and the desktop tool in this mode. Bridges can be saved and reused.

In this version of Aspen Basic Engineering, Microsoft Word and Microsoft Excel are Bridge applications. The Bridge concept is designed for extension to other desktop applications at a later date.

Costing Interface The Costing Interface is a two-way interface for estimating equipment costs and transfers equipment data between Aspen Basic Engineering and Costing Tools and vice-versa:

• Costing Tool to Aspen Basic Engineering Use the interface to transfer data to equipment items in the Aspen Basic Engineering database.

• Aspen Basic Engineering to Costing Tool Use the interface to update equipment data in the Costing Tool database, for example, after performing a thermal heat exchanger design from the Aspen Basic Engineering database.

• Supports only one-to-one mappings.

Object Mapper This interface incorporates the Class View (and the three-tier data model) functionality. (The New button item has been removed from each tab, and the disabled Components tab has also been removed.)

Simulator Interface This interface has been updated to incorporate the Class View (and the three-tier data model) functionality.

Aspen Basic Engineering supports the following simulators:

• Aspen Plus Version 12.1 and later

• HYSYS Version 3.1 and later

• Pro/II Version .5.5 and later and client/server


Rules Editor The Rules Editor is a syntax coloring editor for the creation and modification of knowledge base (KB) script source files. It also allows these source files to be compiled and loaded into the server, and allows you to execute Methods, Rules, Sorts and Filters.

Rules, methods, demons, and events are the primary means of implementing a knowledge base. Rules is a generic term used to cover all knowledge base elements regardless of their specific type.

Explorer The Aspen Basic Engineering Explorer provides an organizational view of objects and data, diagrams and datasheets in an open workspace. You collect database content into a tree view of folders from which you can then perform a variety of operations.

Subject to your permissions, you can perform basic object operations such as copy and clone through to browsing or editing object attributes. The attribute views can either allow you to navigate the actual stored object structure or to view the data in a flat engineering-oriented display. This latter view is helpful to end-users rather than configuration users.

Authorized users can also assign security to folders giving another way of managing access to objects, documents and data. The access rights simply control access to the folder content. This is provided in addition to the main access control features of the new Aspen Basic Engineering.

Folders are also used as a central part of the new Modular Design features of Aspen Basic Engineering. The Explorer is used to import and export modules in the form of Packages.

Packages The Packages functionality includes the following:

• Export a folder: An XML file is created in the packages directory with the folder and all contained objects.

• Import a package: Objects in the package are added into the current folder.

• Export a drawing: An XML file is created in the packages directory with the drawing and all contained objects.

• Export a datasheet: An XML file is created in the packages directory with the datasheet and all contained objects.

• List Packages: When exporting/Importing Packages a list of all existing Packages is available.


Project Management and Smartplant

Project Management within Aspen Basic Engineering A project within Aspen Basic Engineering is an isolated piece of work whose changes are only visible to users logged on to that Project.

Projects typically are used for numerous purposes including:

• Modifying an existing ‘as-built’ plant Modifications can be made in a project so the main design is unaffected. Once the modifications have been carried out to the physical plant then the project can be ‘committed’, at which point the changes will be applied to the main design.

• Design alternatives During a design different topology options can be created and analyzed, each in its own project. Once the preferred design alternative is identified then the corresponding project can be ‘committed’ to the main design and the projects for the other alternatives discarded.

• Segregating a Design A design can be broken up into a number of sections, each section being a project, so that users would work on the section(s) that they have been given access to. On completion of sections the corresponding projects would be ‘committed’ to create a single contiguous design.

Project Support within Smartplant Smartplant® is a central data and document repository, and centralized project administration function. Aspen Basic Engineering supports this function, allowing projects to be published and retrieved to Smartplant.

Intergraph’s SmartPlant Foundation (SPF) is at the core of Smartplant® and is required to allow Aspen Basic Engineering/Smartplant functionality.

Note: Before you can use Aspen Basic Engineering with Smartplant, a workspace must be registered with an Smartplant plant database. This only needs to be done the first time a workspace is to be used with Smartplant. Registration is achieved via the Register Framework menu option.

Refer to the Aspen Basic Engineering online Help for further details of Project Management within Aspen Basic Engineering and working with Smartplant.


3 Aspen Basic Engineering Basics 17

3 Aspen Basic Engineering Basics

Aspen Basic Engineering is a client/server application that allows multiple process designers to be connected to a single workspace. Changes made by one client are immediately reflected in the information shown to other clients.

To generate a process design, you create database objects that represent the real world process. You can view and modify data for these objects using several client applications.

This chapter contains the following sections:

• Starting Aspen Basic Engineering

• Accessing a project workspace

• Datasheet Editor

• Page setup configuration

• Using workspaces

• Quitting Aspen Basic Engineering

Starting Aspen Basic Engineering To start the Aspen Basic Engineering Datasheet Editor:

• Do one of the following:

o On the desktop, double-click the Aspen Basic Engineering icon.

or

o From the Start Menu, point to Programs | AspenTech | Aspen Basic Engineering, and click Datasheet Editor.

Note: To work with datasheets or diagrams, you must access a project workspace.

18 3 Aspen Basic Engineering Basics

Opening Workspaces Before you can work with datasheets or diagrams, you must open a workspace.

Note: The Aspen Basic Engineering client can only be connected to one workspace at a time. The Status bar shows the current workspace name and the server machine on which it resides.

To change from the current workspace to another workspace, you must close the current workspace and then open a new workspace.

To open a workspace:

1 From the File menu, click Open Workspace.

2 After Aspen Basic Engineering has verified the user name and password, the Open Workspace dialog box is displayed. The list of workspaces presented depends upon the username entered. This information is configured by the project administrator who maintains a list of users that can access each workspace.

3 To connect to a workspace, select a workspace name, and then click OK. If you are the first user to connect to a workspace, or you are the first user to rejoin an inactive workspace, you may experience a delay while the Aspen Basic Engineering server starts the workspace.

4 To close the current workspace click File | Close Workspace. After the workspace is closed, the Status bar reflects the change in status. Both the workspace and hostname areas are blank, indicating that you are no longer connected to a workspace.

3 Aspen Basic Engineering Basics 19

Aspen Basic Engineering Windows The names and layout of the items in the Aspen Basic Engineering windows (Datasheet Editor shown in this example) are:

Toolbars Toolbars are used to access commonly used commands.

• If the toolbar is not already displayed, click View | Toolbar.

To discover more about toolbar buttons:

• Position the mouse pointer over a button. A tooltip appears beside the button, showing its name. The Status bar contains a longer description of toolbar buttons.

To turn tooltips off, click View | Tooltips.

Note: When you turn off tooltips, the short description appears in the Status bar when the pointer passes over a toolbar button.

Status Bar The Status bar displays the following information:

• Messages generated by the system

• User name

• Name of the current workspace

• Name of the server on which this workspace is running

To display the Status bar, click View | Status Bar.

20 3 Aspen Basic Engineering Basics

4 Using Aspen Basic Engineering 21

4 Using Aspen Basic Engineering

This section details procedures enabling you to understand:

• Database objects

• Cases

• Documents (drawings and diagrams)

• Revision control

Working with Database Objects Aspen Basic Engineering uses an object-oriented database, containing discrete data items, known as objects. An object can represent:

• A real object

• A connection between one or more real objects

• An abstract data item

You create objects by:

• Adding symbols to a diagram

• Entering values on a datasheet

• Using the commands from the Object menu or the Aspen Basic Engineering toolbar

Creating Database Objects To create an object in the database:

1 From the Object menu, click Create. The Select Class dialog box appears, listing all the available types of object that can be created in this workspace.

2 Type or select the name of the type of object required and then click OK. The object selected is created in the database.

To select more than one object class, hold down the SHIFT or CTRL key at the same time as selecting a class:

22 4 Using Aspen Basic Engineering

To Select Use

A range of objects from the previous selection to the current selection

SHIFT

Multiple separate items CTRL

Note: This is standard Microsoft Windows behavior and can be used on many of the dialog boxes in Aspen Basic Engineering.

Deleting Database Objects To delete a database object:

1 From the Object menu, click Delete. The Select Object dialog box appears, listing the objects that exist in the database.

2 Type or select the name of the object to be deleted and then click OK. The object is deleted from the database, along with any associated fitting objects.

Copying Database Objects A copy is a duplicate of a selected object in which the copied object has no association with the original object. The attribute values of either the originals or the copies can be modified without affecting the other.

Copying an object copies not only the original object, but also any fittings or sub-objects of the original. For example, if you copy a vessel that has an agitator, the result is a new vessel which has a new agitator as a fitting. All of the attributes of the original vessel and agitator are copied to the new objects, including their status. That is, a locked value on the original vessel is locked on the copy.

To copy an existing database object:

1 From the Object menu, click Copy. The Select Object dialog box appears, listing all the objects that exist in the database.

2 Select the object(s) to be copied and then click OK.

Cloning Database Objects A clone is a duplicate of a selected object in which certain attributes of the original remain linked to the clone. A change to the original attribute's value is reflected in the clone. The attributes that are linked are determined by the definition of the object's class in the prototype store. See also Copying Database Objects above.

Cloning an object clones not only the original object, but also any fittings or sub-objects of the original. For example, if you clone a vessel that has an agitator, the result is a new vessel clone, which has a new agitator clone as a fitting.

To clone an existing database object:


1 From the Object menu, click Clone. The Select Object dialog box appears, listing all the objects that exist in the database.

2 Select the object or objects to be cloned and then click OK.

Working with Holds A hold is a database object. You apply it to other database objects and attributes to flag them as being held. Use holds to warn other users that the held attribute or object data is uncertain, or liable to change.

You create and remove holds by:

• Using the commands from the Object menu.

• Drawing hold clouds on a diagram.

• Setting the properties of a datasheet or label field.

Creating a Hold

To create a hold in the Aspen Basic Engineering window:

1 From the Object menu, click Create Hold.

2 Typically, you are prompted to supply a reason for creating the hold.

Removing a Hold

To remove (close) a hold:

1 From the Object menu, click Close Hold. The Select Hold dialog box appears.

2 In the Select hold list, select the held object and then click OK.

3 Typically, you are prompted to supply a reason for removing (closing) the hold.

Current Object Filters Many Aspen Basic Engineering commands require you to select one or more objects from the standard Select Object dialog box. When a large number of objects exist, this list becomes extremely long and difficult to navigate.

When over 500 objects are in the selection, the list of objects is presented as a set of object ranges.

To focus on a particular object range:

1 Select the range from the object list.

The standard Select Object dialog box appears, containing only the objects in the range selected.

To reduce the list of objects available for selection:

1 Change the object filter.


Changing the Object Filter

To change the current object filter shown in the central window at the top of the Datasheet Editor window:

1 Click the down arrow at the right of the filter window and select the required filter from the pull down list.

Working with Cases A case in Aspen Basic Engineering is a named set of values that applies to the same objects and connections. Its scope does not cover topological cases where the number of objects or connectivity of the same objects is different.

There are two types of cases:

• Global cases – These apply to all objects in the database.

• Restricted cases – These apply to individual objects in the database.

Initially, all database values on a project are part of the same global design case. You can create, delete and rename other cases. For datasheets that show more than one case, you can show or hide field values and copy data from one case to another.

Creating Cases To create a new case:

1 From the Case menu, point to Create, then click Global or Restricted.

2 For restricted cases only, you must now select the object for the case.

3 In the Case Name dialog box, type a new name and click OK.

Deleting Cases To delete a design case:

1 From the Case menu, click Delete.

2 In the Select Case dialog box, click the required case and then click OK. A dialog box appears, giving you the option of deleting any documents that are based on the selected case.

3 Click OK. The case is deleted, along with all its database values.

Renaming Cases To rename an existing case:

1 From the Case menu, click Rename.

2 In the Existing Case dialog box, select the case to be renamed.

3 In the New Name field, type a new name for the case, and click OK.

Note: You cannot rename a case to a name that already exists.


Copying Cases To copy the data associated with a case to another case:

1 From the Case menu, click Copy Object Case.

2 In the Select Object dialog box, click the relevant object(s) and then click OK. The Copy From Case dialog box is displayed, listing all of the cases available in the current project.

3 Click the source case, from which data is to be copied, and then click OK.

4 From the Copy To Case dialog box, click the destination case, to which the data is to be copied, and then click OK. All data associated with the source case is copied to the destination case.

Working with Documents Use documents to manipulate objects and their values in a database. Aspen Basic Engineering uses two different types of document:

Document Type

Handled Through

Description

Datasheet Datasheet Editor

Shows database values for one or more objects in the database. You can then perform document management actions on the group and not the individual documents. Document groups can be created as a pre-defined set or manually built up from existing datasheets

Drawing Drawing Editor

Shows a graphical representation of objects and the connections between them, and enables you to manipulate these objects and their connectivity. Also enables you to modify database values through labels placed on the diagram

Accessing Documents Documents (datasheets and diagrams) are accessed from the File menu.

Accessing Datasheets • From the File menu, point to Datasheets and click one of the five 'by'

options.

The following table explains the five menu options:

Menu Option Use To Access When You Click This Option

by Object New or existing datasheets by object

The Select Object dialog box opens, where you select the required database object.

You then click OK to open the Datasheets dialog box

by Type New or existing datasheets by their type

The Select Datasheet Type dialog box opens, where you select the required datasheet type. You then click OK to open the Datasheets


Menu Option Use To Access When You Click This Option

dialog box

by Submitted Existing submitted datasheets

The Datasheets dialog box opens directly

by Checked Existing checked datasheets


by Issued Existing issued datasheets


With all options, you ultimately reach the Datasheets dialog box.

Use the buttons on the right of the dialog box to perform tasks, such as renaming a datasheet or issuing a checked datasheet.

Accessing Diagrams • From the File menu, click Diagrams.

The Diagrams dialog box appears, which has the same features as the Datasheets dialog box, described above.

Creating New Datasheets To create a new datasheet:

1 From the File menu, point to Datasheet, and then click by Object or by Type.

2 From the displayed list, click the name of the required database object, datasheet type, or group, and then click OK.

3 In the Datasheets dialog box, ensure New is selected, select the document you want and then click Open.


Creating New Diagrams Before creating a new diagram, you must decide if you want it to be:

• A one-off diagram of a plant, representing one operational case.

• One of several (shared) diagrams of the same plant, each representing a different operational case. For example, you may have two shared diagrams, representing winter and summer operating conditions.

Creating One-Off Diagrams 1 From the File menu, click Diagrams (the Diagrams dialog box is

displayed).

2 Select New at the top of the dialog box. A list appears with two entries: New Diagram and Shared Diagram.

3 Select New Diagram and click the Open button.

4 In the dialog box that appears, enter the diagram name and click OK.

The Aspen Basic Engineering Drawing Editor opens, with the diagram appearing in the Drawing Window. The diagram status is now current.

Note:You need the drawing application installed to use diagrams. You can change a diagram from one-off to shared, at a later date.

Creating Shared Diagrams

To create a shared diagram:

1 From the File menu, click Diagrams. The Diagrams dialog box appears.

2 Select New at the top of the dialog box. A list appears with two entries: New Diagram and Shared Diagram.

3 Select Shared Diagram and click the Open button. The Select Diagram dialog box appears, listing the existing diagrams plus an option entitled 'New Shared'.

To create a shared diagram based on an existing diagram, select the existing diagram.

Select New Share to create a shared diagram that will form the template for future shared diagrams.

Opening Existing Documents With either choice, you are prompted for the diagram name (see Creating One-Off Diagrams, above).

You open existing documents from the File menu:

1 Follow the accessing documents procedure (see Accessing Documents) until you reach either the Datasheets or the Diagrams dialog box. These dialog boxes have the same features.

2 In the Datasheets or Diagrams dialog box, select the datasheet or diagram and click the Open button.


Tip: Use the Current, Submitted, Checked or Issued radio buttons to switch between categories of documents. Note: If you open the current version of a document that is also submitted or checked, you are prompted to confirm opening. If you select a datasheet group, all members of the group are opened.

Viewing Document Status To view the status of documents:

1 From the File menu, follow the accessing documents procedure (see Accessing Documents) to reach the Datasheets or Diagrams dialog box, as appropriate. These dialog boxes have the same features.

2 Use the tabs at the top of the dialog box, to list the datasheets by their status.

Printing Documents • Printing a currently open datasheet.

• Printing multiple datasheets.

• Printing diagrams.

For information on printing datasheets, see the User Guide - Using Datasheets and Diagrams.

Renaming Documents To rename a document:

1 Follow the accessing documents procedure (see Accessing Documents) until you reach either the Datasheets or the Diagrams dialog box. These dialog boxes have the same features.

2 Select Current at the top of the dialog box (Datasheets or Diagrams dialog box).

3 Select a datasheet or diagram and then click the Rename button.

4 Type the new name for the document in the dialog box and click OK.


Document Revision Control Four document revision control states can be applied to documents within a project using the document revision control menu. This allows you to revise documents from their present state to either the next appropriate state or to be withdrawn.

Note: Use of the revision control system is controlled by in-built Aspen Basic Engineering security functions. Only permitted users are allowed to check and issue documents. However, any user can submit a document for checking. See your Aspen Basic Engineering administrator for further details.

Document revision control states are:

Revision State Description

Current Documents that exist and are currently available for modification

Submitted Documents that are currently submitted for checking

Checked Documents that have been checked and are awaiting issue

Issued Documents that have been issued within Aspen Basic Engineering

Note: A document can be in any or all of the states at any one time, although only one version of each document can be in each state. Only documents in the current state can be modified. Documents in other states are read-only.

Current Version

The current version of a document is available to all users on the project, and can be opened by any project user at any time. Only documents in the current state can be modified. Values shown on the current version that have changed since the document was last issued can be shown in a distinctive manner. For datasheets, these values can be shown italicized and in a different color, for diagrams they can be shown in a different color.

The revision control actions that you can perform on a current document are:

• Submit (for checking).

• Withdraw (delete).


Submitted Version

For information on how to submit a document for checking, see Submitting a Document.

Documents submitted for checking are read-only versions of the current documents, whose fields show the values as they were in the database at the time that the document was submitted. You cannot edit the fields on a submitted datasheet, so cannot change the database through a submitted sheet. The submitted document still retains the concept of changed since last issue and these changed values are displayed in the same way as the current version of the document.

The submitted revision level allows you to check the data entered on the submitted datasheet. You can perform the following revision control actions on a Submitted document:

• Check

• Withdraw (delete)

To use these options, you must have Check privileges; otherwise, you cannot check or withdraw documents.

Checked Version

For information on how to check a document, see Checking a Document.

Checked documents are read-only versions of the current documents, whose value fields reflect the values in the database at the time they were submitted for checking. You cannot edit the fields on a checked datasheet and therefore cannot modify the database through a checked document. The checked document still retains the concept of changed since last issue and these changed values are displayed in the same way as the current version of the document.

The checked revision level shows that a document that was submitted has been checked and is now awaiting issue.

You can perform the following revision control actions on a Checked document:

• Issue

• Withdraw (delete)

To use these options, you must have Issue privileges; otherwise, you cannot issue or withdraw documents.

Issued Version

For information on how to issue a document, see Issuing a Document.

Issued documents are read-only versions of the last issue of the current documents of the same name. The values in issued documents are those that the fields had at the time that the document was submitted. This version is the one against which the comparison with the last issue is made.

Only the last issued version is recorded within Aspen Basic Engineering. The only way to remove the issued document is to withdraw the current version from the database.


Submitting a Document Any user can submit a document for checking. You can submit an open or closed document. For information about submitted documents, see Submitted Version, under Document Revision Control.

Note: You cannot submit individual members of a datasheet group.

Submitting a Closed Document

To submit a document without having to open it:

1 From the File menu, do one of the following:

For datasheets point to Datasheet, click by Object or by Type and then from the displayed list, click the name of the required database object, type or group.

– or –

For diagrams, click Diagram.

2 In the Datasheets or Diagrams dialog box, select Current at the top of the dialog box.

3 Select the required document(s) from the list, and then click the Control button.

4 From the menu click Submit. If any of the selected documents are already in the Submitted or Checked states, you are prompted to confirm the re-submission.

To Click

Resubmit the document, replacing the version that is currently submitted, even if it was in the checked state

Yes

Abandon the submission of the named document, or group of documents, but continue submitting the other documents

No

Abandon the submission of all chosen documents Cancel

Submitting an Open Document

To submit an open datasheet:

• From the Datasheet menu, click Submit.

Note: This menu option is active only when you are viewing the current version of a datasheet.

Diagrams open in the Aspen Basic Engineering Drawing Editor, and this is where you change their status.

To submit an open diagram:

• From the Aspen Basic Engineering Drawing Editor File menu, point to Status and click Submit.


Checking a Document Only submitted documents can be checked.

You can pass a submitted document as checked without opening it or while the document is open. For information about checked documents, see Checked Version, under Document Revision Control.

Note: You cannot check individual members of a datasheet group.

Checking a Closed Document

To pass a submitted document as checked:


For datasheets, point to Datasheet and click by Submitted.

– or –


The Datasheets or Diagram dialog box appears.

2 If necessary, select Submitted at the top of the dialog box.


4 From the menu that appears, click Check. The selected documents are checked.

Note: If the current version of the document has been modified after it was submitted, you are prompted for confirmation to proceed.

Checking an Open Document

To check an open submitted datasheet:

• From the Datasheet menu, click Check.

Note: This menu option is active only when you are viewing the submitted version of a datasheet.

Diagrams open in the Aspen Basic Engineering Drawing Editor, and this is where you change their status.

To check an open submitted diagram:

• From the Aspen Basic Engineering Drawing Editor File menu, point to Status and click Check.


Issuing a Document Only checked documents can be issued.

You can issue a checked document that is open or closed. For information about issued documents, see Issued Version under Document Revision Control.

Note: You cannot issue individual members of a datasheet group.

Issuing a Closed Document

To issue a closed document:


For datasheets, point to Datasheet and click by Checked.

– or –



2 If necessary, select Checked at the top of the dialog box.


4 From the menu that appears, click Issue.

5 When prompted, type the revision level for the document and click OK.

Note: The revision level entered here is used to mark the values that have changed since the last issue.

The selected documents are issued.

Issuing an Open Document

To issue an open checked datasheet:

• From the Datasheet menu, click Issue.

Note: This menu option is only active when you are viewing the checked version of a datasheet.

Diagrams open in the Aspen Basic Engineering Drawing Editor and this is where you change their status.

To issue an open checked diagram:

• From the Aspen Basic Engineering Drawing Editor File menu, point to Status and click Issue.


Deleting a Document When you use the Withdraw command on the current version of a document, the document is deleted, provided that it is not open in any user's session. To delete a document:

1 Follow the accessing documents procedure (see Accessing Documents) until you reach either the Datasheets or the Diagrams dialog box.

These dialog boxes have the same features.

2 In the Datasheets dialog box, or Diagrams dialog box, select Current at the top of the dialog box.

3 Select the required document(s) and click the Control button.

4 From the Menu that appears, click Withdraw.

You are prompted to confirm the deletion before proceeding.

Note: If any of the selected documents are open in any user’s Aspen Basic Engineering client, a warning dialog is displayed and the named documents are not deleted.

Removing a Document from the Revision Process If you decide not to proceed with checking and issuing a submitted document, you can remove the document from the revision control process using the Withdraw command. To do this:

1 From the File menu,

For datasheets, point to Datasheet and click by Submitted or by Checked.

– or –



2 If necessary, select Submitted or Checked at the top of the dialog box.

3 In either the Datasheets or Diagrams dialog box, select the required document(s) and click the Control button.

4 From the menu click Withdraw. The selected documents are removed from their submitted or checked states. (If you click Withdraw when viewing the Current version list of documents, the document is deleted.)

Note: You cannot independently withdraw individual members of a datasheet group from the revision procedure.

5 Glossary 35

5 Glossary

Glossary of Terms

Administration User A user with responsibility for the creation and management of Workspaces, including the registration of users and allocation of roles and responsibilities.

AES Aspen Engineering Suite, a collection of AspenTech products for process engineering or the functional organization that produces the same suite of products.

Aggregation A special kind of association representing a “whole/part” relationship. The object at one end of the association represents a whole and the object at the other end represents the part. For example, a centrifugal pump may have an aggregation association with the class “impeller”.

Annotation A free form single line of text that can be used to place comments on a document.

API datasheet The American Petroleum Institute is the primary trade association representing the oil and natural gas industry in the United States. It publishes a wide range of standards for the design of equipment, many of which include datasheets. Some of the API datasheets will be included in Aspen Basic Engineering.

36 5 Glossary

Application A tool/program that is interfaced to Aspen Basic Engineering to exchange data.

Application Interface A provisional title given to the mechanism to easily interface an application to the product. This feature is likely to be renamed.

As-Built As-built refers to the design representing the physical state of a plant as it exists at that point in time. A workspace/design becomes ‘as-built’ when the plant is physically constructed. The plant and therefore the as-built design/workspace will change throughout the life of the plant as modifications are made to the plant as the result of projects carried out to improve performance and/or operability of the plant.

Association An association is a structural or semantic relationship between two objects. For example, a piping system may have an association with the equipment items where the piping system terminates.

Attribute The property of an object instanced from the data model.

ATESA AspenTech Enterprise Server Architecture

Authoring Application The term is used to refer to a GAIP application in which data is edited by designers. This equates to: Aspen Basic Engineering, SP P&ID, INTools, SP 3D (there are others also). It does not include SPF that doesn’t allow editing of data.

Base Class A class from which another class is derived.

BEDD Basic Engineering Design Data. The information concerning the site, climatic conditions, utilities etc., that pertain to a particular process plant or site.

5 Glossary 37

Boolean A data type, for an attribute, that restricts the attribute to hold only the value True or False. This data type is used to model data items normally represented by check boxes or Yes/No values.

Bridge An instance of an interface between the workspace and another tool (for example a desktop tool).

Case A named set of data associated with the objects in a project database. You can create design cases to hold different design data for the same topology of the objects. See also Restricted Case and Global Case.

Case Fixed A property of an attribute, that indicates whether this attribute has the same value for all design cases. For attributes where the data type is an object class then this is always true. A vector attribute that is case variant may have a different number of elements for each design case.

Category A keyword or keywords that may be attached to a data model construct to support sorting, searching and filtering of data model constructs and instances.

CCDM Common Core Data Model. The Equipment Data model used to represent engineering objects. The out of the box CCDM contains all the data model constructs to support the delivered datasheets and application interfaces.

Claim Status of an object that indicates whether it is included in the scope of a project.

Class A class is a set of objects that share the same set of attributes. A class definition acts as a template for all instances of the objects of the class. Classes may have relationships between them. Relationships include generalization and association.

38 5 Glossary

Class Library A named collection of data model constructs related in some way. For example a Class Library may contain all the constructs related to rotating equipment.

Class Store A self-consistent collection of data model constructs required to support a Workspace. A Class Store is created using the Class Library Editor and loaded into a Workspace when the Workspace is first opened.

Class View An Aspen Basic Engineering application or third party external application view of the data in, or associated with, a class.

Clone A duplicate of a selected object in which certain attributes (see clone fixed below) of the original remain linked to the clone. A change to the original attributes’ value is reflected in the clone.

Clone Fixed A property of an attribute that indicates whether an attribute has the same value for all clones of an object.

Composite (Class) View An engineering view of the data represented by, or associated with, a class that is the result of merging the class views for a class. Typically a single composite view is used to represent all the data required by a major engineering artifact such as a pump.

Conceptual Data Model The Aspen Basic Engineering data model expressed in the form of classes, associations and enumeration data model construct. The conceptual model is based on data modelling principles that employ abstraction and normalisation to create a compact and re-usable model. Typically many data model constructs are used to model one major engineering object.

Configuration User A configuration user is an Aspen Basic Engineering user responsible for the customization of Aspen Basic Engineering within their organization. For example, the creation of organization specific data models, datasheets, labels, scripts and configuration tasks.

5 Glossary 39

Connection A two-ended link between database objects, used to represent the flows between these objects.

Copy A duplicate of a selected object in which the copied object has no association with the original object. A change to the original attributes’ value has no effect on the copy.

Data Model A formal representation of the data that may be stored in the Aspen Basic Engineering Workspace. The data model is expressed in the data model constructs, held in one or more class libraries.

Data Model Construct Any basic building block of the data model. Data Model Constructs include: class, association, enumeration, class view, and composite view.

Datasheet The pre-established form that is filled in by an end-user working on an engineering project.

• Old Definition: A single page document.

• New Definition: A multi-page document.

Datasheet Builder A user who constructs datasheets as a primary task, or a user who is doing the task of defining a datasheet.

Datasheet Group A collection of datasheets that are treated as a single document for the purpose of creation and revision control.

Default Fixed A property of an attribute that determines if the attribute values can be changed from its default value.

40 5 Glossary

Delete A command to delete the active/visible item and should not be inferred as meaning delete workspace object. For example, deleting a graphical representation does not destroy the underlying workspace object. In use cases, the preferred terms are Remove and Destroy.

Destroy To destroy an object in the workspace such that it no longer exists.

Discipline A discipline is a privilege that can be defined by a configuration user to restrict access to the attributes of a class.

Display Name A property of a data model construct that is used to identify the construct in the end user interface but is not used to reference the construct internally within the system. For example, the display name of a class may be changed by the configuration user without affecting internal references to the class.

Document Old Definition: A database item that is one of:

• A single page datasheet.

• A summary sheet.

• A Drawing.

New Definition: A database item that is one of:

• A multi-page datasheet.

• A summary sheet.

• A Drawing.

Drawing A document that is edited using the Drawing Application.

End User An engineer using Aspen Basic Engineering and other tools to execute an engineering project, with little or no interest in, or responsibility for, the configuration or administration of the Aspen Basic Engineering software installation.

5 Glossary 41

Engineering Framework Intergraph/AspenTech developed application that is used to integrate FEED tools, currently Aspen Basic Engineering, INTools, SP P&ID and a data repository (Notia) together.

Enumeration Data Type A data type that specifies the allowed values which an attribute of that data type may hold.

Equipment List An alternative name for a summary sheet.

EXPRESS A data modeling language adopted by the ISO working group on STEP.

FEED Front-End Engineering and Design. In this context primarily relates to the ease by which objects and/or data can be created or updated on the basis of object data from simulators, under conditions where the simulation topology can be relatively abstract in comparison to the desired engineering PFD.

Field In a datasheet or label, a location where a user can enter or view data from a workspace object.

Field Lock An access control mechanism that allows only users with Lock privilege to modify the field.

Field Status An attribute value can have a number of status flags:

• D – value is derived. The value has been generated by the knowledge base.

• S – value is secure. The value can only be viewed by users with secure privilege.

• L – value is locked. The value can only be modified by users with overwrite privilege.

• V – value varies between cases.

• H – value is held.

42 5 Glossary

Fitting The parts of an equipment item – for example impellers, motors. Alternatively, in a piping system, items such as valves that are considered as part of the piping system (q.v.).

Folder Analogous to a file system folder used to organize objects in the workspace.

GAIP Dow’s “Global project methodology Automation Improvement Project”.

Generalization A generalization is a relationship between a general thing (called the superclass) and a more specific kind of thing (called the subclass). A subclass automatically has the attributes of the superclass to which it is related by generalization. The subclass is said to inherit the attributes of the superclass.

Global Case A case that applies to all objects in a workspace.

Graphic Hold A graphic hold is used to indicate areas of a drawing that a user is working on at the current time.

GUI Graphical User Interface. A ‘thin’ GUI has small process footprint, and does little if any processing and relies on a server or other tiers in the architecture. A ‘thick’ GUI carries out a significant part of the business logic in its own processing.

Hold A means of recording supplementary information about an attribute, a group of attributes, or a diagram. An example is a tag of descriptive text to indicate that some values are provisional. See also Graphic hold above.

Knowledge Base (KB) A collection of procedural rules that can manipulate workspace content either by the users instigation or automatically as a demon in response to changes in workspace content.

5 Glossary 43

Link A mapping between an attribute of a workspace object and a piece of data in a third party tool.

Link set A collection of links (q.v.) and additional context information, for example, the object that the link set applies to.

Lock See Field Lock, User Lock and Transaction Lock.

Mapping A relationship between two entities. Typically, this is a specified link for passing information from one entity to the other.

Mass Balance Header The column of a mass balance grid (usually the left column), containing stream names and other data.

Mass Balance Column A column in a mass balance grid, other than the Mass Balance Header, containing data for a particular piping system.

MMC Microsoft Management Console, an extensible user interface that provides an environment for running management applications.

Multiplicity The property of a data model construct that determines how many instances of it may exist. For example, the multiplicity of an attribute determines whether an object of that class may contain a single instance of the data type or a vector of the data type.

44 5 Glossary

Object An object is a software packet containing a collection of related data. The data an object may contain is determined by the class of the object. The class of an object functions as a template for the creation of an object. An object is an instance of a class. An object can represent something in the real world, for example a centrifugal pump or a shell and tube heat exchanger. An object can also represent some information about the design process for equipment in a process plant, for example an object containing thermal design program options.

Overspill An action that may happen when a datasheet is full. This happens automatically for summary sheets.

Overspill Sheet The datasheet created when Overspill occurs.

Page A database object that represents a single page of a document.

PIP Datasheet Process Industry Practices (PIP) is a consortium of process industry owners and engineering construction contractors who serve the industry. PIP publishes documents called “Practices.” These Practices reflect a harmonization of company engineering standards in many engineering disciplines and include datasheets for equipment specification. Some of these datasheets will be included in Aspen Basic Engineering.

Piping System A representation of an aggregation of connections and intermediate fittings that are considered to be (conceptually) one stream.

Privilege The level of access that a user has to an object or to perform an action. Some privileges can be created by the configuration user, see Discipline.

5 Glossary 45

Project A project is a checked out collection of objects contained within a parent project or workspace. The content of a project can be committed back to its parent project and facilities are provided to reconcile any conflicts in performing the commit operation.

A project can represent a task to take part of the ‘as-built’ design and perform a redesign for any number of reasons such as: increasing the throughput; improving product quality; improving efficiency; improving operability. On implementation of the plant modifications, resulting from the project, the as-built design should be updated to reflect the physical changes to the plant.

Quantity Type A quantity type is a definition of a dimensioned physical quantity, such as pressure or temperature, and of the units of measure that may be used for the quantity type. Attributes intended to hold physical quantity values are assigned a quantity type property.

Reference Point A point on a drawing around which an object or objects can be transformed (for example, moved or sized).

Remove To remove a representation of an object without destroying the object itself.

Restricted Case A case that applies to a specific object in the workspace.

PFD A specific type of Drawing created using the Drawing Application.

Role (1) The label at each end of an association that identifies the participation of a class in an association. For example in the association between a piping system and a terminating equipment item, the piping system may have a “is terminated by” role and the equipment item may have a “terminates piping system” role.

46 5 Glossary

Role (2) A named set of privileges. A role can be assigned to a user or to a group of users and is typically named to reflect the user’s function in an organization.

Role Members The users and groups that have been assigned to a role.

Simulator Interface An Aspen Basic Engineering term for the functionality that allows data from a simulation data source file to be “loaded” into the Aspen Basic Engineering database. Comparable to the CASA Loader.

Smart Plant Foundation (SPF) Smart Plant Foundation is Intergraph’s data warehouse and document management database system. This is the central database for the Engineering Framework and holds all the data and documents relating to the data transfer and storage for The Engineering Framework.

Snapin Snapin is a management application that extends the Microsoft Management Console and runs within the console’s environment.

STEP Acronym for Standard for the Exchange of Product Model Data. ISO standard 10303.

STEP File A standard format text file (ISO 10303-21) that can be used to transfer data between applications.

Stream A unit operation/simulator concept for material flow between two unit operations.

Subclass A class that is a refinement or more specific kind of another class.

Superclass A class that is a more general or less specific kind of another class.

5 Glossary 47

Summary Sheet A datasheet that shows information about a related group of objects.

System Class One of a set of basic classes defined by AspenTech that are required for Aspen Basic Engineering to function. System classes are defined in the System Library.

System Library A class library that Aspen Basic Engineering requires to be loaded in the system in order to function. A workspace must load the System Library. No user will be able to edit the System Library.

Table A data model construct used to represent tabular data. A table has a fixed set of columns and an unconstrained number of rows. A typical use of a table is to store profile information (e.g. temperature profiles) where the number of data points in the profile may differ between design cases. Tables will be defined as classes that are derived from the system class “Table”.

Smartplant® The technology integrating SPF and authoring tools.

Transaction Lock A temporary lock placed on data by the system, to prevent conflicts in concurrent transactions.

UO Unit Operation. A unit operation object in AZ is an object set up to store incoming data (from a simulator for example). A mapping links these objects with equipment objects.

UOM Units of Measure

User Library A class library containing classes defined by a user organization.

48 5 Glossary

User Lock A user specific lock on workspace data/content that prevents other users from modifying or reading the same data/content. Sometimes qualified by read, or write user locks (write includes read implicitly).

W3C World-Wide Web Committee – organization among other things handling standardization of XML and its various parts (XSL, XSLT, etc).

Workspace The AZ (in-memory) object oriented database and associated content normally shared in integrated engineering. A container for projects.

Workspace Package The root of the Project tree (‘As-Built’ in Dow-GAIP terminology).

Index 49

Index

A

Aspen Basic Engineering main window 18 overview 17 starting 17

available 3

B

Buttons 19

C

Cases about 24 copying 25 creating 24 deleting 24 renaming 24

Checked state 28 Checking documents 31 Cloning objects 22 Close Hold command 23 Copying

cases 25 objects 22

Creating cases 24 datasheets 26 diagrams 26 holds 23 objects 21

Current state 28

D

Database about database objects 21

Datasheets about 25 creating 26

Deleting cases 24 documents 33 objects 22

Design cases, about 24 Diagrams

about 25 creating 26

documentation 1 Documents

about 25 checking 31 deleting 33 issuing 32 opening 27 removing from revision control

process 33 renaming 28 revision control 28 submitting 30 viewing status 28

Drawings about 25

F

Filters, object selection 23

50 Index

G

Global cases 24

H

Holds about 23 creating 23 removing 23

I

Issued state 28 Issuing documents 32

L

Log in to Aspen Basic Engineering 18

M

Multiple selection 21

N

New state 28

O

Object selection filters, about 23 Objects

about 21 cloning 22 copying 22 creating 21 deleting 22 selection filters 23

Opening documents 27

R

Removing holds 23

Renaming cases 24 documents 28

Restricted cases 24 Revision control

about 28

S

Select Object dialog box 23 Selecting

from long lists 23 multiple objects 21

Submitted state 28 Submitting documents 30

T

Toolbar 19 ToolTips 19

W

Withdraw command 33