Intergraph Smart Construction Administration and Configuration Guide

Transcription

1 Intergraph Smart Construction Administration and Configuration Guide Version 2017 (5.0) January 2017

2 Copyright Copyright Intergraph Corporation. All Rights Reserved. Intergraph is part of Hexagon. 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. Portions of the user interface copyright Telerik AD U.S. Government Restricted Rights Legend Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at of the Federal Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS and the rights of the Government are as specified at DFARS Unpublished - rights reserved under the copyright laws of the United States. Intergraph Corporation 305 Intergraph Way Madison, AL Documentation Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides, Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a particular software product. Other Documentation Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support, SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph as guidance for using a software product. Terms of Use a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the 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 and Documentation. 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. b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other Documentation for Licensee s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a reasonable number of copies of Other Documentation for Licensee s internal, non-commercial use. The Other Documentation may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any reason by Intergraph Corporation by giving written notice to Licensee. Disclaimer of Warranties Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its publication date. The information and the software discussed in this document are subject to change without notice and are subject to applicable technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document. The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT. Intergraph Smart Construction Administration and Configuration Guide 2

3 Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data. Users should verify for themselves that the data is accurate and suitable for their project work. Limitation of Damages IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL, SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION S LIABILITY EXCEED THE AMOUNT THAT INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2) YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED. IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW. Export Controls Intergraph Corporation s software products and any third-party Software Products obtained from Intergraph Corporation, its subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access) under the following circumstances: a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries. b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce Denied Persons, Entities, and Unverified Lists, the U.S. Department of Treasury Specially Designated Nationals List, and the U.S. Department of State Debarred List, c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design, development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive nuclear uses. d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place. Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation s Export Compliance Department, Huntsville, Alabama 35894, USA. Trademarks Intergraph, the Intergraph logo, Intergraph Smart, SmartPlant, SmartMarine, SmartSketch, SmartPlant Cloud, Sapphire, PDS, FrameWorks, I-Route, I-Export, ISOGEN, SPOOLGEN, SupportManager, SupportModeler, TANK, PV-Elite, CADWorx, CADWorx DraftPro, GTSTRUDL, and CAESAR II are trademarks or registered trademarks of Intergraph Corporation or its affiliates, parents, subsidiaries. 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. Intergraph Smart Construction Administration and Configuration Guide 3

4 Contents Preface Smart Construction documentation Welcome to Smart Construction Smart Construction architecture Administering Smart Construction Configure Smart Construction Security Create and manage role assignments Create Smart Construction users Associate Smart Construction users with a construction responsibility Configure access groups Create and configure planning groups Create a planning group role Example planning group configuration Manage Smart Construction Servers and Projects Connect to a new server Edit server information Delete a server Create a new plant or project in SmartPlant Foundation Desktop Client Select a new plant or project in Smart Construction Smart Construction site properties in Server Manager Configure Smart Construction client preferences Configure the recording path for a work schedule animation Configure Smart Construction browsers to load data after a search Configure models to open to the last viewed position Configure System Settings for Smart Construction Configure and update system settings for Smart Construction Configure the client timeout value Turn on Smart Construction queues Including reference files for drawings in IWP Summary reports Manage Template Files for Smart Construction Open a Smart Construction template file Attach template files to configuration documents Check in and sign off a Smart Construction template file Intergraph Smart Construction Administration and Configuration Guide 4

5 Contents Configure and Update a Materials System Configuring a SmartPlant Materials system for Smart Construction Create a TNS entry for the SmartPlant Materials database Configure a materials system with Smart Construction Set up the SmartPlant Materials site API Install SQL scripts for a SmartPlant Materials database Verify the materials system is working Set up a project forecast in a materials system Attach materials template files to the materials system configuration document Use the SmartPlant Foundation Desktop Client to manage the template files Specify which work steps consume materials Enable the Material Request Window and Report in Smart Construction Configure and enable the Material Request window Enable the Material Request Form report Reset IIS application pools and retrieve documents Import Project Data into Smart Construction Importing your schedule into Smart Construction Export your schedule from your scheduling software Configure your schedule mapping for import Import project data in Smart Construction Import project configuration data into Smart Construction Configure project configuration mappings and relationships Configure and import project configuration data Configure IIS to process large files Update security for services on the Import Project Data window Export schedule Importing your schedule to Primavera P6 from Smart Construction Configure a Schedule System for Schedule Data Import Configuring a schedule system with Primavera P6 SDK Set up the schedule system source Configure the Primavera SDK schedule system Verify the schedule system is working Configure schedule mapping for import Import schedule data into Smart Construction Configuring a schedule system with Primavera P6 Web Services Set up the schedule system source Configure the Primavera Web Services schedule system Verify the schedule system is working Configure schedule mapping for import Import schedule data into Smart Construction Configure the Rules of Progress Configure the rules of progress in the rules of progress workbook Attach the ROP Configuration workbook and XML files to the Rules of Progress configuration document Intergraph Smart Construction Administration and Configuration Guide 5

6 Contents Configure Mapped Properties for a Published Document Map properties and generate XML for a Smart Construction retrieve Attach the SPCRetrieveMappings.xlsm and XML files to the Retrieve Mappings configuration document Manage Component Disciplines and Categories Manage component categories Create a new component category Search for component categories Update a component category Manage component disciplines Create a new component discipline Search for component disciplines Update a component discipline Manage the relationship between component disciplines and categories Import Smart Construction schema Load the Plant Breakdown Structure schema Load the IWP enumerated list schema Getting Data into Smart Construction Retrieving published data in Smart Construction Publish data to a Smart Construction site Configure mapped properties for retrieve Configure rules of progress Retrieve data Query for the status of the rules of progress association Update the number of items processed with the Rules of Progress queue Stop and restart the Rules of Progress queue Cancel the retrieval of a document Retrieve composite models into Smart Construction Link composite document to retrieved documents Delete composite models Configure the refresh time on the Retrieve dialog box Deleted components and tombstones in Smart Construction Load non-published data into Smart Construction Loading non-published data into Smart Construction Details about delivered component register template files Loading and using data with fabrication modifications in Smart Construction Getting data with fabrication modifications into Smart Construction Using data with fabrication modifications in Smart Construction Manage Browser Color Definitions Create a browser color definition Sequence browser color definitions Update a color definition Delete a color definition Find saved query definitions in the SmartPlant Foundation Desktop Client Intergraph Smart Construction Administration and Configuration Guide 6

7 Contents Configure File Types for Smart Construction Configure file types for IWP files Configure file types for Smart Construction Configure Engineering Numbering System (ENS) to Automatically Name Work Packages Automatically name IWPs example Create an ENS definition to name IWPs Create ENS items to name IWPs Create a new ENS relationship between the ENS definition and the IWP object Create and Configure External Data Filters Create a new external data filter connection Create a new external data filter query Create a new external data filter Use an external data filter in Smart Construction Configure Work Package Disciplines and Purposes Edit schema for disciplines and purposes Edit existing or add new disciplines to the schema Edit existing or add new purposes to the schema Add disciplines and purposes to the FIWP purpose lookup enumerated list Load edited schema into SmartPlant Foundation View the new work package discipline and purpose entries in Smart Construction Configure IWP Status Edit existing or add status entries to the schema Load edited schema into SmartPlant Foundation View the new status entries in Smart Construction Configure Documents Configure document classification and filtering in SmartPlant Foundation Desktop Client Configure IWP files to automatically attach to IWPs Update the Automatically attach related documents when an IWP is created system option Configure file attachment behavior when adding components to IWPs Enable showing related files when adding components to an IWP Enable showing related files for document sources Configure security to show related files when adding components to an IWP Inform users to enable the user preference for showing related files Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Configure and manage Smart Construction column sets in SmartPlant Foundation Desktop Client Understanding column sets in SmartPlant Foundation Desktop Client Intergraph Smart Construction Administration and Configuration Guide 7

8 Contents Differences in column sets and column items in Smart Construction and the SmartPlant Foundation Desktop Client Column sets delivered with Smart Construction Configuring column sets in the SmartPlant Foundation Desktop Client Create and configure filters in SmartPlant Foundation Desktop Client Create a new filter category Verify new filter category in Smart Construction Create and configure selection rules in the SmartPlant Foundation Desktop Client Create a new selection rule Manage security for the new selection rule Verify the new selection rule in Smart Construction Configure document categories in Documents window Edit existing document nodes in the Tree View Create and configure document category nodes Create and configure work package toolbar items Create the new work package toolbar item Use the Smart Construction - Display Editor to configure and personalize your toolbar item Validate the new toolbar item Save the new toolbar item Manage security for the new toolbar item Work package toolbar item details Create and configure custom search criteria for Smart Construction Create custom search criteria for Smart Construction in the SmartPlant Foundation Desktop Client Find custom search criteria for Smart Construction in the SmartPlant Foundation Desktop Client Create a relationship between the custom search criteria and relationship or edge definition Manage IWP files in the SmartPlant Foundation Desktop Client Find IWP files in the SmartPlant Foundation Desktop Client Working with component register documents Find component register documents in the SmartPlant Foundation Desktop Client Create and configure SIDs in SmartPlant Foundation Desktop Client Create a SID in the SmartPlant Foundation Desktop Client Attach a document to a SID Create a material item for a SID Hide a SID from use in the Smart Construction client Find SIDs in the SmartPlant Foundation Desktop Client Update SIDs in the SmartPlant Foundation Desktop Client Create and configure cost codes Create a cost code in the SmartPlant Foundation Desktop Client Find cost codes in the SmartPlant Foundation Desktop Client Update a cost code in the SmartPlant Foundation Desktop Client View assemblies in your Smart Construction project Manage crews in Smart Construction Create a new crew in the SmartPlant Foundation Desktop Client Find crews in the SmartPlant Foundation Desktop Client Update crews in the SmartPlant Foundation Desktop Client Configure and manage Dashboards in Smart Construction Create a new Dashboard view in SmartPlant Foundation Desktop Client Intergraph Smart Construction Administration and Configuration Guide 8

9 Contents Find Dashboard views in SmartPlant Foundation Desktop Client Update Dashboard views in SmartPlant Foundation Desktop Client Manage security for your Dashboard view Create a new Dashboard item in SmartPlant Foundation Desktop Client Find Dashboard items in the SmartPlant Foundation Desktop Client Configure your Web Browser dashboard item to open to a specific website or address Add or remove search criteria for a dashboard item Manage security for Dashboard items Update Dashboard items in the SmartPlant Foundation Desktop Client Relate Dashboard items to a Dashboard view in SmartPlant Foundation Desktop Client Configure the SmartPlant Foundation System Calendar for the Smart Construction Work Package Schedule window Update and configure items on the Smart Construction interface Update Smart Construction interface items View relationships associated with Smart Construction interface items View access groups associated with Smart Construction interface items View Smart Construction objects in SmartPlant Foundation Desktop Client Smart Construction Launch Parameters Smart Construction command line parameters Install Smart Construction in Silent Mode Localize Smart Construction Client resource localization Make a backup copy of the resource file Translate the strings into the chosen language Determine the language or culture code for the language Compile the resource file into a binary DLL Move the files to a new folder for the language Verify the correct language strings display in the client application Localize a printed reports Server resource localization Make backup copies of the resource files Translate the strings into the chosen language Determine the language or culture code for the language Compile the resource files Move the files to a new folder for the language Verify the correct language strings display in the application Extend the Smart Construction Schema Extend the Smart Construction schema work process Details about extending the schema Intergraph Smart Construction Administration and Configuration Guide 9

10 Contents Smart Construction Acronyms Glossary Index Intergraph Smart Construction Administration and Configuration Guide 10

11 Preface This guide provides administrative and configuration information for Intergraph Smart Construction administrators. Users of this guide can learn how to configure and perform administrative duties for Smart Construction. Smart Construction documentation Smart Construction documentation is available as Help and as Adobe PDF files. To view printable guides for Smart Construction, click Help > Printable Guides in the software. Intergraph gives its customers permission to print as many copies of the delivered PDF files as they need for their non-commercial use. Do not print the PDF files for resale or redistribution. Installation and setup guide Intergraph Smart Construction Installation and Setup Guide - Provides installation and setup instructions for Smart Construction administrators and users. Administration and configuration guides Intergraph Smart Construction Administration and Configuration Guide - Provides information to help administrators manage and configure the Smart Construction server and client. Intergraph Smart Construction Rules of Progress Configuration Guide - Provides reference and configuration information for developers and system administrators to configure and set up the rules of progress for their construction project. Programming guides Intergraph Smart Construction API and Programmer's Guide - Provides reference information for developers and administrators about APIs and customization. Intergraph Smart Construction Customization Guide - Provides customization information for Smart Construction system administrators and developers. User's guides Intergraph Smart Construction User's Guide - Provides information and instructions to help users create and manage information in Smart Construction. Intergraph Smart Construction Getting Started Guide - Provides overview information to help users start working in Smart Construction. Troubleshooting guide Intergraph Smart Construction Troubleshooting Guide - Provides troubleshooting information for Smart Construction users and administrators. Intergraph Smart Construction Administration and Configuration Guide 11

12 Customer Support Preface For the latest support information for this product, use a World Wide Web browser to connect to ( Also, you can submit any documentation comments or suggestions you might have on the Intergraph support site. Intergraph Smart Construction Administration and Configuration Guide 12

13 S ECTION 1 Welcome to Smart Construction Smart Construction is a tool that facilitates faster, more accurate construction execution. The software provides you with the ability to create work packages that are optimized for overall completion. You can view, navigate, and filter 3D models and 2D drawings; view materials information; view schedule information; and report completion based on rules of progress in a single environment. For information about running SmartPlant Enterprise products remotely using Citrix, see the SmartPlant Enterprise Citrix Configuration Guide delivered with SmartPlant Foundation. Smart Construction architecture Smart Construction uses SmartPlant Foundation technology to help you better manage your construction project and the data associated with it. Through the interoperability of Smart Construction and SmartPlant Foundation, Smart Construction users are able to create construction work areas (CWAs), construction work packages (CWPs), and installation work packages (IWPs) that detail work to be executed with engineering, construction, and design data stored in a SmartPlant Foundation database. Users are also able to view, navigate, and filter 3D models and 2D drawings that were published to a SmartPlant Foundation database. Users can connect to IWP data on their mobile device through the Smart Construction OnSite mobile app. Intergraph Smart Construction Administration and Configuration Guide 13

14 Welcome to Smart Construction As seen in the following diagram, Smart Construction is installed with SmartPlant Foundation. Smart Construction uses SmartPlant Foundation to share engineering, construction, and design data among Intergraph SmartPlant Enterprise life cycle engineering products and users. SmartPlant Foundation provides a comprehensive electronic data storage, exchange, management, and integration system for Smart Construction. Data published to SmartPlant Foundation from Intergraph SmartPlant Enterprise life cycle engineering products, such as Intergraph Smart 3D or Plant Design System (PDS ), can be accessed and viewed in Smart Construction. An open API provides direct integration with SmartPlant Materials and other non-intergraph applications, such as project control, schedule systems, or external document systems. Smart Construction delivers Microsoft Excel workbook templates that administrators can use to create and edit project data and rules of progress for a Smart Construction site. Administrators can use the open API to configure an existing materials system and documents system. Intergraph Smart Construction Administration and Configuration Guide 14

15 S ECTION 2 Administering Smart Construction The administrative functions described in this guide may be performed in either Smart Construction or the SmartPlant Foundation Desktop Client. When it is necessary to perform administrative functions for Smart Construction in the SmartPlant Foundation Desktop Client, you must log on to Desktop Client with system administration privileges. For more information on system administration privileges, see SmartPlant Foundation How to Configure the Security Model. Configure Smart Construction Security (on page 16) Manage Smart Construction Servers and Projects (on page 25) Import Project Data into Smart Construction (on page 46) Configure and Update a Materials System (on page 37) Configure a Schedule System for Schedule Data Import (on page 69) Configure the Rules of Progress (on page 88) Map properties and generate XML for a Smart Construction retrieve (on page 93) Configure System Settings for Smart Construction (on page 31) Getting Data into Smart Construction (on page 102) Configure File Types for Smart Construction (on page 132) Create and Configure External Data Filters (on page 137) Manage Component Disciplines and Categories (on page 95) Manage Browser Color Definitions (on page 129) Configure Engineering Numbering System (ENS) to Automatically Name Work Packages (on page 134) Configure Work Package Disciplines and Purposes (on page 140) Configure Smart Construction Objects in SmartPlant Foundation Desktop Client (on page 154) Intergraph Smart Construction Administration and Configuration Guide 15

16 S ECTION 3 Configure Smart Construction Security Smart Construction security uses the SmartPlant Foundation security model to control access to and operation of project data in Smart Construction. Smart Construction administrators must configure and manage security through user roles and access groups in SmartPlant Foundation Desktop Client. The SmartPlant Foundation security model is a flexible mechanism to control role-based user access to data and the operations that can be performed on that data. The security model is comprised of: Users Roles, domains, and access groups Configurations Role assignments A user is assigned a role in a configuration. Roles are related to access groups, which control access to the different components of the system. The security model controls user access to: Application modules Menus and toolbars Shortcut menu commands Relationship manipulation and navigation The SmartPlant Foundation Desktop Client is used to configure the security model by creating and relating security objects. No additional schema modeling of classes, interfaces, or relationship definitions is required. Once the security access model is designed, the various levels of access are modeled by creating access groups and relating them to roles. The access groups are related to the relevant methods, interfaces, and view definitions to which they have to grant access. Smart Construction is delivered with several default roles, access groups, and configurable GUI items, which are loaded with the default Smart Construction administrative files. For information about Smart Construction default roles, see Create and manage role assignments (on page 17). For more information on delivered access groups, see Configure access groups (on page 19). For more information on Smart Construction users, see Create Smart Construction users (on page 17). For more information on configurable GUI items, see Update and configure items on the Smart Construction interface (on page 195). To configure Smart Construction security, you must create users, configure roles of users, then assign or relate the new user to access groups using the SmartPlant Foundation Desktop Client. The SmartPlant Foundation How to Configure the Security Model guide describes the configuration and components of the SmartPlant Foundation Security Model. You can access the guide by clicking Help > Printable Guides. Intergraph Smart Construction Administration and Configuration Guide 16

17 Configure Smart Construction Security Create and manage role assignments Smart Construction is delivered with three default roles: Viewer, Planner, and Administrator. Role Smart Construction Viewer Smart Construction Planner Smart Construction Administrator Planning Group A Description View-only access to Smart Construction data Permissions to view, modify, and update data in Smart Construction Permissions to view, modify, and update data, as well as perform administrative tasks on the Smart Construction system. By default, all Smart Construction roles are managed by the Smart Construction Administrator role. Smart Construction delivers an example planning group role, which limits access to functionality to specific users. The role assignment links a user to a role in a given configuration. By default, all Smart Construction roles are managed by the Smart Construction Administrator role. When you create a new Smart Construction role, set the role to be managed by the Smart Construction Administrator role. For more information about role creation, assignments, and configuration, see Role Configuration and User and Role Assignment Configuration in the SmartPlant Foundation How to Configure the Security Model guide. For more information on planning groups, see Create and configure planning groups (on page 23). Create Smart Construction users Smart Construction delivers three example users: SPC Viewer, SPC Planner, and SPC Administrator. You can load the example Smart Construction users with the SmartPlant Foundation Desktop Client Loader. Browse to the 004-Users folder located in the Smart Construction installation location. For example, navigate to [Drive]:\Program Files (x86)\smartconstruction\2017\loadfiles\004-users. User SPC Viewer SPC Planner SPC Admin Role Smart Construction Viewer Smart Construction Planner Smart Construction Administrator The role assignment links a user to a role in a given configuration. Intergraph Smart Construction Administration and Configuration Guide 17

18 Configure Smart Construction Security requirements: In order to use Smart Construction OnSite, users must meet following A password must be set for the user, and it cannot be blank. The user must be assigned the SmartPlant Foundation Viewer role. The user must be assigned a construction responsibility. For more information on associating Smart Construction users with their area of construction responsibility, see Associate Smart Construction users with a construction responsibility (on page 18). You can load the users when you set up and configure your Smart Construction project. You do not need to reload the users during a Smart Construction upgrade. For more information about role creation, assignments, and configuration, see User and Role Assignment Configuration in the SmartPlant Foundation How to Configure the Security Model guide. For more information on configuring users, see Create login users in the SmartPlant Foundation How to Configure the Security Model guide. Associate Smart Construction users with a construction responsibility Smart Construction delivers a set of construction responsibilities that can be associated with a Smart Construction user in the SmartPlant Foundation Desktop Client. When a user's position of responsibility has been defined in the system, the user and their responsibility can be associated with an IWP. Users with a construction assignment can access IWPs in the Smart Construction OnSite app. The following responsibilities are delivered: Foreman General Foreman Field Engineer You can define a user's construction responsibility in SmartPlant Foundation Desktop Client when you create the user or by updating an existing user. You can then assign that user to an IWP in the Details window of an IWP in Smart Construction. For more information, see Add user assignments to an IWP in the Intergraph Smart Construction User's Guide. Smart Construction delivers three example users with construction responsibilities associated with them. You can load the example Smart Construction users with the SmartPlant Foundation Desktop Client Loader. Browse to the 004-Users folder located in the Smart Construction installation location. For example, navigate to [Drive]:\Program Files (x86)\smartconstruction\2017\loadfiles\004-users. For more information on creating Smart Construction users, see Create Smart Construction users (on page 17). Intergraph Smart Construction Administration and Configuration Guide 18

19 Configure Smart Construction Security Configure access groups Access groups govern user access to Smart Construction commands and navigation and are modeled to represent different levels of functional access. For example, access groups can be used to configure security for reports, models, drawings, filters, selection rules, attached files on IWPs, and specific toolbar buttons in Smart Construction. To grant user permissions to access a specific command or function, associate that user's roles to the appropriate access group. The following access groups and roles are delivered in Smart Construction. Access Groups Access Group Descriptions Roles SPC_ActualManHoursEdit SPC_AddComponentsWithNoSteps SPC_Admin SPC_AdvancedQueryManager SPC_AdvancedQueryShare SPC_AutoLoadSavedFilters Makes the Actual Man Hours for the IWP editable on the Components window. Add components that have no remaining unplanned work steps. Includes all administrator functions, methods, and procedures. Modify queries that they create as well as modify or delete other shared queries. Share queries that they create as well as modify or delete other shared queries. Save a filter view, so it can be automatically loaded when a model or drawing is opened. Planner, Administrator Planner, Administrator Administrator Administrator Administrator None by default SPC_BrowserItemView View browser items. Viewer, Planner, Administrator, Planning Group A (Example) SPC_ComponentRegistersView View component register items. Viewer, Planner, Administrator, Planning Group A (Example) SPC_ConstructionResourcesManage SPC_CWADeleteAll Find, create, update, delete construction resources. Delete CWAs without related packages that anyone owns. Planner, Administrator Planner, Administrator SPC_CWADeleteOwned Delete CWAs without related packages that they created. Planner, Administrator, Planning Group A (Example) SPC_CWAUpdate Create, update, and delete CWAs. Planner, Administrator, Planning Group A (Example) SPC_CWADeleteAll Delete CWPs without related packages that anyone owns. Planner, Administrator Intergraph Smart Construction Administration and Configuration Guide 19

20 Configure Smart Construction Security Access Groups Access Group Descriptions Roles SPC_CWPDeleteOwned Delete CWPs without related packages that they created. Planner, Administrator, Planning Group A (Example) SPC_CWPUpdate Create, update, and delete CWPs. Planner, Administrator, Planning Group A (Example) SPC_DashboardView Able to view the Dashboard. Viewer, Planner, Administrator, Planning Group A (Example) SPC_DashboardManager SPC_DocumentsSourceView Share views that they create. Users can modify or delete other shared views. Able to view document source items and to determine if files should be attached when adding components to an IWP. Planner, Administrator, Planning Group A (Example) Viewer, Planner, Administrator, Planning Group A (Example) SPC_DocumentView View documents. Viewer, Planner, Administrator, Planning Group A (Example) SPC_DrawingView View drawings. Viewer, Planner, Administrator, Planning Group A (Example) SPC_Everyone SPC_ExportViewerFilters SPC_FileUpdate Gives access to functionality for all users. Every user must have access to this role. Export filters from the viewers to a Microsoft Excel file. Determine if files attached to an IWP can be included in or excluded from reports. Viewer, Planner, Administrator, Planning Group A (Example) Planner, Administrator, Planning Group A (Example) Planner, Administrator SPC_FindAllPackages Search for All Packages in Work Packages browser windows. If the access group is not added, then All Packages does not show in browser. Also, allows users to acknowledge changes for all IWPs with engineering changes. Viewer, Planner, Administrator SPC_FindGroupPackages Search for IWPs owned by anyone in the planning group or groups of users. Planning group name displays in browser search list. Viewer, Planner, Administrator, Planning Group A (Example) SPC_FIWPDeleteAll Delete IWPs that anyone owns. Planner, Administrator Intergraph Smart Construction Administration and Configuration Guide 20

21 Configure Smart Construction Security Access Groups Access Group Descriptions Roles SPC_FIWPDeleteOwned Delete IWPs that they create. Planner, Administrator, Planning Group A (Example) SPC_FIWPUpdate Create, update, delete IWPs. Planner, Administrator, Planning Group A (Example) SPC_HiddenItemView SPC_ImportProjectData View hidden Smart Construction items. Hides Smart Construction items, such as drawings and models, from users with this access group associated to a role. Import and update schedule and project data. Administrator Planner, Administrator SPC_ManageAllUsersFilters Create, update, and delete saved filters that are marked available for all users. Planner, Administrator SPC_ManagePublicColorDefinitions Change, modify, and update color definitions. Administrator SPC_MaterialAllowForecast Perform a materials forecast. Planner, Administrator, Planning Group A (Example) SPC_MaterialAllowReserve Perform a materials reservation. Planner, Administrator, Planning Group A (Example) SPC_MaterialUpdate Create and update materials; Forecast and reserve materials. Planner, Administrator, Planning Group A (Example) SPC_MaterialView View Materials. Viewer, Planner, Administrator, Planning Group A (Example) SPC_MessageView View messages. Viewer, Planner, Administrator, Planning Group A (Example) SPC_ModelView View 3D models. Viewer, Planner, Administrator, Planning Group A (Example) SPC_OriginalDrawingView SPC_OriginalSpoolView Allows a user to view the original engineering drawing as well as its superseding fabrication drawing. Allows a user to view the original engineering spool as well as its superseding fabrication spool. Administrator Administrator Intergraph Smart Construction Administration and Configuration Guide 21

22 Configure Smart Construction Security Access Groups Access Group Descriptions Roles SPC_PackageComponentsAndAssembli esforsamepurpose SPC_PackageMismatchedCWPs Allow a spool or assembly and components of that spool or assembly to both be put in an IWP of the same purpose. See and plan all CWPs, regardless of planning group association. None by default Planner, Administrator SPC_PackageReplacedEngineeringCom ponents SPC_PlanAllCWPs Allow an engineering component item which has been replaced by a fabricated component item to be planned in an IWP. See and plan all CWPs, regardless of planning group association. None by default Planner, Administrator SPC_ProjectConfigurationUpdate Update project configuration data. Administrator SPC_RemoveComponentViaViewer Remove components from an IWP when you right-click a component in a model or drawing. Planner, Administrator, Planning Group A (Example) SPC_ReportsView View reports. Viewer, Planner, Administrator, Planning Group A (Example) SPC_Retrieve Access the retrieve option. Administrator SPC_ROPUtility SPC_ScheduleUpdate SPC_UpdateAutoLoadedSavedFilter SPC_UpdateExternalSystemProperties SPC_ViewAndPrint SPC_WorkPackageScheduleUpdate Access the Rules of Progress Utility option. Update schedule; Import and export schedule information. Update a filter that has been applied from a filter view that is set to be automatically opened when a model or drawing is opened. Update properties of an object imported from an external system. Opens a drawing or document in SmartPlant Markup Plus for viewing or printing. Update and save changes in the Work Package Schedule window. Administrator Planner, Administrator Viewer, Planner, Administrator, Planning Group A (Example) Administrator Planner, Administrator Planner, Administrator SPC_WPView View IWPs, CWPs, and CWAs. Viewer, Planner, Administrator, Planning Group A (Example) Intergraph Smart Construction Administration and Configuration Guide 22

23 Configure Smart Construction Security By default, the SPC_BrowserItemView access group is associated to models and drawings after being retrieved into Smart Construction. You can edit access groups on models and drawings to fit your business needs. To configure access groups, you need to log on to the SmartPlant Foundation Desktop Client as an administrator. For more information, see Roles and Access Groups in the SmartPlant Foundation How to Configure the Security Model guide. Create and configure planning groups Roles are used to manage user access to different components in the Smart Construction system. Smart Construction employs a special type of role called a planning group, which can be used to limit access to specific functionality to a specific group of users. For example, you could limit access to specific drawings within a CWP to a group of contractors, named Planning Group B. Members of Planning Group B would only be able to view and plan the drawings and components related to the drawings they were given access to. For more information, see Example planning group configuration (on page 24). In order to limit access to specific users in a planning group, a planning group must be created and configured and then associated with specific users. Then you can associate it to contractors, contracts, drawings, or CWPs, depending on your implementation. If you want users to have more access, you can associate them with the access group SPC_PlanAllCWPs, which allows users to see and plan all CWPs, regardless of the planning group association. In order to create and configure planning group roles, Smart Construction administrators must first create the planning group role, and they must associate that role with a user or a number of users. For information on creating and configuring roles and managing role assignments, see Create and manage role assignments (on page 17). Smart Construction delivers an example planning group, Planning Group A, which can be associated with users. For information on the access groups associated with Planning Group A, see the matrix in Configure access groups (on page 19). Create a planning group role 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click File > New > Administration > Role. 3. Type the name and description for the new role. 4. Select the Smart Construction Administrator role on the Managed by role box. 5. Select the SPC Planning Group option to make the new role a planning group. 6. Click Finish to save changes. 7. Use the Configuration Role Assignment dialog box to manage and configure users to the new role. For information on creating and configuring roles and managing role assignments, see Create and manage role assignments (on page 17). Intergraph Smart Construction Administration and Configuration Guide 23

24 Configure Smart Construction Security Example planning group configuration You can use a planning group to limit access to specific IWPs to a group of contractors. A particular user is a member of a planning group. That planning group is a member of a group of contractors assigned to a specific contract. The work for the contract is limited to a specific CWP, which is broken into different IWPs. The user can only work with particular IWPs under the CWP of their contract. The following is a general work process for configuring the example configuration. 1. Create a planning group role. For more information, see Create a planning group role (on page 23). 2. Create a role for a group of contractors. For more information on creating roles, see Role Configuration and User and Role Assignment Configuration in the SmartPlant Foundation How to Configure the Security Model guide. 3. Associate users to the contractor group and the planning group. For more information on user and role assignment, see Role Configuration and User and Role Assignment Configuration in the SmartPlant Foundation How to Configure the Security Model guide. To find contractors in SmartPlant Foundation Desktop Client, click Smart Construction > Find > Contractors. 4. Associate relationships using the project configuration data. A planning group can be related to a contractor. A contractor can be related to a contract. A contract can be related to a CWP. For more information, see Import project configuration data into Smart Construction (on page 54). 5. In Smart Construction, create IWPs and relate the appropriate CWP to the IWP to allow access to users in the planning group. Intergraph Smart Construction Administration and Configuration Guide 24

25 S ECTION 4 Manage Smart Construction Servers and Projects Smart Construction security and the SmartPlant Foundation security model control server and project access for users. Users with privileges can create, edit, and delete servers, as well as create or select a plant or project. For more information, see Configure Smart Construction Security (on page 16) or SmartPlant Foundation How to Configure the Security Model or SmartPlant Foundation How to Configure Concurrent Engineering. Connect to a new server 1. Click Start > All Programs > Intergraph Smart Construction > Smart Construction to open the Logon Information dialog box. 2. Click Options to expand the Logon Information dialog box. 3. Click New to open the New Server dialog box. 4. Type a meaningful name for the new server in the Name box. This name displays on the Server list on the Logon Information dialog box. 5. Type the actual server name in the Web host box. The name specifies where the server is located. 6. Type the name of the virtual directory in the Web host box. 7. Select the Secure channel (SSL) option if the server connection is to be accessed by SSL. 8. Select the Trusted site option if you are running in a non-domain account environment. Type domain credentials to log on. 9. Click Validate to test the connection to the server. 10. Click OK to add the server to the Server list on the Logon Information dialog box. Intergraph Smart Construction Administration and Configuration Guide 25

26 Manage Smart Construction Servers and Projects Edit server information 1. Click Start > All Programs > Intergraph Smart Construction > Smart Construction to open the Logon Information dialog box. 2. Click Edit to open the Edit Server dialog box. 3. Edit the server information as needed. 4. Click Validate to test the connection to the server. 5. Click OK to save changes. Delete a server 1. Click Start > All Programs > Intergraph Smart Construction > Smart Construction to open the Logon Information dialog box. 2. Select a server from the Server list. 3. Click Edit to open the Edit dialog box. 4. Click Delete to remove the server from the Server list. Create a new plant or project in SmartPlant Foundation Desktop Client You can create new plants and projects for your Smart Construction site using SmartPlant Foundation Desktop Client. Create a new plant 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click File > New > Organization/Support Items > Plant. 3. Define the necessary values on the Plant form. 4. Click Finish. The new plant displays in the New Items window. Create a new project 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Right-click a new Plant and select Create Project. To select all of the project under a plant at once, press SHIFT as you check the option beside the plant. 3. In the Name box, type a name for the new project. 4. In the Status box, select a Status (Active or Created). 5. Click OK. Intergraph Smart Construction Administration and Configuration Guide 26

27 Manage Smart Construction Servers and Projects Select a new plant or project in Smart Construction 1. Log on to Smart Construction. 2. Click Expand on the Project Selection List at the top of the Project Home Page to open the Project Selection dialog box. 3. Select a project from the list. If you select a new project while working in Smart Construction, the client restarts. Unsaved work could be lost. Save all work before switching projects. The Smart Construction project scope uses the SmartPlant Foundation active scope. Smart Construction automatically selects your scope, if only one plant is configured in SmartPlant Foundation. If your SmartPlant Foundation scope is set at the project level and not the plant level, Smart Construction automatically sets your scope to the plant level. The scope is updated in SmartPlant Foundation. If your SmartPlant Foundation scope is set at multiple projects and not the plant level, Smart Construction opens the Project Select dialog box, prompting you to select your scope. The scope is updated in SmartPlant Foundation. If scope is not set and multiple scopes are available for selection, Smart Construction opens the Project Select dialog box, prompting you to select your scope. If you click Cancel without selecting a scope, Smart Construction closes. Smart Construction site properties in Server Manager The following properties define information for Smart Construction sites in Server Manager. For more information on site properties, see Modify site settings in the SmartPlant Foundation Server Manager User's Guide. SPCSaveDebugFiles - Setting to save data XML files for customization of reports. The default value is False. SPCDebugTempDataPath - Location to store data XML files during the customization of reports. SPCProjectConfigurationServiceDBDriver - Specifies the type of OLEDB driver for the project configuration service. The driver depends on the version of Microsoft Excel installed. By default, the value is Microsoft.ACE.OLEDB.12.0, the driver for Office SPCRetrievePropertyProcessorsDirectory - Location of a custom retrieve processor. SPCStatusSystemProcessors - Location of a custom rules of progress system. SPCViewableFileTypes - Lists the viewable files that Smart Construction can display. The Smart Construction retrieve also uses this property to verify the file type. If a document does not have a viewable file type indicated on this property, the document is retrieved as a component register document. SPCRetrieveStepProcessors - Location of custom work step processors. Intergraph Smart Construction Administration and Configuration Guide 27

28 Manage Smart Construction Servers and Projects SPCCopyWorkPackageProcessorsDirectory - Location of custom processors for copying work packages. SPCRulesofProgressPath - Location and name of the generated XML file that details rules of progress data. The file must be stored on the Smart Construction server, and the file name must be ROP.xml. By default, the path is left blank. SPCTransactionMode - Specifies the database commit behavior for document retrieval in Smart Construction. Currently, this property can only be set to Periodic, which commits data in small chunks. The commit is final, meaning no rollback operation is performed if an error occurs. In previous versions, a value of Single was also available. This setting specified that a single transaction be used to commit objects to the database during a retrieve. This value is no longer supported, and transactions will be committed in a periodic manner, regardless of whether you change the property value to Periodic. SPCIncludeCompsInVolumeSelect - Specifies that the Get Objects by Volume dialog box returns all components in the Clip Volume dialog box or returns only spools and assemblies in the Clip Volume dialog box. By default, the value is set to True to return all components. You can set the property to False to return only components in spools and assemblies. SPCFabricationDocumentType - Specifies the document type that will be retrieved into the construction data warehouse by fabrication. By default, the document type is a POD document. Intergraph Smart Construction Administration and Configuration Guide 28

29 S ECTION 5 Configure Smart Construction client preferences There are several settings you can configure in the Smart Construction client configuration file. Configure the recording path for a work schedule animation You can configure the recording path for a work schedule animation. The recording path must be configured on a per machine basis. By default, the recording path is %TEMP%\RecordingTemp. 1. Browse to the Smart Construction installation location and open the Smart Construction client configuration file (for example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\spcclient\spc.client.exe.config). 2. In the SPC.Client.exe.config file, locate the <appsettings> node. 3. Edit the value for RecordingTempPath to your location. 4. Save and close the SPC.Client.exe.config file. Configure Smart Construction browsers to load data after a search In Smart Construction, you can configure certain browser windows to load data after a search, rather than when the browser window is open. This customization is ideal for sites with a large amount of data. Which browser windows can be configured this way? You can configure the following windows: Available Drawings browser Available Files browser in an IWP Work Packages browser window Drawings browser window Models browser window Component Registers browser window Intergraph Smart Construction Administration and Configuration Guide 29

30 Configure Smart Construction client preferences This configuration must be set up on each Smart Construction client workstation on which you want to load data after a search. If configuring multiple browser windows, use a comma to separate values in the key. 1. Browse to the Smart Construction installation location and open the Smart Construction client configuration file (for example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\spcclient\spc.client.exe.config). 2. Type the following values in the DisableBrowserAutoLoad key in the SPC.Client.exe.config file to configure each window. Window Available Files browser in an IWP Available Drawings browser Work Packages browser window Drawings browser window Models browser window Component Registers browser window Value AvailableFiles AvailableDrawings WorkPackagesBrowser DrawingsBrowser ModelsBrowser ComponentRegistersBrowser 3. Verify your changes appear in Smart Construction. Configure models to open to the last viewed position You can configure models to open to the last viewed position. The view must be configured on a per machine basis. 1. Browse to the Smart Construction installation location and open the Smart Construction client configuration file (for example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\spcclient\spc.client.exe.config). 2. In the SPC.Client.exe.config file, add the key RestoreLastModelView to the <appsettings> node. 3. Set the RestoreLastModelView key it to True. 4. Save and close the SPC.Client.exe.config file. If you are using the Auto load when model is loaded or Auto load when drawing is loaded option for a saved filter view, the last position of the model does not load. Click Reset all on the My preferences dialog box to reset the position of the models. Intergraph Smart Construction Administration and Configuration Guide 30

31 S ECTION 6 Configure System Settings for Smart Construction Administrators may need to perform system-wide administrative tasks on the Smart Construction server in order to support the requirements of a particular implementation. Many system-wide settings for Smart Construction can be configured using SmartPlant Foundation Desktop Client. For example, the Smart Construction system settings can specify whether or not users can manually add work steps to a component in an IWP. For more information on system-wide settings in SmartPlant Foundation, see the SmartPlant Foundation Administrator's Guide. Configure and update system settings for Smart Construction 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Options. 3. In the Find Smart Construction Options dialog box, type SPC System Options, and click OK. 4. In the search results, right-click SPC System Options, and select Update. 5. On the Update form, select Allow adhoc steps for engineered components? to manually add work steps to components retrieved into Smart Construction. 6. Type a value in the Work step man hour decimal places box. If you change the value for the Work step man hour decimal places option, retrieve all models and drawings again in order to see your changes in the client. 7. Select Allow work steps to consume materials? to specify which work steps consume the materials. 8. Select an option from the Manage Crew Size by box. Select Numerical Crew Size to specify crews for an IWP based on the size and number needed. Select Named Crews to specify crews for an IWP by their name. 9. Type a value in the Refresh work steps limit box to specify how many items are processed before the operation is sent to the Rules of Progress queue. By default, the value is set at Type the name for property definitions to be excluded from the Properties dialog box in the Smart Construction client in the Excluded object property definitions box. Intergraph Smart Construction Administration and Configuration Guide 31

32 Configure System Settings for Smart Construction 11. Type the name for property definitions to be included in the Properties dialog box in the Smart Construction client in the Included object property definitions box. You can exclude property definitions from the Properties dialog box in the Smart Construction client, or you can include property definitions. You cannot include and exclude properties at the same time. Separate entries in the list with a semicolon. 12. Select Hide published properties to hide properties published from authoring tools in the Properties dialog box in the Smart Construction client. 13. Select Lock CWP after value is set? to prevent changes to the CWP value on an IWP after the value has been selected and the IWP saved. Clear the option to allow changes to the CWP values once an IWP has been saved. 14. Select Lock Contract after value is set? to prevent changes to the contract value on an IWP after the value has been selected and the IWP saved. Clear the option to allow changes to the contract value once an IWP has been saved. If you select Lock Contract after value is set? and an IWP was previously saved without a contract value selected, Smart Construction allows you to edit the contract value once. 15. Select Lock Contractor after value is set? to prevent changes to the contractor value on an IWP after the value has been selected and the IWP saved. Clear the option to allow changes to the contractor value once an IWP has been saved. If you select Lock Contractor after value is set? and an IWP was previously saved without a contractor value selected, Smart Construction allows you to edit the contractor value once after an IWP has been saved. 16. Select Display drawing type beside drawing name? to show the drawing type next to drawing names in Smart Construction. 17. Select Show custom context menus in viewer to enable the appearance of custom client API methods on the context menu when a component in a model or drawing viewer is right-clicked. 18. Click Finish to save your changes. You can view which version of Smart Construction is installed and configured in the SPC Data Version box. For information on the Document Settings details, see Configure Documents (on page 149). Intergraph Smart Construction Administration and Configuration Guide 32

33 Configure System Settings for Smart Construction Configure the client timeout value You can configure the Smart Construction client timeout value on a per workstation basis. This value controls the amount of time before a connection between the Smart Construction client workstation is disconnected from the Smart Construction server. 1. Browse to the Smart Construction installation location and open the Smart Construction client configuration file (for example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\spcclient\spc.client.exe.config). 2. In the SPC.Client.exe.config file, locate the <appsettings> node. 3. Edit the value for HttpSubmit.Timeout to your correct time interval. The refresh time interval value is set in seconds. By default, the value is 1800 for 30 minutes. Turn on Smart Construction queues By default, Smart Construction delivers all queues turned off. You must start the queues in order to use them. 1. Log on to SmartPlant Foundation as an administrator. 2. Click Smart Construction > Find > Administration > Queues. 3. In the Find dialog box, type the name of the queue and click OK. 4. Right-click the queue name and select Queue > Start. Right-click the queue name and select Queue > Stop to stop the queue. In the Smart Construction client, click Administration > Show Queue Status to view which queues are enabled and their status. Including reference files for drawings in IWP Summary reports In order for the IWP Summary report to include the reference files that provide the border or titleblock components of a drawing, these reference files must be saved in the SPCReferenceFiles folder for your Smart Construction site. This folder is on the Smart Construction server at [drive]:\smartplant Foundation Server Files\Web_Sites\[SiteName]\Bin\SPCReferenceFiles. Reference files must be saved in the SPCReferenceFiles folder so they can be accessed by the Smart Construction server process that creates the IWP Summary report. If a reference file is not found in this folder, and if the server process does not have access to the drawing's linked file location, the drawing is included in the report without the reference file. Intergraph Smart Construction Administration and Configuration Guide 33

34 S ECTION 7 Manage Template Files for Smart Construction Smart Construction has many features that can be personalized and configured to fit your business and project needs using Microsoft Excel workbook template files. Smart Construction features that use a template The following Smart Construction features use template files: Rules of progress Importing your schedule in the Import project data window Importing your Primavera P6 schedule in the Import project data window Mapping project configuration data for the Import project data window Mapping retrieve properties Materials mapping Template delivery location The template files are delivered to the Templates folder in the Smart Construction installation directory (browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates). How the templates work Each template is a Microsoft Excel file that contains a macro. You configure your data as needed in the template workbook and save it. Then, you click the Generate button on the Main tab of the template. The Generate button starts the macro, generating an XML file. Smart Construction uses the generated XML file to configure data in your project. Getting the newly configured data into Smart Construction varies per service and feature. For example, Smart Construction automatically pulls the mapping for project configuration and schedule data for the Import project data window. You must start a retrieve or refresh work steps in order to pull in the latest Rules of Progress data. And, you must start a retrieve to get the latest retrieve mappings. How to manage the files Intergraph recommends that you use the document management feature in the SmartPlant Foundation Desktop Client to manage these template files. The SmartPlant Foundation Desktop Client stores the configuration document, allowing users with the proper permissions to check the document out and in with revisions. Each template (and XML file) has a corresponding configuration document in the SmartPlant Foundation Desktop Client (You can find these configuration documents by clicking Smart Construction > Find > Administration > Configuration Documents). Intergraph Smart Construction Administration and Configuration Guide 34

35 Manage Template Files for Smart Construction After you make changes to your template and generate the XML file, Intergraph recommends that you attach the Microsoft Excel file and the XML file to its configuration document in the SmartPlant Foundation Desktop Client. For more information, see Attach template files to configuration documents (on page 36). Open a Smart Construction template file Smart Construction template files are delivered in the Templates folder in the installation location. Intergraph recommends that you manage the files in the SmartPlant Foundation Desktop Client where you can check the documents in and out, and you also can sign off the documents. The SmartPlant Foundation Desktop Client can manage the versions and revisions of the documents. For more information about document management in the SmartPlant Foundation Desktop Client, see the SmartPlant Foundation Desktop Client User's Guide. You must configure a vault for files attached to the configuration document objects in SmartPlant Foundation. For more information, see Configure a vault for files attached to configuration documents in the Intergraph Smart Construction Installation and Setup Guide. Opening the file for the first time 1. Browse to the Templates folder in the installation location. For example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates. 2. Open the folder for the template you want to view. Opening the template file from SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Configuration Documents to open the Query for Configuration Documents dialog box. 3. Type your search criteria and click Finish to find the configuration documents. 4. In the search results, right-click the configuration document that contains the template and select Edit > Check out. 5. Select a location for the file and click OK. For more information, see Check in and check out a document in the SmartPlant Foundation Desktop Client User's Guide. Enable the macro content for the workbook 1. On the Security Warning bar, click Options. 2. Select Enable this content on the Microsoft Office Security Options and click OK. Intergraph Smart Construction Administration and Configuration Guide 35

36 Manage Template Files for Smart Construction Attach template files to configuration documents After you configure data in a template file for the first time, you must attach all necessary files (in some cases an Excel workbook and an XML file) to the appropriate configuration document in the SmartPlant Foundation Desktop Client. The SmartPlant Foundation Desktop Client stores the configuration document, allowing users with the proper permissions to check the document out and in with revisions. Set your Create scope in the SmartPlant Foundation Desktop Client to the configuration top when attaching files to a Smart Construction configuration document. 1. Click Smart Construction > Find > Administration > Configuration Documents to open the Query for Configuration Documents dialog box. 2. Type your search criteria and click Finish to find the configuration documents. 3. In the search results, right-click the configuration document and select Files > Attach File to open the Attach File dialog box. 4. Click Add File and browse to the necessary files. 5. Click Open and then click OK to add the files to the list. 6. Click Finish. Check in and sign off a Smart Construction template file After making your edits, save the template and generate any XML files, as required. You can then close, check in, and sign off the template file in SmartPlant Foundation Desktop Client. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Configuration Documents to open the Query for Configuration Documents dialog box. 3. Type your search criteria and click Finish to find the configuration documents. 4. In the search results, right-click a configuration document, and click Edit > Check In. Select the document and click OK. 5. Sign off the document in the SmartPlant Foundation Desktop Client. For more information, see Sign off on a document in the SmartPlant Foundation Desktop Client User's Guide. Intergraph Smart Construction Administration and Configuration Guide 36

37 S ECTION 8 Configure and Update a Materials System Smart Construction can be configured to integrate with a materials system. By default, Smart Construction has direct integration with SmartPlant Materials; however, an open API provides integration with other materials systems. See the Intergraph Smart Construction API and Programmer's Guide for more information about integration through the API. Intergraph recommends that the materials system is set up outside of the Smart Construction server. You must then configure the connection for integration between your materials system and Smart Construction. Once configured for integration, Smart Construction uses the materials system forecast data to filter 3D models and 2D drawings. The connection between Smart Construction and the materials system also allows users with the appropriate security privileges to run a forecast and reserve materials for IWPs in Smart Construction. You can also specify which work steps will consume materials. For more information, see Specify which work steps consume materials (on page 42). Configuring a SmartPlant Materials system for Smart Construction The following work process diagram illustrates how to set up and configure a SmartPlant Materials system with Smart Construction. Intergraph Smart Construction Administration and Configuration Guide 37

38 Configure and Update a Materials System What do you want to do? Create a TNS entry for the SmartPlant Materials database (on page 38) Configure a materials system with Smart Construction (on page 38) Set up the SmartPlant Materials site API (on page 39) Install SQL scripts for a SmartPlant Materials database (on page 40) Verify the materials system is working (on page 40) Set up a project forecast in a materials system (on page 41) Attach materials template files to the materials system configuration document (on page 41) Use the SmartPlant Foundation Desktop Client to manage the template files (on page 42) Specify which work steps consume materials (on page 42) Create a TNS entry for the SmartPlant Materials database 1. In Windows Explorer, navigate to the Oracle Home folder. 2. Open the tnsnames.ora file found in the ADMIN folder. 3. Create a TNS entry that points to your SmartPlant Materials database. Consult your local Oracle Administrator for assistance. Configure a materials system with Smart Construction 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > New > Administration > Materials System in the SmartPlant Foundation Desktop Client to open the New Materials System dialog box. 3. Define details for the materials system. An ENS definition automatically names the materials system with the Smart Construction plant name in SmartPlant Foundation. Smart Construction hides your password in SmartPlant Foundation Desktop Client. 4. Click Apply or Finish to create the new materials system. The data source is the name of the local TNS entry that points to the materials database. The user ID and password are the same user ID and password contained in the materials system with permissions to run forecasts and reservations. Intergraph Smart Construction Administration and Configuration Guide 38

39 Configure and Update a Materials System The project forecast name must be the same project forecast name used in your materials system. Your active scope must be set before configuring a materials system in Smart Construction. For more information, see Set your active scope in SmartPlant Foundation Desktop Client in the Intergraph Smart Construction Installation and Setup Guide. Update materials system information in SmartPlant Foundation Desktop Client After you configure a materials system in SmartPlant Foundation, you can update the materials system information as needed. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Materials System to open the Find Materials System dialog box. 3. Type a name of a materials system in the Find Materials System dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. In the search results list, right-click the name of the materials system you want to update and select Update. 5. Edit the materials system information on the Update form. 6. Click Finish to save the changes and update the system. Set up the SmartPlant Materials site API Materials. You must set up the Materials Site API for Smart Construction in SmartPlant 1. In SmartPlant Materials, navigate to the A screen. 2. Click the Integrator tab. 3. Select the record with the Parameter ZI_SITEAPI. 4. Verify that the Value option for the record with Parameter ZI_SITEAPI contains the value Y. 5. If the Value option does not contain the value Y, then select the option and press F9 to bring up the list of values window. 6. Select Y Site API is Activated. Click OK. 7. Press F10 to store the record. 8. Navigate to the A screen. 9. Press F8 to populate the form. 10. Scroll to your Materials User and your Project. 11. Verify that the Use for APIs option is selected, which means the Site API for SmartPlant Materials is enabled. If the Active option is not selected, select the option to enable the Site API for SmartPlant Materials. Intergraph Smart Construction Administration and Configuration Guide 39

40 Configure and Update a Materials System For more information, see Using the Site API Guide delivered with SmartPlant Materials. Install SQL scripts for a SmartPlant Materials database Complete the following steps in each SmartPlant Materials database that you plan to interface with Smart Construction. 1. Log on to SQLPlus using the user name and password of your SmartPlant Materials database. 2. Using SQL Plus, browse to the Materials folder in the Smart Construction server installation location. For example, navigate to [Drive]:\Program Files (x86)\smartconstruction\2017\spcserver\support\materials. 3. Run file scripts located in the Materials folder. Select the scripts that correspond to your version of SmartPlant Materials. If you are installing a new SmartPlant Materials system, run the following scripts: m_api_site_spc_spec.sql m_api_site_spc_body.sql m_api_site_spc_type.sql for version or later If you already have a SmartPlant Materials system installed, run the following scripts: del_spc_fah_results.sql m_api_site_spc_spec.sql m_api_site_spc_body.sql m_api_site_spc_type.sql for version or later For more information, see Using the Site API Guide delivered with SmartPlant Materials. Verify the materials system is working 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Materials System to open the Find Materials System dialog box. 3. Type a name of a materials system in the Find Materials System dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. In the search results list, right-click the name of the materials system and select Test Service. 5. After reviewing either the success or failure message, click OK. Intergraph Smart Construction Administration and Configuration Guide 40

41 Configure and Update a Materials System Set up a project forecast in a materials system After you configure your materials system with Smart Construction, forecast information updates 3D model and 2D drawing filters. You must frequently run project forecasts for all drawings in your project. Intergraph suggests that you run a project forecast daily in order to update Smart Construction filters with the latest forecast information. See SmartPlant Materials documentation or the documentation of your materials system for more information about setting up a project forecast. Attach materials template files to the materials system configuration document You must attach the SP Material Mappings.xlsm workbook and XML file to the Material Mappings configuration document located in the SmartPlant Foundation Desktop Client. The SmartPlant Foundation Desktop Client stores the document, allowing users with the proper permissions to check the document out and in with revisions. Set your Create scope in the SmartPlant Foundation Desktop Client to the configuration top when attaching files to a Smart Construction configuration document. 1. Click Smart Construction > Find > Administration > Configuration Documents to open the Query for Configuration Documents dialog box. 2. Type your search criteria and click Finish to find the configuration documents. 3. In the search results, right-click the Material Mappings document and select Files > Attach File to open the Attach File dialog box. 4. Click Add File and browse to the SP Material Mappings.xlsm workbook and SP Material Mappings.xml file. The files are delivered by default to [drive]:\program Files (x86)\smartconstruction\2017\templates\material Mappings. 5. Click Open, and then click OK to add the files to the list. 6. Click Finish. Customizing the material mappings template You can customize the material mappings for your project by editing the tables in the mapping template. For information and assistance in customizing the material mapping template for your project, please contact Intergraph Customer Support ( 1. Open the SP Material Mappings.xlsm workbook. (Browse to the Templates folder in the installation location, or check out the Material Mappings configuration document from the SmartPlant Foundation Desktop Client.) 2. Enable the macro content for the workbook. Intergraph Smart Construction Administration and Configuration Guide 41

42 3. Edit the SP Material Mappings.xlsm file. 4. Save your changes in the workbook file. Configure and Update a Materials System 5. Open the Main tab of the workbook, click Generate SP Material Mapping to generate the XML mapping to be used. 6. Verify the XML file is generated. 7. Attach the XML and materials mapping template to the Material Mappings configuration document, and check in and sign off the Material Mappings configuration document in the SmartPlant Foundation Desktop Client. Use the SmartPlant Foundation Desktop Client to manage the template files After they are attached to the Material Mappings configuration document, the SP Material Mappings.xlsm workbook and SP Material Mappings.xml file can be managed in the SmartPlant Foundation Desktop Client. You can check the documents in and out, and you also can sign off the documents. The SmartPlant Foundation Desktop Client can manage the versions and revisions of the documents. For more information about document management in the SmartPlant Foundation Desktop Client, see the SmartPlant Foundation Desktop Client User's Guide. Specify which work steps consume materials You can specify which work step consumes material in the RoP Configuration workbook. Materials can be consumed by multiple work steps in IWPs with different purposes; however, materials cannot be consumed by multiple work steps in IWPs with the same purpose. For more information, see Configure the rules of progress in the rules of progress configuration workbook in the Intergraph Smart Construction Rules of Progress Configuration Guide. Configure system setting 1. Click Smart Construction > Find > Administration > Options. 2. In the Find Smart Construction Options dialog box, type SPC System Options and click OK. 3. In the search results, right-click SPC System Options and select Update. 4. Select Allow work steps to consume materials? to enable the functionality to specify which work steps consume the materials. 5. Click Finish to save your changes. For information on Smart Construction system settings, see Configure System Settings for Smart Construction (on page 31). Specify which work steps consume materials In the RoP Configuration workbook, type [Consumes material] in the row below the work step name to specify which work step is to consume the materials. Intergraph Smart Construction Administration and Configuration Guide 42

43 Configure and Update a Materials System You can also indicate that a manual work step consumes a material item on the Components tab of the Work Packages browser window by enabling the Consuming Material column and marking the check box for the work step. Material consumption details Once configured, the rules of progress generation manage changes to the consumption of materials. Action A work step owns the material item Another work step owns the material item Create a work step Create the material item and associate it with the work step. Transfer ownership if both work steps are unplanned, or both steps are planned but not processed. Delete a work step Delete the material item. The material item is not updated. Update a work step Create or remove the material item. Transfer ownership if both work steps are unplanned, or both steps are planned but not processed. Convert a work step from a manually added work step to a configured work step Convert work step from a configured work step to a manually created work step Create the material item and connect it to the work step. Delete the material item. Transfer ownership if the old work step owner is unplanned, or old work step owner is planned but not processed. The material item is not updated. Intergraph Smart Construction Administration and Configuration Guide 43

44 S ECTION 9 Enable the Material Request Window and Report in Smart Construction You can enable the Material Request window and Material Request Form report in the Smart Construction client to help plan material requests. When the Material Request window is enabled, users can manually manage material requests, or material requests can be automatically populated based on components, component register items, and work steps added to IWPs. Material requests can also be manually added, updated, and deleted in the Material Request window. When the Material Request Form report is enabled, users can print a list of material request items for an IWP. Configure and enable the Material Request window The Material Request window can be enabled by configuring access groups and a system setting in order for users to access the object in the Smart Construction client. Configure access groups for the Material Request window Intergraph recommends associating the access group SPC_MaterialView to allow users to view the Material Request window. 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Administration > Work Package Toolbar Items to open the Find Work Package Toolbar Items dialog box. 3. Type your search criteria in the Find Work Package Toolbar Items dialog box. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Right-click the name of the toolbar and select Manage Access Groups. 5. On the Manage Access Groups window, select an access group to add to the toolbar item. 6. Click Relate Selected Item to add the access group to the toolbar. 7. Click OK to save your changes. For more information on managing access groups, see SmartPlant Foundation How to Configure the Security Model. Configure the system setting for the materials consumption 1. Click Smart Construction > Find > Administration > Options. 2. In the Find Smart Construction Options dialog box, type SPC System Options and click OK. 3. In the search results, right-click SPC System Options and select Update. Intergraph Smart Construction Administration and Configuration Guide 44

45 Enable the Material Request Window and Report in Smart Construction 4. Select Allow work steps to consume materials? to enable the functionality to specify which work steps consume the materials. 5. Click Finish to save your changes. For information on Smart Construction system settings, see Configure System Settings for Smart Construction (on page 31). Enable the Material Request Form report You can enable the Material Request Form report by enabling security for the report. You must configure security for the report object in SmartPlant Foundation Desktop Client to enable delivered reports. Relate the necessary access groups to the custom report object. The SPC_ReportsView or SPC_Everyone access groups can be used to configure the security for the report object. It is delivered with Smart Construction. 1. In the SmartPlant Foundation Desktop Client, click Smart Construction > Find > Administration > Custom Reports. 2. Type the name of the item you want to update in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 3. Find the report object in the search results list. 4. Right-click the report option and select Manage Access Groups. 5. Configure the correct access group to allow users to use the report. For more information, see the SmartPlant Foundation How to Configure the Security Model guide. For information on enabling the Material Request Form report, see Enable delivered reports in the Intergraph Smart Construction API and Programmer's Guide or the Intergraph Smart Construction Customization Guide. Reset IIS application pools and retrieve documents After enabling the Material Request window and report, close SmartPlant Foundation Desktop Client and recycle the Internet Information Services (IIS) application pools for your project's site. For more information on resetting IIS application pools, see IIS documentation. After recycling the IIS application pools, retrieve documents into Smart Construction. For more information, see Retrieve data (on page 106). Intergraph Smart Construction Administration and Configuration Guide 45

46 S ECTION 10 Import Project Data into Smart Construction You can use the Import Project Data window in the Smart Construction client to import project data, such as your schedule objects from Primavera P6 and project configuration objects, into your project. Using the Import Project Data window, you can select which CWPs and project configuration objects and relationships you want to create, edit, or remove in your project. The Import Project Data window reads project data from template files in which you can specify data. The window can also directly integrate with your Primavera P6 schedule system. For more information on directly integrating with Primavera P6, see Configure a Schedule System for Schedule Data Import (on page 69). Using the Import Project Data window, you can create, edit, and remove CWPs from your schedule system. You can create CWPs two different ways using the Import Project Data window in Smart Construction: You can export your schedule from your scheduling tool, then import it into Smart Construction. For information on importing your schedule from an exported schedule file, see Importing your schedule into Smart Construction (on page 46). Using the Import Project Data window, you can create, edit, and remove project configuration objects, such as contractors, contracts, CWPs, drawings, and planning groups and their relationships. For information on importing your project configuration data, see Import project configuration data into Smart Construction (on page 54). Importing your schedule into Smart Construction You can export your schedule from your scheduling tool, and then import it into Smart Construction. Configuring your schedule with Smart Construction is a multi-step process, as seen in the following work process diagram. Intergraph Smart Construction Administration and Configuration Guide 46

47 Import Project Data into Smart Construction You can also directly integrate with your scheduling tool. For more information, see Configure a Schedule System for Schedule Data Import (on page 69). What do you want to do? Export your schedule from your scheduling software (on page 47) Configure your schedule mapping for import (on page 48) Import project data in Smart Construction (on page 53) Export your schedule from your scheduling software You must export your schedule from your scheduling software as an XML file in order to import it into Smart Construction. For more information, consult the documentation delivered with your scheduling software. Intergraph Smart Construction Administration and Configuration Guide 47

48 Import Project Data into Smart Construction Configure your schedule mapping for import You must map properties from your scheduling file to properties in Smart Construction. The following is a detailed work process that explains how to configure your schedule mapping for import into Smart Construction. You must configure a vault for files attached to the configuration document objects in SmartPlant Foundation. For more information, see Configure a vault for files attached to configuration documents in the Intergraph Smart Construction Installation and Setup Guide. 1. Open the Primavera Schedule Mappings.xlsm workbook. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). 2. Click the Primavera Schedule tab. 3. Edit values for your exported schedule. If you enter data in the mapping workbook and later decide to remove the data, right-click the cell in Excel and select Clear Contents. For more information on how to edit the workbook, see Structure of the workbook (on page 49). If a Smart Construction property does not exist for the custom property, you must extend the Smart Construction schema to include the custom property. For more information, see Extend the Smart Construction Schema (on page 211). 4. Click Save to save your changes in the workbook file. 5. Open the Main tab of the Primavera Schedule Mappings.xlsm workbook. 6. Click the Generate Primavera Schedule Mapping button to generate the Primavera Schedule Mappings.xml file. 7. Check in and sign off the Primavera Schedule Mappings.xlsm workbook and Primavera Schedule Mappings.xml file into the SmartPlant Foundation Desktop Client. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). If you are generating the Primavera schedule mapping data for the first time, attach the Primavera Schedule Mappings.xlsm workbook and XML file to the Primavera Schedule Mapping configuration document in the SmartPlant Foundation Desktop Client. For more information, see Attach the Primavera Schedule Mappings workbook and XML files to the Primavera Schedule Mappings configuration document (on page 52). Intergraph Smart Construction Administration and Configuration Guide 48

49 Import Project Data into Smart Construction Primavera Schedule Mappings.xlsm details Use topics in the following section to learn more about the Primavera Schedule Mappings.xlsm workbook. Installation and location of the workbook When Smart Construction is installed on a server, the Primavera Schedule Mappings.xlsm workbook is delivered to the Import Project Data Systems folder in the Templates folder of the installation location (for example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates\import Project Data Systems to find Primavera Schedule Mappings.xlsm). Structure of the workbook The Primavera Schedule Mappings.xlsm workbook contains two tabs. The Main tab generates an XML file and saves it in the location specified when the file is checked out. The Primavera Schedule tab contains data and properties that are to be imported into Smart Construction. Main tab The Main tab is located on the first sheet of the workbook. It contains the Generate Primavera Schedule Mapping button, which generates the XML file and saves it in the location specified when the file is checked out. The Generate Primavera Schedule Mapping button should not be renamed or removed because it contains a macro. The code behind the button should not be modified or removed. Primavera Schedule tab The Primavera Schedule tab contains data and properties that are to be imported into Smart Construction. Column names are fixed and cannot be modified. Columns can be moved to different locations on the same sheet. Do not add new columns. Smart Construction does not read or handle any newly added columns. For more information on configuring UDFs and mapping arguments, see Configure a User-Defined Field (UDF) in your Smart Construction mapping (on page 50) or Mapping arguments for your Smart Construction project data (on page 51). Column Header Entity Explanation Identifies a P6 object type, which appears as a node in the exported Primavera PM (XML) file (limited to WBS currently). Intergraph Smart Construction Administration and Configuration Guide 49

50 Import Project Data into Smart Construction Column Header Attribute SPCInterface SPCProperty Argument Explanation Identifies a field name for the specified Entity, which appears as a sub node in the exported Primavera PM (XML) file for the specified Entity type. For example, the WBS contains Code, Name, SequenceNumber, and so on. A Smart Construction Interface definition realizing the specified SPCProperty value. A Smart Construction Property definition realized by the specified SPCInterface. Identifies a method (from the Project Data Mappings service) and argument list (optional, depending on the method) to generate the desired value from the Primavera WBS data. Configure a User-Defined Field (UDF) in your Smart Construction mapping In Primavera P6, User-Defined fields (UDFs) are custom fields, created to track information specific to your project, WBS, or activities. To use these UDFs in your Smart Construction project, you must map the UDF from Primavera to data in Smart Construction. You can create this mapping in the Primavera schedule mapping workbooks. Column Header Entity Attribute SPCInterface SPCProperty Explanation Identifies a P6 object type, which appears as a node in the exported Primavera PM (XML) file (limited to WBS currently). Identifies the UDF to be mapped, using the syntax UDF.[UDF title or name]. If the UDF is on an activity, use the syntax ACTIVITY:UDF.[UDF title or name]. A Smart Construction Interface definition realizing the specified SPCProperty value. A Smart Construction Property definition realized by the specified SPCInterface. Intergraph Smart Construction Administration and Configuration Guide 50

51 Import Project Data into Smart Construction Column Header Argument Explanation Identifies a method (from the Project Data Mappings service) and argument list (optional, depending on the method) to generate the desired value from the Primavera WBS data. If you are mapping a one-to-one relationship between a UDF and a Smart Construction property, the Argument column is left blank. For example, if you have a UDF named Discipline in your Primavera P6 system, you can map it like the following: Mapping arguments for your Smart Construction project data You can specify arguments for your project data in the Argument column of the Primavera mappings workbooks. You can map arguments in order to call an external mapping function, allowing you to personalize your project data. The following list defines the default methods provided by the Project Data Mappings service: BuildWBSPath() this method builds a WBS path based on the WBS hierarchy from the Primavera project data; the resulting value mirrors the value generated by the former Refresh Schedule command. CalculateEarlyStartDate() this method calculates the early start date for WBS items transforming to CWPs. CalculateEarlyFinishDate() this method calculates the early finish date for WBS items transforming to CWPs. CalculateLateStartDate() this method calculates the late start date for WBS items transforming to CWPs. CalculateLateFinishDate() this method calculates the late finish date for WBS items transforming to CWPs. MinDate(Activity:DateField) this method calculates the earliest date from all Activities under a WBS item, using the date field specified. MaxDate(Activity:DateField) this method calculates the latest date from all Activities under a WBS item, using the date field specified. RollupValue(Activity:P6Field) this method calculates a sum from all Activities under a WBS item, using the numeric field specified. Intergraph Smart Construction Administration and Configuration Guide 51

52 Import Project Data into Smart Construction Attach the Primavera Schedule Mappings workbook and XML files to the Primavera Schedule Mappings configuration document After you generate schedule mapping data for your project for the first time, you must attach the Primavera Schedule Mappings.xlsm workbook and XML file to the Primavera Schedule Mappings configuration document located in the SmartPlant Foundation Desktop Client. The SmartPlant Foundation Desktop Client stores the document, allowing users with the proper permissions to check the document out and in with revisions. Set your Create scope in the SmartPlant Foundation Desktop Client to the configuration top when attaching files to a Smart Construction configuration document. 1. Click Smart Construction > Find > Administration > Configuration Documents to open the Query for Configuration Documents dialog box. 2. Type your search criteria and click Finish to find the configuration documents. 3. In the search results, right-click the Primavera Schedule Mappings document and select Files > Attach File to open the Attach File dialog box. 4. Click Add File and browse to the Primavera Schedule Mappings.xlsm workbook and Primavera Schedule Mappings.xml files. 5. Click Open, and then click OK to add the files to the list. 6. Click Finish. Use the SmartPlant Foundation Desktop Client to manage the Primavera Schedule Mappings.xlsm workbook After it is attached to the Primavera Schedule Mappings configuration document, the Primavera Schedule Mappings.xlsm workbook and Primavera Schedule.xml file can be managed in the SmartPlant Foundation Desktop Client. For more information, see Attach the Primavera Schedule Mappings workbook and XML files to the Primavera Schedule Mappings configuration document (on page 52). You can check the documents in and out, and you also can sign off the documents. The SmartPlant Foundation Desktop Client can manage the versions and revisions of the documents. For more information about document management in the SmartPlant Foundation Desktop Client, see the SmartPlant Foundation Desktop Client User's Guide. Intergraph Smart Construction Administration and Configuration Guide 52

53 Import Project Data into Smart Construction Import project data in Smart Construction 1. Log on to Smart Construction as an administrator. 2. Click Administration > Import Project Data. 3. In the Import Project Data window, select a system name in the System Name box. 4. Click Settings. 5. Edit your project settings for the project data system, and then click OK. Use the Browse dialog box to navigate to the Microsoft Excel workbook that contains the project data you want to load or the XML file that contains the Primavera schedule you want to load. Confirm the schedule settings for your schedule system. 6. Using the table in the Import Project Data window, select the objects from the file that you want to load into your Smart Construction database. The grid displays the contents of the input source. If a Microsoft Excel workbook contains multiple sheets, each sheet appears in the window as a separate tab of the table. For each item found in the input source, the Action column indicates which process is needed to synchronize the data file with the database. Use the options in the Quick Selection pane for fast navigation and selection of your data. 7. Select the check boxes by the items to be added to the database, modified in the database, or removed from the database. Select the check box in the Name column to apply all changes to the object. You can select individual check boxes for an object to apply specific changes to that object. 8. Click Process. This process creates a new SmartPlant Foundation design document and attaches an XML file that includes the content of the selected data file. The document name is [System Name]_[Service Name]. This document cannot be checked out. It is managed by Smart Construction and exists in the CURRENT state. If your import project data file is large in size, you can configure IIS to process large file sizes. For more information, see Configure IIS to process large files (on page 66). For more information on the Import project data window, see Learn more about the Import Project Data window in the Intergraph Smart Construction User's Guide. If you remove a CWP from your project data but the CWP is associated with an IWP, the CWP cannot be deleted. Intergraph Smart Construction Administration and Configuration Guide 53

54 Import Project Data into Smart Construction Import project configuration data into Smart Construction Smart Construction allows you to create, import, and edit project data. You can create and configure contracts, contractors, and CWPs, and you can import construction resources. Smart Construction delivers a Microsoft Excel workbook template administrators can use to create and edit project data for a Smart Construction site to fit the specific needs of an organization. You can import the data from the Microsoft Excel workbook into Smart Construction. When importing project data into Smart Construction, objects for the data are created in SmartPlant Foundation. If you are importing contract, contractor, CWP data, or construction resources into Smart Construction, contract, contractor, CWP, and construction resource objects are created in SmartPlant Foundation. You can configure and map project configuration objects, such as contractors and contract numbers, CWPs, drawings, commissioning systems, and planning groups. You can also use the workbook to create a construction resource hierarchy. Configure project configuration mappings and relationships Before configuring your project data, you can define and map how project configuration objects and relationships will be configured for your project. For more information on the delivered project configuration relationships and data, see Delivered project configuration objects and relationships (on page 56). For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). You must configure a vault for files attached to the configuration document objects in SmartPlant Foundation. For more information, see Configure a vault for files attached to configuration documents in the Intergraph Smart Construction Installation and Setup Guide. 1. Open the Project Configuration Mappings.xlsm workbook. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). 2. Edit values for your project configuration mapping data. To map a new property, type the property definition in the SPCProperty column and the interface definition name in the SPCInterface column. Type the project configuration workbook tab name in the Entity column to which the property is to map. Type a tab heading name in the Attribute column. For example, to map a drawing's commissioning system property to the Drawing tab of the project configuration workbook, you would type the following - To configure a relationship between two objects, type a tab name in the Entity column, type an object name in the Attribute column, and type Rel in the Argument column. By default, you can only configure relationships that are delivered with Smart Construction. 3. Click Save to save your changes in the workbook file. 4. Open the Main tab. Intergraph Smart Construction Administration and Configuration Guide 54

55 Import Project Data into Smart Construction 5. Click Generate Project Configuration Mapping to generate the Project Configuration Mappings.xml file. 6. Check in and sign off the Project Configuration Mappings.xlsm workbook and XML file into the SmartPlant Foundation Desktop Client. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). If mapping the project configuration data for the first time, attach the Project Configuration Mappings.xlsm workbook and XML file to the Project Configuration Mappings configuration document in the SmartPlant Foundation Desktop Client. For more information, see Attach the Project Configuration Mappings.xlsm workbook and Project Configuration Mappings.xml file to the Project Configuration Mappings configuration document (on page 57). Project Configuration Mappings.xlsm details Use topics in the following section to learn more about the Project Configuration Mappings.xlsm workbook. Installation and location of the workbook When Smart Construction is installed on a server, the Project Configuration Mappings.xlsm is delivered to the Templates folder of the installation location (for example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates\import Project Data Systems to find Project Configuration Mappings.xlsm). Structure of the workbook The Project Configuration Mappings.xlsm workbook contains two tabs, Main and Project Configuration. Main tab The Main tab is located on the first sheet of the workbook. It contains the Generate Mapping button, which generates the XML file and saves it in the current Project Configuration Mappings.xlsm file location when you check out the document. Do not rename or remove the Generate Configuration File button. Do not modify or remove the code behind the button. Project Configuration tab The following table lists the columns and their purpose for the Project Configuration tab of the Project Configuration Mappings.xlsm workbook. Column Name Entity Attribute Purpose Maps data to the tab name in the project configuration workbook. Maps data to the column heading in the project configuration workbook. Intergraph Smart Construction Administration and Configuration Guide 55

56 Import Project Data into Smart Construction Column Name SPCInterface SPCProperty Argument Purpose A Smart Construction Interface definition realizing the specified SPCProperty value. A Smart Construction Property definition realized by the specified SPCInterface. Identifies a method and argument list to generate the desired value. You can specify rel to create a relationship between an entity and an attribute. Delivered project configuration objects and relationships If you use the delivered project configuration workbook and the Project Configuration Mappings.xlsm, the following objects can be created in SmartPlant Foundation Desktop Client and made available in Smart Construction. Contractors Contracts CWPs Construction Resources Using the delivered Project Configuration Mappings.xlsm, the following relationships can be created between project configuration objects. Intergraph Smart Construction Administration and Configuration Guide 56

57 Import Project Data into Smart Construction Attach the Project Configuration Mappings.xlsm workbook and Project Configuration Mappings.xml file to the Project Configuration Mappings configuration document Set your Create scope in the SmartPlant Foundation Desktop Client to the configuration top when attaching files to a Smart Construction configuration document. 1. Click Smart Construction > Find > Administration > Configuration Documents to open the Query for Configuration Documents dialog box. 2. Type your search criteria and click Finish to find the configuration documents. 3. In the search results, right-click the Project Configuration Mappings document and select Files > Attach File to open the Attach File dialog box. 4. Click Add File and browse to the Project Configuration Mappings.xlsm workbook and XML file. 5. Click Open, and then click OK to add the files to the list. 6. Click Finish. Use the SmartPlant Foundation Desktop Client to manage the Project Configuration mapping files After it is attached to the Project Configuration Mappings configuration document, the Project Configuration Mappings.xlsm workbook and XML file can be managed in the SmartPlant Foundation Desktop Client. For more information, see Attach the Project Configuration Mappings.xlsm workbook and Project Configuration Mappings.xml file to the Project Configuration Mappings configuration document (on page 57). You can check the documents in and out, and you also can sign off the documents. The SmartPlant Foundation Desktop Client can manage the versions and revisions of the documents. For more information about document management in the SmartPlant Foundation Desktop Client, see the SmartPlant Foundation Desktop Client User's Guide. Configure and import project configuration data The following is a detailed work process that explains how to configure your project configuration for import into Smart Construction. Project configuration is managed using a configuration template that is imported into Smart Construction. See Configure project configuration mappings and relationships (on page 54) for information on how to configure and map project configuration data. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). Smart Construction delivers example project configuration data. Intergraph recommends that you copy the Project Configuration Sample.xlsx workbook and create a unique project configuration workbook specific to your business needs. When you configure and import project configuration objects into Smart Construction, the objects are also created in SmartPlant Foundation Desktop Client. For more information, see Manage project configuration in SmartPlant Foundation (on page 62). Intergraph Smart Construction Administration and Configuration Guide 57

58 Configure project configuration data Import Project Data into Smart Construction 1. Open the project configuration workbook. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). 2. Edit values for your project configuration data. For more information on the structure of the workbook, see Structure of the workbook (on page 59). Drawings must be retrieved in your Smart Construction project in order to create project configuration objects and relationships for them. 3. Click Save to save your changes in the workbook file. Import project configuration data 1. Log on to Smart Construction as an administrator. 2. Click Administration > Import Project Data. 3. In the Import Project Data window, select a system name in the System Name box. 4. Click Settings. 5. Edit your project settings for the project data system, and then click OK. Use the Browse dialog box to navigate to the Microsoft Excel workbook that contains the project data you want to load or the XML file that contains the Primavera schedule you want to load. Confirm the schedule settings for your schedule system. 6. Using the table in the Import Project Data window, select the objects from the file that you want to load into your Smart Construction database. The grid displays the contents of the input source. If a Microsoft Excel workbook contains multiple sheets, each sheet appears in the window as a separate tab of the table. For each item found in the input source, the Action column indicates which process is needed to synchronize the data file with the database. Use the options in the Quick Selection pane for fast navigation and selection of your data. 7. Select the check boxes by the items to be added to the database, modified in the database, or removed from the database. Select the check box in the Name column to apply all changes to the object. You can select individual check boxes for an object to apply specific changes to that object. 8. Click Process. This process creates a new SmartPlant Foundation design document and attaches an XML file that includes the content of the selected data file. The document name is [System Intergraph Smart Construction Administration and Configuration Guide 58

59 Import Project Data into Smart Construction Name]_[Service Name]. This document cannot be checked out. It is managed by Smart Construction and exists in the CURRENT state. If your import project data file is large in size, you can configure IIS to process large file sizes. For more information, see Configure IIS to process large files (on page 66). For more information on the Import project data window, see Learn more about the Import Project Data window in the Intergraph Smart Construction User's Guide. The Resources tab in the Smart Construction Import Project Data dialog box is read-only. When you process the construction resource data in the Import Project Data dialog box, Smart Construction syncs the construction resources in the project configuration workbook and your system. Project configuration workbook details Use topics in the following section to learn more about the project configuration workbook. Installation and location of the workbook When Smart Construction is installed on a server, the Project Configuration Sample.xlsx is delivered to the Templates folder of the installation location (for example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates\import Project Data Systems to find Project Configuration Sample.xlsx). Smart Construction delivers example project configuration data. Intergraph recommends that you copy the Project Configuration Sample.xlsx workbook and create a unique project configuration workbook specific to your business needs. Structure of the workbook The workbook contains five tabs, Contractors, Contracts, CWPs, Drawings, and Resources. Each tab defines different project data and relationships. Contractors tab The following table lists the columns and their purpose for the Contractors tab of the project configuration workbook. Column Name Contractor ContractorDescription PlanningGroup Contract Purpose Contractor name. Description of the contractor. Name of the planning group object from SmartPlant Foundation. For more information on planning groups, see Create and configure planning groups (on page 23). Contract name or number. Intergraph Smart Construction Administration and Configuration Guide 59

60 Contracts tab Import Project Data into Smart Construction The following table lists the columns and their purpose for the Contracts tab of the project configuration workbook. Column Name Contract ContractDescription Purpose Contract name or number, as listed in the Contractors tab. Description of the contract. CWPs tab The following table lists the columns and their purpose for the CWPs tab of the project configuration workbook. Column Name CWP CWPDescription CWPEWP CWPArea CWPDiscipline WBSPath PlannedStart PlannedFinish ActualStart Purpose CWP name or number. Description of the CWP. EWP of the CWP. Design area for the CWP. Discipline for the CWP. Disciplines listed in this column must be spelled the same as those in the Construction discipline enumerated list. For more information, see Configure Work Package Disciplines and Purposes (on page 140). Work breakdown structure for the CWP. The WBSPath value is required if you plan to export your schedule data from Smart Construction and import it into Primavera P6. The planned start date for the CWP. If you are using Primavera P6, the value matches the start_date value. The planned finish date for the CWP. If you are using Primavera P6, the value matches the end_date value. The actual start date of the CWP. If you are using Primavera P6, the value matches the act_start_date value. Intergraph Smart Construction Administration and Configuration Guide 60

61 Import Project Data into Smart Construction Column Name ActualFinish EarlyStart EarlyFinish LateStart LateFinish BudgetedLabor Purpose The actual finish date of the CWP. If you are using Primavera P6, the value matches the act_end_date value. The earliest start date of the CWP. The earliest finish date of the CWP. The latest start date of the CWP. The latest finish date of the CWP. Amount of labor budgeted for the CWP in hours. If you are using Primavera P6, the value matches the best_work_qty value. Drawings tab The following table lists the columns and their purpose for the Drawings tab of the project configuration workbook. Drawings must be retrieved in your Smart Construction project in order to create project configuration objects and relationships for them. Column Name Drawing CWP CommissioningSystem Purpose The drawing name must be spelled correctly and must match the name of the drawing retrieved into Smart Construction. For more information, see Getting Data into Smart Construction (on page 102). CWP name or number, as listed in the CWP tab. Relates a commissioning system to a drawing as a property. Resources tab You can define the construction resource hierarchy in the Resources tab of the project configuration workbook. The Resources tab in the Smart Construction Import Project Data dialog box is read-only. When you process the construction resource data in the Import Project Data dialog box, Smart Construction syncs the construction resources in the project configuration workbook and your system. You can define a new level of a hierarchy in each column and details about a construction resource in each row. The column number defines the hierarchy level of the construction resource. All resources belong to the Level 1 resource or Intergraph Smart Construction Administration and Configuration Guide 61

62 Import Project Data into Smart Construction top-level category above it, and a new resource structure is created when a new top-level category is created. Column Name Column 1 Column [Number] Purpose Defines Level 1 or top-level category of a construction resource hierarchy. Resources included under a top-level category resource are considered part of the hierarchy of the category, until a new category is defined. The column number defines the hierarchy level of a construction resource. A top-level category of a resource is defined in the column above and to the left of the resource in the list. And, other members of the hierarchy are defined in the columns below and to the right of it in the list. Manage project configuration in SmartPlant Foundation In addition to the project configuration import operation in Smart Construction, administrators can use SmartPlant Foundation to manage the ProjectConfiguration.xls workbook, as well as the project configuration objects and relationships. Manually create project configuration objects in SmartPlant Foundation If given the appropriate security privileges, an administrator can manually create project configuration objects, such as CWPs, contracts, contractors, and crews, in SmartPlant Foundation. 1. Log on the SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > New or Smart Construction > New > Administration and select a category of object to create. 3. Type a name and other details in the New dialog box. 4. Click Apply or Finish to create the object. After you create an object, you can configure relationships for that object. For more information, see Configure relationships for project configuration objects (on page 63). For more information on creating objects in the SmartPlant Foundation Desktop Client, see Create and Modify Objects in the SmartPlant Foundation Desktop Client User's Guide. Intergraph Smart Construction Administration and Configuration Guide 62

63 Import Project Data into Smart Construction Find project configuration objects in SmartPlant Foundation 1. Log on the SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find or Smart Construction > Find > Administration and select a category of object to query. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK. For more information on searching for objects in the SmartPlant Foundation Desktop Client, see Search for Objects in the SmartPlant Foundation Desktop User's Guide. Configure relationships for project configuration objects You can configure relationships among project configuration objects at any time for your project using the SmartPlant Foundation Desktop Client. For example, if you manually create project configuration objects in the SmartPlant Foundation Desktop Client or you import CWPs from an external system such as Primavera P6, you can create relationships for those objects in the SmartPlant Foundation Desktop Client. See the following topics to learn how to view, create, and terminate relationships. View relationships for an object 1. Log on the SmartPlant Foundation Desktop Client as an administrator. 2. Find the objects for which you want to view relationships. a. Click Smart Construction > Find and select a category of object to query. b. Type the name of the object for which you want to search. c. Click OK. 3. Right-click an object in the search results and select Show All Relationships to view the object's relationships. For more information, see View relationships in the SmartPlant Foundation Desktop Client User's Guide. Intergraph Smart Construction Administration and Configuration Guide 63

64 Import Project Data into Smart Construction Create relationships among objects You can create relationships among project configuration objects at any time. 1. Log on SmartPlant Foundation Desktop Client as an administrator. 2. Find the objects for which you want to create a relationship. a. Click Smart Construction > Find and select a category of object to query. b. Type the name of the object for which you want to search. c. Click OK. 3. Drag one object on to another to create a relationship. For more information about manually creating relationships in SmartPlant Foundation, see Drag objects to create relationships in the SmartPlant Foundation Desktop Client User's Guide. Cancel or terminate relationships among objects Canceling or terminating relationships among project configuration objects can be helpful to manage changes in the construction project. 1. Log on the SmartPlant Foundation Desktop Client as an administrator. 2. Find the objects for which you would like to cancel or terminate a relationship. a. Click Smart Construction > Find and select a category of object to query. b. Type the name of the object for which you want to search. c. Click OK. 3. Right-click an object in the search results and select Terminate Relationships to cancel relationships for the object. For more information, see Terminate relationships in the SmartPlant Foundation Desktop Client User's Guide. Update a Commissioning System property on a drawing You can update the commissioning system property to fit your business needs. The commissioning system property must be added to a drawing using the ProjectConfiguration.xls workbook. 1. Log on the SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > 2D Drawings. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK. 5. Right-click the drawing you want to update and select Update to open the Update dialog box. 6. Edit the Commissioning System box. 7. Click Finish to save your changes. Intergraph Smart Construction Administration and Configuration Guide 64

65 Import Project Data into Smart Construction View construction resources and constraints You can view Smart Construction resources and constraints in the SmartPlant Foundation Desktop Client. Search for construction resources 1. Log on to the SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Construction Resources. 3. Type the name of the item in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. View construction resource details 1. Log on to the SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Construction Resources. 3. Type the name of the item in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Select the construction resource from the search results. 5. Right-click the construction resource and select Details to open the Details window. View relationships among construction resource objects 1. Log on the SmartPlant Foundation Desktop Client as an administrator. 2. Find the objects for which you want to create a relationship. a. Click Smart Construction > Find and select a category of object to query. b. Type the name of the object for which you want to search. c. Click OK. 3. Right-click an object in the search results. 4. Select Show All Relationships to view all relationships for the object. 5. Select Show Tree Node Child to view if the object has any members below it in the resource structure. 6. Select Show Tree Node Parent to view the object's category. 7. Select Show Work Package Constraint to view if the resource was added to an IWP as a constraint. Intergraph Smart Construction Administration and Configuration Guide 65

66 Import Project Data into Smart Construction Configure IIS to process large files You can configure the Maximum allowed content length (Bytes) option in the IIS Manager to process large file sizes. This setting is helpful when your project data file is large. 1. Open IIS Manager. 2. Navigate to and select your Smart Construction site under the Default Web Site node. 3. Right-click Request Filtering under the IIS section and select Open Feature. 4. Right-click the Hidden Segments tab in the Request Filtering window and select Edit Feature Settings. 5. Change the value for the Maximum allowed content length (Bytes) box to the desired value. 6. Click OK. You must recycle the Internet Information Services (IIS) application pools for your project's site. For more information on resetting IIS application pools, see IIS documentation. Consider adding 5 MB to your current input file size (input file size + 5 MB) as the value for the Maximum allowed content length (Bytes) box. Update security for services on the Import Project Data window When configuring your project data in the Import Project Data window, update the security access for users for the services your project is using. For example, if you plan to use only the Project Configuration service, you can remove access to the other listed services. For more information, see Configure access groups (on page 19). Export schedule You can export project schedule information from Smart Construction, including the relationships created in the Work Package Schedule window, to an XML file that you can import to your external scheduling system, such as Primavera P6. For more information on importing your schedule into Primavera P6, see Importing your schedule to Primavera P6 from Smart Construction (on page 67). If you set up your project configuration data in Smart Construction using the Project Configuration workbook, the WBSPath value is required if you plan to export your schedule data from Smart Construction and import it into Primavera P6. For more information, see Import project configuration data into Smart Construction (on page 54). 1. In Smart Construction, click Administration on the Smart Construction Standard Toolbar. 2. Select Export Schedule to open the Schedule Export dialog box. Intergraph Smart Construction Administration and Configuration Guide 66

67 3. Select a level of detail to export. 4. Click Filter CWPs. 5. Select which CWPs you want to export. Import Project Data into Smart Construction If you filter CWPs, use the search criteria to narrow your results. Only those CWPs are exported. 6. Click Export Options. 7. Select Include WBS hierarchy. 8. Select your schedule system source from the Use WBS hierarchy from list. 9. Type or browse to a file name and location in the Export File Location box. If you export your schedule from Smart Construction and import it into Primavera P6, the file name specified in the Smart Construction Export file location box is used as the Project Name and the ProjectID in Primavera P6. For example, if you name your schedule ExampleProject in the Smart Construction Export file location box, the Project Name in Primavera P6 is ExampleProject, and the Project ID in Primavera P6 is ExampleProject Select Export crew as resource to export crew details if you select to export schedule data at an IWP level. You can export named crews only. For more information, see Configure System Settings for Smart Construction (on page 31). See Importing your schedule to Primavera P6 from Smart Construction (on page 67) for more information on how to import crews into Primavera P6 software. 11. Click Export on the Schedule Export dialog box to export the schedule to an XML file. 12. Import the XML file to your external schedule system. For more information, see the documentation of your external scheduling system. Importing your schedule to Primavera P6 from Smart Construction After you export your schedule from Smart Construction, you can import it into Primavera P6, using the Import Wizard. The level of export you select in Smart Construction determines which level of the schedule becomes an activity in Primavera P6; all parent items in the schedule hierarchy become parent WBS nodes in Primavera P6. Contact Intergraph Customer Support ( for information regarding supported workflows. If importing data into Primavera P6, Intergraph recommends you select Hour as the Unit of Time for duration. In Primavera P6, click Edit > User Preferences to open the User Preferences dialog box. Select the Time Units tab. In the Durations Format section, select Hour in the Unit of Time box. The WBSPath on the Contract_CWP tab of the ProjectConfiguration.xls workbook is required if you plan to export your schedule from Smart Construction and import it into Primavera P6. For more information, see Import project configuration data into Smart Construction (on page 54). Intergraph Smart Construction Administration and Configuration Guide 67

68 Import Project Data into Smart Construction If you export your schedule from Smart Construction and import it into Primavera P6, the file name specified in the Smart Construction Export file location box is used as the Project Name and the ProjectID in Primavera P6. For example, if you name your schedule ExampleProject in the Smart Construction Export file location box, the Project Name in Primavera P6 is ExampleProject, and the Project ID in Primavera P6 is ExampleProject-1. Work planned in Smart Construction is displayed in Primavera P6 under the Labor Units section. Progress is measured as Physical % in Primavera P6. Importing your schedule at the IWP level If you export your schedule at the IWP level (select IWP on the Export Schedule dialog box) in Smart Construction and import it into Primavera P6, IWPs are imported as Activities in Primavera P6. Parent CWPs are imported as WBS nodes. If named crews are not configured or a crew is not selected, the IWP dates determine the duration. If actual start and finish dates are configured, the dates determine the duration. If actual start and finish dates are not set, planned start and finish dates determine the duration. If you export named crews from Smart Construction, you import the named crews into Primavera P6 as resources. For more information on named crew, see Configure and update system settings for Smart Construction (on page 31). Primavera creates an entry for each resource on the named crew. For example, if you have Named Crew with three members, Primavera P6 imports the crew as three resources - Named Crew (1), Named Crew (2), and Named Crew (3). The crew is assigned as a resource in Primavera P6, and the planned man hours of the IWP and the crew size determine the duration of the activity. If configured, the actual start and finish dates determine the duration. Importing your schedule at the component level If you export your schedule at the component level (select Component on the Export Schedule dialog box) in Smart Construction and import it into Primavera P6, components are imported as Activities in Primavera P6 with the planned start date and duration. Parent CWPs and IWPs are imported as WBS nodes. The components are sorted by the Smart Construction sequence number, which is displayed as the Activity ID in Primavera P6. Activities between WBS nodes (IWPs) have a relationship if the parent IWPs in Smart Construction have a dependency relationship in the Smart Construction Work Package Schedule window. Importing your schedule at the work step level If you export your schedule at the work step level (select Work Step on the Export Schedule dialog box) in Smart Construction and import it into Primavera P6, IWPs are imported as Activities in Primavera P6 with the planned start date and duration. Parent CWPs are imported as WBS nodes. Work steps are imported as steps. The work steps are sorted by the Smart Construction sequence number, which is displayed as the Activity ID in Primavera P6. Activities between WBS nodes (CWPs and IWPs) have a relationship if the parent IWPs in Smart Construction have a dependency relationship in the Smart Construction Work Package Schedule window. Intergraph Smart Construction Administration and Configuration Guide 68

69 S ECTION 11 Configure a Schedule System for Schedule Data Import Smart Construction can be configured to integrate directly with a schedule system through an open API. Once configured for integration, Smart Construction uses the schedule system to load Construction Work Packages (CWPs) into a project in the Import Project Data window. You can use either one of the following as the source for your schedule system in Smart Construction: Primavera P6 Software Development Kit (SDK) Primavera P6 Web Services To use either of these sources with Smart Construction, you must perform a set of configuration procedures before you can import schedule data into Smart Construction. If using Primavera Web Services as the source for your schedule system, SSL and message encryption are not supported for communication with Smart Construction. Intergraph Smart Construction Administration and Configuration Guide 69

70 Configure a Schedule System for Schedule Data Import Configuring a schedule system with Primavera P6 SDK Use the following steps to configure a schedule system that uses Primavera P6 Software Development Kit (SDK) as the schedule source. What do you want to do? Set up the schedule system source (on page 71) Configure the Primavera SDK schedule system (on page 72) Verify the schedule system is working (on page 73) Configure schedule mapping for import (on page 73) Import schedule data into Smart Construction (on page 78) Intergraph Smart Construction Administration and Configuration Guide 70

71 Configure a Schedule System for Schedule Data Import Set up the schedule system source The schedule system must be set up and configured before you begin to configure Smart Construction to use it as a source. To use the Primavera P6 SDK, you must install the SDK on the Smart Construction server and change a web server application pool identity for your Smart Construction site in IIS. Install Primavera P6 Software Development Kit (SDK) on the Smart Construction server If you are using the Primavera P6 Software Development Kit (SDK) as a source for your schedule system, you must install the SDK on the Smart Construction server. The Primavera P6 SDK setup maps the ODBC Data Source name with the associated database name. Smart Construction is compatible with the Primavera P6 version 8.3 SDK. The Primavera P6 user must have the View All Global Project Data via SDK security setting selected in Primavera P6 if using the SDK as a data source. If you are using Primavera P6 Web Services as your scheduling system source, you do not need to install the SDK. For detailed information about installing the Primavera P6 SDK, refer to your Primavera P6 documentation. Primavera support for its SDK is limited. While the majority of implementations using the SDK are successful, issues might be encountered that Primavera does not support. It might be necessary to use an alternative data source as the integration method between Primavera and Smart Construction. For example, you can import your exported Primavera schedule (as an XML file) into Smart Construction. Change the PrimaveraWCFServicePool user If you are setting up the Primavera P6 SDK for versions 8.2 or 8.3 of the software, you must change user account that is configured as the identity of the PrimaveraWCFServicePool application pool. By default, the PrimaveraWCFServicePool application pool identity is configured as the local system account. You must change the identity to a user account that can access a local copy of the PrmBootStrap.xml file. Typically, the user who installs the Primavera P6 SDK on the Smart Construction server will find the PrmBootStrap.xml file delivered to the location [Drive]:\Users\[User name]\appdata\local\oracle\primavera P6\P6 Professional. 1. Open the Internet Information Services (IIS) Manager. 2. Browse to the Application Pools node. 3. Right-click the PrimaveraWCFServicePool application pool and select Advanced Settings to open the Advanced Settings dialog box. 4. Under Process Model, select the Identity property and specify the user account. 5. Click OK and close the Internet Information Services (IIS) Manager. After you change the PrimaveraWCFServicePool user, recycle the Internet Information Services (IIS) application pools for your project's site. For more information on resetting IIS application pools, see IIS documentation. Intergraph Smart Construction Administration and Configuration Guide 71

72 Configure a Schedule System for Schedule Data Import Configure the Primavera SDK schedule system To use the Primavera P6 Software Development Kit (SDK) as a schedule source, you must configure the connection information for that source using the SmartPlant Foundation Desktop Client. For information on using the Primavera P6 SDK as your schedule source, see Install Primavera P6 Software Development Kit (SDK) on the Smart Construction server (on page 71). Your active scope must be set before configuring a schedule system in Smart Construction. For more information, see Set your active scope in SmartPlant Foundation Desktop Client in the Intergraph Smart Construction Installation and Setup Guide. The Primavera P6 user must have the View All Global Project Data via SDK security setting selected in Primavera P6 if using the SDK as a data source. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > New > Administration > Schedule System to open the New Schedule System form. If the Schedule System object has already been created, click Smart Construction > Find > Administration > Schedule System to search for the schedule system object, and in the search results list, right-click the name of the schedule system and click Update. 3. Define the details for the Primavera SDK in the Primavera SDK Settings details section. An ENS definition automatically names the schedule system with the name of the Smart Construction plant name in SmartPlant Foundation. The DSN must match the system DSN in the ODBC for the Primavera P6 SDK. The System login and System password must match the login name and password for Primavera P6. If you are using Primavera P6 v7.0, type 0 in the Schedule System Access Level box. If you are using Primavera P6 v8.2 or 8.3, type -1 in the Schedule System Access Level box. Smart Construction hides your password in SmartPlant Foundation Desktop Client. 4. Click Apply or Finish to create or update the schedule system. Intergraph Smart Construction Administration and Configuration Guide 72

73 Configure a Schedule System for Schedule Data Import Verify the schedule system is working 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Schedule System to open the Find Schedule System dialog box. 3. Type a name of a schedule system in the Find Schedule System dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. In the search results list, right-click the name of the schedule system and click Test SDK Service. 5. After reviewing either the success or failure message, click OK. The test attempts to connect to Primavera P6 using the connection information provided for the schedule system. If you receive an error message, you should review the connection information on the schedule system object. See Configure the Primavera SDK schedule system (on page 72) for more information. Configure schedule mapping for import You must map properties from your scheduling file to properties in Smart Construction. The following detailed work process explains how to configure your schedule mapping for import into Smart Construction. You must configure a vault for files attached to the configuration document objects in SmartPlant Foundation. For more information, see Configure a vault for files attached to configuration documents in the Intergraph Smart Construction Installation and Setup Guide. 1. Open the Primavera Schedule SDK Mappings.xlsm workbook. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). 2. Click the Primavera Schedule SDK tab. 3. Edit values for your schedule. The Primavera P6 SDK documentation (p6_pro_sdk.chm) provides helpful information about which values to map to for the project-level and task-level WBS entries. The project-level entries can map to the PROJWBS table in the help file, and task-level entries can map to the TASK table in the help file. The field name in Primavera P6 maps to properties in Smart Construction. If you enter data in the mapping workbook and later decide to remove the data, right-click the cell in Excel and select Clear Contents. For more information on how to edit the workbook, click Structure of the workbook (on page 74). If a Smart Construction property does not exist for the custom property, you must extend the Smart Construction schema to include the custom property. For more information, see Extend the Smart Construction Schema (on page 211) 4. Click Save to save your changes in the workbook file. Intergraph Smart Construction Administration and Configuration Guide 73

74 Configure a Schedule System for Schedule Data Import 5. Open the Main tab of the Primavera Schedule SDK Mappings.xlsm workbook. 6. Click Generate Primavera Schedule SDK Mapping to generate the Primavera Schedule SDK Mappings.xml file. 7. Check in and sign off the Primavera Schedule SDK Mappings.xlsm workbook and Primavera Schedule SDK Mappings.xml file into the SmartPlant Foundation Desktop Client. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). If you are generating the Primavera schedule mapping data for the first time, attach the Primavera Schedule SDK Mappings.xlsm workbook and XML file to the Primavera Schedule SDK Mappings configuration document in the SmartPlant Foundation Desktop Client. For more information, see Attach the mappings workbook and XML files to the Primavera Schedule SDK Mappings configuration document (on page 77). Primavera Schedule SDK Mappings.xlsm details Use topics in the following section to learn more about the Primavera Schedule SDK Mappings.xlsm workbook. Installation and location of the workbook When Smart Construction is installed on a server, the Primavera Schedule SDK Mappings.xlsm is delivered to the Import Project Data Systems folder in the Templates folder of the installation location (for example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates\import Project Data Systems to find Primavera Schedule SDK Mappings.xlsm). Structure of the workbook The Primavera Schedule SDK Mappings.xlsm workbook contains two tabs. The Main tab generates an XML file and saves it in the location specified when the file is checked out. The Primavera Schedule SDK tab contains data and properties that are to be imported into Smart Construction. Main tab The Main tab is located on the first sheet of the workbook. It contains the Generate Primavera Schedule SDK Mapping button, which generates the XML file and saves it in the location specified when the file is checked out. The Generate Primavera Schedule SDK Mapping button should not be renamed or removed because it contains a macro. The code behind the button should not be modified or removed. Primavera Schedule SDK tab The Primavera Schedule SDK tab contains data and properties that are to be imported into Smart Construction. Column names are fixed and cannot be modified. Columns can be moved to different locations on the same sheet. Intergraph Smart Construction Administration and Configuration Guide 74

75 Configure a Schedule System for Schedule Data Import Do not add new columns. Smart Construction does not read or handle any newly added columns. Column Header Entity Attribute SPCInterface SPCProperty Argument Explanation Identifies the table name. For example, the PROJWBS table in Primavera P6 (limited to WBS currently). Identifies the Column name in the Project WBS. An attribute can also be a UDF. A Smart Construction Interface definition realizing the specified SPCProperty value. A Smart Construction Property definition realized by the specified SPCInterface. Identifies a method (from the Project Data Mappings service) and argument list (optional, depending on the method) to generate the requested value from the Primavera WBS data. The Primavera P6 SDK documentation (p6_pro_sdk.chm) provides helpful information about which values to map to for the project-level and task-level WBS entries. The project-level entries can map to the PROJWBS table in the help file, and task-level entries can map to the TASK table in the help file. The field name in Primavera P6 maps to properties in Smart Construction. For more information on configuring UDFs and mapping arguments, see Configure a User-Defined Field (UDF) in your Smart Construction mapping (on page 50) or Mapping arguments for your Smart Construction project data (on page 51). Configure a User-Defined Field (UDF) in your Smart Construction mapping In Primavera P6, User-Defined fields (UDFs) are custom fields, created to track information specific to your project, WBS, or activities. To use these UDFs in your Smart Construction project, you must map the UDF from Primavera to data in Smart Construction. You can create this mapping in the Primavera schedule mapping workbooks. Column Header Entity Explanation Identifies a P6 object type, which appears as a node in the exported Primavera PM (XML) file (limited to WBS currently). Intergraph Smart Construction Administration and Configuration Guide 75

76 Configure a Schedule System for Schedule Data Import Column Header Attribute SPCInterface SPCProperty Argument Explanation Identifies the UDF to be mapped, using the syntax UDF.[UDF title or name]. If the UDF is on an activity, use the syntax ACTIVITY:UDF.[UDF title or name]. A Smart Construction Interface definition realizing the specified SPCProperty value. A Smart Construction Property definition realized by the specified SPCInterface. Identifies a method (from the Project Data Mappings service) and argument list (optional, depending on the method) to generate the desired value from the Primavera WBS data. If you are mapping a one-to-one relationship between a UDF and a Smart Construction property, the Argument column is left blank. For example, if you have a UDF named Discipline in your Primavera P6 system, you can map it like the following: Mapping arguments for your Smart Construction project data You can specify arguments for your project data in the Argument column of the Primavera mappings workbooks. You can map arguments in order to call an external mapping function, allowing you to personalize your project data. The following list defines the default methods provided by the Project Data Mappings service: BuildWBSPath() this method builds a WBS path based on the WBS hierarchy from the Primavera project data; the resulting value mirrors the value generated by the former Refresh Schedule command. CalculateEarlyStartDate() this method calculates the early start date for WBS items transforming to CWPs. CalculateEarlyFinishDate() this method calculates the early finish date for WBS items transforming to CWPs. CalculateLateStartDate() this method calculates the late start date for WBS items transforming to CWPs. CalculateLateFinishDate() this method calculates the late finish date for WBS items transforming to CWPs. MinDate(Activity:DateField) this method calculates the earliest date from all Activities under a WBS item, using the date field specified. Intergraph Smart Construction Administration and Configuration Guide 76

77 Configure a Schedule System for Schedule Data Import MaxDate(Activity:DateField) this method calculates the latest date from all Activities under a WBS item, using the date field specified. RollupValue(Activity:P6Field) this method calculates a sum from all Activities under a WBS item, using the numeric field specified. Attach the mappings workbook and XML files to the Primavera Schedule SDK Mappings configuration document After you generate schedule mapping data for your project for the first time, you must attach the Primavera Schedule SDK Mappings.xlsm workbook and XML file to the Primavera Schedule SDK Mappings configuration document located in the SmartPlant Foundation Desktop Client. The SmartPlant Foundation Desktop Client stores the document, allowing users with the proper permissions to check the document out and in with revisions. Set your Create scope in the SmartPlant Foundation Desktop Client to the configuration top when attaching files to a Smart Construction configuration document. 1. Click Smart Construction > Find > Administration > Configuration Documents to open the Query for Configuration Documents dialog box. 2. Type your search criteria and click Finish to find the configuration documents. 3. In the search results, right-click the Primavera Schedule SDK Mappings document and select Files > Attach File to open the Attach File dialog box. 4. Click Add File and browse to the Primavera Schedule SDK Mappings.xlsm workbook and Primavera Schedule SDK Mappings.xml files. 5. Click Open, and then click OK to add the files to the list. 6. Click Finish. Use the SmartPlant Foundation Desktop Client to manage the Primavera Schedule SDK Mappings.xlsm workbook After it is attached to the Primavera Schedule SDK Mappings configuration document, the Primavera Schedule SDK Mappings.xlsm workbook and Primavera Schedule SDK Mappings.xml file can be managed in the SmartPlant Foundation Desktop Client. For more information, see Attach the mappings workbook and XML files to the Primavera Schedule SDK Mappings configuration document (on page 77). You can check the documents in and out, and you also can sign off the documents. The SmartPlant Foundation Desktop Client can manage the versions and revisions of the documents. For more information about document management in the SmartPlant Foundation Desktop Client, see the SmartPlant Foundation Desktop Client User's Guide. Intergraph Smart Construction Administration and Configuration Guide 77

78 Configure a Schedule System for Schedule Data Import Import schedule data into Smart Construction In order to see a project data system in the Import Project Data window in Smart Construction, the access group SPC_ScheduleUpdate (or the access group assigned to the user who is allowed to use this feature) must be associated with the project data system object. For new sites created with version 2017 and later, in order to see the Primavera SDK and Primavera Web Services data sources, you need to associate them with the appropriate access group. For more information on access groups, see Configure access groups (on page 19). 1. Log on to Smart Construction as an administrator. 2. Click Administration > Import Project Data. 3. In the Import Project Data window, select a system name in the System Name box. 4. Click Settings. 5. Edit your project settings for the project data system, and then click OK. Use the Browse dialog box to navigate to the Microsoft Excel workbook that contains the project data you want to load or the XML file that contains the Primavera schedule you want to load. Confirm the schedule settings for your schedule system. 6. Using the table in the Import Project Data window, select the objects from the file that you want to load into your Smart Construction database. The grid displays the contents of the input source. If a Microsoft Excel workbook contains multiple sheets, each sheet appears in the window as a separate tab of the table. For each item found in the input source, the Action column indicates which process is needed to synchronize the data file with the database. Use the options in the Quick Selection pane for fast navigation and selection of your data. 7. Select the check boxes by the items to be added to the database, modified in the database, or removed from the database. Select the check box in the Name column to apply all changes to the object. You can select individual check boxes for an object to apply specific changes to that object. 8. Click Process. This process creates a new SmartPlant Foundation design document and attaches an XML file that includes the content of the selected data file. The document name is [System Name]_[Service Name]. This document cannot be checked out. It is managed by Smart Construction and exists in the CURRENT state. If your import project data file is large in size, you can configure IIS to process large file sizes. For more information, see Configure IIS to process large files (on page 66). Intergraph Smart Construction Administration and Configuration Guide 78

79 Configure a Schedule System for Schedule Data Import For more information on the Import project data window, see Learn more about the Import Project Data window in the Intergraph Smart Construction User's Guide. If you remove a CWP from your project data but the CWP is associated with an IWP, the CWP cannot be deleted. Configuring a schedule system with Primavera P6 Web Services Use the following steps to configure a schedule system that uses Primavera P6 Web Services as the schedule source. What do you want to do? Set up the schedule system source (on page 80) Configure the Primavera Web Services schedule system (on page 80) Verify the schedule system is working (on page 80) Configure schedule mapping for import (on page 81) Import schedule data into Smart Construction (on page 86) Intergraph Smart Construction Administration and Configuration Guide 79

80 Configure a Schedule System for Schedule Data Import Set up the schedule system source The schedule system must be set up and configured before you begin to configure Smart Construction to use it as a source. For guidance on setting up Primavera P6 Web Services, consult your Oracle documentation. If using Primavera Web Services as the source for your schedule system, SSL and message encryption are not supported for communication with Smart Construction. Configure the Primavera Web Services schedule system To use Primavera P6 Web Services as your schedule source, you must configure the connection information for that source using the SmartPlant Foundation Desktop Client. For information on implementing P6 Web Services, refer to your Primavera documentation. Your active scope must be set before configuring a schedule system in Smart Construction. For more information, see Set your active scope in SmartPlant Foundation Desktop Client in the Intergraph Smart Construction Installation and Setup Guide. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > New > Administration > Schedule System to open the New Schedule System form. If the Schedule System object has already been created, click Smart Construction > Find > Administration > Schedule System to search for the schedule system object, and in the search results list, right-click the name of the schedule system and click Update. 3. If using Primavera Web Services, complete the Primavera Web Service Settings details section. The P6 Web Services Host requires both the host name and TCP port number of the Primavera Web Services host. For example, P6host: Click Apply or Finish to create or update the schedule system. Verify the schedule system is working 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Schedule System to open the Find Schedule System dialog box. 3. Type a name of a schedule system in the Find Schedule System dialog box. Click OK. 4. In the search results list, right-click the name of the schedule system and click Test Web Service. 5. After reviewing either the success or failure message, click OK. The test attempts to connect to Primavera P6 using the connection information provided for the schedule system. If you receive an error message, you should review the connection information on the schedule system object. See Configure the Primavera SDK schedule system (on page 72) for more information. Intergraph Smart Construction Administration and Configuration Guide 80

81 Configure a Schedule System for Schedule Data Import Configure schedule mapping for import You must map properties from your scheduling file to properties in Smart Construction. The following detailed work process explains how to configure your schedule mapping for import into Smart Construction. You must configure a vault for files attached to the configuration document objects in SmartPlant Foundation. For more information, see Configure a vault for files attached to configuration documents in the Intergraph Smart Construction Installation and Setup Guide. 1. Open the Primavera Schedule Web Mappings.xlsm workbook. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). 2. Click the Primavera Schedule Web tab. 3. Edit values for your schedule. 4. Click Save to save your changes in the workbook file. The field name in Primavera P6 maps to properties in Smart Construction. If you enter data in the mapping workbook and later decide to remove the data, right-click the cell in Excel and select Clear Contents. For more information on how to edit the workbook, see Structure of the workbook (on page 49) If a Smart Construction property does not exist for the custom property, you must extend the Smart Construction schema to include the custom property. For more information, see Extend the Smart Construction Schema (on page 211) 5. Open the Main tab of the Primavera Schedule Web Mappings.xlsm workbook. 6. Click Generate Primavera Schedule Web Mapping to generate the Primavera Schedule Web Mappings.xml file. 7. Check in and sign off the Primavera Schedule Web Mappings.xlsm workbook and Primavera Schedule Web Mappings.xml file into the SmartPlant Foundation Desktop Client. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). If you are generating the Primavera schedule mapping data for the first time, attach the Primavera Schedule Web Mappings.xlsm workbook and XML file to the Primavera Schedule Web Mappings configuration document in the SmartPlant Foundation Desktop Client. see Attach the mappings workbook and XML files to the Primavera Schedule SDK Mappings configuration document (on page 77). Intergraph Smart Construction Administration and Configuration Guide 81

82 Configure a Schedule System for Schedule Data Import Primavera Schedule Web Mappings.xlsm details Use topics in the following section to learn more about the Primavera Schedule Web Mappings.xlsm workbook. Installation and location of the workbook When Smart Construction is installed on a server, the Primavera Schedule Web Mappings.xlsm is delivered to the Import Project Data Systems folder in the Templates folder of the installation location (for example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates\import Project Data Systems to find Primavera Schedule Web Mappings.xlsm). Structure of the workbook The Primavera Schedule Web Mappings.xlsm workbook contains two tabs. The Main tab generates an XML file and saves it in the location specified when the file is checked out. The Primavera Schedule Web tab contains data and properties that are to be imported into Smart Construction. Main tab The Main tab is located on the first sheet of the workbook. It contains the Generate Primavera Schedule Web Mapping button, which generates the XML file and saves it in the location specified when the file is checked out. The Generate Primavera Schedule Web Mapping button should not be renamed or removed because it contains a macro. The code behind the button should not be modified or removed. Primavera Schedule Web tab The Primavera Schedule Web tab contains data and properties that are to be imported into Smart Construction. Column names are fixed and cannot be modified. Columns can be moved to different locations on the same sheet. Do not add new columns. Smart Construction does not read or handle any newly added columns. Column Header Entity Attribute Explanation Identifies the table name. For example, the PROJWBS table in Primavera P6 (limited to WBS currently). Identifies the Column name in the Project WBS. An attribute can also be a UDF. Intergraph Smart Construction Administration and Configuration Guide 82

83 Configure a Schedule System for Schedule Data Import Column Header SPCInterface SPCProperty Argument Explanation A Smart Construction Interface definition realizing the specified SPCProperty value. A Smart Construction Property definition realized by the specified SPCInterface. Identifies a method (from the Project Data Mappings service) and argument list (optional, depending on the method) to generate the requested value from the Primavera WBS data. The field name in Primavera P6 maps to properties in Smart Construction. For more information on configuring UDFs and mapping arguments, see Configure a User-Defined Field (UDF) in your Smart Construction mapping (on page 50) or Mapping arguments for your Smart Construction project data (on page 51). Configure a User-Defined Field (UDF) in your Smart Construction mapping In Primavera P6, User-Defined fields (UDFs) are custom fields, created to track information specific to your project, WBS, or activities. To use these UDFs in your Smart Construction project, you must map the UDF from Primavera to data in Smart Construction. You can create this mapping in the Primavera schedule mapping workbooks. Column Header Entity Attribute SPCInterface SPCProperty Explanation Identifies a P6 object type, which appears as a node in the exported Primavera PM (XML) file (limited to WBS currently). Identifies the UDF to be mapped, using the syntax UDF.[UDF title or name]. If the UDF is on an activity, use the syntax ACTIVITY:UDF.[UDF title or name]. A Smart Construction Interface definition realizing the specified SPCProperty value. A Smart Construction Property definition realized by the specified SPCInterface. Intergraph Smart Construction Administration and Configuration Guide 83

84 Configure a Schedule System for Schedule Data Import Column Header Argument Explanation Identifies a method (from the Project Data Mappings service) and argument list (optional, depending on the method) to generate the desired value from the Primavera WBS data. If you are mapping a one-to-one relationship between a UDF and a Smart Construction property, the Argument column is left blank. For example, if you have a UDF named Discipline in your Primavera P6 system, you can map it like the following: Mapping arguments for your Smart Construction project data You can specify arguments for your project data in the Argument column of the Primavera mappings workbooks. You can map arguments in order to call an external mapping function, allowing you to personalize your project data. The following list defines the default methods provided by the Project Data Mappings service: BuildWBSPath() this method builds a WBS path based on the WBS hierarchy from the Primavera project data; the resulting value mirrors the value generated by the former Refresh Schedule command. CalculateEarlyStartDate() this method calculates the early start date for WBS items transforming to CWPs. CalculateEarlyFinishDate() this method calculates the early finish date for WBS items transforming to CWPs. CalculateLateStartDate() this method calculates the late start date for WBS items transforming to CWPs. CalculateLateFinishDate() this method calculates the late finish date for WBS items transforming to CWPs. MinDate(Activity:DateField) this method calculates the earliest date from all Activities under a WBS item, using the date field specified. MaxDate(Activity:DateField) this method calculates the latest date from all Activities under a WBS item, using the date field specified. RollupValue(Activity:P6Field) this method calculates a sum from all Activities under a WBS item, using the numeric field specified. Intergraph Smart Construction Administration and Configuration Guide 84

85 Configure a Schedule System for Schedule Data Import Attach the mappings workbook and XML files to the Primavera Schedule Web Mappings configuration document After you generate schedule mapping data for your project for the first time, you must attach the Primavera Schedule Web Mappings.xlsm workbook and XML file to the Primavera Schedule Web Mappings configuration document located in the SmartPlant Foundation Desktop Client. The SmartPlant Foundation Desktop Client stores the document, allowing users with the proper permissions to check the document out and in with revisions. Set your Create scope in the SmartPlant Foundation Desktop Client to the configuration top when attaching files to a Smart Construction configuration document. 1. Click Smart Construction > Find > Administration > Configuration Documents to open the Query for Configuration Documents dialog box. 2. Type your search criteria and click Finish to find the configuration documents. 3. In the search results, right-click the Primavera Schedule Web Mappings document and select Files > Attach File to open the Attach File dialog box. 4. Click Add File and browse to the Primavera Schedule Web Mappings.xlsm workbook and Primavera Schedule Web Mappings.xml files. 5. Click Open, and then click OK to add the files to the list. 6. Click Finish. Use the SmartPlant Foundation Desktop Client to manage the Primavera Schedule Web Mappings.xlsm workbook After it is attached to the Primavera Schedule Web Mappings configuration document, the Primavera Schedule Web Mappings.xlsm workbook and Primavera Schedule Web Mappings.xml file can be managed in the SmartPlant Foundation Desktop Client. For more information, see Attach the mappings workbook and XML files to the Primavera Schedule Web Mappings configuration document (on page 85). You can check the documents in and out, and you also can sign off the documents. The SmartPlant Foundation Desktop Client can manage the versions and revisions of the documents. For more information about document management in the SmartPlant Foundation Desktop Client, see the SmartPlant Foundation Desktop Client User's Guide. Intergraph Smart Construction Administration and Configuration Guide 85

86 Configure a Schedule System for Schedule Data Import Import schedule data into Smart Construction In order to see a project data system in the Import Project Data window in Smart Construction, the access group SPC_ScheduleUpdate (or the access group assigned to the user who is allowed to use this feature) must be associated with the project data system object. For new sites created with version 2017 and later, in order to see the Primavera SDK and Primavera Web Services data sources, you need to associate them with the appropriate access group. For more information on access groups, see Configure access groups (on page 19). 1. Log on to Smart Construction as an administrator. 2. Click Administration > Import Project Data. 3. In the Import Project Data window, select a system name in the System Name box. 4. Click Settings. 5. Edit your project settings for the project data system, and then click OK. Use the Browse dialog box to navigate to the Microsoft Excel workbook that contains the project data you want to load or the XML file that contains the Primavera schedule you want to load. Confirm the schedule settings for your schedule system. 6. Using the table in the Import Project Data window, select the objects from the file that you want to load into your Smart Construction database. The grid displays the contents of the input source. If a Microsoft Excel workbook contains multiple sheets, each sheet appears in the window as a separate tab of the table. For each item found in the input source, the Action column indicates which process is needed to synchronize the data file with the database. Use the options in the Quick Selection pane for fast navigation and selection of your data. 7. Select the check boxes by the items to be added to the database, modified in the database, or removed from the database. Select the check box in the Name column to apply all changes to the object. You can select individual check boxes for an object to apply specific changes to that object. 8. Click Process. This process creates a new SmartPlant Foundation design document and attaches an XML file that includes the content of the selected data file. The document name is [System Name]_[Service Name]. This document cannot be checked out. It is managed by Smart Construction and exists in the CURRENT state. If your import project data file is large in size, you can configure IIS to process large file sizes. For more information, see Configure IIS to process large files (on page 66). Intergraph Smart Construction Administration and Configuration Guide 86

87 Configure a Schedule System for Schedule Data Import For more information on the Import project data window, see Learn more about the Import Project Data window in the Intergraph Smart Construction User's Guide. If you remove a CWP from your project data but the CWP is associated with an IWP, the CWP cannot be deleted. Intergraph Smart Construction Administration and Configuration Guide 87

88 S ECTION 12 Configure the Rules of Progress Smart Construction provides the ability to automatically assign work steps, along with their man hours and rates, to components in IWPs. These work steps form the basis of determining the completion status of an IWP. Administrators can configure rules of progress data to generate and associate work steps with components. By default, the Rules of Progress Service delivered with Smart Construction communicates with an XML file generated from a Microsoft Excel workbook that is delivered with the Smart Construction server installation. The Smart Construction administrator can check out and modify the workbook, then generate a new XML file with rules of progress data for the Smart Construction site to fit the specific needs of an organization. The rules of progress data in the generated XML file are associated with components during the Smart Construction retrieve. After a retrieve is started, the Smart Construction Rules of Progress queue generates and associates the rules of progress information with retrieved components. The Rules of Progress queue creates a separate scheduler task, SPC Process ROP Scheduler, to relate the scheduler to the Rules of Progress queue. The SPC Process ROP Scheduler task regularly polls the queue to process the rules of progress data for retrieved documents. If you choose not to use the delivered workbook or XML configuration file or if you already have a rules of progress system, you can create your own version of the Rules of Progress Service. In order to do this, you must implement the IRulesOfProgress WCF Service Contract and create a rules of progress component as described in the Intergraph Smart Construction API and Programmer's Guide. Configure the rules of progress in the rules of progress workbook The following is a detailed work process that explains how to populate the ROP Configuration.xlsm workbook with rules of progress data. The Rules of Progress is managed using a configuration template and XML files. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). You must configure a vault for files attached to the configuration document objects in SmartPlant Foundation. For more information, see Configure a vault for files attached to configuration documents in the Intergraph Smart Construction Installation and Setup Guide. Intergraph recommends that you store and manage your rules of progress data in SmartPlant Foundation Desktop Client; however, you can configure rules of progress data locally from the web site folder on the Smart Construction server in order to test and validate the data prior to storing and managing the configuration document in SmartPlant Foundation Desktop Client. For more information about testing and validating locally, see Test and validate rules of progress data locally in the Intergraph Smart Construction Rules of Progress Configuration Guide. Intergraph Smart Construction Administration and Configuration Guide 88

89 Edit and add rules of progress data for component classes Configure the Rules of Progress 1. Open the ROP Configuration.xlsm workbook. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). 2. Select a rate table tab to open rate table worksheet. Add a new worksheet to your workbook, if you want to add a new rate table to define work steps. If you add a new rate table tab to the ROP Configuration.xlsm workbook, you must copy the correct header and metadata to the new tab. Open a delivered tab, select rows 1 through 6 and columns A through F, copy and paste the data onto a new tab. 3. Define the component class definition type in the Component Classes row (starting in row 1, column B). Separate entries with commas for multiple class definitions. These class definitions match class definitions of objects published to SmartPlant Foundation. In the following example, the class definitions include P3DPipe, P3DPipeRun, PDS_Dwg_Pipe, and PDS_Pwg_PipeRun. Any component mapped to these component class definitions use the values defined on the rate table worksheet. 4. Define the lookup values for the class definition. Lookup values are preceded with a tilde (~) and are property definition names. In the following example, the lookup values include SPC_ComponentItem_Size, SPC_ComponentItem_Thickness, SPC_ComponentItem_Material, and unit of measure (UoM). You can specify a range for lookup values that are scoped by double or a unit of measure (UoM) type in the schema. For example, you can specify a range for ~SPC_ComponentItem_Size and ~SPCComponentItem_Rating. If using a range, type ([Minimum value],[maximum value]). You can specify a list of properties for string lookup values, such as ~SPC_ComponentItem_Thickness. If using a list of values, type {Property value Property value}. The list can only be applied to one lookup value per row. Multiple values must be separated by the pipe ( ) in braces; these values are treated as an OR value. For example, {XS XXS} would match all lookup values with a thickness of XS or XXS. You can specify a UoM along with a lookup value that does not use a wildcard. Provide a value or range, add a tilde (~), and type the UoM display value, as displayed in SmartPlant Foundation. For example, you can search for a specific value, like 20~in, or Intergraph Smart Construction Administration and Configuration Guide 89

90 Configure the Rules of Progress a range of values, like (3-6)~m. If no matches are found using the value and the UoM, then the value is considered without the specified UoM. If no match is found using only the value, the rules of progress will attempt to match using wildcard values. If you specify a UoM for one lookup value, you must also specify UoMs for all other lookup values that support UoMs in the same row. The wildcard values * and? can be used to define lookup values. If there is an exact match (all lookup columns match the values on the component exactly), the rules of progress uses that row. Otherwise, the rules of progress attempts a match on the rows that contain wildcards. If multiple rows that contain wildcards are a match, the rules of progress uses the first match. The wildcard values cannot be used to look up the ~UOM lookup value. You cannot use a wildcard value as a part of a range. The wildcard value * finds any string of values. And, the wildcard value? finds one value. The ~UOM lookup value is required. If you type data in the ROP Configuration.xlsm workbook and decide to remove the data, right-click the cell in Excel and select Clear Contents. 5. In the purpose and work step column, define the IWP purpose in the first row below the component class definitions, the sequence number in the second row, and the work step name in the third row. The IWP purpose must be spelled exactly the same as the purpose defined in the FIWP purposes enumerated list. For more information, see Configure Work Package Disciplines and Purposes (on page 140) The work step name is limited to 100 characters or fewer. The sequence number is optional. All purpose and work step columns in a rate table tab must have sequences defined, or Smart Construction defines the sequence of work steps. In the following example, components with the Component Classes of P3DPipeRun, PDS_Dwg, and PDS_Dwg_PipeRun in an Installation IWP have the work step Install associated. 6. Type [Consumes material] in the row below the work step name to specify which work step is to consume the materials. 7. Designate a new work step rate basis for the given lookup row in the <Rate Basis> column, or designate a new work step rate basis in the fifth row of the purpose and work step column. 8. If you choose use the default rate basis, Smart Construction calculates the rate based on units of a component. For more information, see Designate work step rate basis in the Intergraph Smart Construction Rules of Progress Configuration Guide. Intergraph Smart Construction Administration and Configuration Guide 90

91 Configure the Rules of Progress 9. Define a rate for the new work step value in the purpose and work step column. 10. Save your changes in the workbook file. Generate the XML file and retrieve documents 1. Open the Main tab of the workbook. 2. Click Generate configuration file to generate the XML mapping to be used during retrieve. After you generate the configuration file, Smart Construction informs you of any validation errors in the ROP Configuration.xlsm. Smart Construction highlights the tabs containing errors and, within those tabs, the cells containing errors. 3. Verify the XML file generated to the location you specified when you checked out the files. If generating rules of progress data for the first time, browse to the Templates\ROP Configuration folder in the installation location. For example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates\rop Configuration to find the generated XML file. 4. Check in and sign off the workbook. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). 5. Retrieve documents into Smart Construction. For more information, see Getting Data into Smart Construction (on page 102). 6. Verify the correct work steps, rates, and values are associated with the correct type of component. Attach the ROP Configuration workbook and XML files to the Rules of Progress configuration document After you generate rules of progress data for your project for the first time, you must attach the ROP Configuration workbook and XML file to the Rules of Progress configuration document located in the SmartPlant Foundation Desktop Client. The SmartPlant Foundation Desktop Clients stores the document, allowing users with the proper permissions to check the document out and in with revisions. Set your Create scope in the SmartPlant Foundation Desktop Client to the configuration top when attaching files to a Smart Construction configuration document. 1. Click Smart Construction > Find > Administration > Configuration Documents to open the Query for Configuration Documents dialog box. 2. Type your search criteria and click Finish to find the configuration documents. 3. In the search results, right-click the Rules of Progress document and select Files > Attach File to open the Attach File dialog box. 4. Click Add File and browse to the ROP Configuration.xlsm workbook and XML files. 5. Click Open, and then click OK to add the files to the list. 6. Click Finish. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). Intergraph Smart Construction Administration and Configuration Guide 91

92 S ECTION 13 Configure Mapped Properties for a Published Document Mapping is required to retrieve documents into the Smart Construction domain. Mapping helps define properties and data that will be retrieved into Smart Construction from the publishing tool. Tools, such as Smart 3D, can publish documents to the SmartPlant Foundation data warehouse. The data warehouse can be configured with a Smart Construction server and project. After tools publish to the data warehouse, documents can be retrieved into the Smart Construction domain. Before you retrieve documents into Smart Construction, administrators can check out and edit the SPCRetrieveMappings.xlsm file to map properties and data related to the documents between the publishing tool and Smart Construction. After mapping properties in the SPCRetrieveMappings.xlsm workbook, administrators can then generate an XML file from the SPCRetrieveMappings.xlsm that is used to map properties during retrieve. During a retrieve operation, Smart Construction gets the view files and data files associated with the published document that is being retrieved. The data files contain engineering data exposed by various 3D models and 2D drawings generated by the various Intergraph engineering tools. These data files contain the component list and relationships you see in the engineering tools, as well as Smart Construction. For more information, see the Intergraph Smart Construction Customization Guide. Intergraph Smart Construction Administration and Configuration Guide 92

93 Configure Mapped Properties for a Published Document Map properties and generate XML for a Smart Construction retrieve Use the following work process to map properties and generate XML for a Smart Construction retrieve. Retrieve mapping is managed using a configuration template and XML files. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). You must configure a vault for files attached to the configuration document objects in SmartPlant Foundation. For more information, see Configure a vault for files attached to configuration documents in the Intergraph Smart Construction Installation and Setup Guide. Map properties in the mapping workbook 1. Open the SPCRetrieveMappings.xlsm file. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). 2. Edit the SPCRetrieveMappings.xlsm file. 3. Save your changes in the workbook file. Generate XML and retrieve documents 1. Open the Main tab of the workbook. 2. Click Generate Retrieve Mapping to generate the XML map file to be used during retrieve. 3. Verify that the XML file was generated to the location you specified when you checked out the files. If generating the retrieve mapping data for the first time, browse to the Templates\Retrieve Mappings folder in the installation location. For example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates\retrieve Mappings to find the generated XML file. 4. Check in and sign off the workbook. For more information on managing configuration files for Smart Construction, see Manage Template Files for Smart Construction (on page 34). If generating retrieve mappings for your project for the first time, attach the SPCRetrieveMappings.xlsm workbook and XML file to the Retrieve Mappings configuration document located in the SmartPlant Foundation Desktop Client. The SmartPlant Foundation Desktop Client stores the document, allowing users with the proper permissions to check the document out and in with revisions. For more information, see Attach the SPCRetrieveMappings.xlsm and XML files to the Retrieve Mappings configuration document (on page 94). 5. Retrieve documents into Smart Construction. For more information, see Getting Data into Smart Construction (on page 102). For more information on the retrieve process after mapping the properties, see Retrieve process after mapping properties in the Intergraph Smart Construction Customization Guide. Intergraph Smart Construction Administration and Configuration Guide 93

94 Configure Mapped Properties for a Published Document Attach the SPCRetrieveMappings.xlsm and XML files to the Retrieve Mappings configuration document If generating retrieve mappings for your project for the first time, attach the SPCRetrieveMappings.xlsm workbook and XML file to the Retrieve Mappings configuration document located in the SmartPlant Foundation Desktop Client. The SmartPlant Foundation Desktop Client stores the document, allowing users with the proper permissions to check the document out and in with revisions. Set your Create scope in the SmartPlant Foundation Desktop Client to the configuration top when attaching files to a Smart Construction configuration document. 1. Click Smart Construction > Find > Administration > Configuration Documents to open the Query for Configuration Documents dialog box. 2. Type your search criteria and click Finish to find the configuration documents. 3. In the search results, right-click the Retrieve Mappings document and select Files > Attach File to open the Attach File dialog box. 4. Click Add File and browse to the SPCRetrieveMappings.xlsm workbook and XML files. 5. Click Open, and then click OK to add the files to the list. 6. Click Finish. Intergraph Smart Construction Administration and Configuration Guide 94

95 S ECTION 14 Manage Component Disciplines and Categories In Smart Construction, component disciplines are mapped to component categories. A component category is the category of a component within a discipline, and it is mapped to a particular component item. For example, a pipe support and a piping component are both components items within the Pipe component category, which is related to the discipline Piping. You can map the relationships between a component discipline and category, and a component category and component item class definition. When mapped properly, the relationships among component category, discipline, and component item determine which components can be added to IWPs - the discipline of the component must match the discipline of the IWP. In addition, the relationships determine the correct components to display in a filtered 3D model or 2D drawing. If a class definition is not assigned a component category, engineered published components related to the class definition are excluded from the Smart Construction retrieve. You can customize the relationships among component categories, component disciplines, and component class definitions. You can create and manage component categories and disciplines for Smart Construction in the SmartPlant Foundation Desktop Client. You can manage the relationship between component categories and component items in the SPCRetrieveMappings.xlsm workbook. For more information, see Configure Mapped Properties for a Published Document (on page 92). When you map data in the SPCRetrieveMappings.xlsm workbook, a relationship between a component category and a component is created, based on the tool used to publish the component and the class definition of the component. The component category can then be mapped to component disciplines and managed manually through SmartPlant Foundation Desktop Client. By default, when you first install Smart Construction, a sample of component categories, component disciplines, and component item mappings are delivered. You can then customize these mappings to fit your business needs. You must retrieve data in order to see your changes. The relationship between component categories and component class definitions is created when you generate and load the XML file mapping from the SPCRetrieveMappings.xlsm workbook and retrieve documents into Smart Construction. For more information, see Configure Mapped Properties for a Published Document (on page 92). The relationship mapping between component category and component discipline is delivered in a load file, which is loaded during Smart Construction installation. The delivered file, 042-SPC_ComponentData, is loaded when you load Smart Construction administrative files. For more information, see Load Smart Construction administrative files in the Intergraph Smart Construction Installation and Setup Guide. Intergraph Smart Construction Administration and Configuration Guide 95

96 Manage Component Disciplines and Categories Manage component categories You can create and update component categories in SmartPlant Foundation Desktop Client. If you create a component category in SmartPlant Foundation Desktop Client, you can use it in the SPCRetrieveMappings.xlsm workbook to map to component items. If you use the new component category in the workbook, you must spell the component category exactly the same in the as the component category SmartPlant Foundation Desktop Client. Create a new component category 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > New > Administration > Component Category to open the New Component Category dialog box. 3. Type a name in the Name box. 4. Type a description in the Description box. 5. Click Finish to save. Search for component categories 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Component Categories to open the Find Component Categories dialog box. 3. Type the name of the object in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. Update a component category 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Component Categories to open the Find Component Categories dialog box. 3. Type the name of the object in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Right-click the component category and select Update. 5. Edit details about the component category. 6. Click Finish to save changes. Intergraph Smart Construction Administration and Configuration Guide 96

97 Manage Component Disciplines and Categories Manage component disciplines You can create and update component categories in SmartPlant Foundation Desktop Client. Create a new component discipline 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > New > Administration > Component Discipline to open the New Component Discipline dialog box. 3. Type a name in the Name box. 4. Type a description in the Description box. 5. Select a component category to relate the discipline to in the Component category box. 6. Click Finish to save. Search for component disciplines 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Component Disciplines to open the Find Component Disciplines dialog box. 3. Type the name of the object in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. Update a component discipline 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Component Disciplines to open the Find Component Disciplines dialog box. 3. Type the name of the object in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Right-click the component discipline, and select Update. 5. Edit details about the component discipline. 6. Click Finish to save changes. Intergraph Smart Construction Administration and Configuration Guide 97

98 Manage Component Disciplines and Categories Manage the relationship between component disciplines and categories The component category can be mapped to component disciplines and managed manually through SmartPlant Foundation Desktop Client. You can relate multiple disciplines to multiple component categories. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Component Categories to open the Find Component Categories dialog box. 3. Type the name of the object in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Right-click the component category, and select Manage Work Package Disciplines to open the Manage Work Package Disciplines dialog box. 5. Select a component discipline on the right pane, and click Relate Selected Item to relate the discipline to the component category. 6. Click Move Selected Item Up or Move Selected Item Down to order the disciplines associated with the component category. 7. Click Remove Selected Item to delete the relationship between the discipline selected and the component category. 8. Click OK to save changes. Intergraph Smart Construction Administration and Configuration Guide 98

99 S ECTION 15 Import Smart Construction schema Use the SmartPlant Foundation Schema Import Wizard to import schema files into your Smart Construction project. For more information on the Schema Import Wizard, see the SmartPlant Foundation Desktop Client User's Guide. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Administration > Schema Import Wizard in the Desktop Client. 3. Browse to the schema location. 4. Select a compare context option. Intergraph recommends you select the Compare content of selected files against all database items with a matching container ID option to compare your schema for Smart Construction. 5. Select the schema file to import. Click Browse on the Schema Import Wizard window to browse to the Smart Construction installation location. Select 01_SPC_AuthoringSchema.xml in the 001-Schema folder (For example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\loadfiles\001-schema). 6. Select a Compare Option. This step is optional. 7. Click Next. The Comparison Results form displays. The totals (New, Updated, and Removed objects and relationships) are displayed at the bottom of the form. 8. Select schema objects to import into your Smart Construction project. Select the check box next to each object name and click Next to import them one by one. Or, click Select All to import all objects, and click Next. 9. Verify the correct schema objects were loaded into the Smart Construction site in the Review Changes window. Click Finish. After loading schema changes, close SmartPlant Foundation Desktop Client and recycle the Internet Information Services (IIS) application pools for your project's site. For more information on resetting IIS application pools, see IIS documentation. Load the Plant Breakdown Structure schema After loading the Smart Construction schema, you must load the Plant Breakdown Structure (PBS) schema. If using a custom PBS, see Configuring a Custom Plant Breakdown Structure (PBS) for Smart Construction in the Intergraph Smart Construction Customization Guide. Use the SmartPlant Foundation Schema Import Wizard to import the PBS schema files into your Smart Construction project. For more information on the Schema Import Wizard, see the SmartPlant Foundation Desktop Client User's Guide. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Administration > Schema Import Wizard in the Desktop Client. 3. Browse to the schema location. Intergraph Smart Construction Administration and Configuration Guide 99

100 4. Select a compare context option. Import Smart Construction schema Intergraph recommends you select the Compare content of selected files against all database items with a matching container ID option to compare your schema for Smart Construction. 5. Select the schema file to import. Click Browse on the Schema Import Wizard window to browse to the Smart Construction installation location. Select 02_SPC_PBS_AuthoringSchema.xml in the 001-Schema folder (For example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\loadfiles\001-schema). 6. Select a Compare Option. This step is optional. 7. Click Next. The Comparison Results form displays. The totals (New, Updated, and Removed objects and relationships) are displayed at the bottom of the form. 8. Select schema objects to import into your Smart Construction project. Select the check box next to each object name and click Next to import them one by one. Or, click Select All to import all objects, and click Next. 9. Verify the correct schema objects were loaded into the Smart Construction site in the Review Changes window. Click Finish. After loading schema changes, close SmartPlant Foundation Desktop Client and recycle the Internet Information Services (IIS) application pools for your project's site. For more information on resetting IIS application pools, see IIS documentation. Load the IWP enumerated list schema After loading the PBS schema, you can load the package enumerated list schema, which loads the enumerated lists for the delivered package disciplines, purposes, and statuses (related to CWAs, CWPs, and IWPs). If you choose to not load the delivered package enumerated list schema, you must configure your own disciplines, purposes, and statuses. For more information, see Configure Work Package Disciplines and Purposes (on page 140) and Configure IWP Status (on page 147). Use the SmartPlant Foundation Schema Import Wizard to import the IWP enumerated list schema into your Smart Construction project. For more information on the Schema Import Wizard, see the SmartPlant Foundation Desktop Client User's Guide. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Administration > Schema Import Wizard in the Desktop Client. 3. Browse to the schema location. 4. Select a compare context option. Intergraph recommends you select the Compare content of selected files against all database items with a matching container ID option to compare your schema for Smart Construction. 5. Select the schema file to import. Click Browse on the Schema Import Wizard window to browse to the Smart Construction installation location. Select 03_SPC_PackageEnumSchema.xml in the 001-Schema folder (For example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\loadfiles\001-schema). 6. Select a Compare Option. This step is optional. Intergraph Smart Construction Administration and Configuration Guide 100

101 Import Smart Construction schema 7. Click Next. The Comparison Results form displays. The totals (New, Updated, and Removed objects and relationships) are displayed at the bottom of the form. 8. Select schema objects to import into your Smart Construction project. Select the check box next to each object name and click Next to import them one by one. Or, click Select All to import all objects, and click Next. 9. Verify the correct schema objects were loaded into the Smart Construction site in the Review Changes window. Click Finish. After loading schema changes, close SmartPlant Foundation Desktop Client and recycle the Internet Information Services (IIS) application pools for your project's site. For more information on resetting IIS application pools, see IIS documentation. Intergraph Smart Construction Administration and Configuration Guide 101

102 S ECTION 16 Getting Data into Smart Construction In order to work with data in Smart Construction, you must retrieve and load the data into your site and project. You can retrieve published data and documents, such as 3D models and 2D drawings that were published from authoring tools to the SmartPlant Foundation data warehouse configured with your Smart Construction server and project. For more information about retrieving published data, see Retrieving published data in Smart Construction (on page 103). You can also retrieve non-published data from a register. The register can be configured using a delivered register template For more information, see Load non-published data into Smart Construction (on page 113). After data is loaded into Smart Construction, you can use the data to plan your construction project. If you retrieve a 3D document, the file is available for retrieve on the Models tab of the Retrieve data dialog box. The viewable ZVF file can be opened in the Smart Construction 3D Model View. If you retrieve a 2D document, the file is available for retrieve on the Drawings tab of the Retrieve data dialog box. The file can be opened in the Smart Construction 2D Drawings View. The viewable file of a 2D document is defined in the SPCViewableFile property in Server Manager. If you retrieve a component register or if the published file does not have a file extension defined in the SPCViewableFile property in Server Manager, the file is retrieved as a component register. It displays on the Retrieve data dialog box when you search for component registers. The file can be opened in the Smart Construction Component Registers window. Intergraph Smart Construction Administration and Configuration Guide 102

103 Getting Data into Smart Construction Retrieving published data in Smart Construction In order to view documents in Smart Construction, authoring tools like PDS or Smart 3D must publish documents to the SmartPlant Foundation data warehouse configured with a Smart Construction server and project. You can then retrieve the data into Smart Construction, which moves documents from the Shared domain to the Smart Construction domain. What do you want to do? Publish data to a Smart Construction site (on page 103) Configure mapped properties for retrieve (on page 105) Configure rules of progress (on page 105) Retrieve data (on page 106) Publish data to a Smart Construction site After creating data in an authoring tool, users publish the data to SmartPlant Foundation. Authoring tools must publish to the SmartPlant Foundation data warehouse that is configured with the Smart Construction server. Users can retrieve and work with many different types of data in Smart Construction. If a tool can publish to SmartPlant Foundation, then Smart Construction can retrieve and open the data in the Model View, Drawing View, Component Registers browser window, or SmartPlant Markup Plus. Refer to individual tool documentation for more information on publishing documents to SmartPlant Foundation. You can also refer to the Integration User's Guide for more information. Intergraph Smart Construction Administration and Configuration Guide 103

104 Getting Data into Smart Construction Example retrieve scenarios The following diagram illustrates a generic retrieve scenario for Smart Construction. 1. After creating a document in a tool, users publish the document to SmartPlant Foundation. Tools must publish to the SmartPlant Foundation data warehouse that is configured with the Smart Construction server. 2. Smart Construction queries SmartPlant Foundation to retrieve the document into the Smart Construction domain. Intergraph highly recommends that users first retrieve model data into Smart Construction, then drawing data and documents. For more information, contact Intergraph Customer Support ( In order to retrieve documents into Smart Construction, users must log on to SmartPlant Foundation Desktop Client and Smart Construction as an administrator. Users must also start the Smart Construction Scheduler in the SmartPlant Foundation Desktop Client. If is configured in SmartPlant Foundation, users can receive notifications when the retrieve operation is complete. Users can retrieve and work with many different types of data in Smart Construction. If a tool can publish to SmartPlant Foundation, then Smart Construction can retrieve and open the document in the Model View, Drawing View, SmartPlant Markup Plus, or the Component Registers window. The following diagram illustrates a basic overview of how to retrieve a PDS model into Smart Construction: 1. After creating a model in PDS, users publish the model to SmartPlant Foundation, using the Material Data Publisher. 2. Smart Construction queries SmartPlant Foundation to retrieve the model. After retrieving the model, users can display and filter the model. Intergraph Smart Construction Administration and Configuration Guide 104

105 Getting Data into Smart Construction The following diagram illustrates a basic overview of how to retrieve a spool from Smart 3D and SmartPlant Spoolgen into Smart Construction: 1. After creating a pipeline model in Smart 3D, users export the spool to SmartPlant Spoolgen. 2. In SmartPlant Spoolgen, users can create, edit, refine, and generate spools. Then they publish the spool to SmartPlant Foundation. 3. Smart Construction queries SmartPlant Foundation to retrieve the spool. After retrieving the spool, users can display the spool data in models and IWPs. For more information on best practices of spool creation with fabrication modifications, see Loading and using data with fabrication modifications in Smart Construction (on page 125). Refer to individual tool documentation for more information on publishing documents to SmartPlant Foundation. You can also refer to the Integration User's Guide for more information. Configure mapped properties for retrieve Mapping is required to retrieve data into the Smart Construction domain. Mapping helps define properties and data that are retrieved into Smart Construction from the register. For more information, see Configure Mapped Properties for a Published Document in the Intergraph Smart Construction Customization Guide. Configure rules of progress Smart Construction provides the ability to automatically assign work steps to components in IWPs, along with their man hours and rates. These work steps form the basis of determining the completion status of an IWP. Administrators can configure rules of progress data to generate and associate work steps with register components and tagged items. For more information on configuring the rules of progress, see Configure the Rules of Progress (on page 88). Intergraph Smart Construction Administration and Configuration Guide 105

106 Getting Data into Smart Construction Retrieve data You can retrieve documents from the SmartPlant Foundation data warehouse to your Smart Construction project. You must start the Smart Construction Scheduler in SmartPlant Foundation Desktop Client in order to retrieve documents into Smart Construction. The Retrieve Data queue must be enabled and turned on in order to retrieve documents in Smart Construction. For more information, see Turn the retrieve queue on or off in the Intergraph Smart Construction User's Guide or Stop and restart the Retrieve Data queue (on page 108). Any 2D isometric drawing with the exception of those from Spoolgen or SmartPlant Isometrics can be retrieved in Smart Construction after the 3D model data has been published, loaded, and consolidated in SmartPlant Foundation. In order to retrieve a spool into Smart Construction, first retrieve the model related to the spool, drawings related to the spool, and then retrieve the spool drawing (.pod). You can disable the rules of progress functionality in order to improve retrieve performance. Before you retrieve a large amount of data, recycle the Internet Information Services (IIS) application pools for your project's site. For more information on resetting IIS application pools, see IIS documentation. Data is committed to the database in chunks as it is retrieved. This commit is final, meaning no rollback operation is performed if an error occurs. For more information, see the description of the SPCTransactionMode property in Smart Construction site properties in Server Manager (on page 27). 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Start the Smart Construction Scheduler in the SmartPlant Foundation Desktop Client. a. Click Find > Administration > Schedulers. b. In the Find Schedulers dialog box, type the name of the Scheduler, and click OK. Smart Construction uses the Smart Construction Scheduler to retrieve data. c. Right-click the Scheduler, and click Scheduler > Start. 3. Log on to Smart Construction as an administrator. 4. Click Administration on the Smart Construction Standard Toolbar and select Retrieve Data to open the Retrieve Data dialog box. 5. On the Retrieve Data dialog box, type or select search criteria to view data available for retrieve, then click Execute Search. Intergraph Smart Construction Administration and Configuration Guide 106

107 6. Select documents to retrieve into Smart Construction. Getting Data into Smart Construction To retrieve parts of a composite model, click Expand next to the model name. Then, select the parts of the model you want to retrieve. Press SHIFT or CTRL and select multiple documents to retrieve into Smart Construction. 7. Click Retrieve. 8. To verify documents were retrieved, click Drawings, Models, or Component Registers on the Smart Construction home page to view newly retrieved documents. You can turn on the SmartPlant Foundation server logging in order to gather useful information about the retrieve and rules of progress generation. In SmartPlant Foundation Server Manager, you can set the Trace Settings for your site. SmartPlant Foundation Server Manager uses the Custom property to log data for Smart Construction. For more information, see Use SmartPlant Foundation Server Logging in the Intergraph Smart Construction Troubleshooting Guide. You can also see Setting Up SmartPlant Foundation Server Logging in the SmartPlant Foundation Troubleshooting Guide and Set tracing levels for a site in the SmartPlant Foundation Server Manager User's Guide. If a document fails to retrieve, the document status displays in the Status column. The failure message is available on the Information column. You can try to retrieve the document again by selecting the document, and clicking Retrieve. See the SmartPlant Foundation documentation for information on the failure message. You can cancel the retrieval of a document after it has begun. For more information, please see Cancel the retrieval of a document (on page 110). Click the progress bar in the Status column for more information about the model or drawing that is being retrieved. You can link composite documents to retrieved documents in the Retrieve Data dialog box in Smart Construction using the Link composite document to retrieved documents option. This option is helpful if you need to synchronize different versions and revisions of a composite document, or you can use the option to link directly to a previously retrieved composite document without having to retrieve all of the documents again. For more information, see Link composite document to retrieved documents (on page 111). After a retrieve is started, the Smart Construction Rules of Progress queue generates and associates the rules of progress information with retrieved components. The Rules of Progress queue creates a separate scheduler task, SPC Process ROP Scheduler, to relate the scheduler to the Rules of Progress queue. The SPC Process ROP Scheduler task regularly polls the queue to process the rules of progress data for retrieved documents. For more information, see Query for the status of the rules of progress association (on page 109). In the Smart Construction client, click Administration > Show Queue Status to view which queues are enabled and their status. The viewable file for models and drawings is defined in the SPCViewableFile property in Server Manager. If you retrieve a component register or if the published file does not have a Intergraph Smart Construction Administration and Configuration Guide 107

108 Getting Data into Smart Construction file extension defined in the SPCViewableFile property in Server Manager, the file is retrieved as a component register. It displays on the Retrieve data dialog box when you search for component registers, and the file is retrieved as a component register. For more information, see Smart Construction site properties in Server Manager (on page 27). By default, the SPC_BrowserItemView access group is associated to models and drawings after being retrieved into Smart Construction. You can edit access groups on models and drawings to fit your business needs. If a class definition is not assigned a component category, engineered published components related to the class definition are excluded from the Smart Construction retrieve. Query for the status of scheduled documents You can query a scheduled task to view the status of the task. 1. Log on to the SmartPlant Foundation Desktop Client as an administrator. 2. Click Query > Schedule Tasks, or click Query for Scheduled Tasks on the toolbar. 3. In the Schedule Tasks dialog box, type the name of the task and any other details for the query. 4. Click Finish to view search results in the list view. Stop and restart the Retrieve Data queue You can stop and restart the Retrieve Data queue. The Retrieve Data queue must be enabled and turned on in order to retrieve documents in Smart Construction. When you stop the queue, the chunk of data currently processing is finished, then the queue stops. When you restart the queue, the queue deletes and recreates the SPC Retrieve Scheduler task. Restarting the queue can be helpful if the SPC Retrieve Scheduler task locks or fails. 1. Log on to SmartPlant Foundation as an administrator. 2. Click Smart Construction > Find > Administration > Queues. 3. In the Find dialog box, type the name of the queue and click OK. 4. Right-click the Retrieve Data queue and select Queue > Stop. 5. Right-click the Retrieve Data queue and select Queue > Start. By default, Smart Construction delivers all queues turned off. You must start the queues in order to use them. In the Smart Construction client, click Administration > Show Queue Status to view which queues are enabled and their status. Intergraph Smart Construction Administration and Configuration Guide 108

109 Getting Data into Smart Construction Configure the number of threads for the Smart Construction Scheduler You can configure the number of threads running on the Smart Construction Scheduler. By default, there are four threads running on the scheduler, used to handle retrieve and the import of any data, such as project configuration or rules of progress. 1. Log on the SmartPlant Foundation Desktop Client as an administrator. 2. Click Find > Administration > Schedulers. 3. In the Find Schedulers dialog box, type the name of the Scheduler, and click OK. Smart Construction uses the Smart Construction Scheduler to retrieve data. 4. Right-click the scheduler in the search results and select Update. 5. Configure the number of threads in the Max Threads box. Query for the status of the rules of progress association After a retrieve is started, the Smart Construction Rules of Progress queue generates and associates the rules of progress information with retrieved components. The Rules of Progress queue creates a separate scheduler task, SPC Process ROP Scheduler, to relate the scheduler to the Rules of Progress queue. The SPC Process ROP Scheduler task regularly polls the queue to process the rules of progress data for retrieved documents. You can query the SPC Process ROP Scheduler task to view its status. 1. Log on to SmartPlant Foundation as an administrator. 2. Click Query > Schedule Tasks, or click Query for Scheduled Tasks on the toolbar. 3. In the Schedule Tasks dialog box, type the name of the task and any other details for the query. 4. Click Finish to view search results in the list view. In the Smart Construction client, click Administration > Show Queue Status to view which queues are enabled and their status. Update the number of items processed with the Rules of Progress queue By default, the Rules of Progress queue processes 200 items at a time. You can update the number of items processed at a time. 1. Log on to SmartPlant Foundation as an administrator. 2. Click Smart Construction > Find > Administration > Queues. 3. In the Find dialog box, type the name of the queue and click OK. 4. Right-click the Rules of Progress queue and select Update. 5. Edit the Number of Items to process box with a new value. Intergraph Smart Construction Administration and Configuration Guide 109

110 Getting Data into Smart Construction 6. Click Finish to save. Stop and restart the Rules of Progress queue You can stop and restart the Rules of Progress queue. When you stop the queue, the chunk of data currently processing is finished, then the queue stops. When you restart the queue, the queue deletes and recreates the SPC Process ROP Scheduler task. Restarting the queue can be helpful if the SPC Process ROP Scheduler task is locked or fails. 1. Log on to SmartPlant Foundation as an administrator. 2. Click Smart Construction > Find > Administration > Queues. 3. In the Find dialog box, type the name of the queue and click OK. 4. Right-click the Rules of Progress queue and select Queue > Stop. 5. Right-click the Rules of Progress queue and select Queue > Start. By default, Smart Construction delivers all queues turned off. You must start the queues in order to use them. In the Smart Construction client, click Administration > Show Queue Status to view which queues are enabled and their status. Cancel the retrieval of a document You can cancel the retrieval of a document after it has begun. When you do so, the content that was retrieved prior to the cancellation remains in the database (it is not rolled back). What happens after the cancellation depends on what was being retrieved: If this is the first retrieval of the document or of a new revision/version of the document, the document status is set to Partial. The document cannot be opened by a user. If the document had not changed since its last retrieval, when the retrieval is canceled the status shows the date and time of the last successful retrieval. The document can be opened by a user. 1. Click Administration on the Smart Construction Standard Toolbar. Select Retrieve Data to open the Retrieve Data dialog box. 2. On the Retrieve Data dialog box, type or select search criteria to view data available for retrieve, then click Execute Search. 3. Click Cancel document next to the progress bar in the Status column. Intergraph Smart Construction Administration and Configuration Guide 110

111 Getting Data into Smart Construction Retrieve composite models into Smart Construction When administrators publish large models to SmartPlant Foundation, the models can exceed memory resources limitations on the publishing computer. Large models can be divided into separate smaller models in the authoring tool and published to SmartPlant Foundation individually. The separate smaller models can then be combined into a composite model in SmartPlant Foundation. When combined into a composite model in SmartPlant Foundation, the models are treated as one large model by SmartPlant Foundation, and when configured properly, the composite model can be retrieved into Smart Construction. In Smart Construction, you can retrieve composite models the same as any other model; you can also select the parts of a composite model to retrieve on the Retrieve Data dialog box by clicking Expand next to the model name and selecting the parts of the model you want to retrieve. For more information on the publishing and configuration of composite models, see Publishing Large 3D Models to SmartPlant Foundation in the SmartPlant Foundation User's Guide. Link composite document to retrieved documents You can link composite documents to retrieved documents in the Retrieve Data dialog box in Smart Construction using the Link composite document to retrieved documents option. This option is helpful if you need to synchronize different versions and revisions of a composite document. For example, you can use the option to synchronize a new revision of a composite document that has a previously retrieved document appended to it. Or you can use the option to link directly to a new composite document without having to retrieve all documents again. For example, a new composite document was created in SmartPlant Foundation using a document or documents that were already retrieved in Smart Construction; however, the composite document has not yet been retrieved into Smart Construction. You can use the Link composite document to retrieved documents option to link the composite document to the retrieved document. 1. Click Administration on the Smart Construction Standard Toolbar and select Retrieve Data to open the Retrieve Data dialog box. 2. On the Retrieve Data dialog box, type or select search criteria to view data available for retrieve, then click Execute Search. Search for models. 3. Click Link composite documents to retrieved documents in the Status column of the document you want to link. 4. Click Link on the message box to send a scheduled task to SmartPlant Foundation to link the document and build relationships. Click Don't link to cancel linking the retrieved documents. You can query for the status of the scheduled task in SmartPlant Foundation Desktop Client. The name of the scheduled task is the name of the composite document. For more information, see Query for the status of scheduled documents (on page 108). Intergraph Smart Construction Administration and Configuration Guide 111

112 Getting Data into Smart Construction Delete composite models When you delete a composite 3D document in the SmartPlant Foundation Desktop Client, a scheduler task is created to remove the composite model from Smart Construction. Verify the Smart Construction Scheduler is started. 1. In the SmartPlant Foundation Desktop Client, click Smart Construction > Find > Composite 3D Documents. 2. Search for the composite 3D document. 3. Right-click the composite 3D document and click Document > Delete Document. Configure the refresh time on the Retrieve dialog box By default, the Retrieve dialog box refreshes every one minute. You can configure the refresh time on the Retrieve dialog box to fit your business needs. The refresh rate for the Retrieve dialog box must be configured on a per workstation basis. 1. Browse to the Smart Construction installation location and open the Smart Construction client configuration file (for example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\spcclient\spc.client.exe.config). 2. In the SPC.Client.exe.config file, locate the <appsettings> node. 3. Verify the value for IsRetrieveRefreshEnabled is set to True, in order to enable the Retrieve refresh. 4. Edit the value for RetrieveDialogRefresh to your correct time interval. The refresh time interval value is set in seconds. By default, the value is 60 (for one minute). Deleted components and tombstones in Smart Construction If a component is planned in a Smart Construction IWP and it is removed from the engineering document, the component is considered a tombstone. The tombstone component stays planned in an IWP, and progress can be reported. Users can view the component in the drawing related to the component and IWP. After a component is removed from an engineering document, administrators must retrieve the engineering document and all associated documents to correctly synchronize the deletion. If the associated documents were not retrieved, they are considered out of sync, indicated by a visual warning in the Smart Construction client. Retrieve the documents to remove the out of sync warning. Users can select the Show/Hide Removed Component option in the out of date 3D models to view components that have been deleted. If the tombstone component is removed from an IWP and it is not included in any other IWP, Smart Construction deletes the component. If a component is not planned in a Smart Construction IWP and it is removed from the engineering document, the component is deleted from the database. After a component is removed from an engineering document, administrators must retrieve the engineering document and all associated documents to correctly synchronize the deletion. If the associated documents Intergraph Smart Construction Administration and Configuration Guide 112

113 Getting Data into Smart Construction were not retrieved, they are considered out of sync, indicated by a visual warning in the Smart Construction client. Retrieve the documents to remove the out of sync warning. Users can select the Show/Hide Removed Component option in the out of sync 3D models to view components that are deleted. Because the component was not planned in an IWP, it is not available to add to an IWP. Load non-published data into Smart Construction You can configure and load data into your Smart Construction project using non-published data. Rather than publishing documents and data from an authoring tool, you can create, define, and configure data in a delivered template from which you generate an XML file that can be loaded into your Smart Construction data warehouse site as a design document. The design document can then be retrieved into Smart Construction as a component register document. The component register document can be added to IWPs as components and then used in planning for construction. Smart Construction delivers three component register templates, Generic Register.xls, Cable Register.xls, and Instrument Index Register.xls. These workbooks can be used as delivered, or you can customize them to fit your business needs. Intergraph Smart Construction Administration and Configuration Guide 113

114 Getting Data into Smart Construction Loading non-published data into Smart Construction You can configure data in the delivered Microsoft Excel workbook template, which generates an XML file that can be loaded into your Smart Construction data warehouse site as a design document. The design document can then be retrieved into Smart Construction as a component register document. What do you want to do? Configure data in register templates (on page 115) Load the register output file in the Smart Construction site (on page 116) Configure mapped properties for retrieve (on page 116) Configure rules of progress (on page 117) Retrieve component register documents (on page 117) Intergraph Smart Construction Administration and Configuration Guide 114

115 Getting Data into Smart Construction Configure data in register templates 1. Browse to the Component Registers folder in the Templates folder of the installation location. For example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates\component Registers. 2. Open the component register template in Microsoft Excel. 3. Enable the macro content for the workbook. a. On the Security Warning bar, click Options. b. Select Enable this content on the Microsoft Office Security Options, and click OK. 4. Specify details for the register on the [Register name] tab. For more information, see Structure of the component register template (on page 117) and Delivered Smart Construction component register templates (on page 119). For information about adding custom properties to the register templates, see Add custom properties to register templates (on page 123). 5. Specify details for the register on the Data tab. The column headers are specified in row 6, and the data of the register start at row 7. The tag name must be unique for each tag in the register template. The unit must be spelled the exact same (with same capitalization) as the unit specified on the Register Syntax tab. Type a description in the Description column of the Generic Register, Cable Description column of the Cable Schedule register, or Column Description column of the Instrument Index register to associate material items in the Material Request form. The tag item description is used as the material description in the Material Request form. If you need to delete a column on the Data tab, select the entire column and delete it from the tab. 6. Open the Main tab. 7. Specify a document name in the Document Name box. The document name can be a string value containing 100 characters or less. The document name cannot contain special characters * ' %? ". 8. Specify a document revision in the Document Revision box. The document revision number must be greater than 0. Document revision numbers should be specified in sequential order. 9. Select the Is this the first revision? box to indicate if the register is the first revision. Clear the Is this the first revision? box if the register is not the first revision. 10. Click Save to save your register details. Intergraph Smart Construction Administration and Configuration Guide 115

116 Getting Data into Smart Construction 11. Click Generate File to generate the output file in the same folder as the register workbook. Load the register output file in the Smart Construction site When you generate the register XML file, the component register template transforms the data into a load file. You can load the register output file into your Smart Construction site. Use the SmartPlant Foundation Loader to load the register output file into your Smart Construction site. 1. Log on to SmartPlant Foundation Desktop Client in your Smart Construction site as an administrator. 2. Click File > Loader to open the Loader dialog box. 3. Browse to the register output file. 4. Select the register output file to load. 5. Click Process to display the results of the load in the Processed load files list. 6. Click Load Results to view load process details. 7. Click Close. Configure mapped properties for retrieve Mapping is required to retrieve documents into the Smart Construction domain. Mapping helps define properties and data that are retrieved into Smart Construction from the register. When you generate data from the component register template workbook, your data is transformed into a load file and design document, which contains the register items mapped with Smart Construction data objects. The data objects must be mapped to Smart Construction interface and property definitions to correctly retrieve into your Smart Construction site. The work process to map properties and data for retrieval can be found in Configure Mapped Properties for a Published Document in the Intergraph Smart Construction Customization Guide; however, the following notes define how to map register properties. You can use the Nonpublished tab delivered with the SPCRetrieveMapping.xlsm workbook to define your mapping, or you can create a new tab to define your register mapping. The DomainUID for delivered Smart Construction registers is SPC_AuthoringDomain. The EFClassDef for delivered Smart Construction registers is the class definition of the register. The EFClassDef must be formatted as one word without any spaces. The EFInterface definition is the interface definition of the Smart Construction data object that is being mapped. It exposes the data object property definition. The EFProperty definition is the property definition of the Smart Construction data object being mapped. The SPCInterface definition is the interface definition of the Smart Construction property into which the Smart Construction data object property definition maps. The SPCProperty definition is the property definition of the Smart Construction property into which the Smart Construction data object property published. Examine the schema of the SPC_DataObject for a comprehensive list of interface and property definitions available for mapping. Intergraph Smart Construction Administration and Configuration Guide 116

117 Getting Data into Smart Construction After you configure retrieve mapping, you can open the SmartPlant Foundation Desktop Client of your Smart Construction site, search for the register design document, and then click Show Data Object. Select a register item, and click Export Data to view a list of properties associated. For more information about configuring mapping properties, see Configure Mapped Properties for a Published Document in the Intergraph Smart Construction Customization Guide. For register-specific retrieve mapping information, see Delivered Smart Construction component register templates (on page 119). Configure rules of progress Smart Construction provides the ability to automatically assign work steps to components in IWPs, along with their man hours and rates. These work steps form the basis of determining the completion status of an IWP. Administrators can configure rules of progress data to generate and associate work steps with register components and tagged items. The register class must be specified in the Component Class row in the ROP Configuration.xlsm workbook. For more information on configuring the rules of progress, see Configure the Rules of Progress (on page 88). For register-specific rules of progress information, see Delivered Smart Construction component register templates (on page 119). Retrieve component register documents After you load the register load file into your Smart Construction site, retrieve the register data into Smart Construction. For more information, see Retrieve data (on page 106). Details about delivered component register template files The following section describes the structure, location, and configuration details for delivered Smart Construction component register template files. Structure of the component register template Each delivered Smart Construction component register template contains three tabbed workbooks. Each tab defines different features of the register. Main tab The Main tab is located on the first sheet of the workbook, and it contains the Generate [Register name] File button, which generates the XML load file. The load file can be loaded into your Smart Construction data warehouse site as a design document. Do not rename or remove the Generate [Register name] File button. Do not modify or remove the code behind the button. [Register Name] tab The [Register Name] tab specifies the name of the delivered register, and it contains configuration details for the register. Intergraph Smart Construction Administration and Configuration Guide 117

118 Getting Data into Smart Construction Column Header Column Description InterfaceDef PropertyDef Notes Rules Required Comments Explanation Identifies the names of columns in the Data tab. Defines the interface definition for the property. Defines the property definition for the property. Defines the data format required for data in the register. Lists the validation rules associated with the register. Specifies whether the data is required for a successful import of data. Provides a box for comments and details. Data tab Each component register template contains a Data tab, which details the data to be generated. These details are then associated to the component register document that is retrieved into Smart Construction. The data column headings are unique to each register template delivered with Smart Construction. For more information on specific delivered registers, see Delivered Smart Construction component register templates (on page 119). The following details apply to the Data tab for all delivered Smart Construction register templates. The template column headings specifying the register details appear in the sixth row. The register header is contained in the first five rows of the register. Data for the register template must be defined in rows seven and below. The unit must be spelled the exact same (with same capitalization) as the unit specified on the Register Syntax tab. Type a description in the Description column of the Generic Register, Cable Description column of the Cable Schedule register, or Column Description column of the Instrument Index register to associate material items in the Material Request form. The tag item description is used as the material description in the Material Request form. Register Syntax tab The Register Syntax tab specifies the syntax available for each register template. For example, the unit (meter) for the actual length of a cable tag must be available in the Register Syntax tab to successfully generate the tab. Intergraph Smart Construction Administration and Configuration Guide 118

119 Getting Data into Smart Construction Installation and location of the register templates When Smart Construction is installed on a server, the component register templates are delivered to the Component Registers folder in the Templates folder of the installation location. For example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates\component Registers. Revising a register You can update and revise a component register to add or edit tag items. When you run a new version of a component register and load the register output file into your Smart Construction site, the register design document loads with the new revision number in the Current state. The previous revision is Superseded. When you generate a revision of a component register, you must specify the same document name as the previous revision in the Document Name box on the Main tab of the component register template. Using the same name ensures that the document is retrieved as a new version of the existing document in Smart Construction. You must specify the revision number in the Document Revision box on the Main tab of the component register template. The revision number must be higher than the revision number of the document that exists in the Smart Construction site. Revision numbers must be specified in sequential order. Smart Construction uses the major values of the RevNum revision scheme for registers. You must type 01, 02, or another numerical value in the DocumentRevision Value box (if any other value is entered, it causes the register to not run properly). Delivered Smart Construction component register templates Smart Construction delivers the following register templates, Cable Schedule Register, Generic Register, and Instrument Index Register. You can configure these files to load your data into the Smart Construction site. Cable schedule register Using the Smart Construction cable schedule register workbook, you can specify cable schedule details to load into Smart Construction. The Cable Tag value is required in the Smart Construction cable schedule register. Mapping between the cable schedule register and Smart Construction schema objects The following table details how the delivered cable schedule register maps to Smart Construction schema objects. For more information, see Configure mapped properties for retrieve and Configure Mapped Properties for a Published Document in the Intergraph Smart Construction Customization Guide. Register Column Name Register Interface Definition Register Property Definition Cable Specification ISPC_DataObjectElectrical SPC_DataObject_CableSpeci fication Intergraph Smart Construction Administration and Configuration Guide 119

120 Getting Data into Smart Construction Register Column Name Register Interface Definition Register Property Definition Cable Formation ISPC_DataObjectElectrical SPC_DataObject_CableForm ation Via Item ISPC_DataObjectElectrical SPC_DataObject_ViaItem Rated Voltage ISPC_DataObjectElectrical SPC_DataObject_VoltageRati ng From Item Tag ISPC_DataObjectElectrical SPC_DataObject_FromItemT ag Actual Length ISPC_DataObject SPC_DataObject_Units To Item Tag ISPC_DataObjectElectrical SPC_DataObject_ToItemTag Rules of progress The register class must be specified in the Component Class row in the ROP Configuration.xlsm. For more information on configuring the rules of progress, see Configure the Rules of Progress (on page 88). Generic register The Smart Construction generic register is a general register that provides a format for you to load multiple types of construction components into Smart Construction. The Tag ID value is required in the Smart Construction generic register workbook. Mapping between the generic register and Smart Construction schema objects The following table details how the delivered generic register maps to Smart Construction schema objects. For more information, see Configure mapped properties for retrieve and Configure Mapped Properties for a Published Document in the Intergraph Smart Construction Customization Guide. Register Column Name Register Interface Definition Register Property Definition Description ISPC_DataObject SPC_DataObject_ShortDescri ption Commodity Code ISPC_DataObject SPC_DataObject_Commodity Code Units ISPC_DataObject SPC_DataObject_Units Intergraph Smart Construction Administration and Configuration Guide 120

121 Getting Data into Smart Construction Register Column Name Register Interface Definition Register Property Definition Size ISPC_DataObject SPC_DataObject_Size Material ISPC_DataObject SPC_DataObject_Material Rating ISPC_DataObject SPC_DataObject_Rating Thickness ISPC_DataObject SPC_DataObject_Thickness Module ISPC_DataObject SPC_DataObject_Module Weld Unit ISPC_DataObjectCost SPC_DataObject_WeldCostF actor Fluid Volume ISPC_DataObjectDimensionin g SPC_DataObject_FluidVolum e Rules of progress The register class must be specified in the Component Class row in the ROP Configuration.xlsm workbook. For more information on configuring the rules of progress, see Configure the Rules of Progress (on page 88). Instrument index register Using the Smart Construction instrument index register workbook, you can specify instrument index details to load into Smart Construction. The Instrument Tag value is required in the Smart Construction instrument index register. Mapping between the instrument index register and Smart Construction schema objects The following table details how the delivered instrument index register maps to Smart Construction schema objects. For more information, see Configure mapped properties for retrieve and Configure Mapped Properties for a Published Document in the Intergraph Smart Construction Customization Guide. Intergraph Smart Construction Administration and Configuration Guide 121

122 Getting Data into Smart Construction Register Column Name Register Interface Definition Register Property Definition Instrument Description ISPC_DataObject SPC_DataObject_ShortDescri ption Instrument Type I/O Type ISPC_DataObjectInstrumentat ion ISPC_DataObjectInstrumentat ion SPC_DataObject_Instrument FuncType SPC_DataObject_Instrument SysIOType Material ISPC_DataObject SPC_DataObject_Material Location Service Model Number Status ISPC_DataObjectInstrumentat ion ISPC_DataObjectInstrumentat ion ISPC_DataObjectInstrumentat ion ISPC_DataObjectInstrumentat ion SPC_DataObject_InstrumentL ocation SPC_DataObject_Instrument Service SPC_DataObject_Manufactur erdeviceid SPC_DataObject_Instrument Status Rules of progress The register class must be specified in the Component Class row in the ROP Configuration.xlsm. For more information on configuring the rules of progress, see Configure the Rules of Progress (on page 88). Customizing the delivered component register templates and experience. Modifying the Excel macros requires Visual Basic and programming knowledge The component register templates can be customized to fit your business needs. The delivered component register templates include Excel macros that generate XML. The code puts specific columns into specific properties of SPC_DataObject. The properties that you want to populate must already exist on the ISPC_DataObject interface definition within the Smart Construction schema. For more information about adding properties to the schema, see the SmartPlant Schema Editor's Guide or the SmartPlant Mapping User's Guide. For more information, contact Intergraph Customer Support ( Intergraph Smart Construction Administration and Configuration Guide 122

123 Getting Data into Smart Construction Add custom properties to register templates You customize the delivered register templates to import component register documents with custom properties. Assigning properties to a component in a register template is a multi-step process: 1. Extend the Smart Construction schema to include custom interface definitions and properties not delivered with Smart Construction. SPC_ComponentItem must realize the custom interface definitions that expose the custom properties used on the register template. 2. Configure the custom properties in the register templates. 3. Configure the custom interface and property definitions in the retrieve mapping for Smart Construction. 4. Configure the custom interface and property definitions in the rules of progress configuration workbook. 5. Retrieve published component registers into Smart Construction. Extend the Smart Construction schema to include custom properties If a Smart Construction property does not exist for the custom property, you must extend the Smart Construction schema to include the custom property. Create a custom interface definition to expose your custom properties. When adding the custom interface definition, update the SPC_ComponentItem class definition to realize the custom interface definition. For information on extending the Smart Construction schema, see Extending the Smart Construction Schema in the Intergraph Smart Construction Customization Guide. Configure a custom property in the register template You can configure the custom property in the register template. You must add a column for each property you plan to associate to the template. 1. Browse to the Component Registers folder in the Templates folder of the installation location. For example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\templates\component Registers. 2. Open the component register template in Microsoft Excel. 3. Enable the macro content for the workbook. a. On the Security Warning bar, click Options. b. Select Enable this content on the Microsoft Office Security Options, and click OK. 4. Add a new column for the new property on the [Register name] tab, and specify details for the new custom property, such as the interface definition in the InterfaceDef column and property definition in the PropertyDef column. Intergraph Smart Construction Administration and Configuration Guide 123

124 Getting Data into Smart Construction 5. Add a column for the new property on the Data tab, and define details for the new property. For more information, see Structure of the component register template (on page 117) and Delivered Smart Construction component register templates (on page 119). The column headers are specified in row 6, and the data of the register start at row 7. The tag name must be unique for each tag in the register template. If you need to delete a column on the Data tab, select the entire column and delete it from the tab. 6. Open the Main tab. 7. Specify a document name in the Document Name box. The document name can be a string value containing 100 characters or less. The document name cannot contain special characters * ' %? ". 8. Specify a document revision in the Document Revision box. The document revision number must be greater than 0. Document revision numbers should be specified in sequential order. 9. Select the Is this the first revision? box to indicate if the register is the first revision. Clear the Is this the first revision? box if the register is not the first revision. 10. Click Save to save your register details. 11. Click Generate File to generate the output file in the same folder as the register workbook. Load the register output file in the Smart Construction site When you generate the register XML file, the component register template transforms the data into a load file. You can load the register output file into your Smart Construction site. Use the SmartPlant Foundation Loader to load the register output file into your Smart Construction site. 1. Log on to SmartPlant Foundation Desktop Client in your Smart Construction site as an administrator. 2. Click File > Loader to open the Loader dialog box. 3. Browse to the register output file. 4. Select the register output file to load. 5. Click Process to display the results of the load in the Processed load files list. 6. Click Load Results to view load process details. 7. Click Close. Intergraph Smart Construction Administration and Configuration Guide 124

125 Getting Data into Smart Construction Configure retrieve mapping for custom properties When you add custom properties to register templates, the data objects must be mapped to Smart Construction interface and property definitions to be retrieved correctly into your Smart Construction site. The work process to map properties and data for retrieval can be found in Configure Mapped Properties for a Published Document in the Intergraph Smart Construction Customization Guide. Configure rules of progress for the custom property You can configure your rules of progress to use the custom property as a lookup value. The register class must be specified in the Component Class row in the ROP Configuration.xlsm workbook. For more information on configuring the Rules of Progress, see Configure the Rules of Progress (on page 88) or the Intergraph Smart Construction Rules of Progress Configuration Guide. Retrieve component register documents After you load the register load file into your Smart Construction site, retrieve the register data into Smart Construction. For more information, see Retrieve data (on page 106). Loading and using data with fabrication modifications in Smart Construction On some construction projects, fabrication might require modifications to the engineering data. For example, if engineering has designed a long pipeline that won't fit on a truck, fabrication might modify the pipeline, dividing it into three pieces to be welded together at the construction site. Or, engineering might design an elbow pipe that is fabricated as a pulled bend. The following section outlines how to get data with fabrication modifications into your construction project, and it also details how to work with that data in Smart Construction. Intergraph Smart Construction Administration and Configuration Guide 125

126 Getting Data into Smart Construction Getting data with fabrication modifications into Smart Construction The following diagram illustrates one way data can be loaded into Smart Construction with fabrication modifications. In this example, engineering uses Smart 3D to create design data to send to fabrication. Fabrication uses Spoolgen to modify the design data. For a more detailed explanation of how to get modified spool drawings into Smart Construction, see the SmartPlant Enterprise Integration Capability Statements Creating Pipe Spools for Procurement, Fabrication, and Construction. 1. Engineering creates data in Smart 3D. A model is generated with spools, along with isometric drawings. This data is published to the construction site's data warehouse in SmartPlant Foundation. Piping component files (PCFs) are saved from ISO drawings. 2. Engineering sends the PCFs to fabrication. 3. Fabrication imports the PCFs into Spoolgen. 4. Fabrication reviews the PCFs, comparing the as-designed data with how it will be fabricated, and recommends modifications. 5. If required, fabrication modifies the PCFs, using Spoolgen. In most cases, only a small portion of drawings are modified. Smart Construction 2017 requires Spoolgen for this work process. 6. Fabrication generates new spool drawings from Spoolgen to the construction project's data warehouse in SmartPlant Foundation. The spool drawing should be named the same as the one originally published from Smart 3D. Intergraph Smart Construction Administration and Configuration Guide 126

127 Getting Data into Smart Construction To better identify your drawings in Smart Construction, select the Display drawing type beside drawing name? system option. For more information, see Configure and update system settings for Smart Construction (on page 31). 7. Construction retrieves data in Smart Construction. For more information on retrieving data in Smart Construction, see Retrieve data (on page 106). If data was previously retrieved in Smart Construction, the new fabrication data supersedes the existing data. Before data can be retrieved into Smart Construction, administrators can configure the SPCRetrieveMappings.xlsm workbook for fabrication data. For more information, see Specify whether a component based on a class definition is replaced by fabrication in the Intergraph Smart Construction Customization Guide. Administrators can also copy properties from one component to another. For example, engineering properties can be copied to a component modified by fabrication. For more information, see Copy properties between a replaced component and a replacement component in the Intergraph Smart Construction Customization Guide. Using data with fabrication modifications in Smart Construction After data is retrieved into your Smart Construction site, you can plan components in your IWPs. For more information, see Add, view, or remove components in an IWP in the Intergraph Smart Construction User's Guide. Which components are planned in IWPs? In most cases, you'll plan IWPs with the latest retrieved data in your construction site. If data with fabrication modifications is retrieved into your construction site, you'll plan IWPs with data that has modification changes. When you select a component in a model or drawing and drag it to your IWP, the latest data is pulled into your IWP. There are special cases when superseded, or outdated, components can be planned. If you have specific security permissions, you can plan a superseded component or spool in your IWP by dragging the superseded component to an IWP. If you try to plan a superseded component without the proper permissions, Smart Construction alerts you. I was working with a particular spool in a drawing in my project, and now I can't find it. Where did it go? If you can't find a particular spool in a drawing, it was most likely superseded and replaced with new data after fabrication modifications were retrieved into your site. Smart Construction alerts users with an engineering change flag on an IWP when planned drawings have been updated. What components do I see in models and drawings? In most cases, you'll see the latest isometric data in drawings, if that data was retrieved into your Smart Construction project. Models are not always updated graphically with the latest fabrication changes. When you search for components using Quick Find, or you filter, use selection rules or the Clip Volume box, the search results and filters display the latest retrieved data. That data includes fabrication modifications, if that data was retrieved to your site. When highlighting fabricated components, such as spools in a 3D model, the make-up of these components could differ from what is present in the model being viewed. You can select a user preference to determine what is highlighted in the model - closest match highlights the original Intergraph Smart Construction Administration and Configuration Guide 127

128 Getting Data into Smart Construction engineered parts that match closest to the fabricated parts, and exact match highlights only the parts that exist in the model being viewed. Smart Construction displays the exact match in any fabrication drawing. Using the SPC_PackageReplacedEngineeringComponents, SPC_OriginalDrawingView, and SPC_OriginalSpoolView access groups, you can search and select components in models using the Clip Volume dialog box, selection rules, and Quick Find to view which components and spools were superseded by fabrication. The results show both the current component and the superseded one. How do I see both the engineering and fabrication data in Smart Construction? Using the SPC_OriginalDrawingView and SPC_OriginalSpoolView access groups, you can view both the engineering and fabrication data in Smart Construction, if that data was retrieved to your site. When configured, you can view the superseded and current data in filters, Quick Find, selection rules, and the Clip Volume dialog box. You can configure Smart Construction to display both the latest engineering drawing and any superseded versions of the drawing. For example, an engineering drawing might be superseded by a drawing with fabrication changes. You can configure Smart Construction to display both the current spool and any superseded versions of the spool. Intergraph Smart Construction Administration and Configuration Guide 128

129 S ECTION 17 Manage Browser Color Definitions Administrators can create and manage color definitions or filters for the Work Package browser window and the Materials window. Users can apply these filters to color packages and material items. For example, administrators can create a color definition for a specific discipline. When a user applies that discipline filter to the Work Package browser window, the associated IWPs are colored. For more information on using the browser color definitions, see Filter the objects in browser windows with color definitions in the Intergraph Smart Construction User's Guide. Create a browser color definition Users with the SPC_ManagePublicColorDefinitions access group associated with their role can create and update browser color definitions. 1. Log on to Smart Construction as an administrator. 2. Click Work Packages or Materials on the Project Home Page. 3. Click Browser Color Definitions to open the Create Color Definition dialog box. 4. Click + Add to add criteria to the color definition. 5. On the Properties and Relationships menu, select a property or relationship name. Click Search criteria to return to the Search criteria menu. 6. Type or select search criteria for the property or relationship. Type or select dates for date boxes. 7. Click Add to add the search criteria to your search. menu. Click Properties and Relationships to return to the Properties and Relationships 8. Continue to add properties and relationships to the search criteria. Select more property or relationship definitions from the Properties and Relationships menu to personalize your search for filtering. 9. Click Preview to view a list of work packages that fit your criteria. 10. Click Save to open the Save Query menu. 11. Type a name for the filter in the Name box. 12. Type a description and display name in the Description box. client. The description is the filter name that displays to users in the Smart Construction Intergraph Smart Construction Administration and Configuration Guide 129

130 Manage Browser Color Definitions 13. Select a color in the Select color box. For more information on selecting colors in Smart Construction, see Change colors in models or drawings in the Intergraph Smart Construction User's Guide. 14. Click Save. Sequence browser color definitions 1. Log on to Smart Construction as an administrator. 2. Click Work Packages or Materials on the Project Home Page. 3. Click Browser Color Definitions to view the list of color definition filters available for the window. 4. Select the color definition filters you want to sequence, and use the Up and Down arrows to sequence the color definitions. If an object can be filtered by more than one criterion, it is filtered by the criterion listed at the bottom of the Browser Color Definitions list. Update a color definition 1. Log on to Smart Construction as an administrator. 2. Click Work Packages or Materials on the Project Home Page. 3. Click Browser Color Definitions to view the list of color definition filters available. 4. Click the filter name to edit the description. 5. Type your changes in the box and press ENTER or TAB to save changes. 6. Click Change color to open the Filter options box and select a new color for the filter. For more information, see Change colors in models or drawings in the Intergraph Smart Construction User's Guide. 7. Click Manage to open the Manage color definition dialog box. 8. On the Manage color definition dialog box, select the criterion to edit the details. 9. Click + Add to add criteria to the color definition. On the Properties and Relationships menu, click a property or relationship definition to define. Click Search criteria to return to the Search criteria menu. 10. Type or select search criteria for the property or relationship. Type or select dates for date boxes. 11. Click Add to add the search criteria to your search. menu. Click Properties and Relationships to return to the Properties and Relationships 12. Continue to add properties and relationships to the search criteria. Select more property or relationship definitions from the Properties and Relationships menu to personalize your search for filtering. 13. Click Preview to view items that fit your criteria. Intergraph Smart Construction Administration and Configuration Guide 130

131 Manage Browser Color Definitions 14. Click Save to open the Save Query menu. 15. Click Yes to update the saved color definition. Delete a color definition 1. Log on to Smart Construction as an administrator. 2. Click Work Packages or Materials on the Project Home Page. 3. Click Browser Color Definitions to view the list of color definition filters available. 4. Click Delete next to the color definition you want to delete. 5. Click Yes to delete the color definition. Find saved query definitions in the SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Administration > Saved Query Definitions. 3. Type the name of the item you want to update in the Find dialog box and click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. Intergraph Smart Construction Administration and Configuration Guide 131

132 S ECTION 18 Configure File Types for Smart Construction A file type is a setting in SmartPlant Foundation that specifies the format of attached files based on the file extension. The setting determines how files are viewed in Smart Construction. You must have the correct security privileges to create, edit, and configure file types. Contact your Smart Foundation system administrator for more information. Configure file types for IWP files In order to add a file to a Smart Construction IWP and view that file, the file type of the added file must be configured in SmartPlant Foundation. For information on configuring file types in SmartPlant Foundation, see SmartPlant Foundation How to Configure the Infrastructure Model or SmartPlant Foundation How to Configure Document Management. Configure file types for Smart Construction When you installed and configured Smart Construction, several administrative files were loaded into SmartPlant Foundation to help configure Smart Construction. The administrative load files enabled the ability for system administrators to select a view application for file types. You must have the correct security privileges to create, edit, and configure file types. Contact your SmartPlant Foundation system administrator for more information. Available View Applications Native Markup 2D Viewer 3D Viewer Opens file types in the native application or viewer for that file format. For example, an Excel workbook would open in Microsoft Excel or Excel Viewer, if those applications were present on the machine. Opens file type in SmartPlant Markup Plus. Opens file type in the 2D viewer. Opens file type in the 3D viewer. 1. Log on SmartPlant Foundation as an administrator. 2. Click Find > Administration > File Types. 3. Type the name of the item you want to update in the Find dialog box. Click OK. Intergraph Smart Construction Administration and Configuration Guide 132

133 Configure File Types for Smart Construction You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Right-click a file type object and select Update. 5. Under Smart Construction, select an application from the View Application box. 6. Select the Exclude this file type from work packages check box to exclude the file type from IWPs. 7. Click Apply or Finish to save changes. If you do not have SmartPlant Markup Plus installed, set the view application to Native. The file type opens in its native application, if the application is present on the machine. If you set the view application to 2D Viewer or 3D Viewer, the file type opens in the 2D Viewer and 3D Viewer delivered with SmartPlant Markup Plus. If you exclude a specific file type from Smart Construction IWPs, the exclusion applies to any new files added, not to files that already exist in Smart Construction. Intergraph Smart Construction Administration and Configuration Guide 133

134 S ECTION 19 Configure Engineering Numbering System to Automatically Name Work Packages You can configure the Engineering Numbering System (ENS) in SmartPlant Foundation Desktop Client to automatically name work packages (CWAs, CWPs, and IWPs) in Smart Construction. For more information on ENS, see Configure the Engineering Numbering System (ENS) in the SmartPlant Foundation How to Configure Classified Objects guide. The ENS provides an automated object identification facility, which allows project-specific identification formats to be configured as templates. SmartPlant Foundation uses these templates to guide the user when creating new objects. The ENS definition is composed of various components called ENS items that can extract data from constants and from other properties on the object or related objects. These components are configured in sequence with additional delimiter characters to define the required format. On the ENS Definition dialog box, the Property set by ENS is the property of an object you want the ENS set on. For a Smart Construction work package, select the Name property. You can open the Manage the ENS Definition dialog box by right-clicking the ENS definition and selecting Manage ENS Items. You can view how your ENS items displays in the Preview box on the bottom left of the Manage ENS Definition dialog box. You can use the WBS path as part of your naming convention for IWPs. You can specify that the WBS path for the CWP related to the IWP is included in the name. If you subsequently change the CWP to which the IWP is related, the WBS path in the IWP name does not change. Once an IWP is created, the name is read-only. The only way to get the new WBS path into the name is to delete and re-create the IWP. If traversing a relationship definition, you must precede the relationship definition name with the direction (+ or -). If traversing from end 1 to end 2 of the relationship, use the minus symbol (-) before the name of the relationship definition. If traversing from end 2 to end 1, use the plus symbol (+) before the name of the relationship definition. If the ENS is configured, the number or name box is locked and displays To be assigned. When the package is saved, ENS fills in the name with the configured format. Intergraph Smart Construction Administration and Configuration Guide 134

135 Configure Engineering Numbering System to Automatically Name Work Packages Automatically name IWPs example The ENS consists of an ENS definition and ENS items that can extract data from constants and from other properties on the object or related objects. These components are configured and sequenced with additional delimiter characters to define the required format. Usually the ENS definition contains an ENS Item of type function sequence. The sequence is incremented each time a new object is created. Once the ENS definition has been created and ENS items added to it, you apply the ENS to an object by relating the ClassDef of the object to an ENS definition. The following example creates ENS items that name Smart Construction IWPs with the following format, IWP-Purpose-SequenceNumber. Create an ENS definition to name IWPs 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click File > New > Administration > ENS Definition. 3. On the New ENS Definition dialog box, type a required Name, optional Description, and select the Property set by ENS. The Property set by ENS is the property of an object you want the ENS set on. For a Smart Construction IWP, select the Name property. 4. Click Finish to create the ENS definition. When you click Finish, the Manage ENS Definition dialog box automatically displays allowing you to start adding new ENS items to the definition. You can also access this dialog box by right-clicking an ENS definition and selecting Manage ENS Items. Create ENS items to name IWPs After creating your ENS definition, you must create ENS items to define your IWP names. The following example creates ENS items that name Smart Construction IWPs with the following format, IWP-Purpose-SequenceNumber. Format the constant ENS item IWP The first ENS item is a constant containing the characters IWP. 1. Click the Create button on the Manage Engineering Numbering System dialog box to display the New ENS Item dialog box. 2. Type a name for the ENS item and select Constant for the ENS Type. 3. Enter a dash (-) in the ENS delimiter after box. 4. Type IWP in the ENS constant box. 5. Click Finish to save the new ENS item and add it as the first item in the list on the Manage Engineering Numbering System dialog box. Format the ENS item for Purpose The second ENS item is for the Purpose property selected when you create a new IWP. Intergraph Smart Construction Administration and Configuration Guide 135

136 Configure Engineering Numbering System to Automatically Name Work Packages 1. Click the Create button on the Manage Engineering Numbering System dialog box to display the New ENS Item dialog box. 2. Type a name for the ENS item and select Property for the ENS Type. 3. Enter a dash (-) in the ENS delimiter after box. 4. Type a value for the ENS Field length. 5. Select the ENS pad justification. 6. Type FIWP_Purpose for the ENS property definition UID. 7. Click Finish to save the new ENS Item. Format the ENS item for Sequence The final ENS item is for the Sequence number for each IWP created. This sequence number starts at 1 for each combination of the preceding options. 1. Click the Create button on the Manage Engineering Numbering System dialog box to display the New ENS Item dialog box. 2. Type a name for the ENS item and select Function for the ENS Type. 3. Type a value for the ENS delimiter after box. 4. Type a value for the ENS field length. 5. Select the ENS pad justification. 6. Type a value in the Sequence start number box. 7. Type a value in the ENS pad character box. 8. Click Finish to save the new ENS item. Create a new ENS relationship between the ENS definition and the IWP object After adding ENS items to the ENS definition, you must add the ENS definition to the SPC_FIWP class definition. 1. Click Find > Schema > Class Definition. You can also query for the class definition. Click Query > Schema > Class Definition. 2. Type SPC_FIWP or the name of the class definition to find. 3. Drag the ENS definition you previously created onto the IWP class definition. 4. On the New Relationship dialog box, click OK to create the new ENS relationship. If the ENS is configured, the number or name box is locked and displays To be assigned. When the package is saved, ENS fills in the name with the configured format. Intergraph Smart Construction Administration and Configuration Guide 136

137 S ECTION 20 Create and Configure External Data Filters You can use external data sources, such as a database, to create filters for use in 3D models and 2D drawings in Smart Construction projects. This feature provides direct integration between your existing systems and Smart Construction. Configuring external data filters is a multi-step process consisting of setting up an external data filter connection, setting up an external data filter query, and creating an external data filter object in SmartPlant Foundation. The data filter object in SmartPlant Foundation uses the connection information and query to set up and map a structure between the external data and the object properties as published to the Smart Construction server. You can configure filters for numeric values by adding a tilde and a UoM after the numeric value. For example, 3~in. The filtered object must exist in SmartPlant Foundation Desktop Client. Create a new external data filter connection In order to create an external data filter, you must set up a connection object to communicate with the external data source. Verify the correct data source provider is installed on the server when you configure the external filters. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > New > Administration > External Data Filter Connection to open the New External Data Filter Connection form. 3. On the New External Data Filter Connection form, type a name for an external data filter connection in the Name box. 4. Type a description for the external data filter connection in the Description box (optional). 5. Enter an OLEDB data source for the external data connection in the Connection string box. An OLEDB connection string specifies the data source type (provider), data source location, and credentials. Formats for data connections vary, depending on the tool used to create the connection. The following example is an OLEDB connection created using Microsoft Access 2010: Provider=Microsoft.ACE.OLEDB.12.0;Data Source=c:\temp\externalfilters\GateValveStatus2010_x64.xlsx;Extended Properties="Excel 12.0;HDR=Yes;" 6. Click Apply or Finish to save the external data filter connection information. Intergraph Smart Construction Administration and Configuration Guide 137

138 Create and Configure External Data Filters Create a new external data filter query After creating the external data filter connection object, you need to specify the query to run against the data provider. The query must be a standard SQL select type query that returns data for the objects that meet the query criteria, such as Tag Number, Line Number, or spool. Those fields can be mapped to an existing property of the object in the SmartPlant schema. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > New > Administration > External Data Filter Query to open the External Data Filter Query form. 3. On the External Data Filter Query form, type a name for the data filter query in the Name box. 4. Type a description for the data filter query in the Description box (optional). 5. Type a query string in the Query string box. The query string must be a standard SQL select statement that returns the objects that you want to select in the 3D model or 2D drawing, as seen in the following example: SELECT <FieldName> FROM <Table> WHERE <Condition = 'Value'> ORDER BY <FieldName>. For example, a query string for a spool external filter could be SELECT Spool_No FROM [SummaryReport$]. 6. Click Apply or Finish to save the New External Data Filter Query form. Create a new external data filter After creating the connection and query objects, you need to create the filter object. You can then connect the filter object to the connection and query objects using the New External Data Filter form. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > New > Administration > External Data Filter to open the New External Data Filter form. 3. Type a name for the new data filter in the Name box. The name displays in the Smart Construction Available Filters list in a 3D model or 2D drawing. 4. Type a description of the new data filter in the Description box. 5. Type the mapping to connect the data returned to the Smart Construction schema object property in the Mapping box. The mapping string is in the format of <interface name>@<property name>@<query field name>. For example, a mapping for a spool external filter could be IObject@Name@Spool_No. If you are returning multiple fields in your query, separate multiple items with #, as seen in the following format: Intergraph Smart Construction Administration and Configuration Guide 138

139 Create and Configure External Data Filters <interface field>#<interface field name>. 6. Select a connection object for the data filter to use in the Connection box. 7. Select the query object to use for this data filter in the Query box. 8. Type a name in the Filter subcategory box to display the external filter in a subcategory in the Available Filters list in Smart Construction. If no subcategory is defined, the external filter displays in the External Data category in the client. 9. Click Apply or Finish to save the external data filter information. Use an external data filter in Smart Construction If a model or drawing was open in Smart Construction while you created and configured an external filter, you must close the 3D Model View or 2D Drawing View in order to view the filter in the Available Filters group. 1. Log on to Smart Construction. 2. Click Models or Drawings on the Project Home Page. 3. Select a model in the Models Browser to open. Or select a drawing in the Drawings Browser to open. 4. On the Toolbox, click Expand to view the Applied Filters group, if not expanded already. group. The model or drawing name is the first item displayed in the Applied Filters 5. Click Add Filter on the Applied Filters group to open the Available Filters group. 6. Click Expand next to External Data filters in the Available Filters group to view filters available for the model or drawing. 7. Add a filter to the Applied Filters group or 3D model or 2D drawing from the External Data group. You can add a filter one of the following ways: Select the check box next to a filter name in the Available Filters group. Select a filter name on the Available Filters group and then drag the filter name to the open 3D model or 2D drawing. Select a filter name on the Available Filters group and then drag the filter name to the Applied Filters group. Double-click the filter name in the Available Filters group to add to the Applied Filters group. Intergraph Smart Construction Administration and Configuration Guide 139

140 S ECTION 21 Configure Work Package Disciplines and Purposes You can update and configure disciplines and purposes that display in the Overview windows of CWPs and IWPs in Smart Construction. When you create a CWP and IWP in Smart Construction, you can select a discipline for the package, such as Piping or Electrical. After you select a discipline for an IWP, you can then select a purpose specific to the IWP's discipline, such as Fabrication or Installation. Disciplines and purposes are configurable and can be personalized for a company's business needs and practices. If you want to add new objects and relationships to meet the needs of your company, you can extend the Smart Construction schema in the Custom_SPC.eds file in Schema Editor. For more information, see Extend the Smart Construction Schema (on page 211). When you install Smart Construction, the following enumerated lists are delivered with the Smart Construction schema: Construction discipline - defines disciplines for IWPs and CWPs. FIWP purposes - defines purposes for IWPs. FIWP purposes lookup - defines a relationship between IWP disciplines and purposes. Purposes are assigned to disciplines. You can create and edit disciplines and purposes by editing or adding child entries in their respective enumerated list, Construction discipline or FIWP purposes enumerated list. After editing or creating disciplines or purposes, you can define the relationships among the IWP disciplines and purposes in the FIWP purposes lookup enumerated list. This enumerated list defines which purposes are available for which disciplines in the Smart Construction client interface. After you add or edit disciplines and purposes in the schema, you must load the edited schema file into SmartPlant Foundation Desktop Client. After the load, users can view the updated disciplines and purposes on the package Overview window in Smart Construction. Intergraph Smart Construction Administration and Configuration Guide 140

141 Configure Work Package Disciplines and Purposes Edit schema for disciplines and purposes When you install Smart Construction, the following enumerated lists are delivered with the Smart Construction schema: Construction discipline - defines disciplines for IWPs and CWPs. FIWP purposes - defines purposes for IWPs. FIWP purposes lookup - defines a relationship between IWP disciplines and purposes. Purposes are assigned to disciplines. If you want to add new objects and relationships to meet the needs of your company, you can extend the Smart Construction schema in the Custom_SPC.eds file in Schema Editor. For more information, see Extend the Smart Construction Schema (on page 211). Edit or create disciplines in the Construction discipline enumerated list Disciplines can be edited or created by editing or adding child entries in the Construction discipline enumerated list. For example, you can add disciplines such as Piping or Electrical to the Construction discipline enumerated list, as seen in the following diagram. Intergraph Smart Construction Administration and Configuration Guide 141

142 Edit or create purposes in FIWP purposes enumerated list Configure Work Package Disciplines and Purposes Purposes can be edited or created by editing or adding child entries to the FIWP purposes enumerated list. For example, you can add purposes such as Installation, Fabrication, and Hydro-testing to the FIWP purposes enumerated list, as seen in the following diagram. Define relationships in the FIWP purposes lookup enumerated list After editing and creating disciplines and purposes, the relationships among all IWP disciplines and purposes must be defined in the FIWP purposes lookup enumerated list. For every discipline added to the Construction disciplines enumerated list, you must also relate it to the FIWP purposes lookup enumerated list. For every purpose added to the FIWP purposes enumerated list, you must also relate it to the appropriate discipline child list in the FIWP purpose lookup enumerated list. The entries in the FIWP purposes lookup enumerated list must be related from the Construction discipline enumerated list and the FIWP purposes enumerated list. Intergraph Smart Construction Administration and Configuration Guide 142

143 Configure Work Package Disciplines and Purposes Edit existing or add new disciplines to the schema Existing disciplines can be edited, and new disciplines can be added as new child entries in the Construction discipline enumerated list using SmartPlant Schema Editor. 1. Configure your custom schema files. For more information, see Extend the Smart Construction schema work process (on page 211). 2. Open the SmartPlant Schema Editor. 3. Click File > Open > Starting File. 4. Browse to the Custom_SPC.eds file. Click Open. 5. Click View > Schema (All). 6. Expand EnumListType in the Tree View. 7. Right-click Construction discipline and click Edit Construction discipline to open the Edit Enumerated List dialog box. 8. To edit an existing discipline, click on the name of a discipline in the Tree View to select it. Edit information related to the selected discipline. You can edit the name of the discipline in the Name/short description box or the number in the Number box. 9. To add a new discipline to the enumerated list, click New Child Entry on the Edit Enumerated List dialog box. a. Type a name to describe the new discipline in the Name/short description box. b. Type a number in the Number box. 10. Click OK on the Edit Enumerated List dialog box to add the new discipline. 11. Click File > Save All Modified Files. Edit existing or add new purposes to the schema Existing purposes can be edited, and new purposes can be added as new child entries in the FIWP purposes enumerated list using SmartPlant Schema Editor. 1. Open the SmartPlant Schema Editor. 2. Click File > Open > Starting File. 3. Browse to SPC_CustomSPC.eds and click Open. 4. Click View > Schema (All). 5. Expand EnumListType in the Tree View. 6. Right-click FIWP purposes and click Edit FIWP purposes to open the Edit Enumerated List dialog box. 7. To edit an existing purpose, click on the name of a purpose in the Tree View to select it. Edit information related to the selected purpose. You can edit the name of the discipline in the Name/short description box or the number in the Number box. Intergraph Smart Construction Administration and Configuration Guide 143

144 Configure Work Package Disciplines and Purposes 8. To add a new purpose to the enumerated list, click New Child Entry on the Edit Enumerated List dialog box. a. Type a name to describe the new package purpose in the Name/short description box. b. Type a sequence number in the Number box. 9. Click OK on the Edit Enumerated List dialog box to add the new purpose. 10. Click File > Save All Modified Files. Intergraph Smart Construction Administration and Configuration Guide 144

145 Configure Work Package Disciplines and Purposes Add disciplines and purposes to the FIWP purpose lookup enumerated list All new or edited disciplines and purposes from both the Construction discipline and the FIWP purposes enumerated lists must be related to the FIWP purposes lookup enumerated list. The FIWP purpose lookup enumerated list must be edited in the SmartPlant Schema Editor. Add a discipline to the FIWP purpose lookup enumerated list 1. Open the Custom_SPC.eds file in Schema Editor. 2. Click View > Schema (All). 3. Expand EnumListType in the Tree View. 4. Right-click FIWP purpose lookup and click Edit FIWP purpose lookup to open the Edit Enumerated List dialog box. 5. Click New Child List on the Edit Enumerated List dialog box. 6. Type a name in the Name/short description box. The name for the discipline entry must match the name of the discipline used in the Construction discipline enumerated list. 7. Type a number in the Number box. 8. Click OK to save changes. Add a purpose to a discipline in the FIWP purpose lookup enumerated list 1. Open the Custom_SPC.eds file in Schema Editor. 2. Expand EnumListType in the Tree View. 3. Right-click FIWP purpose lookup and click Edit FIWP purpose lookup to open the Edit Enumerated List dialog box. 4. On the Overview tab, select a discipline in the enumerated list. 5. Click Browse next to the Contains box to open the Possible Entries for [discipline name] dialog box. 6. Search for the purpose you want to add to the discipline in the Starts with box. 7. Select the purpose from the Selectable list. 8. Click OK. 9. Verify the purpose was added to the Contains box on the Edit Enumerated Entry dialog box. 10. Click OK to save changes. 11. Click File > Save All Modified Files. 12. Close the SmartPlant Schema Editor. Intergraph Smart Construction Administration and Configuration Guide 145

146 Configure Work Package Disciplines and Purposes Load edited schema into SmartPlant Foundation After editing or creating disciplines and purposes in the SmartPlant Schema Editor, you must load the edited custom schema into the SmartPlant Foundation Desktop Client. For more information, see Import Smart Construction schema (on page 99). View the new work package discipline and purpose entries in Smart Construction After loading the schema into SmartPlant Foundation Desktop Client, you can view the new discipline and purpose entries in Smart Construction. 1. Log on to Smart Construction. 2. Click Work Packages on the Project Home Page. 3. Select a level from the list in the Work Package Browser Navigation Tree. Depending on your selection, you can create CWPs, CWAs, and IWPs. 4. Click New on the Work Packages browser. 5. Select a Discipline from the list. 6. Select a Purpose from the list. Intergraph Smart Construction Administration and Configuration Guide 146

147 S ECTION 22 Configure IWP Status You can update and configure status entries that display in the IWP Overview window in Smart Construction. When you create an IWP in Smart Construction, you can select a status for the IWP, such as Issued for Construction or Complete. When you install Smart Construction, the enumerated list, SPCPackageStatusEnum, is delivered with the Smart Construction schema. You can add new or edit existing statuses in the SPCPackageStatusEnum enumerated list. If you want to add new objects and relationships to meet the needs of your company, you can extend the Smart Construction schema in the Custom_SPC.eds file in Schema Editor. For more information, see Extend the Smart Construction Schema (on page 211). After you add or edit status entries in the schema, you must load the edited schema file into SmartPlant Foundation Desktop Client. After the load, users can view the newly edited statuses on the IWP Overview window in Smart Construction. Edit existing or add status entries to the schema Existing status entries can be edited, and new status entries can be added as new child entries in the SPCPackageStatusEnum enumerated list using SmartPlant Schema Editor. 1. Configure your custom schema files. For more information, see Extend the Smart Construction schema work process (on page 211). 2. Open the SmartPlant Schema Editor. 3. Click File > Open > Starting File. 4. Browse to Custom_SPC.eds. Click Open. 5. Click View > Schema (All). 6. Expand EnumListType in the Tree View. 7. Right-click SPCPackageStatusEnum and click Edit SPCPackageStatusEnum to open the Edit Enumerated List dialog box. 8. To edit an existing status, click on the name of a status in the Tree View to select it. Edit information related to the selected status. You can edit the name of the status in the Name/short description box or the number in the Number box. The Number box determines the sequence of the status in the Status list on the Smart Construction IWP Overview window. 9. To add a new status to the enumerated list, click New Child Entry on the Edit Enumerated List dialog box. 10. Type a name to describe the new status in the Name/short description box. 11. Type a number in the Number box. Intergraph Smart Construction Administration and Configuration Guide 147

148 Configure IWP Status The sequence number determines the sequence of the status in the Status list on the Smart Construction IWP Overview window. 12. Click OK on the Edit Enumerated List dialog box to add the new status. 13. Click File > Save All Modified Files. Load edited schema into SmartPlant Foundation After editing or creating new status entries in the SmartPlant Schema Editor, you must load the edited schema into SmartPlant Foundation Desktop Client. For more information, see Import Smart Construction schema (on page 99). View the new status entries in Smart Construction After loading the schema into SmartPlant Foundation Desktop Client, you can view the new status entries in Smart Construction. 1. Log on to Smart Construction. 2. Click Work Packages on the Project Home Page. 3. Select a level from the list in the Work Package Browser Navigation Tree. Depending on your selection, you can create CWPs, CWAs, and IWPs. 4. Click New on the Work Packages browser. 5. Select a Status from the list. Intergraph Smart Construction Administration and Configuration Guide 148

149 S ECTION 23 Configure Documents In order to import and manage documents within Smart Construction, some configuration is required in the SmartPlant Foundation Desktop Client. Configure document classification and filtering in SmartPlant Foundation Desktop Client The categories of documents and filtering of what documents can be viewed in Smart Construction is configured in SmartPlant Foundation Desktop Client. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Options. 3. In the Find Smart Construction Options dialog box, type SPC System Options, and click OK. 4. In the search results, right-click SPC System Options, and select Update. 5. To populate the Documents classification tree, in the Documents Setting Details section of the Update form, in the Document Category Setting box enter an interface name and a document classification name in the form InterfaceName@DocumentClassificationName. Use a tilde (~) to include more than one classification in the tree. For example, ISPFDocumentClass@3D Documents~ISPFDocumentClass@Construction Documents would result in two nodes appearing in the Documents tree called "3D Documents" and "Construction Documents." 6. In the Document Category Filter Interface box, enter an interface name to specify the classification within which users can search in the Documents window. Use a tilde (~) to include more than one interface. For example, a value of ISPFDesignDocClass~ISPFTemplateClass would restrict search on classifications that implement one of the listed interfaces. 7. In the Document Query Interface List box, enter an interface name to restrict the search to specific document types. Use a tilde (~) to include more than one interface. This value is blank by default, meaning all document types will be shown in the query results. 8. Click Finish to save your changes. The RelDef to navigate to Document ClassDef and File attachment configuration boxes are used to define how to create documents in Smart Construction. These fields are the same fields used by SmartPlant Foundation for document creation. For more information, see Configure classified documents in the How To Configure Classified Objects guide. Intergraph Smart Construction Administration and Configuration Guide 149

150 Configure Documents Configure IWP files to automatically attach to IWPs When you create an IWP, you can automatically attach files to the IWP based on the discipline or purpose of the IWP. For example, you can configure a certain file to attach to piping installation IWPs. After you configure the relationship between the file and the discipline or purpose, the file automatically attaches to any new IWPs created with the specified discipline or purpose. 1. Add a file to an IWP so that it is available in the Available Files browser in Smart Construction. For more information, see Add, view, or remove files in a work package in the Intergraph Smart Construction User's Guide. 2. Log on to SmartPlant Foundation Desktop Client. 3. Click Smart Construction > Find > Work Package Files to search for available files for your site. 4. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 5. Click OK to find files. 6. Right-click an IWP file and select Update to open the Update form. 7. Type a discipline name in the Auto attach disciplines box. Use commas to separate disciplines in the Auto attach disciplines box. The discipline must be spelled exactly the same as the discipline defined in the Construction discipline enumerated list. For more information, see Configure Work Package Disciplines and Purposes (on page 140). If left blank, Smart Construction attaches the file to all disciplines. 8. Type a purpose name in the Auto attach purposes box. Use commas to separate purposes in the Auto attach purposes box. The purpose must be spelled exactly the same as the purpose defined in the FIWP purposes enumerated list. For more information, see Configure Work Package Disciplines and Purposes (on page 140). If left blank, Smart Construction attaches the file to all purposes. 9. Select the Auto-attach enabled option to automatically attach the selected file to the IWP. 10. Verify that the Automatically attach related documents when an IWP is created option is selected in the Smart Construction system options. For more information, see Update the Automatically attach related documents when an IWP is created system option (on page 151). 11. Click Finish to save changes. Intergraph Smart Construction Administration and Configuration Guide 150

151 Configure Documents Update the Automatically attach related documents when an IWP is created system option 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Options. 3. In the Find Smart Construction Options dialog box, type SPC System Options, and click OK. 4. In the search results, right-click SPC System Options, and select Update. 5. Verify that the Automatically attach related documents when an IWP is created option is selected to automatically attach files to IWPs on creation. Clear the Automatically attach related documents when an IWP is created option if you do not want files automatically attached to IWPs on creation. Configure file attachment behavior when adding components to IWPs By default, when you add a component to an IWP, files associated with the component are not automatically attached to the IWP. If you want to change this default behavior so that file attachment can be determined when a component is added to an IWP: You must develop a customized solution to determine the documents that can be attached. For an example of such a solution, refer to the customization samples that are delivered with the software. Configure Smart Construction to implement the customized solution. This subsection details how to configure Smart Construction to implement your customized solution. You should perform each of these procedures after your custom solution has be developed. Enable showing related files when adding components to an IWP 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Options. 3. In the Find Smart Construction Options dialog box, type SPC System Options, and click OK. 4. In the search results, right-click SPC System Options, and select Update. 5. Enable the Show related files when adding components to IWP option. You can define a custom columnset for the Attach Files dialog box by entering the UID of your custom columnset in the Columnset for Attached Files by Components Dialog box. Click Smart Construction > Find > Administration > Documents Source Items, then update the Columnset for Attached Files by Components Dialog box. Intergraph Smart Construction Administration and Configuration Guide 151

152 Configure Documents Enable showing related files for document sources 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration > Documents Source Items. 3. In the Find Documents Source Items dialog box, type the name of the documents source item object, and click OK. 4. In the search results, right-click the document source item and select Update. 5. Enable the Show in Attach Files by Components option. In order to see any of the document source items in the Related Files dialog box, one of the user's roles must be associated with the SPC_DocumentsSourceView access group. Create a new documents source You can add new documents source items if new sources are required. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > New > Administration > Documents Source Items. 3. In the New Documents Source Items dialog box, provide a name for the source in the Name box and add configuration information as required. 4. Associate the appropriate access group to the newly created Document Source. For more information on creating a new documents source, contact Intergraph Support. For information on configuring the delivered documents sources, see Configure document classification and filtering in SmartPlant Foundation Desktop Client (on page 149). For information on access groups, see Configure access groups (on page 19). Configure security to show related files when adding components to an IWP In order to see any of the document source items in the Related Files dialog box, one of the user's roles must be associated with the SPC_DocumentsSourceView access group. For more information, see Configure access groups (on page 19). Intergraph Smart Construction Administration and Configuration Guide 152

153 Configure Documents Inform users to enable the user preference for showing related files After enabling the option to show related files on the Smart Construction system object, a user preference option, When I add components to an IWP, ask me what to do with the related documents, is available to users of the software. This option must be enabled by each user in order for the Related Files dialog box to be shown when adding components to an IWP. For more information, see Change my preferences in the Intergraph Smart Construction User's Guide. Intergraph Smart Construction Administration and Configuration Guide 153

154 S ECTION 24 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Through the interoperability of Smart Construction and SmartPlant Foundation, administrators can view, update, and configure Smart Construction objects in SmartPlant Foundation Desktop Client. Configure and manage Smart Construction column sets in SmartPlant Foundation Desktop Client Smart Construction uses SmartPlant Foundation Desktop Client's column set functionality for list views. Column sets can be created and configured in the SmartPlant Foundation Desktop Client for use in Smart Construction list views. Understanding column sets in SmartPlant Foundation Desktop Client In the SmartPlant Foundation Desktop Client, column sets control what properties are displayed in the list view window. Using column sets and column items, administrators can determine the appearance and order of properties to display. Each type of item can have its own column set to determine which properties appear in the list view window. Column sets are composed of column items. Each column item represents a property or relationship value for an item. You can control the order in which the properties are displayed, the property names that are displayed, column widths, and other display attributes by setting the values on the column items. Use the Manage Column Items dialog box to create and configure column items in the SmartPlant Foundation Desktop Client. For more information, see Configure column sets in the How to Configure the GUI Model Guide delivered with the SmartPlant Foundation Desktop Client. Intergraph Smart Construction Administration and Configuration Guide 154

155 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Differences in column sets and column items in Smart Construction and the SmartPlant Foundation Desktop Client Smart Construction uses column sets and column items in much the same way as the SmartPlant Foundation Desktop Client; however, there are two differences in how column items are defined in Smart Construction and the SmartPlant Foundation Desktop Client. In SmartPlant Foundation Desktop Client column sets, the property value defined is the property definition unique identifier (UID). In Smart Construction, the property value is the property defined in the code for each row in the list. Administrators can configure column items to display custom properties or navigate edge and relationship definitions. For more information, see Create a new column item for a column set (on page 160) and Syntax to navigate relationship and edge definitions for Smart Construction column items (on page 161). For information on creating custom column items, see Create Custom Column Items for a Components List Column Set in the Intergraph Smart Construction Customization Guide. Administrators can define a data template in the Data Template column or a cell style in the Cell Style column to specify how the cell in the column set is to behave. Administrators can define one or the other, not both. If a data template is not specified, the column item uses the default data template - read-only text. For example, the SPC_ComponentListComplete column item has the QtyCompleteCellTemplate data template defined, which defines the Complete option on the Components list. Column sets delivered with Smart Construction Smart Construction delivers several column sets for various Smart Construction windows. Column set name Window Description SPC_ComponentListDefaultColumnSet SPC_ComponentListElectricalColumnSet SPC_ComponentListPipingColumnSet SPC_ComponentRegister_ComponentListC olumnset Components window of an IWP Components window of an IWP Components window of an IWP Component Items window. This column set displays for IWP where a discipline is not associated for a column set. The discipline determines which column set is associated with the Components window. This column set displays for electrical IWPs. This column set displays for piping IWPs. This column set displays for Component Items windows not related to a document category. Intergraph Smart Construction Administration and Configuration Guide 155

156 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Column set name Window Description SPC_ComponentRegister_ElectricalColumn Set SPC_CustomReportParams Component Items window Manage Selection Criteria dialog box in SmartPlant Foundation Desktop Client. This column set displays for component registers that are related to a specific document category. By default, the column set is related to the Smart Construction non-published document Cable Schedule, 3D Cable Schedule, and Electrical Cable Schedule. This column set helps define custom report parameters. SPC_DashboardViewWorkPackageColumn Set Dashboard Work Packages window This column set opens in the Dashboard Work Packages window from the Work Breakdown Pie Chart item. SPC_DetailViewComponentRegister SPC_DetailViewCWAColumnSet SPC_DetailViewCWPColumnSet SPC_DetailViewDefaultColumnSet Component Registers browser window CWA browser window Work Packages browser window Browser windows This column set displays in the detail view of the Component Registers browser window. The column set displays the detail view of the CWA browser window This column set displays when you are viewing CWPs in the Work Packages browser window. This column set displays in a browser window that does not have a specific column set specified. Intergraph Smart Construction Administration and Configuration Guide 156

157 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Column set name Window Description SPC_DetailViewDocSourceFilesTabColumn Set SPC_DetailViewDocSrcFilesTab_ExternalFil es_columnset SPC_DetailViewDocSrcFilesTab_SPFDocu ments_columnset SPC_DetailViewDocSrcFilesTab_UnManage dfiles_columnset SPC_DetailViewDrawingColumnSet SPC_DetailViewModelsColumnSet SPC_DetailViewWorkbenchDrawingTabCol umnset SPC_DetailViewWorkbenchFilesTabColumn Set SPC_DetailViewWorkPackageColumnSet SPC_ExportFilter Files tab of an IWP Files tab of an IWP Files tab of an IWP Files tab of an IWP Drawings browser window Models browser window Drawings window of an IWP Files window of an IWP Work Packages browser window Microsoft Excel report from the applied filters list. This column set displays the detail view of the Files window of an IWP. This column set displays in the detail view of the external files section of the Available Files browser in an IWP. This column set displays in the detail view of the SmartPlant Foundation documents section of the Available Files browser in an IWP. This column set displays in the detail view of the package files of the Available Files browser in an IWP. This column set displays in the Drawings browser window. This column set displays in the Models browser window. This column set displays in the Drawings window of an IWP. This column set displays in the Files window of an IWP. This column set displays in the Work Packages browser window. This column set displays in the Microsoft Excel report that is generated when you export an applied filter. Intergraph Smart Construction Administration and Configuration Guide 157

158 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Column set name Window Description SPC_ExportScheduleCWP Export Schedule dialog box This column set displays when you filter CWPs in the Export Schedule dialog box. SPC_FIWPScheduleCrossRefColumnSet SPC_MaterialListDefaultColumnSet SPC_MaterialProjectForecastColumnSet SPC_MaterialsWorkPackageForecastColum nset SPC_MaterialsWorkPackageReservationCol umnset SPC_RetrieveDocumentColumnSet CWP list on the Schedule window of an IWP or CWP. Material Request window in an IWP Materials window Materials window in an IWP Materials window in an IWP Retrieve Data dialog box This column set displays in the CWP list of the Schedule window of an IWP or CWP. This column set displays in the Material Request window of an IWP. This column set displays in the Materials window. This column set displays in the Materials Forecast tab of an IWP. This column set displays in the Materials Reservation tab of an IWP. This column set displays in the Retrieve Data dialog box. SPC_ROPUtilityComponentsColumnSet Components window in the Rules of Progress Utility window. The column set displays when you explore components in the Rules of Progress Utility window. For more information, see Configuring column sets in the SmartPlant Foundation Desktop Client (on page 159). Intergraph Smart Construction Administration and Configuration Guide 158

159 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Configuring column sets in the SmartPlant Foundation Desktop Client For information on creating and configuring column sets in the SmartPlant Foundation Desktop Client to use in Smart Construction, see Configure column sets in the How to Configure the GUI Model Guide delivered with the SmartPlant Foundation Desktop Client. Administrators can configure column items to display custom properties or navigate edge and relationship definitions. For more information, see Create a new column item for a column set (on page 160) and Syntax to navigate relationship and edge definitions for Smart Construction column items (on page 161). For information on creating custom column items, see Create Custom Column Items for a Components List Column Set in the Intergraph Smart Construction Customization Guide. Administrators can define a data template in the Data Template column or a cell style in the Cell Style column to specify how the cell in the column set is to behave. Administrators can define one or the other, not both. If a data template is not specified, the column item uses the default data template - read-only text. For example, the SPC_ComponentListComplete column item has the QtyCompleteCellTemplate data template defined, which defines the Complete option on the Components list. Create a new column set for the Components window You can create a new column set for the Components window of an IWP or the Component Items window of a component register. The IWP discipline determines which column set is associated with the Components window, and you can create a new column set for a specific discipline. If a column set has not been created for a specific discipline, a default column set displays in an IWP Components window in Smart Construction. The document category of a component register determines which column set is associated with the Component Items window of a component register. You can create a new column set for a specific document category. If a column set has not been created for a specific document category, a default column set displays in the Component Items window in Smart Construction. 1. Click File > New > Administration > Column Set to open the New Column Set dialog box. 2. Type a name for the new column set in the Name box. 3. Type a description for the new column set in the Description box. 4. If specifying a column set for a specific discipline, type the name of a discipline in the Package Discipline box. The discipline name must be spelled exactly the same as it appears in the Construction discipline enumerated list. For more information, see Configure Work Package Disciplines and Purposes (on page 140). 5. Click Finish. 6. If specifying a column set for a specific component register document category, drag the new column set to the document category in the document category tree. You can select Terminate Relationships to remove the relationship between the document category and the column set. For more information, see Relationship Management in the SmartPlant Foundation Desktop Client User's Guide. Intergraph Smart Construction Administration and Configuration Guide 159

160 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client 7. Select the relationship to create in the New Relationship dialog box, and click OK. Create a new column item for a column set 1. Click Find > Administration > Column Sets to open the Find dialog box. 2. Type *SPC* in the Find dialog box, and click OK to find Smart Construction column sets. 3. Right-click a column set, and select Manage Column Items for Edit to open the Manage Column Items for Edit dialog box. 4. On the Manage Column Items for Edit dialog box, click Create in the right pane to open the Column Item dialog box. 5. Type a name for the column item in the Name box. 6. Type a description for the column item in the Description box. 7. Type a value for a property name, edge definition, or relationship definition in the Edge definition box, if you are defining a column item by navigating a property name or edge or relationship definition. For information on the syntax to use, see Syntax to navigate relationship and edge definitions for Smart Construction column items (on page 161). 8. Type the data template name in the Data Template box. You can create editable properties for column items in the IWP Components window. The properties can be added to components, work steps, or both. Editable properties are available for string, integer, double, and date property values, not on properties on related items. Type DynamicComponentPropertyCellTemplate to add an editable property to components in the IWP Components window. Type DynamicWorkStepPropertyCellTemplate to add an editable property to work steps in the IWP Components window. 9. Click Finish. After creating a column item, you can edit more details for the column item in the Manage Column Items for Edit dialog box. For more information, see Update column items in a Smart Construction column set (on page 161). To set a Display As property for the column item, open the column item in the Manage Column Items for Edit dialog box, and edit the Display As value. To localize the column item, surround the Display As value with braces { }, which serve as a key to retrieve the value from the resource file. Add the display value to the resource file. Intergraph Smart Construction Administration and Configuration Guide 160

161 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Syntax to navigate relationship and edge definitions for Smart Construction column items Use the following syntax to define properties or navigate relationship or edge definitions for Smart Construction column items. Purpose Syntax Example To show a property [ObjectName]_[PropertyDef initionuid] SPC_ComponentItem_Module, which defines the modules associated with a component. To expand an object with a relationship definition [RelationshipDefinitionUID] _12->End2.[PropertyDefiniti onuid], if expanding from end 1 to end 2. [RelationshipDefinitionUID] _21->End1.[PropertyDefiniti onuid], if expanding from end 2 to end 1. SPC.ComponentItem_Types_12->E nd2.name, which expands to the name of the component item type. To expand an object with an edge definition [EdgeDefinitionUID]_12->E nd2.[propertydefinitionuid] EDG_ComponentToDiscipline_12-> End2.Name, which displays the name of the discipline for a component. Update column items in a Smart Construction column set 1. Click Find > Administration > Column Sets to open the Find dialog box. 2. Type *SPC* in the Find dialog box, and click OK to find Smart Construction column sets. 3. Right-click a column set, and select Manage Column Items for Edit to open the Manage Column Items for Edit dialog box. 4. Select the value you want to edit in the Manage Column Items for Edit dialog box. For example, you can edit what text is displayed in the Smart Construction client. 5. Click the box of the value you want to update for a column item and make your changes. 6. Click OK to save your changes. If you update column items, the changes you make display in all column sets using that column item. To set a Display As property for the column item, open the column item in the Manage Column Items for Edit dialog box, and edit the Display As value. To localize the column item, surround the Display As value with braces { }, which serve as a key to retrieve the value from the resource file. Add the display value to the resource file. Intergraph Smart Construction Administration and Configuration Guide 161

162 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Details for column items The following details can be defined for column items in SmartPlant Foundation Desktop Client. Property Name Description Display As Size OrderValue Property Edge Filterable Data Template Cell Style Hidden by default Disable hide column? Sortable Description Name of the column item. Description for the column item. Name is it displays in the Smart Construction client. Width of the column item. Sequence of how columns appear in the column set. The name of the code-based property (not a property definition). The relationship of edge to be navigated or the property definition name you want to display. The column item is available for filtering. For more information, see Configure the number of column items available for filtering (on page 163). Data template for the column item. A data template can be specified or a cell style property, but not both. Style of the cell in a column item. A data template can be specified or a cell style property, but not both. The column item is added to the column set, but not displayed by default. The user can right-click the column header in the Smart Construction client to display the column item. If set to True, the column item can never be hidden from display. For example, Name can always be shown. If set to True, the column item is available for sorting. Intergraph Smart Construction Administration and Configuration Guide 162

163 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Property Header Style Description Style of the column header. Add column items to a column set 1. Click Find > Administration > Column Sets to open the Find dialog box. 2. Type *SPC* in the Find dialog box, and click OK to find Smart Construction column sets. 3. Right-click a column set, and select Manage Column Items for Edit to open the Manage Column Items for Edit dialog box. 4. Select a column item in the right pane of the Manage Column Items for Edit dialog box to add to the column set. Select column items with the prefix SPC_ComponentList to add to the column set in the Components window. 5. Click Relate Selected Item to relate the column item to the column set. 6. Click OK to save your changes. Remove column items from a column set 1. Click Find > Administration > Column Sets to open the Find dialog box. 2. Type *SPC* in the Find dialog box, and click OK to find Smart Construction column sets. 3. Right-click a column set, and select Manage Column Items for Edit to open the Manage Column Items for Edit dialog box. 4. Select a column item in the left pane of the Manage Column Items for Edit dialog box to remove from the column set. 5. Click Remove Selected Item to remove the column item to the column set. Configure the number of column items available for filtering You can configure the number of column items available for individual filtering on the filtering dialog box in the Smart Construction client. By default, individual filters are available for up to 200 properties. This setting must be configured on each client work station. For more information on filtering column items in Smart Construction, see Filter column headings in the Intergraph Smart Construction User's Guide. 1. Browse to the Smart Construction installation location and open the Smart Construction client configuration file (for example, browse to [Drive]:\Program Files (x86)\smartconstruction\2017\spcclient\spc.client.exe.config). 2. In the SPC.Client.exe.config file, locate the <appsettings> node. 3. Edit the value for the MaximumDistinctFilterCount key to your value. 4. Save and close the SPC.Client.exe.config file. Intergraph Smart Construction Administration and Configuration Guide 163

164 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Create and configure filters in SmartPlant Foundation Desktop Client You can create filter categories that display component properties in Smart Construction models and drawings. After configuring a filter category, filters are dynamically created for you to filter the model or drawing. The filter categories can display component properties delivered with Smart Construction, such as component size. Or you can configure filter categories to display custom properties. The following topics describe how to configure filter categories based on delivered Smart Construction properties. For information on how to configure filter categories for custom properties, see Create Custom Filter Categories Based on Component Properties in the Intergraph Smart Construction Customization Guide. Create a new filter category 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > New > Administration > 2D Filter Category to create a filter category for a 2D drawing. 3. Click Smart Construction > New > Administration > 3D Filter Category to create a filter category for a 3D model. 4. Type a name in the Name box. 5. Type a description for the new filter category in the Description box. 6. Specify how you want the filter category to display in the Smart Construction application in the Display As box. 7. Type SPC.Server.FilterHandlers in the Handler Assembly box. 8. Type SPC.Server.FilterHandlers.DrawingFilter_PropertyFilterHandler for the Handler class box. 9. Select the Enabled option to enable the filter in the Smart Construction application. 10. Select the ShowIfEmpty option to display the filter category in Smart Construction if there are not any filters available for the category. Clear the option if you do not want the category to display when filters are not available. 11. Select the Is filter search enabled to include a search box in the Available Filters box in the Smart Construction client. If you want to include a search box in the Available Filters box in the Smart Construction client, the filter handler assembly and class must support the query. You can include a search box for all filters in the Available Filters box except for Materials and Package Status filters. 12. Specify the interface definition of the property in the Filter interfacedef uid box. 13. Specify the name of the property in the Filter Property DefUID box. 14. Specify a class definition in the Parameter value 1 box. Intergraph Smart Construction Administration and Configuration Guide 164

165 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client is for. Value You can use the following values to specify what kind of component the new filter Details SPC_ComponentItem SPC_Spool SPC_Assembly This value specifies the new filter is for component items. This value specifies the new filter is for spools. This value specifies the new filter is for assemblies. 15. Click Finish to save the new filter category. Search for filter categories in SmartPlant Foundation 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Administration > Filter Categories. 3. Type the name of the item you want to update in the Find Filter Categories dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. Verify new filter category in Smart Construction Verify the new custom filter category displays in Smart Construction. 1. Log on to Smart Construction. 2. Click Models or Drawings on the Smart Construction Home Page to open a model or drawing. 3. Click Add Filter. 4. Browse the filter categories in the Available Filters list for the newly customized filter category you created. 5. Add the filter to the drawing or model. Select the check box next to a filter name on the Available Filters group. Select a filter name from the Available Filters group then drag the filter name to the open model or drawing. Select a filter name from the Available Filters group then drag the filter name to the Applied Filters group. Double-click the filter name in the Available Filters group to add to the Applied Filters group. 6. Verify the correct data displays with the custom filter. Intergraph Smart Construction Administration and Configuration Guide 165

166 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Create and configure selection rules in the SmartPlant Foundation Desktop Client You can create selection rules that allow users to select specific groups of components based on component properties or relationships in Smart Construction models and drawings. These selection rules can be based on a combination of an interface definition and property definition, or they can be based on navigating a relationship definition. You can configure selection rules based on delivered interface definitions, property definitions, or relationship definitions. Or you can create custom selection rules based on custom interface definitions, property definitions, or relationship definitions. The following topics describe how to configure filter categories based on delivered Smart Construction properties. For information on how to configure filter categories for custom properties, see Create a Custom Selection Rule in the Intergraph Smart Construction Customization Guide. Create a new selection rule You can create selection rules based on a combination of an interface definition and property definition or based on navigating a relationship definition. For example, a Modules selection rule is based on a combination of an interface definition and property definition. Module is a property on a component. The Modules selection rule would use the ISPC_ComponentItem interface definition and SPC_ComponentItem_Module property definition to display groups of components in a module. For example, a Bolt-up activities selection rule uses a relationship definition to display components because bolt-ups are activities related to a component. 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > New > Administration > New Selection Rule to create a new selection rule. 3. Type a name in the Name box. 4. Type a description in the Description box. 5. Specify how you want the selection rule to display in the Smart Construction application in the Display As box. 6. Specify a sequence number in the Sequence box. 7. Specify a handler type name in the Handler Type Name box. For property selections, type Navigation_PropertySelectionRule in the Handler Type Name box. 8. Type an interface definition name of the property in the Selection rule interfacedef UID box, if you are defining the selection rule with a combination of an interface definition and property definition. 9. Type the property definition name in the Selection rule propertydef UID box, if you are defining the selection rule with a combination of an interface definition and property definition. Intergraph Smart Construction Administration and Configuration Guide 166

167 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client 10. Type a relationship definition in the Selection rule reldef UID box, if you are defining the selection rule with a relationship definition. 11. Select the Selection rule IsEnd1 option if the selection rule navigates the relationship definition from End 1 to End 2. Clear the Selection rule IsEnd1 option if the selection rule navigates the relationship definition from End 2 to End Click Finish to save the new selection rule. Search for selection rules in SmartPlant Foundation 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Administration > Selection Rules. 3. Type the name of the item you want to update in the Find Selection Rules dialog box, and click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. Manage security for the new selection rule After you create the new selection rule, you must manage security for the object by configuring access groups for users to access the object in the Smart Construction client. 1. Click Smart Construction > Find > Administration > Selection Rules to open the Find Selection Rules dialog box. 2. Type your search criteria in the Find Selection Rules dialog box. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 3. Right-click the name of the selection rule and select Manage Access Groups. 4. On the Manage Access Groups window, select an access group to add to the selection rule. 5. Click Relate Selected Item to add the access group to the selection rule. 6. Click OK to save your changes. For more information on managing access groups, see SmartPlant Foundation How to Configure the Security Model. Intergraph Smart Construction Administration and Configuration Guide 167

168 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Verify the new selection rule in Smart Construction Verify the new selection rule works properly in Smart Construction. 1. Log on to Smart Construction. 2. Click Models or Drawings on the Smart Construction Home Page to open a model or drawing. 3. Click Open selection rules on the 3D model or 2D drawing Toolbox. 4. Select the new selection rule from the Selection rule list. 5. Select components in the 3D model or 2D drawing to display selected component in the Selection Results list. 6. Click Expand to view search results in the Selection Results list. Configure document categories in Documents window The Documents window in Smart Construction client displays all published and non-published documents in SmartPlant Foundation. The document nodes in the Tree View define document categories, such as 3D documents or Bill of Materials documents. You can configure the document category nodes in the Documents window. Edit existing document nodes in the Tree View You can edit the existing document nodes in the Tree View. For example, you can configure the Tree View to only display 3D documents or another document node. Edit method 1. Find the method of the object you want to edit. Click Find > Administration > Method. 2. Type the name of the method in the Find dialog box. Click OK. To find the method associated with the default document Tree View, search for SPC_AllDocuments. To find the method for a custom document Tree View, type the name of the method in the Find dialog box. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 3. Right-click the method in the search results and click Update. 4. Edit the method as needed. To find and edit the document category UID, complete the following steps: a. Select a document category from the Tree View. b. Right-click the document category and select Export Data. Intergraph Smart Construction Administration and Configuration Guide 168

169 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client If you right-click a document category, and you do not see Export Data, see Configure Export Data option (on page 170) for more information. c. On the Export Data dialog box, copy the IObject UID, as defined on the right pane. For example, for the 3D Documents is IObject UID="DC_3D_Documents_1". d. Click Cancel on the Export Data dialog box. 5. Click Finish to update the method. View edited category in Smart Construction 1. Log on to Smart Construction 2. Click Documents on the Home Page. You can view the edited document category in the Tree View. Create and configure document category nodes You can create and configure document category nodes that display in the document Tree View in Smart Construction. All configuration must be done in SmartPlant Foundation. For example, you can create and configure a new document category node, such as Construction Documents, that users with specific security privileges can query. Create a new method 1. Log on to SmartPlant Foundation as an administrator. 2. Click File > New > Administration > Method to open the New Method dialog box. 3. On the New Method dialog box, type a name. 4. Type a description (optional). 5. Type a display name. 6. Select SPCDocumentDrillDown for the Client API. 7. Type a value for the Document Node UID. To find the document category UID, complete the following steps: a. Select a document category from the Tree View. b. Right-click the document category and select Export Data. If you right-click a document category, and you do not see Export Data, see Configure Export Data option (on page 170) for more information. c. On the Export Data dialog box, copy the IObject UID, as defined on the right pane. For example, for the 3D Documents is IObject UID="DC_3D_Documents_1". d. Click Cancel on the Export Data dialog box. 8. Type the document interface definition for the document category you do not want available in the Classification tree filtering box (optional). For example, Smart Construction by default filters the Tree View so that Template documents do not display. The method SPC_AllDocuments lists ISPFDesignDocClass~ISPFTemplateClass in the Classification tree filtering box to hide the Template document class. Intergraph Smart Construction Administration and Configuration Guide 169

170 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client 9. Select the option Available in Desktop client. 10. Click Finish to create the new method and display it in the New Items window. 11. Configure security for the new method. Associate the necessary access groups with the new method. For more information on configuring security for methods, see SmartPlant Foundation How to Configure the Security Model. Create Feature Config object 1. Click Smart Construction > New > Administration > Feature Config Item. 2. On the New Feature Config Item dialog box, type a name. 3. Type a description. 4. Select MainDocCatTree for the Type. 5. Select the method you created in the Spfmethod box. 6. Click Finish. View new category in Smart Construction 1. Log on to Smart Construction 2. Click Documents on the Home Page. You can view the new document category in the Tree View. Configure Export Data option If you right-click a document category, and you do not see the Export Data option, complete the following steps to enable the option. 1. In SmartPlant Foundation Desktop Client, click Find > Administration > Method. 2. Type ExportData in the Find dialog box to find the ExportData method. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 3. Right-click ExportData in the search results and select Manage Interface Definitions. 4. On the Manage Interface Definitions dialog box, search for the ISPFDocumentClass interface definition. 5. Select ISPFDocumentClass interface definition and click Relate Selected Item to relate the interface definition to the ExportData method. 6. Click OK. 7. Right-click a document category from the Tree View and verify Export Data displays on the shortcut menu. Intergraph Smart Construction Administration and Configuration Guide 170

171 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Create and configure work package toolbar items In Smart Construction, administrators can configure and personalize work package toolbar items. For example, administrators can add a new toolbar item, such as Production, to be included in an IWP. New controls, such as text boxes, combo boxes, and check boxes can be created and configured for the new toolbar item. Toolbar items can be configured for CWAs, CWPs, and IWPs. You must complete the following steps to create and configure a new work package toolbar item: 1. Create the new work package toolbar item (on page 172) 2. Use the Smart Construction - Display Editor to configure and personalize your toolbar item (on page 173) 3. Validate the new toolbar item (on page 180) 4. Save the new toolbar item (on page 180) 5. Manage security for the new toolbar item (on page 180) Intergraph Smart Construction Administration and Configuration Guide 171

172 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Create the new work package toolbar item 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > New > Administration > Work Package Toolbar Item to open the New Work Package Toolbar Item dialog box. 3. On the New Work Package Toolbar Item dialog box, type a name for the new toolbar item in the Name box. 4. Type a description in the Description box. 5. Type WorkbenchSectionViewModel_Configurable in the Section ViewModel TypeName box. 6. Type a name for the work package rollup object in the Change flag property box. The Change flag property box determines which work package rollup object is used to display an engineering change flag for that work package toolbar section. 7. Select a type of package for the new work package toolbar item in the Work Package Type box. 8. Select the Update Mode check box to allow updates to your new work package toolbar item. 9. Select the Copy Mode check box to allow users to copy the new work package toolbar item. 10. Type a tooltip as it is to display in the Smart Construction user interface in the Toolbar item tooltip box. 11. Leave the Toolbar item style box empty. This value is not used in configuration. 12. Type a numerical value in the Toolbar item sequence box to define the sequence of the work package toolbar items. 13. Type a display name in the Toolbar item display as box to define how the new item displays in the Smart Construction user interface. 14. Type the name of an image in the Icon Name box. When you type the name of the image in the Icon Name box, include the file extension, such as.png or.jpg. 15. Add the image to the Images folder, located in the Smart Construction installation location (For example, browse to and open [Drive]:\Program Files (x86)\smartconstruction\2017\spcclient\images). Add the icon to the Images folder on any client machine using the newly configured work package toolbar item. 16. Select the Use Display Editor option to use the Smart Construction - Display Editor to configure and personalize your toolbar item. 17. Click Finish to save your changes. Intergraph Smart Construction Administration and Configuration Guide 172

173 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Use the Smart Construction - Display Editor to configure and personalize your toolbar item Administrators can configure the new work package toolbar item to use controls like text boxes, check boxes, and combo boxes using the Smart Construction - Display Editor in the SmartPlant Foundation Desktop Client. If you do not see your changes display in Smart Construction, try logging out of the Smart Construction client and logging back in. Also, check the access groups associated with your toolbar items. An example interface definition and several example property definitions are delivered with Smart Construction. Administrators can use these definitions when ISPC_UserDefine is selected as an interface definition on any added control. For more information, see Personalize Example Interface and Property Definitions (on page 178). For information on localizing Smart Construction, see Localize Smart Construction (on page 203). What do you want to do? Open the Smart Construction Display Editor (on page 173) Add and configure a text box to the work package toolbar item (on page 174) Add and configure a combo box to the work package toolbar item (on page 174) Add and configure a check box to the work package toolbar item (on page 176) Use the Smart Construction - Display Editor to position the new control (on page 176) Edit a control (on page 177) Delete a control (on page 177) Define the order of configured controls (on page 177) Personalize example interface and property definitions (on page 178) Open the Smart Construction Display Editor 1. Click Smart Construction > Find > Administration > Work Package Toolbar Items to open the Find Work Package Toolbar Items dialog box. 2. Type your search criteria in the Find Work Package Toolbar Items dialog box. 3. Right-click the name of the toolbar you want to configure and select Display Editor to open the Smart Construction - Display Editor window. Intergraph Smart Construction Administration and Configuration Guide 173

174 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Add and configure a text box to the work package toolbar item You can use the Smart Construction - Display Editor window to create and configure a text box for the Smart Construction work package window. 1. Open the Smart Construction - Display Editor on the toolbar item you want to configure. For more information, see Open the Smart Construction Display Editor (on page 173). 2. On the Smart Construction - Display Editor window, select the Show Grid option to help arrange and align controls. 3. Click Add on the Smart Construction - Display Editor window. 4. Select Textbox on the Select Type dialog box. 5. On the SPC Textbox Attribute dialog box, type a label name in the Label box. This is required. 6. Type a pixel value in the Label Offset box to define where the label displays to the left of where the text box is positioned. 7. Type a pixel value in the Width box to define the width of the text box. If you type zero as your value, the text box stretches to the screen width. 8. Type a pixel value in the Height box to define the height of the text box. The default value is 23 pixels. 9. Select an interface definition value in the Interface box to define where to save and retrieve the data of this control. This is required. 10. Select a property definition value in the Property box. The property value is associated with the interface definition defined for the control, and it helps define where to save and retrieve the data of this control. This is required. 11. In the Tab Order box, type a value to define the display sequence for this control on the work package window. 12. Select Always or Read Only for the Edit Mode value. 13. Select whether or not the text box value is required for the work package from the Required box. 14. Click OK on the SPC Textbox Attribute dialog box to save changes to the new text box. Add and configure a combo box to the work package toolbar item You can use the Smart Construction - Display Editor window to create and configure a combo box for the Smart Construction work package window. Combo boxes display a list of values. Administrators can configure combo boxes for a Smart Construction work package window to use values from a SmartPlant Foundation enumerated list or a list of objects retrieved from a relationship definition relating to a work package object. 1. Open the Smart Construction - Display Editor on the toolbar item you want to configure. For more information, see Open the Smart Construction Display Editor (on page 173). Intergraph Smart Construction Administration and Configuration Guide 174

175 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client 2. On the Smart Construction - Display Editor window, select the Show Grid option to help arrange and align controls. 3. Click Add on the Smart Construction - Display Editor window. 4. Select Combobox on the Select Type dialog box. 5. On the SPC Combobox Attribute dialog box, type a label name in the Label box. This is required. 6. Type a pixel value in the Label Offset box to define where the label displays to the left of where the combo box is positioned. 7. Type a pixel value in the Width box to define the width of the combo box. If you type zero as your value, the combo box stretches to the screen width. 8. Type a pixel value in the Height box to define the height of the combo box. The default value is 23 pixels. 9. Select a value for the Combo Item Source box. 10. Select a relationship definition in the RelDef box. This is required, if you select the source of the combo box to be a relationship definition. 11. Select an interface definition in the Interface box. This is required. If you select the source of your combo box to be a property enumerated list, the interface definition defines where to save and retrieve information for this control. If you select the source of your combo box to be a relationship definition, the interface definition selected is the target object of the relationship definition to return the display value for the combo box list. 12. Select a property definition value in the Property box. This is required. If you select the source of your combo box to be a property enumerated list, the property value is the property associated with the selected interface definition. If you select the source of your combo box to be a relationship definition, the property value associated with the selected interface definition. 13. In the Tab Order box, type a value to define the display sequence for this control on the work package window. 14. Select Always or Read Only for the Edit Mode value. 15. Select whether or not the combo box value is required for the work package from the Required box. 16. Click OK on the SPC Combobox Attribute dialog box to save changes to the new combo box. Intergraph Smart Construction Administration and Configuration Guide 175

176 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Add and configure a check box to the work package toolbar item You can use the Smart Construction - Display Editor window to create and configure a check box for the Smart Construction work package window to display Boolean values. 1. Open the Smart Construction - Display Editor on the toolbar item you want to configure. For more information, see Open the Smart Construction Display Editor (on page 173). 2. On the Smart Construction - Display Editor window, select the Show Grid option to help arrange and align controls. 3. Click Add on the Smart Construction - Display Editor window. 4. Select Checkbox on the Select Type dialog box. 5. On the SPC Checkbox Attribute dialog box, type a label name in the Label box. 6. Select an interface definition value in the Interface box to define where to save and retrieve the data of this control. This is required. 7. Select a property definition value in the Property box. This is required. The property value is associated with the interface definition defined for the control, and it helps define where to save and retrieve the data of this control. 8. In the Tab Order box, type a value to define the display sequence for this control on the work package window. 9. Select Always or Read Only for the Edit Mode value. 10. Click OK on the SPC Checkbox Attribute dialog box to save changes to the new check box. Use the Smart Construction - Display Editor to position the new control You can drag your newly added controls in the Smart Construction - Display Editor window to place them in a desirable position on the work package toolbar item. Controls snap to the grid automatically. 1. Select Show Grid to help position controls to the grid. 2. Select the control you want to position. 3. Drag the control to its desirable position. 4. Click Save to save your changes. Intergraph Smart Construction Administration and Configuration Guide 176

177 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Edit a control You can edit controls for a work package toolbar item at any time in the Smart Construction - Display Editor window. 1. Select a control on the Smart Construction - Display Editor window and click Edit. 2. Edit control details on the Attributes dialog box. 3. Click OK to save changes on the Attributes dialog box. 4. Click Save to save changes on the Smart Construction - Display Editor window. Delete a control To delete a control from a work package toolbar item, select a control on the Smart Construction - Display Editor window and click Delete. Click OK to verify you want to delete the control. Define the order of configured controls You can define the order of configured controls on a toolbar item by manually updating the order on each control or using the Tab Order dialog box. Manually update the Tab Order value for each control 1. Select a control from the Smart Construction - Display Editor window and click Edit. 2. Update the value for the Tab Order box on the Attributes dialog box. 3. Click OK to save changes. 4. Click Save on the Smart Construction - Display Editor window to save your changes. Use the Tab Order dialog box to order the controls 1. Click Tab Order on the Smart Construction - Display Editor window to open the Tab Order dialog box. 2. Select a control from the list and click the up and down arrows to order the controls. 3. Repeat step 2 until all controls are in the correct navigational order. 4. Click OK on the Tab Order dialog box to save changes. 5. Click Save on the Smart Construction - Display Editor window to save your changes. Intergraph Smart Construction Administration and Configuration Guide 177

178 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Personalize example interface and property definitions An example interface definition and several example property definitions are delivered with Smart Construction. Administrators can personalize these schema definitions to fit their business needs. For more information on configuring these items, see the SmartPlant Schema Editor User's Guide. ISPC_UserDefined interface definition is delivered with Smart Construction. ISPC_UserDefined is realized by SPC_FIWP, SPC_CWP, and SPC_CWA. ISPC_UserDefined is implied by ISPC_FIWP, ISPC_CWP, and ISPC_CWA, and it implies IObject. Administrators can use the example property definitions when ISPC_UserDefined is selected as an interface definition on any added control. Property Scoped By Type of User Control User_String1 String Text box User_String2 String Text box User_String3 String Text box User_String4 String Text box User_String5 String Text box User_String6 String Text box User_String7 String Text box User_String8 String Text box User_String9 String Text box User_String10 String Text box User_Integer1 Integer (int) Text box User_Integer2 Integer (int) Text box User_Integer3 Integer (int) Text box User_Integer4 Integer (int) Text box User_Integer5 Integer (int) Text box User_Double1 Double Text box User_Double2 Double Text box User_Double3 Double Text box Intergraph Smart Construction Administration and Configuration Guide 178

179 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Property Scoped By Type of User Control User_Double4 Double Text box User_Double5 Double Text box User_Date1 YMD Text box with a date selector tool User_Date2 YMD Text box with a date selector tool User_Date3 YMD Text box with a date selector tool User_Date4 YMD Text box with a date selector tool User_Date5 YMD Text box with a date selector tool User_Boolean1 Boolean Check box User_Boolean2 Boolean Check box User_Boolean3 Boolean Check box User_Boolean4 Boolean Check box User_Boolean5 Boolean Check box User_Yes_No Yes/No Combo box User_LengthUoM LengthUoM Combo box User_ISODrawingType IsometricDrawingTypes Combo box User_WBSItemTypes WBSItemTypes Combo box Intergraph Smart Construction Administration and Configuration Guide 179

180 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Validate the new toolbar item Validation requires that the interface, relationship, and property definitions selected must be accessible from the work package object, SPC_FIWP. Attribute and interface information provided on the controls of your work package toolbar item automatically validate when you save the toolbar item; however, you can manually validate your new controls at any time during configuration. 1. Open the Smart Construction - Display Editor window. 2. Click Validate. 3. Click OK to verify the validation passed. Save the new toolbar item After you finish configuring your new toolbar item, you can save your changes. Attribute and interface information provided on the controls of your work package toolbar item automatically validate when you save the toolbar item. 1. Open the Smart Construction - Display Editor window. 2. Click Save. 3. Click OK to verify the save operation completed. Manage security for the new toolbar item After you save the new toolbar item, you must manage security for the object, configuring access groups in order for users to access the object in the Smart Construction client. 1. Click Smart Construction > Find > Administration > Work Package Toolbar Items to open the Find Work Package Toolbar Items dialog box. 2. Type your search criteria in the Find Work Package Toolbar Items dialog box. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 3. Right-click the name of the toolbar and select Manage Access Groups. 4. On the Manage Access Groups window, select an access group to add to the toolbar item. 5. Click Relate Selected Item to add the access group to the toolbar. 6. Click OK to save your changes. For more information on managing access groups, see SmartPlant Foundation How to Configure the Security Model. Intergraph Smart Construction Administration and Configuration Guide 180

181 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Work package toolbar item details Administrators can configure the Smart Construction schema to add new property definitions, interface definitions, class definitions, and relationship definitions. For more information on enhancing schema, see the Intergraph Smart Construction Customization Guide and the SmartPlant Schema Editor User's Guide. Certain boxes in your configured controls automatically set to Read Only because they repeat information already configured on another work package toolbar item, such as the Information window. If you add a property definition to a text box that contains a date, the control detects a property definition using a data type of Date (SPF PropertyType = YMD) and automatically adds a tool to allow users to select a date. If you create and configure work package toolbar items, the toolbar items and their information do not display on the work package print report. Administrators must create a custom report template, adding the new work package toolbar items. Administrators can replace the delivered work package report with the new customized report template. For more information, see the Intergraph Smart Construction API and Programming Guide. If you do not see updates and changes to your configured toolbar item, log out of Smart Construction, and log back in to refresh the display. Create and configure custom search criteria for Smart Construction You can create and configure custom search criteria in Smart Construction based on the properties of a related object. Administrators must first create a custom search criteria object, then relate the search object to a relationship or an edge definition. To create a custom search criteria on a document master or revision object, administrators only need to create a custom search criteria object with a target interface definition and target property definition specified. Create custom search criteria for Smart Construction in the SmartPlant Foundation Desktop Client 1. In SmartPlant Foundation, click Smart Construction > New > Administration > Custom Search Criteria to open the New Custom Search Criteria form. 2. Type a name for the custom search criteria in the Name box. 3. Type a description for the custom search criteria in the Description box. 4. Type an interface definition in the Primary interface box to specify from which end of the relationship or edge definition you are querying with the custom search criteria. The value in the Primary interface box must be the primary schema interface definition that is realized by the object the custom search criteria is querying. Intergraph Smart Construction Administration and Configuration Guide 181

182 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client 5. Type an interface definition in the Target interface box to specify what you are querying in your search criteria. The target interface definition can be any interface exposed by the object at the other end of either the relationship or edge definition. 6. Type a property definition name in the Target property box to specify a property for the custom search criteria to search. Defining a target property definition determines how the custom search criteria displays in the Smart Construction client. If the target property definition is defined, Smart Construction displays a search box where users can type search criteria for a query. If the target property definition is not defined, Smart Construction displays all related items that realize the target interface definition in a list. To create a custom search criteria for a document master or revision object, you must specify a target interface definition and a target property definition. 7. Type a name in the Display name box to specify how you want the custom search criteria to display in Smart Construction. Find custom search criteria for Smart Construction in the SmartPlant Foundation Desktop Client 1. In SmartPlant Foundation, click Find > Administration > Custom Search Criteria. 2. Type the name of the item you want to find in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. Right-click a custom search criteria object and select Show EdgeDef or Show RelDef display relationships between the custom search criteria and any edge or relationship definitions. Create a relationship between the custom search criteria and relationship or edge definition After creating a custom search criteria object, you must relate it to the relationship definition or edge definition in the query. 1. In SmartPlant Foundation, find the relationship definition or edge definition. Click Find > Schema > Relationship Definition or Edge Definition, then type the name of the item you want to find in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 2. Find the custom search criteria. Intergraph Smart Construction Administration and Configuration Guide 182

183 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client 3. In SmartPlant Foundation, click Find > Administration > Custom Search Criteria. Type the name of the item you want to find in the Find dialog box. Click OK. 4. Drag the custom search criteria object to the relationship or edge definition to create a relationship between the two objects. The starting interface definition of the edge definition must be realized by the object that realizes the primary interface definition of the custom search criteria. To create a custom search criteria on a document master or revision object, administrators only need to create a custom search criteria object with a target interface definition and target property definition specified. You do not need to relate a custom search criteria object to a relationship or edge definition. Manage IWP files in the SmartPlant Foundation Desktop Client In Smart Construction, you can add external files and folders to an IWP for reference. When you add an external file to an IWP, the file is also added to SmartPlant Foundation as a document. Use the SmartPlant Foundation Desktop Client to manage the file. For more information on document management in the SmartPlant Foundation Desktop Client, see the SmartPlant Foundation Desktop Client User's Guide. Find IWP files in the SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Work Package Files to search for available files for your site. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find files. Working with component register documents Smart Construction can retrieve component register documents, such as cable schedules from SmartPlant Electrical. For more information, see Getting Data into Smart Construction (on page 102). Before retrieving the documents, administrators must configure the appropriate mapping and rules of progress for the documents. For more information, see Configure Mapped Properties for a Published Document (on page 92) and Configure the Rules of Progress (on page 88). After the document is retrieved, users can open and view the component register documents. And, the documents can be associated with IWPs, planning them with rules of progress data. For more information, see View and manage component registers in the Intergraph Smart Construction User's Guide. Intergraph Smart Construction Administration and Configuration Guide 183

184 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Find component register documents in the SmartPlant Foundation Desktop Client 1. Log on to the SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Component Registers. 3. Type the name of the item you want to update in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. Create and configure SIDs in SmartPlant Foundation Desktop Client You can create, configure, and manage Smart Construction standard installation diagrams or details (SID) in SmartPlant Foundation Desktop Client. Users can manually add SIDs to a component in an IWP as a work step. Administrators can configure SIDs to automatically associate with a component as a work step when rules of progress data is created during retrieve. For more information on configuring SIDs in rules of progress data, see Configure SID work steps to automatically associate with a component in the Intergraph Smart Construction Rules of Progress Configuration Guide. In order for material items to be correctly associated with a SID work step in the Material Request form, you must configure a SID material item. Create a SID in the SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > New > SID to open the New SID dialog box. 3. Type a name for the SID in the Name box. 4. Type a description for the SID in the Description box. 5. Select a component category in the Component Category box. A component category is required. For more information, see Manage Component Disciplines and Categories (on page 95). 6. Type a value in the Rate box. 7. Select a unit of measure from the UOM list. 8. Select Hidden to hide the SID from use in the Smart Construction client. 9. Click Finish to save changes. You can create SIDs with the same name and different UoMs. Once created, you cannot edit the name or UoM of a SID. If a SID is associated with a component in an IWP, it cannot be deleted from the site. Intergraph Smart Construction Administration and Configuration Guide 184

185 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Attach a document to a SID After you create a SID object in the SmartPlant Foundation Desktop Client, you can attach a document to the object to append to an IWP in Smart Construction. You can open the document from Smart Construction, and document is added to the IWP Summary and Scorecard reports. 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > SIDs to search for available SIDs. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find SIDs. 5. Right-click a SID on which you want to attach a document and select Files > Attach Files to open the Attach File dialog box. 6. Click Add File and select a file to add. For more information, see Attach a file to a document in the SmartPlant Foundation Desktop Client User's Guide. 7. Click Finish. Create a material item for a SID After you create a SID object in the SmartPlant Foundation Desktop Client, you can create material items for the SID. In order for a material item to be configured in the Material Request form, a SID material item must be associated with a SID. 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > SIDs to search for available SIDs. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find SIDs. 5. Right-click a SID on which you want to create a material item and click Materials > Material Item to open the New Material Item dialog box. 6. Type a name for the material item in the Name box. 7. Type a description for the material item in the Description box. 8. Type a short description for the material item in the Material short description box. 9. Type a value for a commodity code in the Commodity Code box. 10. Type a value in the Quantity box and select a UoM. 11. Type a value in the Size box. 12. Type a value in the Tag box. 13. Click Finish. Intergraph Smart Construction Administration and Configuration Guide 185

186 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client items. You can right-click a SID and select Show Material Item to display related material Hide a SID from use in the Smart Construction client You can hide a SID from use in the Smart Construction client which prevents the SID from being selected and added as a work step to a component in the Smart Construction client. If a SID was previously associated as a work step and is later hidden, the previously associated SID work step continues to be associated with a component, but the hidden SID is not available for selection as a work step. 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > SIDs to search for available SIDs. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find SIDs. 5. Right-click a SID and select Update. 6. On the Update dialog box, select Hidden to hide the SID. client. 7. Click Finish. Clear the Hidden option to make the SID available for use in the Smart Construction Find SIDs in the SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > SIDs to search for available SIDs. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find SIDs. Update SIDs in the SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > SIDs to search for available SIDs. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find SIDs. 5. Right-click the SID you want to edit in the search results and select Update. 6. On the Update SID form, edit the SID information. Intergraph Smart Construction Administration and Configuration Guide 186

187 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client 7. Click Finish to save changes. Create and configure cost codes You can create, configure, and manage cost codes for Smart Construction in the SmartPlant Foundation Desktop Client. Cost codes are associated to components when the Rules of Progress are generated. Cost codes can be configured in Smart Construction for cost account reference. Cost codes can be assigned to components based on the work package purpose. For example, a spool can have one cost code assigned for installation activities, and a different cost code assigned for painting activities. Cost codes are supported primarily for reporting and data exchange with other systems such as internal tracking systems. Cost codes can be displayed in the IWP components list by enabling the Cost Codes column. For more information on configuring cost codes in rules of progress data, see Configure cost codes to automatically associate with components in the Intergraph Smart Construction Rules of Progress Configuration Guide. Create a cost code in the SmartPlant Foundation Desktop Client 1. Click Smart Construction > New > Cost Code. 2. Type a description for the cost code. 3. Type a value for the cost code in the Code box. 4. Select a unit of measure from the UOM list. 5. Type a value in the Rate box. Find cost codes in the SmartPlant Foundation Desktop Client 1. Click Smart Construction > Find > Cost Code to search for available cost codes. 2. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. Update a cost code in the SmartPlant Foundation Desktop Client 1. Click Smart Construction > Find > Cost Code to search for available cost codes. 2. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 3. Right-click the cost code you want to edit in the search results and select Update. 4. Edit cost code details. Intergraph Smart Construction Administration and Configuration Guide 187

188 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client To edit the cost code UoM or code value, create a new cost code. View assemblies in your Smart Construction project You can view assemblies for your Smart Construction project using the SmartPlant Foundation Desktop Client. You can also view the parent and child relationships of the assembly. 1. Log on to the SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find, then select either 2D Drawings or 3D Models. 3. Type the name of the item you want to find in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Right-click a 2D drawing name or 3D model name in the search results, then select Show Assemblies. 5. In the assemblies list, right-click an assembly name and select Show Child to view child relationships. 6. In the assemblies list, right-click an assembly name and select Show Parent to view parent relationships. Manage crews in Smart Construction You can create and manage crews and configure crews for Smart Construction IWPs. Crews can be created as objects in SmartPlant Foundation and related to IWPs in Smart Construction, or they can be created as constraints in an IWP. If configured as objects in SmartPlant Foundation, administrators configure crews to be managed by crew size or by name. If you manage crews based on size, users can specify crews for an IWP based on the size and duration needed. If you manage crews based on name, users can select crews for an IWP by their name. Administrators can specify how crews are managed using a system option. For more information, see Configure and update system settings for Smart Construction (on page 31). Crews can also be created as construction resources and associated with IWPs as constraints. Administrators can import crews using the project configuration data and associate those crews with an IWP as constraints. For more information, see Import project configuration data into Smart Construction (on page 54). You can run the Constraint Request Forms report to request and manage crews as constraints. Intergraph Smart Construction Administration and Configuration Guide 188

189 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Create a new crew in the SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > New > Crew to open the New Crew dialog box. 3. Type a name for the crew in the Name box. 4. Type a description for the crew in the Description box. 5. Type a value in the Crew Size box. 6. Select a contractor from the Contractor box. 7. Click Finish to save changes and create the new crew. You can create a crew from a contractor object in the SmartPlant Foundation Desktop Client. Search for or create a contractor, then right-click the contractor object and select New Crew to open the New Crew dialog box. Find crews in the SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Crews to search for available crews for your site. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find crews. You can right-click a crew and select Show Contractor to view the contractor associated with the crew. You can find a crew by viewing its relationship with a contractor. Search for contractors in the SmartPlant Foundation Desktop Client. Right-click the contractor and select Show Crew to view the crew associated with the contractor. Update crews in the SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Crews to search for available crews for your site. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find crews. 5. Right-click the crew you want to edit in the search result and select Update. 6. On the Update Crew form, edit the crew. 7. Click Finish to save changes. Intergraph Smart Construction Administration and Configuration Guide 189

190 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Configure and manage Dashboards in Smart Construction The Dashboard provides users tools and views that can be personalized in order to better plan their construction project. A Dashboard view is a configured console that displays charts, graphs, lists, and other Dashboard items. You can create Dashboard views and items in SmartPlant Foundation Desktop Client. Views and items are specific to your plant. Create a new Dashboard view in SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > New > Administration > Dashboard View to open the New Dashboard View dialog box. 3. Type a name for the Dashboard view in the Name box. 4. Type a description for the Dashboard view in the Description box. 5. Type or copy text in the Layout XML box. 6. Type or copy text in the Configuration XML box. 7. Click Finish to save changes and create the new Dashboard view. Find Dashboard views in SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Administration > Dashboard Views to search for Dashboard views for your site. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find the Dashboard view. Intergraph Smart Construction Administration and Configuration Guide 190

191 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Update Dashboard views in SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Administration > Dashboard Views to search for Dashboard views for your site. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find the Dashboard view. 5. Right-click the Dashboard view you want to edit in the search result and select Update. 6. On the Update Dashboard View form, edit the item. 7. Click Finish to save changes. Manage security for your Dashboard view Smart Construction Dashboard views use the SmartPlant Foundation Desktop Client security model. For more information, see Configure Smart Construction Security (on page 16). By default, when a user creates a Dashboard view, no access group is associated with the Dashboard view. When a user shares a Dashboard view, the SPC_Everyone access group is associated with the Dashboard view, and it is available for all users to view and manage. Administrators can associate different access groups to the Dashboard view through SmartPlant Foundation Desktop Client. Users can share, modify, or delete Dashboard views that they create. Users can also share, modify, or delete Dashboard views when they have the SPC_DashboardManager access group associated with their role. 1. Click Smart Construction > Find > Administration > Dashboard Views to open the Find Dashboard Views dialog box. 2. Type your search criteria in the Find Dashboard Views dialog box. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 3. Right-click the name of the Dashboard view and select Manage Access Groups. 4. On the Manage Access Groups window, select an access group to add to the Dashboard view. 5. Click Relate Selected Item to add the access group to the Dashboard view. 6. Click OK to save your changes. For more information on managing access groups, see SmartPlant Foundation How to Configure the Security Model. Intergraph Smart Construction Administration and Configuration Guide 191

192 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Create a new Dashboard item in SmartPlant Foundation Desktop Client Contact Intergraph Customer Support ( to create a new Dashboard item for your Dashboard. 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > New > Administration > Dashboard Item to open the New Dashboard Item dialog box. 3. Type a name for the Dashboard item in the Name box. 4. Type a description for the Dashboard item in the Description box. 5. Type an image name to represent the Dashboard item in the Smart Construction application in the Icon Name box. The image must be included in the Images folder on each workstation using the Dashboard item. For example, place the image in [Drive]:\Program Files (x86)\smartconstruction\2017\spcclient\images. 6. Click Finish to save changes and create the new Dashboard item. Find Dashboard items in the SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Administration > Dashboard Items to search for Dashboard items for your site. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find Dashboard items. Configure your Web Browser dashboard item to open to a specific website or address You can configure your Web Browser dashboard item to always open to a specific website or address. If a website or address is not listed for your Web Browser dashboard item, you can specify a website or address using the Settings option on the Dashboard item in Smart Construction. When you configure a specific address for your dashboard item, the address bar is not available in the dashboard item in Smart Construction. Users can only visit the website or address specified. 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Administration > Dashboard Items to search for Dashboard items for your site. Intergraph Smart Construction Administration and Configuration Guide 192

193 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find Dashboard items. 5. Right-click your Web Browser dashboard item and select Update. 6. Type the name of the website or address in the Argument 1 box. 7. Click Finish to save changes. Add or remove search criteria for a dashboard item Add search criteria for a dashboard item To add search criteria to a dashboard item, you can create a new property definition in SmartPlant Schema Editor. The new property must be exposed by the ISPC_FIWP interface definition, or they must be an exposed property on an interface definition that is implied by ISPC_FIWP. Remove search criteria for a dashboard item 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Administration > Dashboard Items to search for Dashboard items for your site. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find Dashboard items. 5. Right-click the dashboard item and click Update. 6. Type the name of a property in the Excluded Properties box to remove a search criteria to the dashboard item. Separate multiple entries with a semicolon (;). For example, to remove the search criteria All Constraints Met, type All Constraints Met. 7. Click Finish to save changes. Manage security for Dashboard items Smart Construction Dashboard items use the SmartPlant Foundation Desktop Client security model. For more information, see Configure Smart Construction Security (on page 16). 1. Click Smart Construction > Find > Administration > Dashboard Items to open the Find Dashboard Items dialog box. 2. Type your search criteria in the Find Dashboard Items dialog box. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 3. Right-click the name of the Dashboard item and select Manage Access Groups. Intergraph Smart Construction Administration and Configuration Guide 193

194 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client 4. On the Manage Access Groups window, select an access group to add to the Dashboard item. 5. Click Relate Selected Item to add the access group to the Dashboard item. 6. Click OK to save your changes. For more information on managing access groups, see SmartPlant Foundation How to Configure the Security Model. Update Dashboard items in the SmartPlant Foundation Desktop Client 1. Log on to SmartPlant Foundation Desktop Client. 2. Click Smart Construction > Find > Administration > Dashboard Items to search for Dashboard items for your site. 3. Type the name of the object for which you want to search. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Click OK to find Dashboard items. 5. Right-click the Dashboard item you want to edit in the search result and select Update. 6. On the Update Dashboard Item form, edit the item. 7. Click Finish to save changes. Relate Dashboard items to a Dashboard view in SmartPlant Foundation Desktop Client 1. Find Dashboard views in the SmartPlant Foundation Desktop Client. For more information, see Find Dashboard views in SmartPlant Foundation Desktop Client (on page 190). 2. Find Dashboard items in the SmartPlant Foundation Desktop Client. For more information, see Find Dashboard items in the SmartPlant Foundation Desktop Client (on page 192). 3. Drag a Dashboard item to the Dashboard view to create a relationship between the two objects. Configure the SmartPlant Foundation System Calendar for the Smart Construction Work Package Schedule window The Work Package Schedule window uses the SmartPlant Foundation system calendar to configure working days and non-working days. Administrators can specify the calendar to use in the SmartPlant Foundation Options. For more information, see SmartPlant Foundation Options in the SmartPlant Foundation Administrator's Guide. Intergraph Smart Construction Administration and Configuration Guide 194

195 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Administrators can configure working days and non-working days on the calendar in the SmartPlant Foundation Desktop Client. For more information, see Configure and maintain calendars in the SmartPlant Foundation How to Configure the Infrastructure Model guide. If you are using Primavera P6 with your Smart Construction project, configure your Primavera P6 calendar to match your SmartPlant Foundation system calendar. When non-working days are specified, Smart Construction visually represents them in the Work Package Schedule window. When you specify non-working days, you can choose to ignore them in calculating duration and crew size. If you ignore the non-working day in your calculation, the non-working day would be considered a work day. If you include the non-working in your calculation, work does not occur on a non-working day. For example, if you set non-working days for Saturday and Sunday and duration is calculated for five days with work starting on Thursday and non-working days are included, Smart Construction calculates the IWP to end on Wednesday. If you set non-working days for Saturday and Sunday and duration is calculated for five days with work starting on Thursday and non-working days are ignored, Smart Construction calculates the IWP to end on Monday. Update and configure items on the Smart Construction interface You can update and configure items on the Smart Construction interface such as the Smart Construction Standard Toolbar, the Smart Construction Project Home Page, and IWP header items in SmartPlant Foundation Desktop Client. You can update items, view relationships associated with the items, and view access groups associated with the items. Update Smart Construction interface items 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration, and then select an interface item from the menu. To find a Smart Construction Standard Toolbar item to update, click Main Toolbar Items. To find an item on the Smart Construction Home Page to update, click Workspace Items. To find work package header items to update, click Work Package Toolbar Items. 3. Type the name of the item you want to update in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. In the search results list, right-click the name of the item you want to update and select Update. 5. Edit the item information on the Update form. 6. Click Finish to save changes and update the system. Intergraph Smart Construction Administration and Configuration Guide 195

196 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client Do not update or modify the following details on the interface items: ToolbarItem Toolbar item style WorkspaceItem TypeToOpen WorkspaceItem Data Template You can update the following details for a Main toolbar item: Toolbar item tooltip - defines the tooltip for the item. Surround the Display As value with braces { }, which serve as a key to retrieve the value from the resource file. Add the display value to the resource file. Toolbar item sequence - defines the position of the toolbar item going from left to right. Toolbar item display as - defines how the item displays on the interface. You can update the following details for a Workspace item: Workspace item sequence - defines the position of the workspace item going from left to right. Icon Name - defines the image to display on the home page. You can update this image by typing the name of an image in the Icon Name box and inserting the image to the Images folder in the Smart Construction installation folder on each client workstation. For example, browse to and open [Drive]:\Program Files (x86)\smartconstruction\2017\spcclient\images. Workspace item DisplayAs - defines the text that displays on the interface. Surround the Display As value with braces { }, which serve as a key to retrieve the value from the resource file. Add the display value to the resource file. Open view on login? - If selected, the Open view on login? option opens the main menu item when the user logs into Smart Construction. You can update the following details for an work package toolbar items: Toolbar item tooltip - defines the tooltip for the item. Toolbar item sequence - defines the position of the toolbar item going from left to right. Toolbar item display as - defines how the item displays on the interface. Surround the Display As value with braces { }, which serve as a key to retrieve the value from the resource file. Add the display value to the resource file. Update Mode - specifies if the work package tab can be updated or not. Copy Mode - specifies if the work package tab can be copied or not. For more information about configuring new IWP toolbar items, see Create and configure work package toolbar items (on page 171). Intergraph Smart Construction Administration and Configuration Guide 196

197 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client View relationships associated with Smart Construction interface items You can view relationships associated with items on the Smart Construction interface. For example, you can view which access groups are associated with the IWP header item Materials. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration, and then select an interface item. To find a Smart Construction Standard Toolbar item, select Main Toolbar Items. To find an item on the Smart Construction Home Page, select Workspace Items. To find IWP header items, select Work Package Toolbar Items. 3. Type the name of the item on the Smart Construction interface in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. In the search results list, right-click the name of an item and select Show All Relationships. All relationships shared with the item are displayed. View access groups associated with Smart Construction interface items You can view access groups associated with items on the Smart Construction interface. For example, you can view access groups associated with the IWP header item Schedule. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > Administration, and then select an interface item. To find a Smart Construction Standard Toolbar item, select Main Toolbar Items. To find an item on the Smart Construction Home Page, select Workspace Items. To find IWP header items, select Work Package Toolbar Items. 3. Type the name of the item on the Smart Construction interface in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. In the search results list, right-click the name of an item and select Show Access Groups. All access groups associated with the item are displayed. Intergraph Smart Construction Administration and Configuration Guide 197

198 Configure Smart Construction Objects in SmartPlant Foundation Desktop Client View Smart Construction objects in SmartPlant Foundation Desktop Client You can view details and the history of Smart Construction objects in SmartPlant Foundation. You can search for IWPs, CWPs, 2D drawings, 3D models, files available for an IWP, spools, contracts, and contractors in your project. 1. Log on to SmartPlant Foundation Desktop Client as an administrator. 2. Click Smart Construction > Find > and then select the object type you want to search for. 3. Type the name of the object in the Find dialog box. Click OK. You can use wildcards to narrow search results.? and _ find any single character. * and % find any string of characters. 4. Right-click an object name to view more details, update, show relationships, or view history. Intergraph Smart Construction Administration and Configuration Guide 198

199 A PPENDIX A Smart Construction Launch Parameters Smart Construction supports a set of parameters that can be used when launching the application from the command line. The following section explains the parameters that can be used when launching these applications. Smart Construction command line parameters Command line parameters are typically used when launching Smart Construction from another application. They allow you to control who the user logs in as and what plant/project access they have. The command line parameters can also be used to log on to the Smart Construction client. When launching Smart Construction from the command line, all parameters begin with a slash ( / ) and require a colon (:) between the parameter and the value. If the value contains spaces, it must be enclosed inside double quotation marks (" "). The parameter values for /Roles: and /P: are case sensitive. Logon Parameters Parameter /U: /P: /S: /H: /W: /Plant: /Project: /Roles: /Secure: /O: Description User Password Server Host Web directory Plant Project Roles True/False: if logging on to server using SSL Opens windows from the Smart Construction Home Page. Use the Workspace Item name in SmartPlant Foundation Desktop Client as the parameter. SPC.Client.exe /? or SPC.Client.exe /help displays help for command line parameters in the command prompt window. Intergraph Smart Construction Administration and Configuration Guide 199

200 Smart Construction Launch Parameters Detailed below is the behavior, depending on what you pass in on the command line: /U: /P: This autopopulates the user name and password in the client. /U: /P: /Plant: /Project: /S: This logs you in as the user specified with the plant/project specified on the given server if the server is not authenticated. The user and password are ignored if the server is authenticated. If the server is authenticated, the logon dialog box displays with the User name and Password disabled, and the Server list is set to the correct server. /U: /P: /Plant: /Project: /H: /W: This is the same as the previous example, but it uses the host and web directory instead of the server. /U: /P: /Plant: /Project: A logon dialog box displays with the User name and Password boxes populated. /S: /Plant: /Project: If the server is authenticated, this logs you on to Smart Construction. If the server is not authenticated, the logon dialog box displays with the Server list disabled showing the specified server. /H: /W: /Plant: /Project: Same as the previous example except that if the specified Web host and Web directory have not been defined, a new server is created from these. If the new server is authenticated, this logs you on. If the new server is not authenticated, the logon dialog box displays with the Server list disabled showing the specified server. /Plant: /Project: This displays the logon dialog box, but once you have selected a server and logged on, the specified Plant and Project are honored. /U: /S: /O: This logs onto the server and opens a specified window from the Home Page. If you do not specify any command line parameters, the logon dialog box displays. If you pick an authenticated server from the list, the User name and Password are disabled. They are enabled if you pick a server that is not authenticated. If a server is not responding, a message box displays to tell the user, and the OK button is disabled. The OK button is enabled if you select another server that is responding. Examples SPC_Client.exe /U:[UserName] /P:[Password] /S:[ServerName] SPC_Client.exe /U:[UserName] /P:[Password] /PLANT:[PlantName] /PROJECT:[ProjectName] /S:[ServerName] SPC.Client.exe /U:[UserName] /S:[ServerName] /O:"Work Packages" Intergraph Smart Construction Administration and Configuration Guide 200

201 A PPENDIX B Install Smart Construction in Silent Mode To install Smart Construction software in silent mode, use the installation executable file in a command line with the required information passed as arguments. For example, the following commands install one of the Smart Construction software components alone: Setup.exe -silent -install ADDLOCAL=SPCCore,SPCClient SLAACCEPT=YES SERIALNUM= USERNAME=UserName COMPANYNAME=YourCompany Setup.exe -silent -install ADDLOCAL=SPCCore,SPCServer SLAACCEPT=YES SERIALNUM= USERNAME=UserName COMPANYNAME=YourCompany To install both Smart Construction components, use the following command: Setup.exe -silent -install SLAACCEPT=YES ADDLOCAL=ALL SERIALNUM= USERNAME=UserName COMPANYNAME=YourCompany All arguments and values are case-sensitive. Required silent install parameters -q, -quiet, -s, -silent -install SLAACCEPT SERIALNUM USERNAME COMPANYNAME Runs in silent mode (no prompts). Performs an installation. Accepts the sales license agreement. Value must be YES. Provides the product serial number. Provides the user name associated with the product serial number. Provides the company name associated with the product serial number. Intergraph Smart Construction Administration and Configuration Guide 201

202 Install Smart Construction in Silent Mode Optional silent install parameters -l, -log -uninstall -repair ADDLOCAL INSTALLLOCATION REMOVE Writes log information to a file. Removes all installed components of the software. Reinstalls all installed components of the software. Specifies the components to be installed. Names are case-sensitive. For both components, use ALL. To install one of the components alone, use SPCCore with one of the following values separated by commas with no spaces, as shown: SPCCore,SPCClient SPCCore,SPCServer Specifies a path to the location where the software is to be installed. Specifies the list of features to be removed, separated by commas. Feature names are case-sensitive. Intergraph Smart Construction Administration and Configuration Guide 202

203 A PPENDIX C Localize Smart Construction Smart Construction supports localization of both the client user interface and the messages returned to the client from the server, such as error or warning messages. Strings used for display in the user interface are stored in a resource file (.resx). The resource files can be edited to add the foreign text strings and then compiled into a binary resource DLL. This DLL is then placed in the proper location on the client and server computers, so Smart Construction uses the proper DLL based on the locale settings of the computer. Prerequisite software required. Install Microsoft Visual Studio 2008 SDK Version 1.0 and Smart Construction before localizing the software. Customers using multi-byte languages, such as Chinese and Japanese, with Smart Construction need to contact Intergraph Customer Support ( during installation to acquire a database update in order to accommodate the full length of some properties. Client resource localization Smart Construction supports localization of the client user interface. In order to localize the Smart Construction user interface, an administrator needs to perform the following procedure: 1. Make a backup copy of the resource file (on page 204) 2. Translate the strings into the chosen language (on page 204) 3. Determine the language or culture code for the language (on page 204) 4. Compile the resource file into a binary DLL (on page 204) 5. Move the files to a new folder for the language (on page 206) 6. Verify the correct language strings display in the client application (on page 206) Prerequisite software required. Install Microsoft Visual Studio 2008 SDK Version 1.0 and Smart Construction before localizing the software. Surround the Display As value with braces { }, which serve as a key to retrieve the value from the resource file. Add the display value to the resource file. Intergraph Smart Construction Administration and Configuration Guide 203

204 Localize Smart Construction Make a backup copy of the resource file The client resource file, SPCClientResources.resx, is located in the Localization subfolder of the Smart Construction installation location (browse to [Drive]:\Program Files (x86)\smartconstruction\2017\customization\localization). Make a copy of the original SPCClientResources.resx file, and save it as a backup file in a different location than the Localization subfolder, in case you need to recover it later. Translate the strings into the chosen language 1. Open the SPCClientResources.resx file in a text editor that can open an ASCII file, such as Notepad or Microsoft Visual Studio. 2. Translate the strings in the data tags (<data> </data>) to the language of your choice. Preserve the original English language strings in comment tags (<comment> </comment>), as seen in the following image. Do not modify information contained in the opening XML tags and the XSD schema section of the resource file. 3. Save the SPCClientResources.resx file when you are done modifying the strings. Determine the language or culture code for the language Determine the language or culture code of the language for the translated strings. For example, for English, the code is en. For American English, the code is en-us. Compile the resource file into a binary DLL In order to compile the resource file into a binary DLL, you must use the proper.net Framework Resource Generator (ResGen.exe) and Assembly Linker (al.exe) to create the localized resource DLL to use with Smart Construction. Both of these programs are typically located in the Bin folder under [Drive]:\Program Files\Windows SDKs\V7.0A installation path. Run the Resource Generator executable 1. Open a Command Prompt window. 2. Change the active path to the folder that contains the SPCClientResources.resx file that needs to be compiled. 3. Run the Resource Generator executable file and specify the name of the resource file and the name of the output file. Intergraph Smart Construction Administration and Configuration Guide 204

205 Localize Smart Construction As seen in the following example, if you are translating the file into Portuguese, the file name is SPCClientResources.pt.Resources. The command line to execute is "C:\Program Files (x86)\microsoft SDKs\Windows\V7.0A\Bin\ResGen.exe" SPC.ClientResources.Resx SPCClientResources.pt.Resources. Run the Assembly Linker executable Use the Assembly Linker executable to compile the Resources file into a DLL. The command line parameters for the Assembly Linker program are: /t: lib - compiles the file into a library. /embed: SPCClientResources.[culture code].resources - embeds the Resources file generated by the Resource Generator program into a DLL. /culture:[culture code] - identifies the culture for which the DLL is being compiled. /version[version number] - a version number to apply to the DLL. /out.spc.client.infrastructure.resources.dll - name of the output file to write. Intergraph Smart Construction Administration and Configuration Guide 205

206 Localize Smart Construction As seen in the following example, if you are translating the file into Portuguese, the command line to execute is "C:\Program Files (x86)\microsoft SDKs\Windows\V7.0A\Bin\al.exe." /t:lib /embed:spcclientresources.pt.resources /culture:pt /version: /out:spc.client.infrastructure.resources.dll. After you run the Assembly Linker program, you should have three files in the folder: SPC.Client.Infrastructure.Resources.dll SPCClientResources.[culture code].resources SPCClientResources.Resx Move the files to a new folder for the language 1. Create a new folder under the SPCClient installation path (browse to [Drive]:\Program Files (x86)\smartconstruction\2017\spcclient) on each client machine you want to localize. 2. Name the folder the culture code value. For example, name the folder pt for Portuguese. 3. Copy the DLL file, SPC.Client.Infrastructure.Resources.dll, into the new folder. Verify the correct language strings display in the client application 1. Set the Locale Settings to the chosen language. 2. Start Smart Construction. 3. Verify the correct language strings are available in the client application. Intergraph Smart Construction Administration and Configuration Guide 206

207 Localize Smart Construction Localize a printed reports If your computer is set to a different language or locale, you need to localize reports. In order to localize reports generated from Smart Construction, custom templates for each report need to be created for each language. For more information localizing custom reports, see Localize your custom report in the Intergraph Smart Construction API and Programmer's Guide or the Intergraph Smart Construction Customization Guide. Server resource localization Smart Construction supports localization of the messages returned to the client from the server, such as error or warning messages. In order to localize the Smart Construction server messages, an administrator needs to perform the following procedure: 1. Make backup copies of the resource files (on page 207) 2. Translate the strings into the chosen language (on page 207) 3. Determine the language or culture code for the language (on page 208) 4. Compile the resource files (on page 208) 5. Move the files to a new folder for the language (on page 210) 6. Verify the correct language strings display in the application (on page 210) Prerequisite software required. Install Microsoft Visual Studio 2008 SDK Version 1.0 and Smart Construction before localizing the software. Make backup copies of the resource files The server resource files, SPCServerResources.resx and SPCResources.Resx, are located in the Localization subfolder of the Smart Construction installation location (browse to [Drive]:\Program Files (x86)\smartconstruction\2017\customization\localization). Make copies of the original SPCServerResources.resx file and SPCResources.Resx. Save the files as backup copies in a different location than the Localization subfolder, in case you need to recover them later. Translate the strings into the chosen language 1. Open the SPCServerResources.resx file in a text editor that can open an ASCII file, such as Notepad or Microsoft Visual Studio. 2. Translate the strings in the data tags (<data> </data>) to the language of your choice. Preserve the original English language strings in comment tags (<comment> </comment>). Do not modify information contained in the opening XML tags and the XSD schema section of the resource file. 3. Save the SPCServerResources.resx file when you are done modifying the strings. 4. Repeat steps 1-3 for the SPCResources.Resx file. Intergraph Smart Construction Administration and Configuration Guide 207

208 Localize Smart Construction Determine the language or culture code for the language Determine the language or culture code of the language for the translated strings. For example, for English, the code is en. For American English, the code is en-us. Compile the resource files In order to compile the resource files into a binary DLL, you must use the proper.net Framework Resource Generator (ResGen.exe) and Assembly Linker (al.exe) to create the localized resource DLL to use with Smart Construction. Both of these programs are typically located in the BIN directory under [Drive]:\Program Files\Windows SDKs\V7.0A installation path. Run the Resource Generator executable 1. Open a Command Prompt window. 2. Change the active path to the folder that contains the SPCServerResources.resx file that needs to be compiled. 3. Run the Resource Generator executable file and specify the name of the resource file and the name of the output file. For example, if you are translating the file into Portuguese, the file name is SPCServerResources.pt.Resources. The command line to execute would be "C:\Program Files (x86)\microsoft SDKs\Windows\V7.0A\Bin\ResGen.exe." SPC.ServerResources.Resx SPCServerResources.pt.Resources. 4. Repeat steps 1-3 for the SPCResources.resx file. Run the Assembly Linker executable Use the Assembly Linker executable to compile the SPCResources.[culture code].resources and the SPCServerResources.[culture code].resources files into a single SPC.SharedResources.dll. Intergraph Smart Construction Administration and Configuration Guide 208

209 The command line parameters for the Assembly Linker program are: /t: lib - compiles the file into a library. Localize Smart Construction /embed: SPCClientResources.[culture code].resources - embeds the Resources file generated by the Resource Generator program into a DLL. /culture:[culture code] - identifies the culture for which the DLL is being compiled. /version[version number] - a version number to apply to the DLL. /out.spc.client.infrastructure.resources.dll - name of the output file to write. For example, if you are translating the file into Portuguese, the command line to execute would be "C:\Program Files (x86)\microsoft SDKs\Windows\V7.0A\Bin\al.exe." /t:lib /embed:spcresources.pt.resources /embed:spcserverresources.pt.resources /culture:pt /version: /out:spc.shared.resources.dll. After you run the Assembly Linker program, five files can be found in the folder: SPC.SharedResources.dll SPCResources.[culture code].resources SPCResources.Resx SPCServerResources.[culture code].resources SPCServerResources.resx Intergraph Smart Construction Administration and Configuration Guide 209