Académique Documents
Professionnel Documents
Culture Documents
User's Guide
Copyright
Copyright 2002 - 2010 Intergraph Corporation. All Rights Reserved. Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.
Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives licensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement and delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for resale or redistribution.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools, ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are trademarks of their respective owners.
Contents
Preface .......................................................................................................................................................... 5 SmartPlant Foundation Product Documentation .................................................................................... 5 Documentation Comments ..................................................................................................................... 9 What's New in SmartPlant Foundation Web Portal................................................................................ 10 Using the SmartPlant Foundation Web Portal........................................................................................ 15 Customizing the Web Portal ................................................................................................................. 16 Samples ................................................................................................................................................ 18 Exploring the Web Portal Interface .......................................................................................................... 21 Specify an Effective Date and Time for Viewing Data .......................................................................... 25 Setting Web Portal Preferences............................................................................................................ 26 Setting the Active Scope ....................................................................................................................... 28 Set the Active Scope by Query ...................................................................................................... 29 Set the Active Scope by Roles ....................................................................................................... 30 Searching for Objects ............................................................................................................................... 33 Search for items with a particular name ............................................................................................... 40 Search properties and content of an object .......................................................................................... 40 Run a saved query from the Discover web part.................................................................................... 40 Using the List View .................................................................................................................................... 43 Sort a list ............................................................................................................................................... 44 Print the complete contents of a search ............................................................................................... 44 Print only what displays on your monitor in the List web part ............................................................... 44 Create a Microsoft Excel spreadsheet containing your search results ................................................. 45 Using the Discover View ........................................................................................................................... 47 Clear the Search Results tree ............................................................................................................... 48 View a text description in the tree ......................................................................................................... 49 Viewing Drawings and Graphics .............................................................................................................. 51 View a design document ....................................................................................................................... 53 View a drawing ...................................................................................................................................... 53 View an object in a drawing .................................................................................................................. 53 Using the SmartPlant Foundation 3D View Control .............................................................................. 54 3D Navigation Controls................................................................................................................... 54 3D Navigation Tips ......................................................................................................................... 63 Graphics Card Information ............................................................................................................. 65 Troubleshoot 3D Navigation ........................................................................................................... 65 Reviewing Information .............................................................................................................................. 75 View relationships for a selected item .................................................................................................. 85
Contents
View properties for a selected item ....................................................................................................... 85 View the history for a selected item ...................................................................................................... 85 Store objects for viewing later ............................................................................................................... 85 View properties of a shared object ....................................................................................................... 86 View related items for a selected item .................................................................................................. 86 View a summary view of a published object ......................................................................................... 89 To Do List ................................................................................................................................................... 91 Claim a workflow step ........................................................................................................................... 92 View step details ................................................................................................................................... 93 View history of a step ............................................................................................................................ 94 Sign off a step ....................................................................................................................................... 96 Reassign a step .................................................................................................................................... 97 Update a step description ..................................................................................................................... 98 Update a step duration .......................................................................................................................... 98 View workflow details report ................................................................................................................. 99 View workflow history ............................................................................................................................ 99 View a workflow .................................................................................................................................. 100 Applications and Tasks .......................................................................................................................... 105 Glossary ................................................................................................................................................... 107 Index ......................................................................................................................................................... 127
Preface
This document is a user's guide for the SmartPlant Foundation Web Portal and provides conceptual information and procedural instructions for a standard SmartPlant Foundation installation. The content is the same as the online Help delivered as part of the software. Depending on the model you have loaded, and the customization for that model, you may or may not see all the commands and functionality documented here. Intergraph gives you permission to print as many copies of this document as you need for non-commercial use at your company. You cannot print this document for resale or redistribution outside your company.
Preface
SmartPlant Foundation/Integration Architecture Guide - Describes the architecture of the SmartPlant Foundation and integration software. Integration: A Gentle Introduction to the SmartPlant Schema - Provides an introduction to the SmartPlant schema and the data model that describes how the SmartPlant schema is constructed. Token Licensing Installation and Reference Guide - Provides reference and user information for installing and configuring daily and perpetual token licenses in SmartPlant Foundation. SmartPlant Foundation Upgrade Guide - Provides step-by-step instructions for upgrading from SmartPlant Foundation or SmartPlant Basic Integrator version 2008, 2008 Service Pack 1, 2009, or 2009 Service Pack 1 to version 2009 R3 SP2. SmartPlant Enterprise Citrix Configuration Guide - Provides information on configuring integrated SmartPlant Enterprise applications to run in a Citrix environment.
User's Guides
SmartPlant Foundation Web Portal User's Guide - Provides instructions for using the SmartPlant Foundation Web Portal. SmartPlant Foundation Desktop Client User's Guide - Provides instructions for creating, viewing, updating, and managing objects and their relationships. Additionally, it provides information about completing workflow steps and using SmartPlant Foundation in an integrated environment. SmartPlant Markup Plus User's Guide - Provides information on using SmartPlant Markup Plus, either alone or from within the SmartPlant Foundation interface, to view and annotate files created with any authoring tool. If SmartPlant Markup Plus is installed on the local computer, it is available from within SmartPlant Foundation through the View and Markup command in the Desktop Client. Integration User's Guide - Provides information about using SmartPlant Enterprise products in an integrated environment. Also provides a basic understanding of integration and common integration tasks. Integration Administrator's Guide - Provides information for system administrators on how to set up and configure an integrated environment.
Administrative Guides
SmartPlant Foundation Server Manager User's Guide - Provides instructions for using SmartPlant Foundation Server Manager to configure the SmartPlant Foundation server and to upgrade SmartPlant Foundation databases. Schema Editor User's Guide - Provides instructions for using the Schema Editor to view and extend the SmartPlant schema, view and modify authoring tool mapping, and compare schema files. SmartPlant Mapping User's Guide - Provides guidelines, procedures, and examples of mapping between the SmartPlant schema and integrated authoring tools. SmartPlant Model Loader User's Guide - Provides instructions for using the Model Loader to load documents exported from PDS or AVEVA PDMS into the SmartPlant Foundation database. SmartPlant Foundation Administrator's Guide - Provides SmartPlant Foundation administrators with basic information about how to administer standalone SmartPlant Foundation.
Troubleshooting Guide
SmartPlant Foundation Troubleshooting Guide - Contains information about troubleshooting the installation and configuration of SmartPlant Foundation.
Integration Guides
SmartPlant Foundation Core Functionality & Enterprise Integration Capabilities Release Bulletin - Provides information on new SmartPlant Foundation and integration features for the current release. SmartPlant Enterprise Overview - Provides an overview of SmartPlant Enterprise and integration concepts and data exchange among integrated SmartPlant Enterprise authoring tools.
Preface
SmartPlant Enterprise Data Exchange Diagrams - Includes full-size graphics that describe the exchange of data among SmartPlant Enterprise authoring tools. These graphics are also included in the SmartPlant Enterprise Overview. SmartPlant Enterprise Integration Example Guide - Provides an overview of integrating SmartPlant Enterprise and describes a typical example of full integration within SmartPlant Enterprise, including publishing and retrieving plant information using SmartPlant authoring tools and Aspen Basic Engineering. SmartPlant Enterprise Hardware and Software Recommendations - Provides information about the hardware recommendations and software requirements of the authoring tools that are part of the SmartPlant Enterprise suite. Integration Setup Guide - Provides information about setting up and using SmartPlant Enterprise products in an integrated environment. Also provides integration troubleshooting information. Integrated Line List Configuration and User's Guide - Provides configuration and user information for creating, publishing, or retrieving line list documents in SmartPlant Foundation and SmartPlant Materials. SmartPlant Enterprise Backup and Restore Guide - Provides backup, restore, and resynchronization procedures for SmartPlant Foundation, SmartPlant Basic Integrator, and integrated SmartPlant Enterprise authoring tools. The procedures are designed to minimize data loss and downtime when restoring data in an integrated environment. SmartPlant Foundation/Integration Architecture Guide - Describes the architecture of the SmartPlant Foundation and integration software. Integration: A Gentle Introduction to the SmartPlant Schema - Provides an introduction to the SmartPlant schema and the data model that describes how the SmartPlant schema is constructed. SmartPlant Mapping User's Guide - Provides guidelines, procedures, and examples of mapping between the SmartPlant schema and integrated authoring tools. SmartPlant Enterprise Mapping Spreadsheets - Provides Microsoft Excel files containing the retrieve mapping for integrated SmartPlant Enterprise authoring tools. Integration User's Guide - Provides information about using SmartPlant Enterprise products in an integrated environment. Also provides a basic understanding of integration and common integration tasks. Integration Administrator's Guide - Provides information for system administrators on how to set up and configure an integrated environment. Schema Editor User's Guide - Provides instructions for using the Schema Editor to view and extend the SmartPlant schema, view and modify authoring tool mapping, and compare schema files. SmartPlant Mapping User's Guide - Provides guidelines, procedures, and examples of mapping between the SmartPlant schema and integrated authoring tools. SmartPlant Model Loader User's Guide - Provides instructions for using the Model Loader to load documents exported from PDS or AVEVA PDMS into the SmartPlant Foundation database. SmartPlant Enterprise Citrix Configuration Guide - Provides information on configuring integrated SmartPlant Enterprise applications to run in a Citrix environment.
Programming Guides
To view customization and programming documentation for SmartPlant Foundation and integration, browse to the ..\SmartPlant\Foundation\7.x\ProgrammingHelp folder on a computer where the SmartPlant Foundation server components are installed.
Preface
SmartPlant Foundation Server Customization Guide - Provides information for developers on customizing the SmartPlant Foundation Server. SmartPlant Foundation Client Customization Guide - Provides information for developers on customizing the SmartPlant Foundation Client. SmartPlant Foundation Web Portal Customization Guide (SPFWebPortalCustomization.chm) - Provides information about customizing and configuring the SmartPlant Foundation Web Portal. SmartPlant Foundation Web Services Guide - Describes SmartPlant Foundation web methods used for uploading data from and downloading data to the SmartPlant Foundation Server. SmartPlant Schema Modeling Guide - Provides an introduction to the techniques that were used to develop the SmartPlant schema and create a data model. SmartPlant Adapter Interfaces Reference Guide - Provides information for tool developers about the interface classes used to communicate data between the authoring tool and the common user interface and the common user interface and the tool adapter. SmartPlant Common UI Interfaces Reference Guide - Provides information for tool developers about the API exposed through the EFCommonUI.dll, which is used by authoring tool developers to access integration functionality. SmartPlant Metadata Adapter Reference Guide - Provides information for tool developers about programming the metadata adapter. The tool metadata adapter allows communication between the SmartPlant Schema Editor and the tool database to manage mapping between the tool and the SmartPlant schema. SmartPlant Schema Component API Reference Guide - Provides information for developers about the Schema Component API. SmartPlant Enterprise SmartPlant Adapter for SmartPlant Electrical - Describes the SmartPlant Adapter details, functionality and configuration in SmartPlant Electrical. SmartPlant Enterprise SmartPlant Adapter for SmartPlant Instrumentation - Describes the SmartPlant Adapter details, functionality and configuration in SmartPlant Instrumentation. SmartPlant Enterprise SmartPlant Adapter for SmartPlant P&ID - Describes the SmartPlant Adapter details, functionality and configuration in SmartPlant P&ID. SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D - Describes the SmartPlant Adapter details, functionality and configuration in SmartPlant 3D. SmartPlant Enterprise SmartPlant Adapter for PDS 3D - Describes the SmartPlant Adapter details, functionality, and configuration in PDS 3D.
Documentation Comments
Send documentation comments or suggestions to PPMdoc@intergraph.com.
10
Version 2009
The To Do List web part has been added to the Web Portal. The To Do List provides a place for you to view all workflow steps that have been assigned to you and their statuses. The Clip Volume command has been added, which includes a 3D wireframe box that can be manipulated to limit the objects that can be seen in the view. The 3D Navigator control has been added, which supports the common navigation movements you can perform with the mouse and keyboard such as look and move. Additionally, it contains the Select, Home, and Fit navigation commands. Several usability enhancements have been added.
11
12
13
14
SECTION 1
15
16
Custom Themes
Changing the default theme can modify the look of the Web Portal. If needed, you can use themes, skin files and CSS files to modify the fonts, colors, and other styles. Several themes are delivered with the Web Portal. See the Styles section of the SmartPlant Foundation Web Portal Customization Guide (SPFWebPortalCustomization.chm) for more information about using styles and themes.
17
Samples
Samples are delivered with the software that can serve as examples of how to create a custom web part or command, how to define default templates that you can add to Visual Studio 2008 to ease the creation of new parts and pages, how to add user customization to sites, and how to implement SharePoint communication. The samples are delivered in the Web Portal samples directory (typically, C:\Program Files\SmartPlant\Foundation\2009\Samples\WebPortal\). The document SPF Web Portal Samples.pdf contains summaries of all delivered samples. Each sample is delivered in its own directory under the samples directory. A sample's directory includes: A ReadMe document containing instructions for setting up and using the sample. A sample aspx page that includes the Web Part or control. In most cases, screenshots of the new Web Part or control.
18
The sample's folder also contains an aspx page, SPFBreadCrumb.aspx, that uses the new control. The ReadMe document included with the sample provides instructions for adding the sample to a Web Portal page, with the necessary changes to the page highlighted, as shown below.
19
20
SECTION 2
Login/Logoff Toolbar
Enter your username and password in the User name and Password fields. Select your server using the Server drop-down list. Click Login to start SmartPlant Foundation Web Portal. If your system is configured for automatic logon, then the software automatically logs you on to SmartPlant Foundation using your Windows user name when you open the Web Portal.
21
22
23
In order to call an API, you must provide an API name and its required and proper arguments for that API (in order to run API from URL). Each API has its own arguments, and you can find the arguments for a client API by searching for that API. The following is an example URL to call ViewAndNavigate which displays SmartPlant Markup Plus in the Web Portal. http://demo/SPFWebPortal/Default.aspx?u=jdoe&p=jdoepwd&s=url-demo&API=Navigate&Class =SPFDesignDocVersion&Arg1=FRAME&Arg3=True&Name=3D-CivilPlans_003 This URL logs in to the SmartPlant Foundation Web Portal site url-demo with user name jdoe and password jdoepwd. Once logged in, a design document of 3D-CivilPlans_003 is located (including an attached file). Then, SmartPlant Markup Plus displays in the Web Portal as a frame. If there are any redline objects in the file, they also display.
Example URLs
The following URL launches the Web Portal and uses the Navigate API to open a specific version (revision 2A, version 2) of the specified document (SB101). http://localhost/SPFWebPortal/Default.aspx?server=localhost&API=Navigate&Class=SPFDesign DocVersion&Arg1=OPEN&Name=SB101&Arg8=2&Arg9=A&Arg10=2 The following example URL launches the Web Portal and displays the details dialog box for the SPFPlant named PlantA. http://SPFServer/SPFWebPortal/?&api=ShowObj&class=SPFPlant&name=PlantA The example below opens the appropriate drawing using the value specified for ARG1, and highlights in the drawing the object specified by the CLASS and NAME arguments. http://spfdev1/SPFWebPortalDemo3/default.aspx?server=SPF42DemoServer&API=ViewInDraw ing&ARG1=EDG_LatestVersionsContainingDrawingItem&CLASS=SPFTEFSharedEquipment& NAME=T-181 As shown in the following example, you must include the SECURE parameter, and set the value to true, if you are using a secure site (https). https://spfsrv64a/spfwebportal/default.aspx?user=sbarakam&password=&secure=true&server=l ocalhost_SPFSRV64aAUTH&api=QFindObject&arg1=ISPFDesignDocVersion&arg2=False&Crit eria=*
24
25
26
27
28
1. Click Set Active Scope . 2. In the Set Active Scope dialog box, select Set active configuration by query.
3. In the Query scope list, check the box beside the configuration(s) in which you want to search for objects. To select all top configuration items, click Select All Scope. To select all of the projects under a plant at once, press Shift as you check the check box beside the plant. If any projects under the plant are already checked, then all projects under the plant will be unchecked when you press Shift and check the check box beside the plant.
29
30
3. Select the appropriate user role or roles from the Selected roles list. The roles in the list are all of the roles available to you. Your role selection determines the configurations that are available in the Query scope list. 4. In the Query scope list, check the box beside the configuration(s) in which you want to search for objects. To select all of the projects under a plant at once, press Shift as you check the check box beside the plant. If any projects under the plant are already checked, then all projects under the plant will be unchecked when you press Shift and check the check box beside the plant. Only configurations to which you have query access appear in the list. 5. In the Status filter box, select the lifecycle status filter(s) for the configurations. By default, only the active configurations are displayed in the list. To display other configurations in the list, such configurations for newly created, merged, or completed projects, select the appropriate filter. You can use the Query by selected configurations only option to restrict queries to only the selected configurations and not higher configurations. For example, if you select
31
32
SECTION 3
If the user preference Case sensitive quick find is turned on, searches performed on the Quick tab and the Find tab are case sensitive. By default, this option is not checked; therefore, SmartPlant Foundation ignores whether the text you type is in upper-case, lower-case, or mixed case. The full Search web part contains the following tabs: Quick, Find, Content, Query, and Saved.
33
Quick Tab Options The following wildcards can be applied to searches for fine tuning: ? - Finds any single character * - Finds any string of characters % - Performs the same function as * Item type - Defines the item type you want to query. Name - Defines the name of the object to find. Force upper case - Forces text into uppercase for the current search. The default value can be defined on the User Preferences dialog box.
34
Leaving the Description box blank returns all items that match the other criteria on the tab (the items' descriptions are ignored). Typing an asterisk (*) in the Description box returns items that have any description and match the other criteria on the tab.
Find Tab
Allows you to search by name for objects of the selected type. The tree view displays the available types.
When you click a type in the tree view, the Find <Object> dialog box appears. For example, the Find Reports dialog box is shown below.
35
Content Tab
Allows you to search by entering the specific name of an object. Enter the * as a wildcard to search for all objects. You can display properties only, or properties and content, and matching objects or files.
Text to search - Defines the name of the object to find. Type the name in the field. Properties - Select to search only properties of an object. Properties and content - Select to search the properties and content of an object. Display matching objects - Displays matching objects. If the matching object is a file, the parent object displays. Displays matching files - Displays matching files including any file objects. The Content tab is available only on the full Search web part. If your Web Portal is configured with the Quick Find toolbar, you do not see this functionality.
Query Tab
Allows you to use wizards to query classes. Available queries include classification, attributes and properties, and so on. Classes include: QueryObject QueryClassObj QueryClassObjFromClass QueryByContainer The following details describe the available wizard pages. Buttons that display at the bottom of each wizard page are only enabled when a selection or required information for that page is completed.
36
2. The next wizard page allows you to select the classification of the object. Select the node in the tree view that you want to query. Click Next.
37
4. The Query by Container page is only available if you selected this type on the initial wizard page. A saved query displays on the Saved tab. You can provide a name and description for the saved query object. Information entered in the GUI display as field also displays on the Saved tab grid.
38
Saved Tab
Lists your saved queries. You can edit and execute the saved queries. When a saved query is executed, the results display in the Discover and List web parts. After you define your search criteria for a query, you can save that query and run it again later. After you save queries, you can update the search criteria contained in queries.
Save Query List for <username> - Displays the user name of the user who saved the query list. Edit - Select to edit the query. The selected query displays on the Query tab. Be sure to click Save on the Edit Saved Query dialog box to save the changes you make to the search criteria. Only clicking Apply or Finish runs the query with your new criteria, but does not save your changes. Search - Executes the query. The results display in the Discover and List web parts.
39
Click the query in the tree view. The query appears in the Review web part.
Click Run Saved Query on the Actions tab to run the query. The results display in the List web part. Click Edit Saved Query to use the Edit dialog box to edit the criteria for the query.
40
41
42
SECTION 4
43
Sort a list
Click the header of a column. The rows in the list are sorted according to the values in the selected column. If the sort order is ascending, an up-arrow icon in the column header indicates that the list is sorted by this column in ascending order. A down-arrow icon in the column header indicates that the list is sorted by this column in descending order.
Print only what displays on your monitor in the List web part
1. Complete a search. Your search results display in the List web part. 2. Arrange the List web part so that the content displays as you want it to print. 3. Click Print Window . A preview of your print job displays. 4. Click Print to print the contents or Close to dismiss the window.
44
45
46
SECTION 5
Like Windows Explorer, you can expand and close nodes in the tree view to show and hide information in the database. When you expand a node in the tree view, the software expands the default relationship for the object. For example, expanding the DEV Equipment, Equipment type level-0 node in the tree view displays an existing plant and equipment. The default relationship for each object is defined by the system administrator.
If you enable the Look Ahead option, you can see the number of objects included in the relationship beside the expansion heading in the tree view. In the previous example, there are two equipment types defined in SmartPlant Foundation, designated by the number 2 in brackets.
47
If you define values for the Warning dialog number and the Maximum query limit options on the Change User Preferences dialog box, a warning message displays when the query results exceeds your warning dialog number but is less than your defined query limit. Click OK to continue running the query and display the query results. Or, click Cancel to stop the query. If your Maximum query limit is reached, a separate warning message displays to inform you that, if displayed, your query exceeds your defined query limit value. Click OK to display the results. The total results displayed defaults to your defined query limit value. Click Cancel to stop the query. To clear all expansions and reset the tree view back to its original state, click Clear Tree Collapse All to close all expanded tree branches. . Click
48
49
50
SECTION 6
51
Based on how your Web Portal is configured, you can view drawings and models in either the View web part or in a separate SmartPlant Markup Plus window. If you are using the View web part, you do not have the ability to use SmartPlant Markup Plus layers, but you can use navigation and hotspotting on published 3D models and 2D drawings. If you are using a separate SmartPlant Markup Plus window, you cannot use navigation and hotspotting on published 3D models, but you can use SmartPlant Markup Plus layers. For more information, see the SmartPlant Web Portal Customization Guide (SPFWebPortalCustomization.chm) delivered with the SmartPlant Foundation programming documentation. The drawing can display in either SmartPlant Markup Plus or SmartPlant Review (depending on file requirements). To use SmartPlant Review or SmartPlant Markup Plus, the products must be installed. For details about using either product's command, please refer to the documentation delivered with that product.
52
View a drawing
1. In the Search web part, click the Find tab. 2. Expand the Published Data tree and click Published Documents. 3. Select a SmartPlant P&ID drawing in the List web part. The drawing displays in the View web part using SmartPlant Markup Plus. To clear the viewing area, click Clear contents. You can also click the title bar drop-down arrow and click Clear.
53
See Also
3D Navigation Controls (on page 54) Use Keyboard-Only 3D Navigation (on page 56) Use Mouse Only or Mouse + Keyboard Combinations (Fly Mode) (on page 57) Use the 3D Navigator (on page 59) 3D Navigation Tips (on page 63)
3D Navigation Controls
Select navigation controls that are most comfortable or familiar to you. To access in the 3D Navigator. To navigation-specific help at any time, press Q or click the Help control access additional product help, press F1 or go to the Help menu.
54
Viewing Drawings and Graphics Use the 3D Navigator (on page 59) Use Keyboard Controls
Arrow keys as well as the gaming standard W (Move In), A (Left), S (Move Out) and D (Right) are supported.
55
See Graphics Card Information (on page 65) for the basic requirements needed for 3D navigation. You can press and hold the 3D Navigator Look and Move controls for continuous motion. Press and hold the center Move control on/off the view window. to drag the 3D Navigator to a different location
W A S D E C
To move or walk through your model in a first-person perspective. Press and hold the designated direction key. Move left and right is a sidestepping motion. To... Move forward and left. Move forward and right Move backward and left Move backward and right Use... W+A W+D S+A S+D
56
Look around the model as if you were turning your head. Simply move the mouse up/down, left/right from the crosshair point. To... Return to the default, isometric home view of your model Create your own custom home view Reset a customized home view back to the original default home view Use... H
Press the H key if you are 'lost' in the model or need to return to the default model view.
Application-Specific Information
SmartPlant/SmartMarine 3D Fly Mode Information When you exit Fly mode, right-click or press ESC twice to exit 3D navigation. SmartPlant Construction Fly Mode Information To encircle or rotate around a selected object, use the SmartPlant Construction Encircle Model command in the Toolbox. In SmartPlant Construction, you will not be able to use the left-mouse drag operation to encircle objects.
57
Enter and exit fly mode to use mouse and keyboard combination navigation controls. To... Move in Move in (factor of 2) Move left Move out Move out (factor of 2) Move right Move up Use... Mouse Wheel Forward -or- W Middle Mouse Button/Wheel Click A Mouse Wheel Backward -or- S SHIFT + Middle Mouse Button/Wheel Click D E
Move down C Walk through your model in the direction of the crosshair. Roll the middle mouse wheel forward and back, or press and hold the designated WASD key. A left or right move is a sidestepping motion. A middle mouse click moves you halfway in to your target point. Use SHIFT + middle mouse click to move back out the distance of the eye point from the target. The perspective angle does not change. To... Move in and left. Move in and right Move out and left Move out and right Use... W + A -or- Mouse Wheel Forward + A W + D -or- Mouse Wheel Forward + D S + A -or- Mouse Wheel Backward + A S + D -or- Mouse Wheel Backward + D
Middle Mouse Drag Move left/right/up/down Walk at various angles through your model. Roll the mouse wheel forward and backward while holding down the designated direction key. Or, hold down the desired two direction keys simultaneously. In a key combination move, if you release one directional key, you still continue moving in the direction of the other key.
58
Look around the model as if you were turning your head. Simply move the mouse up/down, left/right from the crosshair point. To... Use...
Return to the default view of H your model Create your own custom home view Reset a customized home view back to the original default home view CTRL+H CTRL+SHIFT+H
Press the H key if you are 'lost' in the model or need to get back to a known view. To... Select or De-select objects Use... Left mouse - double click
Encircle or rotate around an Left mouse - press and hold object When rotating around an object, the encircle point is the current center point; not the center of the selected object.
Application-Specific Information
SmartPlant/SmartMarine 3D Navigator Information To start 3D navigation in SmartPlant/SmartMarine 3D applications, press Ctrl+Shift+F or click Navigate View on the main toolbar. on the 3D Navigator is not available. To select an object, navigate to The Select button the required location in your model and click Navigate View to disable 3D navigation. Use the Select command on the SmartPlant/SmartMarine 3D toolbar to select objects. Use SmartPlant/SmartMarine 3D commands to perform required operations. When you right-click to end fly mode, right-click again to exit 3D navigation. The Close button on the 3D Navigator removes it from the display. You can still use the keyboard for navigation.
59
3D Navigator Controls
Quick Help - Displays help specific to 3D navigation. Home (Default View) - Returns to the startup view of the model. See Return to Default View (on page 61). You can also create your own home view. See Create a Custom Home View. Fly Mode - Enters Fly mode where you use the mouse and/or keyboard to interactively move and look through the model. When you are in Fly mode, the 3D Navigator does not display. You can press F or ESC to exit Fly mode. The 3D Navigator then displays at its last position. See Enter Fly Mode (on page 61). Look - Changes your view direction as if you were turning your head. You can look around in all directions. See Look Around (on page 61). Move In/Out - Takes you closer to or further away from model objects. Move (Up/Down/Left/Right) - Changes your position in the model at the crosshair cursor level as if you are 'walking' around in the model. You can move in any direction. See Move (on page 62). Fit - Places all visible elements in the view window if no objects are currently selected. If any objects are selected, the control zooms to the selected objects. See Fit to Object(s) (on page 63). Select - Turns Select mode on and off (not available in the SmartPlant and SmartMarine applications). Once you move your cursor off of the 3D Navigator, it fades into a transparent shadow so that it does not distract from the current view. The 3D Navigator reappears when you move the cursor back over it. You can select and move the 3D Navigator to place it wherever you want in or out of your view window. To use the 3D Navigator, just click on the desired action. A single click causes short movements while a click + hold action on the look and move controls enables you to move continuously.
60
Application-Specific Information
SmartPlant/SmartMarine 3D Fly Mode Information When you exit Fly mode, right-click or press ESC twice to exit 3D navigation. You can also press the F key to start fly mode. Once you enter Fly mode, the 3D Navigator no longer displays. Use your mouse and keyboard to move around through the model. To exit Fly mode, right-click, press F again or press ESC. The cursor changes back to its original icon and the 3D Navigator displays. In Fly mode, your cursor changes to a crosshair that is located at the center of your view window.
Look Around
Press and hold any of the four Look controls to continuously look or turn in that direction as if you were turning your head. Use the Look control in the 3D Navigator to look around from your current position in the model.
61
Press and hold any of the Move controls to continuously move in that direction. As you move through the model, the closer you get to your target, the slower the movement rate becomes. The further away from the target, the faster the movement rate. The Move operations enable you to move through solid objects such as walls, doors and slabs.
Select an Object
Click Select as you navigate around your model to select an object.
Application-Specific Information
SmartPlant Construction Select Information To encircle or rotate around a selected object, use the SmartPlant Construction Encircle Model command in the Common Tools toolbox. SmartPlant Markup Plus Select Information A question mark icon displays to indicate the QuickPick feature is enabled. Use QuickPick to select an object in a dense or crowded area. Each of the numbers in the QuickPick tool corresponds to an object in the area and is highlighted when you select the number.
SmartPlant/SmartMarine 3D Select Information When an object is selected, press and hold the left mouse button to encircle or rotate around the object. The encircle point is the current center point; not the center of the selected object(s). Select mode stays active until you click the Select control in the 3D Navigator. You can use the CTRL key to select multiple objects.
SmartPlant Review Select Information Click Select in the 3D Navigator to enable the SmartPlant Review Auto-Highlight mode. When you select an object, it remains highlighted until you select another object or press ESC. Select mode/Auto-Highlight stays active until you select any other Mouse Drag mode.
62
Application-Specific Information
SmartPlant Review Fit Behavior In SmartPlant Review, the Navigator Fit command is a conditional fit. It performs a fit based on the objects that are selected. 1. Fits to the selected object. 2. Fits to selected item(s) in the SmartPlant Review Project Manager. 3. Fits to the whole model and any visible objects. 4. Select one or more objects in the current view. 5. Click Fit on the 3D Navigator.
3D Navigation Tips
Motion Tips
As you move through the model, the closer you get to your target, the slower the movement rate becomes. The further away from the target, the faster the movement rate. The Move operations enable you to move through solid objects such as walls, doors and slabs. Press ESC to end a navigation operation. To make small left/right/up/down movements, click and hold the middle mouse button as you move in the desired direction. It can sometimes be difficult to make small movements with the mouse and keyboard because the distance of motion for each key press is greater than what is needed. This is especially true when you are close to objects within the 3D model.
Application-Specific Information
SmartPlant/SmartMarine 3D Navigation Tips The Navigate View command always sets the current tilt angle to 0 when it is enabled. The system does not restore the previous tilt angle when 3D navigation is turned off. To get back to the rotated view you were using before entering 3D navigation, select View menu > Previous View.
63
Messages
The color scheme has been changed to Windows Vista Basic. A running program isn't compatible with certain visual elements of windows. Click here for more information. Meaning: This message may display when you open a 3D model. To correctly display the cross hair (in fly mode) on a system running Microsoft Vista as well as to support all capabilities of this operating system, the application automatically unchecks the Enable desktop composition setting. This setting is in Control Panel > System > Advanced system settings > Advanced tab > Performance Settings > Visual Effects. Recovery: If you click to see more information on the message, the Windows information dialog box displays. Check the Don't show me this again option if you do not want the above message to display each time a 3D model is opened.
64
Additional requirements and/or recommendations for cards include: In general, workstation-level graphics cards provide better overall performance with 3D model files than desktop graphics cards. The card must be manufactured within the last three years. Use updated drivers (at least within the last 6 months). Systems running Citrix and remote desktop applications currently do not support the hardware acceleration performance enhancements.
Troubleshoot 3D Navigation
Graphics Card Troubleshooting
You do not see graphics in the window display of a dual-monitor setup when using an ATI V3600 FireGL (driver ver. 8.62 released on 7/21/2009) card. Follow the steps below to configure graphics card. 1. From the Start menu, select Catalyst Control Center. 2. Select Workstations > Settings. 3. Click Shared Front/Back/Z Dual Screen Mode. 4. Click OK and then exit the application. 5. Reboot your system. The 3D Navigator is flickering. Check your card properties and make sure you have Hardware Acceleration enabled. Checking Hardware Acceleration Settings - Microsoft Vista Instructions (on page 67) Checking Hardware Acceleration Settings - Microsoft Windows XP Instructions (on page 71) For NVIDIA Quadro cards (Windows XP), you can turn off the Overlay setting in the NVIDIA control panel. 1. Open the NVIDIA Control Panel application. 2. Go to 3D Settings > Manage 3D Settings. 3. Select Off for the Enable Overlay setting. 4. Save your change and close the application.
65
2. Click the Appearance tab. 3. Click Effects and select Scroll Effect under the Use the following transition effect for menus and tooltips setting.
4. Click OK to save your change. 5. Click OK to close the Display Properties dialog box.
General Messages
The color scheme has been changed to Windows Vista Basic. A running program isn't compatible with certain visual elements of windows. Click here for more information.
66
67
68
69
If your driver does not allow changes (as shown in the above image), you may have to contact your video card manufacturer for instructions on turning on/off hardware acceleration.
70
7. Move the Hardware acceleration slider bar to Full. 8. Click OK to save edits and exit the dialog box. Click OK again to exit the Display Settings dialog box.
71
3. Click Advanced.
72
5. Move the Hardware acceleration slider bar to Full. 6. Click OK to save edits and exit the dialog box. Click OK again to exit the Display Properties dialog box.
73
74
SECTION 7
Reviewing Information
The Review web part displays the currently selected object. You can review the object's properties, related items, and initiate actions (methods) marked as available in the Web Portal. A drop-down list displays the current object. When you click the drop-down list, previously selected objects are listed. You can navigate back to a previous object by selecting it from that list. If you define values for the Warning dialog number and the Maximum query limit options on the Change User Preferences dialog box, a warning message displays when the query results exceeds your warning dialog number but is less than your defined query limit. Click OK to continue running the query and display the query results. Or, click Cancel to stop the query. If your Maximum query limit is reached, a separate warning message displays to inform you that, if displayed, your query exceeds your defined query limit value. Click OK to display the results. The total results displayed defaults to your defined query limit value. Click Cancel to stop the query. The delivered Review web part contains the following tabs: Relationships, Properties, and Actions. The Related Items tab is not available by default, but can be enabled through customization or personalization.
Relationships Tab
The Relationships tab displays various relationships to selected items. Click the Show All Relationships link in the tree view to display all the relationships that exist among the selected object and other objects. If you define values for the Warning dialog number and the Maximum query limit options on the Change User Preferences dialog box, a warning message displays when the query results exceeds your warning dialog number but is less than your defined query limit. Click OK to continue running the query and display the query results. Or, click Cancel to stop the query. If your Maximum query limit is reached, a separate warning message displays to inform you that, if displayed, your query exceeds your defined query limit value. Click OK to display the results.
75
Reviewing Information
The total results displayed defaults to your defined query limit value. Click Cancel to stop the query.
Show All Relationships - Allows you to display all the relationships that exist among the selected object and other objects. Use the collapse and expand buttons to collapse and expand nodes in the tree.
76
Alphabetized - Displays an alphabetical list of properties for the selected object. Categorized - Displays the list of properties grouped by category. Extended - Displays an extended view of the properties for the selected object. Brief - Displays an alternate list of properties for the object if one is defined. Show blank values - Toggles on and off the display of properties whose value is blank.
Actions Tab
The Actions tab displays methods that can be invoked against the currently selected item. Only those methods available in the Web Portal are listed.
77
Reviewing Information
Use the collapse and expand buttons to collapse and expand nodes in the tree.
Main details Name - Displays the name of the object. Description - Displays the description of the object. Configuration details Object configuration - Displays the scope in which the object is created. Object query configuration - Displays the scope in which the object is created based on query settings. Details Category - Displays the category of the object. Type - Displays the type of the object. Title - Displays the title of the object. Status - Displays the status of the object. Owning group Item owning group - The group to which ownership is assigned. Revision detail Revision scheme - The name of the revision scheme of which the object is a part. Any revision of the document must conform to the revision scheme of which it is a part. Minor revision - The minor part of the ExtRevision. For example, Revision 01A can be split with 01 as the major part and A as the minor part. You can sort on this option. Major revision - The major part of the ExtRevision. For example, Revision 01A can be split with 01 as the major part and A as the minor part. You can sort on this option. Print - Prints the displayed information.
78
Reviewing Information
History The History command displays historical information about the attributes of the selected item. The History command allows you to view the update history of the selected object. The command provides you with information about the SmartPlant Foundation object such as its creation date, interfaces, and so forth.
Object Details Name - Displays the name of the selected object. Description - Displays a description of the selected object. Options Hide historic data - Click to remove any historic data from the view. Show inconsistencies only - Click to display only inconsistencies. Show tree - Click to display attributes in a tree view. Property data Internal name - Displays the attribute name. Export to Excel - Moves the content of the view to Microsoft Excel. You can save the file or open it to display the contents of the view in Excel. Print - Displays the contents of the view in a preview window. Click Print on the preview window to print the view. Batch Print
79
Reviewing Information
The Batch Print command allows you to select files to print. Select the file(s) you want to print.
Save Target As The Save Target As command saves a copy of selected files. The following Save Target As dialog box displays when you have SmartPlant Markup Plus installed. Click Browse to select a path for the files. You can also type the path in the Path field.
The following Save Target As dialog box displays if you do not have SmartPlant Markup Plus installed. Click to select files to copy. By default, files are copied to C:\.
Run Report After querying for a report and selecting a report, the Run Report action displays on the Actions tab. Click Run Report to run a report. When executing a report, you may or may not be prompted to enter criteria based on the definition and type of report. All results of the report display in the output format specified by the report. Reports can have the output specified as Microsoft Excel, Microsoft Word, HTML, List View, and so forth.
80
Reviewing Information
If a report does not require you to enter any criteria information, the report runs with the results displayed in the output format specified by the report. If the report requires that criteria be entered, the Prompt for Values dialog box displays.
The Prompt for Values dialog box allows you to enter a single criteria or display a dialog box that allows multiple criteria. To display the Criteria Definition dialog box, select the Value option ellipses.
The Criteria Definitions dialog box allows you to define, clear, or update multiple criteria used when executing the report. After closing this dialog box, the previous dialog box appears. Enter your criteria, and click OK. The report displays in the specified output format. Workflow If the selected item can be attached to a workflow, a Workflow node is available on the Actions tab. See To Do List (on page 91) for more information about the workflow commands. View Shared Data The View Shared <Object> command allows you to view data about a shared object, such as instruments, equipment, and pipelines, that has been published by multiple sources into their tool-specific domains, then correlated. You can see inconsistencies between the data published by tools, the latest retrieved value, and more.
81
Reviewing Information
Published objects must be correlated in order to view data across multiple domains.
The View Shared <Object> dialog box displays the data for the shared object. Each tool that has published data for the object is represented by a column in the table. Click a column header to use the values in that column as the basis for comparison. Values that are inconsistent with values in the selected column are highlighted. By default, the Last In Value column is selected. Name - the name of the shared object. Description - the description of the shared object. Property - this column displays the name of each property of the shared object. Last In Value - the most recently published value for the shared object is displayed in this column. For properties scoped by a unit of measure, the SI values of the property values are used to determine inconsistencies. This means that the units of measure for the property values do not have to be the same to be considered consistent, as long as the SI values are the same. The tolerance value for comparing numeric values is +/-0.5%. By default, the selected column is highlighted in blue, and the cells representing the properties that are inconsistent with the values in the selected column are highlighted in orange. These colors can be customized with CSS files. See the SmartPlant Foundation Web Portal Customization Guide for more information.
82
Reviewing Information
View Related Items The View Related Items command allows you to view the details for the selected item and information about each relationship you can navigate from the item. The top section of the List web part displays details about the selected item. The bottom section of the List web part displays the related items. Select a different type of item from the drop down list to view the related items of that type.
83
Reviewing Information
Summary View Equipment The Summary View Equipment command allows you to view a summary of a published object's relationship in one dialog box.
84
Reviewing Information
85
Reviewing Information
4. Click a column header to compare other values for the property with the selected value. Inconsistent values are highlighted in orange.
86
Reviewing Information
The related items information is displayed in the List web part. If your List web part is configured to display information in tabs, then the View Related Items tab for the item appears in the List web part, as shown below.
The top section of the List web part lists the details for the selected object. The bottom section of the List web part shows items that are related to the selected item.
87
Reviewing Information
Types of related items are displayed separately in the bottom section. To view a different type of related item, select one from the drop down list.
Click a related item in the bottom part of the List web part to populate the Review web part with that item.
88
Reviewing Information
3. Click Summary View Equipment on the Actions tab of the Review web part to open the Summary View Equipment dialog box.
89
Reviewing Information
90
SECTION 8
To Do List
The To Do List web part shows all workflow steps that have been assigned to the you and their statuses. In the To Do List, you can also view and complete checklists associated with workflow steps. You can complete voting steps and mark other steps Completed, Approved, Unable to Complete or Rejected. The To Do List web part has a toolbar, List View with workflow steps and Checklist pane to view and edit checklists. By selecting an object which is in a workflow, you can also view a workflow details report, view the workflow history for an object in a workflow, and view a graphical representation of a workflow.
Save Checklist
Click Save Checklist to save any changes that have been made to the check list.
Configuration Filtering
Click Configuration Filtering to filter your inbox based on the configuration. If Configuration Filtering is on, the To Do List will only display the workflow steps in the active query configuration.
Actions Tab
Highlight a workflow step in the To Do List. Any To Do List actions that are supported in the Web Portal appear in the Actions tab of the Review web part.
91
92
To Do List
The ClaimStep Task box appears.
3. Type any comments in the Comments box then click OK. When you claim a step, the Claim command disappears from the Actions tab of the Review web part for the step in your To Do List, and the step disappears from the To Do Lists of other users. After you claim a step, you can complete the action required by the step. In a parallel workflow, you can claim a single step, instead of all parallel steps, if that single step has a role assigned to it. This applies if the step is set up for claim by role.
93
To Do List
Click Print to print the details of the workflow step. A preview dialog box appears, allowing you to view what will be printed before it is printed.
94
To Do List
The History dialog box appears.
95
To Do List
3. If there is a checklist associated with the step, click Checklist Preview Pane Do List toolbar to display the checklist.
on the To
96
To Do List
If the checklist preview pane is already displayed, the checklist associated with the step appears in the checklist preview pane when you select the step. 4. Complete the checklist. Because checklist items are optional, you are not required to complete checklist items before you can complete a step in a workflow. If an item in the checklist is vital to your overall workflow, we suggest you make that item an actual step in the workflow.
5. Type any comments and messages to the next recipient in the SignOffStep Task box. Information entered in the Comments box is saved with the object in the database. Information entered in the Message to next step box is included in the e-mail sent to the next recipient, but it is not stored in the object or workflow. 6. Click OK. The software automatically removes the step from your To Do List, and the workflow continues to the next step.
Reassign a step
1. Select a workflow step in the To Do List. 2. Click Reassign in the Actions tab of the Review web part. The Reassign box appears.
3. In the Reassign dialog box, select the user or user role to whom you want to reassign the step. You can not assign it to both. 4. Click OK. The software removes the reassigned step from your To Do List, and the step appears in the To Do List of the user or users to whom you assigned the step.
97
To Do List
3. Type the new duration for the step in days, or use the buttons to set the duration. 4. Click on the calendar buttons to set the Target date and Planned date.
98
To Do List
99
To Do List
View a workflow
1. Select an object that is in a workflow. View Workflow appears under the Workflow node on the Actions tab of the Review web part.
The following default colors indicate workflow states: Yellow - The workflow step is ready to begin.
100
To Do List
White - The workflow step is not ready to begin yet. Green - The step has been signed off. Pink - The step has been rejected. Blue - The step has been terminated. A red line connecting two steps indicates that the first step of the two is the reject step for the second. 3. Click on a step to see the details for the step. The step details dialog box appears.
101
To Do List
Click Print to print the details of the workflow step. A preview dialog box appears, allowing you to view what will be printed before it is printed.
102
To Do List
3. Click Properties to configure the properties displayed in each step box.
The current configuration of properties on the step box symbols is displayed in the Properties to Display dialog box. Select a column set to determine what properties are displayed in the step box. Select Display property name if you want to display the name and description of the property in the step box. Click Default to restore the default properties for the step box. Click OK to save your changes and return to the graphical display of the workflow. 4. Click a color in the workflow step color key to change the color.
103
To Do List
The Workflow step color selection dialog box appears.
5. Select a new color to represent the step. Click Default to restore the color to the default color and return to the graphical display of the workflow. 6. Click OK to save your changes and return to the graphical display of the workflow. The workflow display color settings and properties set in the Web Portal also apply to your workflow display color settings and properties in the Desktop Client.
104
SECTION 9
Access to applications is controlled by roles. If you have access to more than one application (including the default Web Portal page), use the Applications Bar to choose which application you want to start. If you have access to one application, that application is started when you log in. Any personalizations or customizations that are created within an application are saved. If you have access to multiple applications, the application you were in most recently is started when you log in.
Tasks
When you open a Web Portal application, the Tasks web part appears below the Applications Bar. Tasks provide the way to perform actions within a Web Portal application. An example task configuration is shown below.
In this example, the user has clicked Doc Portal, and is now in the Document Portal application. The one task for this example application is Attach File. For more information about enabling and configuring applications and tasks in the Web Portal, refer to SmartPlant Foundation Web Portal Customization Guide (SPFWebPortalCustomization.chm) delivered with the SmartPlant Foundation programming documentation.
105
106
Glossary
A active scope
A configuration in which you may view, create, modify, and delete information in the SmartPlant Foundation client.
adapter
Authoring tool software that facilitates the sharing of data between the authoring tool and other integrated tools. Tool adapters generate XML files for publish operations and consume XML when tools retrieve documents. Adapters are also called SmartPlant adapters.
API
1) Application Programming Interface. 2) American Petroleum Institute.
as-built
The set of data that describes the existing conditions of a plant or site; the completed and approved state of a project.
attribute
An object characteristic.
authoring tools
Applications where documents are created and then shared through integration. Integrated authoring tools include Aspen Basic Engineering, SmartPlant P&ID, SmartPlant Electrical, SmartPlant Instrumentation, SmartPlant 3D, SmartPlant Materials, and SmartPlant Foundation.
B batch printing
Printing files at a specified date and time from the SmartPlant Foundation client.
107
Glossary brownfield
An existing plant or site that is modified by one or more projects.
C cache
Memory that stores recently-accessed data so that subsequent requests to access the same data can be processed quickly.
cases
Configurations for instruments that may include specific parameters, settings, or even components for use in a specific situation.
change notification
An e-mail message sent to a user when an action is performed on an object in SmartPlant Foundation.
check out
Allows you to make changes to an existing document in SmartPlant Foundation. Only the user who has checked out a document can save changes to it.
checklist
A series of items, tasks, or questions that the user finishes before a completing a step in a workflow. Checklists can be optional or required.
claim
To take responsibility for a step in a SmartPlant Foundation workflow. To identify the scope of a project by adding items to the project from a drawing or a 3-D model. When authoring tools are integrated, SmartPlant P&ID claims items that are shared among tools. Other authoring tools, such as SmartPlant Instrumentation and SmartPlant 3D, claim items that they create and modify that are not shared.
108
common UI
An ActiveX component (.dll) that provides a standard user interface for integration functionality, such as publish, retrieve, and register. The authoring tools display the common UI when the user clicks particular SmartPlant commands in the authoring tool.
compare
To view the differences between two revisions of the same document in SmartPlant Foundation.
component
A .dll (dynamic link library) that handles requests on the SmartPlant Foundation server. Components are also called business service layers (BSLs).
component schema
A subdivision of the complete SmartPlant schema that contains the set of class definitions that are used within a specific domain or application area.
condition
An object that can restrict access to a method, workflow, or relationship based on specified criteria.
configuration tree
A representation in a tree list, which may include plant, areas, units, and projects that indicates the structure in which the data is stored in SmartPlant Foundation.
container
An object used by the tool adapters and the SmartPlant software components to pass data back and forth between a tool and SmartPlant Foundation. A container may hold data or metadata related to the data model or actual instance data.
contract
A group of documents that are collected and issued for bid, construction, review, and so on.
109
Glossary correlation
The relationship between items that represent the same object in multiple authoring tools.
create scope
A configuration for data creation, modification, and termination in SmartPlant Foundation.
current document
A document that has been signed off. Current documents can be revised in SmartPlant Foundation, but not checked out or in.
cut-off date
Any date on which progress information is calculated. Official cut-off dates are scheduled in advance and are typically part of a reporting schedule. Unofficial cut-off dates are random dates when rollups are not scheduled but progress is calculated anyway.
D data list
A list of plant items that can be modified outside SmartPlant Foundation. You can generate data lists to view and edit SmartPlant Foundation data in Microsoft Excel, and then save the data back into SmartPlant Foundation.
data sheet
A file that allows users to view, edit, and print object data in a customizable format.
database
Collection of files of comprehensive information that have predefined structure and organization; a specific program can communicate, interpret, or process these files.
110
design file
A file generated by a design tool, such as SmartPlant P&ID or Aspen Basic Engineering.
digest
See e-mail digest.
display item
Object used to present data or relationships on a form in SmartPlant Foundation.
distribution matrix
A list of people who will receive a transmittal created in SmartPlant Foundation and an indication of what is expected from each recipient. Workflows can also be configured to use a distribution matrix for sending To Do List or e-mail notifications to workflow step recipients.
document
An object used to track revisions to a design file in SmartPlant Foundation.
document master
An object used to group all the revisions of a document in SmartPlant Foundation.
document revision
An officially recognized change to a document.
domain
A set of data (for example: tool data, SmartPlant Foundation administration data, and schema data) that is segregated and managed independently in SmartPlant Foundation. Data segregation improves performance and maintains data integrity. The SmartPlant Enterprise authoring tools create data in one SmartPlant Foundation domain and publish into another domain.
111
dump file
A file that contains data exported from the SmartPlant Foundation data or system administration database. You can import database dump files using SmartPlant Foundation Server Manager.
E edge definition
Single or multiple relationship definitions with direction. In the SmartPlant schema, an edge definition is used to traverse from a starting object to related objects.
effectivity date
The period of time for which historical data is displayed in SmartPlant Foundation.
e-mail digest
A collection of notification messages from SmartPlant Foundation that are sent together instead of separately. You can set a user preference in the Desktop Client to receive digests instead of individual e-mail messages.
enumerated entry
A member of an enumerated list that defines one possible value for a property in the SmartPlant schema. Enumerated values are sometimes called enumerated entries.
enumerated list
A list of possible string property values defined for a property definition in the SmartPlant schema. Enumerated sets are sometimes called enumerated lists, picklists, codelists, and lookups.
exposes
The relationship between interface definitions and property definitions in the SmartPlant schema. Interface definitions expose the property definitions for class definitions.
112
file type
A setting in SmartPlant Foundation that specifies the format of attached files based on file extension. This setting determines how files are viewed, edited, and printed in SmartPlant Foundation.
folder
A grouping object that can contain a number of items. A folder can contain other folders, to build up a folder hierarchy. A folder can have an owner, which makes it visible only for that user, and it can have an owning group, which allows access for members of the group. Some uses of a folder include grouping objects, putting a folder's contents through a workflow, and generating a data list from a folder's contents.
form
A part of the SmartPlant Foundation client user interface that allows users to specify values for class definition properties.
FTR
Full-Text Retrieval; a separate module of SmartPlant Foundation that allows you to store, index, and search for text contained in or associated with objects managed by SmartPlant Foundation. Full-text retrieval creates an inverted index (a list of the individual words with locations in the files) and uses this index at search time.
G governing case
The specific case used for an instrument.
graph definition
A connected network of edge definitions with structure. Each graph definition in the SmartPlant schema starts at an interface definition and traverses through one or more relationship definitions to another interface definition at the other end. Graph definitions are sometimes referred to as directed graph definitions.
113
greenfield
A new plant on a site with no existing infrastructure.
H hierarchy
A classified structure with superiors, or roots, and subordinates, or dependents, used for grouping data.
host
A computer that stores files.
hotspot
Graphical notification that a user can click a drawing item in a drawing or viewable file to display the properties for the item in SmartPlant Foundation.
I implies
The relationship between two interface definitions in the SmartPlant schema. If an interface definition implies another interface definition, then any class definition that realizes the first interface definition can also realize the implied interface definition.
integration
Technology that standardizes and improves the communication among the various SmartPlant Enterprise authoring tools used in the course of designing, constructing, and operating a plant. Integration manages data exchange among these authoring tools, which enables sharing and reuse of plant information throughout the plant lifecycle.
114
issue
To release a document as part of a transmittal. The document is not considered issued until the status of the transmittal has been changed to issued.
issue request
A staging of documents and drawings to be issued with a transmittal. An issue request means that the documents or drawings are ready to be issued with a transmittal, but does not actually cause the transmittal to be issued.
M master file
A document file that references other files.
meta schema
A set of schema objects that describe the objects in the SmartPlant schema. The meta schema provides the building blocks upon which the SmartPlant schema is built.
method
A call to an API that allows users to perform actions on objects or interfaces in SmartPlant Foundation.
O owning group
The user group to which an object is assigned in SmartPlant Foundation.
115
Glossary picklist
A list of applicable values for a given property in SmartPlant Foundation.
plant
An object that can represent the top level in the delivered SmartPlant Foundation data hierarchy. If you use a custom hierarchy, the object at the top level of the hierarchy may have a different name.
print server
A computer that processes print requests for a defined list of printers in SmartPlant Foundation.
process cases
Configurations for instruments that may include specific parameters, settings, or even components for use in a specific situation.
profile
See user profile.
progress
Functionality that allows users to track the development of deliverables, such as documents or items, against a project plan, indicating any deviations from the original plan.
project
A logical unit of data that is a subset of the items that make up a plant. A project is used for making controlled, incremental changes to the data in a plant. There can be multiple projects for a plant at any given time.
property
An object characteristic.
116
publish
To share a document and its data with other authoring tools by exporting an XML file containing the document data and relationships. When a document is published, the software places the XML file in the appropriate SmartPlant Foundation vault and loads the data from the XML file into the SmartPlant Foundation database. After the document is published, users can retrieve the data from the XML file located in the SmartPlant Foundation vault into other authoring tools.
punchlist
Provides a running to do list of outstanding scope for completions.
Q query
A detailed search based on object properties.
query scope
A configuration for data queries and relationship expansions in SmartPlant Foundation.
R realizes
The relationship between class definitions and interface definitions in the SmartPlant schema. Class definitions realize interface definitions. The interface definitions that are realized by a class definition expose the properties for that class definition.
117
register
To map an authoring tool and all its projects to a SmartPlant Foundation URL, which points to one SmartPlant Foundation database. You must register your authoring tool plant before you can publish and retrieve in an integrated environment.
relationship
An association between two objects.
relationship definition
Associations between interface definitions in the SmartPlant schema. Relationship definitions identify two specific objects that fulfill the roles on each end of the relationship.
resurrected object
A deleted authoring tool object that is reintroduced to the SmartPlant Foundation database when recovered tool data is republished. For example, a tool initially publishes a document containing an object, but later deletes the object and republishes. SmartPlant Foundation then detects that the object is deleted. However, if the tool restores data that was backed up before the object was deleted, through a data restoration or other tool-specific mechanism, and republishes, then SmartPlant Foundation recognizes that the object was previously deleted but has been reintroduced (resurrected).
retrieve
To import document data from an .XML file that was published by another authoring tool for the purpose of maintaining consistency of data across tools. When you retrieve a document, most authoring tools analyze the impact of the newly retrieved data on the existing database and then place tasks on the authoring tool's To Do List. The tasks on the To Do List allow you to create, delete, or modify items at the appropriate time in the design process.
revision
An officially recognized change to a document. Each revision of a document may have multiple versions.
118
role
A role determines a user's level of access to data and functionality in a specific plant/project configuration. Users can belong to more than one role per configuration. Roles are defined by system administrators and are based on related access groups, domains, and owning groups.
rollup
The process of calculating progress data. Progress is calculated for every deliverable at every level of the hierarchy, and all of that information is available for viewing or reporting when you run a rollup. Rollups can be scheduled with official cut-off dates or can be run manually at any time.
S schema
A model used to describe and validate the structure of XML files.
Schema Component
A suite of ActiveX components that provide functionality surrounding the creation, parsing, validation, and comparison of the SmartPlant schema and data. The tool adapters interact with the Schema Component to read the SmartPlant schema, to create data for publish, and to retrieve data.
scoped by
The relationship between property definitions and property types in the SmartPlant schema. The scoped by relationship specifies the property type that defines acceptable values, or scopes, a particular property definition. Every property definition in the SmartPlant schema is scoped by one and only one property type. All properties of that property definition must be of that property type.
section
A collection of display items used on SmartPlant Foundation forms.
server
A computer that stores or processes files.
119
sharing
The relationship between class definitions and shared object definitions in the SmartPlant schema. This relationship indicates that a class definition can be shared.
SI
International System of Units, sometimes referred to as the metric system. When values for units of measure are published, they are converted to SI units and stored, regardless of the units of measure selected when the user defined the value in the authoring tool.
sign off
To approve a particular revision of a document in SmartPlant Foundation. Signing off a document sets the document to be the current released revision, makes it official, and supersedes any previous released revisions. Document revisions that have been signed off are frozen and cannot be checked out.
site
Refers to the SmartPlant Foundation server settings that point to SmartPlant Foundation Administration and Data databases and vaults. Each site allows you to run SmartPlant Foundation operations on data associated with plants and projects configured in the database.
SmartPlant Enterprise
A suite of Intergraph engineering applications that are delivered together.
SmartPlant schema
An XML file that describes the structure of the XML files generated by integrated authoring tools in much the same way as a data dictionary describes the structure of a database. As tools publish documents in XML format, those documents must adhere to the format defined by the schema to ensure that the XML data can be loaded into SmartPlant Foundation and retrieved into the other authoring tools.
120
Glossary status
The state of a change object at the completion of each step in a workflow.
step
A process that must be performed in order to complete a workflow.
subscribe
To register interest in an object so that you receive a notification when the object is modified. You can manually subscribe to change notifications in the SmartPlant Foundation client.
superseded
Indicates that a newer, working version of the selected document exists.
symbology
Settings that determine how a drawing or model will appear when displayed as a graphical report in SmartPlant Foundation.
T TEF
The Engineering Framework; technology behind the integration of SmartPlant Enterprise products.
terminate
To change the status of a SmartPlant Foundation object to terminated without removing it from the SmartPlant Foundation database. Terminating objects, instead of deleting them, allows you to continue to see the history of the object after termination.
timestring
A schedule that assigns a certain number of days for the completion for each step in the lifecycle of a deliverable.
title block
The portion of a drawing that contains information about the drawing, such as who created the drawing, when it was created, who approved it, and so on. The type of information included in the title block varies by drawing type, industry, and organization.
121
Glossary To Do List
A graphical list of tasks that require attention from the user. In SmartPlant Foundation, the To Do List contains workflow steps assigned to the user. In the authoring tools, such as SmartPlant P&ID and SmartPlant Instrumentation, the To Do List contains create, delete, and update tasks generated when a user retrieves a document.
token
A license that provides timed access to users of SmartPlant Foundation. When a user opens the software, a token is activated. There are two types of tokens: daily and perpetual. Daily tokens are available to all users and are valid for 12 consecutive hours after the user logs on to SmartPlant Foundation. When a daily license token is checked out, a token is depleted from the daily token file. If there are no tokens left in the daily token file, then other users cannot access the software. Perpetual tokens are only available to a select group of system users and provide unlimited access to the software.
tombstone
Delete instructions for an object that has been removed in one of the authoring tools. Upon retrieval of a tombstone, delete tasks are created in the authoring tool's To Do List to allow the tool to delete the object from its database.
tool
See authoring tool.
tool adapter
See adapter.
tool schema
A set of schema objects that describe the data in the authoring tool databases before it is transformed into the format prescribed by the SmartPlant schema. The tool schema also specifies the mapping between objects in the tool database and the SmartPlant schema.
tool signature
A unique identifier for the relationship between a plant in SmartPlant Foundation and a specific plant in an authoring tool database. The relationship is created when an authoring tool registers with SmartPlant Foundation.
122
Glossary transmittal
A controlled package of documents used to perform, track, and record the distribution of project documentation among different design teams.
U unit
Group of parts of the schematic and individual worlds of a plant that together perform a given process function. The identifying number of the unit is unique within the project and within the plant. Most companies, but not all, use the concept of unit.
UoM
A unit of measurement.
user
An object that specifies data about a person who is authorized to use SmartPlant Foundation.
user profile
Information about windows, configuration, and interface settings, saved by the SmartPlant Foundation client when you close the application and used to configure the application when you reopen it.
V vault
A folder where files are stored on a host computer.
version
An intermediate update to an existing document that is tracked by the SmartPlant Foundation software.
123
virtual directory
A Web folder created in IIS that points to a physical folder on the Web server. Virtual directories are used by SmartPlant Foundation to run applications and services from the SmartPlant Foundation server and to transfer files between file servers and clients.
W Web Portal
Provides the functionality of the SmartPlant Foundation client system through an easy-to-deploy Internet Explorer web browser. Based on the software configuration and authorization of the System Administrator, you can perform the following functions: View information from the database about a specific object Search for objects in the database View drawings and 3D models View a history for a particular object View relationships between objects
weighting
The percentage of a project that is made up by a step, sub- step, or deliverable. When you create a step or sub-step for a deliverable or assign a deliverable to workpack, you must indicate what percentage of the work that item represents. For example, if a deliverable is 30 percent complete when a particular step is finished, the weighting for that step is 30.
wildcard
A character that helps you narrow your search for objects in the SmartPlant Foundation database. You can use wildcards in any text box in the Find and Query dialog boxes. Text wildcards in SmartPlant Foundation include the following: ? - Finds any single character * - Finds any string of characters % - Performs the same function as *
124
workflow
A series of steps defining actions to be taken on an object in SmartPlant Foundation.
working document
A document that has not been signed off in SmartPlant Foundation.
X XML
Extensible Markup Language; the format for all documents published or retrieved in an integrated environment. These XML files must conform to the structure defined by the SmartPlant schema.
125
Glossary
126
Index
3
3D View Control 56
Q
query 28 by configurations 30 by roles 30 limits 28 scope 30 using a wizard 35 Query Scope 23 quick search 35
A
Active Scope 30 Applications Bar 107
D
documents 53 viewing 53 drawings 53 viewing 53
R
related items 77 roles 30 defining for scope 30
E
Effective Now 23, 27
S
saving 35 a query 35 search results 45 printing 45 viewing 35 searching 35 for objects 35 using text 35 setting 27 active configurations 30 date and time 27 unit of measure 28 user preferences 28
F
finding 35 objects by name 35
H
Home Collection 77
I
interface 23 Introduction 17
L
login 23
T
tasks 107 todo list 93 toolbar 23
M
methods 77
N
navigating 49 SmartPlant Foundation database 49
U
User Preferences 23
V
viewing 53 documents 53 drawings 53
P
printing 45 using Microsoft Excel 45 properties 77 reviewing 77
127
Index
W
wildcards 35 workflows 93
128